|
| 1 | +import { |
| 2 | + getNodeImportCalls, |
| 3 | + getNodeImportStatements, |
| 4 | +} from "@nodejs/codemod-utils/ast-grep/import-statement"; |
| 5 | +import { getNodeRequireCalls } from "@nodejs/codemod-utils/ast-grep/require-call"; |
| 6 | +import { resolveBindingPath } from "@nodejs/codemod-utils/ast-grep/resolve-binding-path"; |
| 7 | +import { updateBinding } from "@nodejs/codemod-utils/ast-grep/update-binding"; |
| 8 | +import { removeLines } from "@nodejs/codemod-utils/ast-grep/remove-lines"; |
| 9 | +import type { SgRoot, SgNode, Edit, Range } from "@codemod.com/jssg-types/main"; |
| 10 | +import type Js from "@codemod.com/jssg-types/langs/javascript"; |
| 11 | + |
| 12 | +type Binding = { |
| 13 | + type: "namespace" | "destructured"; |
| 14 | + binding: string; |
| 15 | + node: SgNode<Js>; |
| 16 | +}; |
| 17 | + |
| 18 | +/** |
| 19 | + * Transform function that converts deprecated crypto.fips calls |
| 20 | + * to the new crypto.getFips() and crypto.setFips() syntax. |
| 21 | + * |
| 22 | + * Handles: |
| 23 | + * 1. crypto.fips → crypto.getFips() |
| 24 | + * 2. crypto.fips = value → crypto.setFips(value) |
| 25 | + * 3. const { fips } = require("crypto") → const { getFips, setFips } = require("crypto") |
| 26 | + * 4. import { fips } from "crypto" → import { getFips, setFips } from "crypto") |
| 27 | + * 5. const { fips } = await import("crypto") → const { getFips, setFips } = await import("crypto") |
| 28 | + * 6. Aliased imports: { fips: alias } → { getFips, setFips } |
| 29 | + */ |
| 30 | +export default function transform(root: SgRoot<Js>): string | null { |
| 31 | + const rootNode = root.root(); |
| 32 | + const edits: Edit[] = []; |
| 33 | + const linesToRemove: Range[] = []; |
| 34 | + |
| 35 | + const bindings = collectCryptoFipsBindings(root); |
| 36 | + |
| 37 | + if (bindings.length === 0) return null; |
| 38 | + |
| 39 | + for (const binding of bindings) { |
| 40 | + if (binding.type === "namespace") { |
| 41 | + edits.push(...transformNamespaceUsage(rootNode, binding.binding)); |
| 42 | + } else { |
| 43 | + edits.push(...transformDestructuredUsage(rootNode, binding.binding)); |
| 44 | + |
| 45 | + const result = updateBinding(binding.node, { |
| 46 | + old: binding.binding, |
| 47 | + new: ["getFips", "setFips"], |
| 48 | + }); |
| 49 | + if (result?.edit) { |
| 50 | + edits.push(result.edit); |
| 51 | + } |
| 52 | + if (result?.lineToRemove) { |
| 53 | + linesToRemove.push(result.lineToRemove); |
| 54 | + } |
| 55 | + } |
| 56 | + } |
| 57 | + |
| 58 | + if (edits.length === 0 && linesToRemove.length === 0) return null; |
| 59 | + |
| 60 | + const sourceCode = rootNode.commitEdits(edits); |
| 61 | + return linesToRemove.length > 0 ? removeLines(sourceCode, linesToRemove) : sourceCode; |
| 62 | +} |
| 63 | + |
| 64 | +/** |
| 65 | + * Collect all crypto.fips bindings from the file |
| 66 | + */ |
| 67 | +function collectCryptoFipsBindings(root: SgRoot<Js>): Binding[] { |
| 68 | + const bindings: Binding[] = []; |
| 69 | + const allStatements = [ |
| 70 | + ...getNodeImportStatements(root, "crypto"), |
| 71 | + ...getNodeImportCalls(root, "crypto"), |
| 72 | + ...getNodeRequireCalls(root, "crypto"), |
| 73 | + ]; |
| 74 | + |
| 75 | + for (const node of allStatements) { |
| 76 | + const resolvedPath = resolveBindingPath(node, "$.fips"); |
| 77 | + |
| 78 | + if (!resolvedPath) continue; |
| 79 | + |
| 80 | + if (resolvedPath.includes(".")) { |
| 81 | + bindings.push({ |
| 82 | + type: "namespace", |
| 83 | + binding: resolvedPath.slice(0, resolvedPath.lastIndexOf(".")), |
| 84 | + node, |
| 85 | + }); |
| 86 | + } else { |
| 87 | + bindings.push({ |
| 88 | + type: "destructured", |
| 89 | + binding: resolvedPath, |
| 90 | + node, |
| 91 | + }); |
| 92 | + } |
| 93 | + } |
| 94 | + |
| 95 | + return bindings; |
| 96 | +} |
| 97 | + |
| 98 | +/** |
| 99 | + * Transform namespace usage: crypto.fips → crypto.getFips(), crypto.fips = val → crypto.setFips(val) |
| 100 | + */ |
| 101 | +function transformNamespaceUsage(rootNode: SgNode<Js>, base: string): Edit[] { |
| 102 | + const edits: Edit[] = []; |
| 103 | + |
| 104 | + const assignments = rootNode.findAll({ |
| 105 | + rule: { pattern: `${base}.fips = $VALUE` }, |
| 106 | + }); |
| 107 | + |
| 108 | + for (const assignment of assignments) { |
| 109 | + const valueNode = assignment.getMatch("VALUE"); |
| 110 | + if (valueNode) { |
| 111 | + let value = valueNode.text(); |
| 112 | + value = value.replace(new RegExp(`\\b${base}\\.fips\\b`, "g"), `${base}.getFips()`); |
| 113 | + edits.push(assignment.replace(`${base}.setFips(${value})`)); |
| 114 | + } |
| 115 | + } |
| 116 | + |
| 117 | + const reads = rootNode.findAll({ |
| 118 | + rule: { |
| 119 | + pattern: `${base}.fips`, |
| 120 | + not: { |
| 121 | + inside: { |
| 122 | + kind: "assignment_expression", |
| 123 | + has: { |
| 124 | + kind: "member_expression", |
| 125 | + pattern: `${base}.fips`, |
| 126 | + }, |
| 127 | + }, |
| 128 | + }, |
| 129 | + }, |
| 130 | + }); |
| 131 | + |
| 132 | + for (const read of reads) { |
| 133 | + edits.push(read.replace(`${base}.getFips()`)); |
| 134 | + } |
| 135 | + |
| 136 | + return edits; |
| 137 | +} |
| 138 | + |
| 139 | +/** |
| 140 | + * Transform destructured usage: fips → getFips(), fips = val → setFips(val) |
| 141 | + */ |
| 142 | +function transformDestructuredUsage(rootNode: SgNode<Js>, binding: string): Edit[] { |
| 143 | + const edits: Edit[] = []; |
| 144 | + |
| 145 | + const assignments = rootNode.findAll({ |
| 146 | + rule: { |
| 147 | + pattern: `${binding} = $VALUE`, |
| 148 | + }, |
| 149 | + }); |
| 150 | + |
| 151 | + for (const assignment of assignments) { |
| 152 | + const valueNode = assignment.getMatch("VALUE"); |
| 153 | + if (valueNode) { |
| 154 | + let value = valueNode.text(); |
| 155 | + value = value.replace(new RegExp(`\\b${binding}\\b`, "g"), "getFips()"); |
| 156 | + edits.push(assignment.replace(`setFips(${value})`)); |
| 157 | + } |
| 158 | + } |
| 159 | + |
| 160 | + const reads = rootNode.findAll({ |
| 161 | + rule: { |
| 162 | + kind: "identifier", |
| 163 | + pattern: binding, |
| 164 | + not: { |
| 165 | + inside: { |
| 166 | + any: [ |
| 167 | + { |
| 168 | + kind: "assignment_expression", |
| 169 | + has: { |
| 170 | + kind: "identifier", |
| 171 | + pattern: binding, |
| 172 | + }, |
| 173 | + }, |
| 174 | + { kind: "import_statement" }, |
| 175 | + { kind: "import_specifier" }, |
| 176 | + { kind: "named_imports" }, |
| 177 | + { kind: "object_pattern" }, |
| 178 | + { kind: "pair_pattern" }, |
| 179 | + ], |
| 180 | + }, |
| 181 | + }, |
| 182 | + }, |
| 183 | + }); |
| 184 | + |
| 185 | + for (const read of reads) { |
| 186 | + edits.push(read.replace("getFips()")); |
| 187 | + } |
| 188 | + |
| 189 | + return edits; |
| 190 | +} |
0 commit comments