|
| 1 | +import type { PrinterBlueprint } from "@codemod-com/printer"; |
| 2 | +import type { TelemetrySender } from "@codemod-com/telemetry"; |
| 3 | +import { type fs, vol } from "memfs"; |
| 4 | +import { afterEach, describe, expect, it, vi } from "vitest"; |
| 5 | + |
| 6 | +import { randomBytes } from "node:crypto"; |
| 7 | +import type { GlobalArgvOptions, RunArgvOptions } from "../buildOptions"; |
| 8 | +import { handleRunCliCommand } from "../commands/run"; |
| 9 | + |
| 10 | +const mockedArgs = { |
| 11 | + _: ["recipe1"], |
| 12 | + target: "./target", |
| 13 | + telemetry: true, |
| 14 | + cache: true, |
| 15 | + format: true, |
| 16 | + threads: 1, |
| 17 | + dry: false, |
| 18 | + install: true, |
| 19 | + "disable-tree-version-check": true, |
| 20 | +} as unknown as GlobalArgvOptions & RunArgvOptions; |
| 21 | + |
| 22 | +const mockedSendDangerousEvent = vi.fn(); |
| 23 | + |
| 24 | +const mockedTelemetry = { |
| 25 | + sendDangerousEvent: mockedSendDangerousEvent, |
| 26 | + sendEvent: vi.fn(), |
| 27 | + sendError: vi.fn(), |
| 28 | +} as unknown as TelemetrySender<any>; |
| 29 | + |
| 30 | +const mockedPrinter = { |
| 31 | + __jsonOutput: true, |
| 32 | + printMessage: vi.fn(), |
| 33 | + printOperationMessage: vi.fn(), |
| 34 | + printConsoleMessage: vi.fn(), |
| 35 | + withLoaderMessage: vi.fn(), |
| 36 | +} as unknown as PrinterBlueprint; |
| 37 | + |
| 38 | +const mocks = vi.hoisted(() => { |
| 39 | + return { |
| 40 | + CodemodDownloader: vi.fn(), |
| 41 | + }; |
| 42 | +}); |
| 43 | + |
| 44 | +const mockedRecipe = { |
| 45 | + bundleType: "package", |
| 46 | + source: "registry", |
| 47 | + name: "recipe1", |
| 48 | + version: "1.0.0", |
| 49 | + engine: "recipe", |
| 50 | + codemods: [ |
| 51 | + { |
| 52 | + bundleType: "package", |
| 53 | + source: "registry", |
| 54 | + name: "codemod1", |
| 55 | + version: "1.0.0", |
| 56 | + engine: "jscodeshift", |
| 57 | + indexPath: "./codemods/codemod1/dist/index.cjs", |
| 58 | + directoryPath: "./codemods/codemod1", |
| 59 | + arguments: [], |
| 60 | + }, |
| 61 | + { |
| 62 | + bundleType: "package", |
| 63 | + source: "registry", |
| 64 | + name: "codemod2", |
| 65 | + version: "1.0.0", |
| 66 | + engine: "jscodeshift", |
| 67 | + indexPath: "./codemods/codemod2/dist/index.cjs", |
| 68 | + directoryPath: "./codemods/codemod2", |
| 69 | + arguments: [], |
| 70 | + }, |
| 71 | + ], |
| 72 | + directoryPath: "./codemods/recipe1", |
| 73 | + arguments: [], |
| 74 | +}; |
| 75 | + |
| 76 | +const mockedCodemod = { |
| 77 | + bundleType: "package", |
| 78 | + source: "registry", |
| 79 | + name: "codemod1", |
| 80 | + version: "1.0.0", |
| 81 | + engine: "jscodeshift", |
| 82 | + indexPath: "./codemods/codemod1/dist/index.cjs", |
| 83 | + directoryPath: "./codemods/codemod1", |
| 84 | + arguments: [], |
| 85 | +}; |
| 86 | + |
| 87 | +vi.mock("../downloadCodemod.ts", async () => { |
| 88 | + return { |
| 89 | + CodemodDownloader: mocks.CodemodDownloader, |
| 90 | + }; |
| 91 | +}); |
| 92 | + |
| 93 | +vi.mock("../fileDownloadService.ts"); |
| 94 | +vi.mock("node:fs/promises", async () => { |
| 95 | + const memfs: { fs: typeof fs } = await vi.importActual("memfs"); |
| 96 | + |
| 97 | + return memfs.fs.promises; |
| 98 | +}); |
| 99 | + |
| 100 | +vi.mock("../../../../packages/runner/dist/buildGlobGenerator.js", () => { |
| 101 | + return { |
| 102 | + buildPathGlobGenerator: async function* () { |
| 103 | + yield "target/src/index.tsx"; |
| 104 | + }, |
| 105 | + }; |
| 106 | +}); |
| 107 | + |
| 108 | +vi.mock("../../../../packages/runner/dist/workerThreadManager.js", () => { |
| 109 | + return { |
| 110 | + WorkerThreadManager: function WorkerThreadManager(...args: any[]) { |
| 111 | + const onMessage = args[2]; |
| 112 | + const onCommand = args[3]; |
| 113 | + |
| 114 | + onCommand({ |
| 115 | + kind: "updateFile", |
| 116 | + oldPath: `./target/src/file_${randomBytes(8).toString("hex")}.tsx`, |
| 117 | + oldData: "", |
| 118 | + newData: "updated", |
| 119 | + formatWithPrettier: false, |
| 120 | + }); |
| 121 | + |
| 122 | + onMessage({ |
| 123 | + kind: "finish", |
| 124 | + }); |
| 125 | + }, |
| 126 | + }; |
| 127 | +}); |
| 128 | + |
| 129 | +vi.mock( |
| 130 | + "../../../../packages/runner/dist/fileCommands.js", |
| 131 | + (requireOriginal) => { |
| 132 | + return { |
| 133 | + ...requireOriginal, |
| 134 | + modifyFileSystemUponCommand: vi.fn(), |
| 135 | + }; |
| 136 | + }, |
| 137 | +); |
| 138 | + |
| 139 | +const memfsVolumeJSON = { |
| 140 | + "codemods/codemod1/dist/index.cjs": `module.exports = function transform(file, api, options) { |
| 141 | + return "transformed by codemod1" |
| 142 | + `, |
| 143 | + "codemods/codemod2/dist/index.cjs": `module.exports = function transform(file, api, options) { |
| 144 | + return "transformed by codemod2" |
| 145 | + `, |
| 146 | + "codemods/codemod1/.codemodrc.json": `{ |
| 147 | + "version": "1.0.0", |
| 148 | + "private": false, |
| 149 | + "name": "codemod1", |
| 150 | + "engine": "jscodeshift" |
| 151 | + }`, |
| 152 | + "codemods/codemod2/.codemodrc.json": `{ |
| 153 | + "version": "1.0.0", |
| 154 | + "private": false, |
| 155 | + "name": "codemod2", |
| 156 | + "engine": "jscodeshift" |
| 157 | + }`, |
| 158 | + "codemods/recipe1/.codemodrc.json": `{ |
| 159 | + "name": "recipe1", |
| 160 | + "version": "1.0.0", |
| 161 | + "private": false, |
| 162 | + "engine": "recipe", |
| 163 | + "names": ["codemod1", "codemod2"] |
| 164 | +}`, |
| 165 | +}; |
| 166 | + |
| 167 | +afterEach(() => { |
| 168 | + mockedSendDangerousEvent.mockReset(); |
| 169 | +}); |
| 170 | + |
| 171 | +describe("Run command", () => { |
| 172 | + // tracks both subcodemod runs and recipe run |
| 173 | + it("Should properly track recipe and sub-codemods of the recipe", async () => { |
| 174 | + vol.fromJSON(memfsVolumeJSON); |
| 175 | + |
| 176 | + mocks.CodemodDownloader.mockReturnValue({ |
| 177 | + async download() { |
| 178 | + return mockedRecipe; |
| 179 | + }, |
| 180 | + }); |
| 181 | + |
| 182 | + await handleRunCliCommand({ |
| 183 | + printer: mockedPrinter, |
| 184 | + args: mockedArgs, |
| 185 | + telemetry: mockedTelemetry, |
| 186 | + }); |
| 187 | + |
| 188 | + expect( |
| 189 | + mockedSendDangerousEvent.mock.calls.map( |
| 190 | + ([{ executionId, ...rest }]) => rest, |
| 191 | + ), |
| 192 | + ).toStrictEqual([ |
| 193 | + { |
| 194 | + kind: "codemodExecuted", |
| 195 | + codemodName: "codemod1", |
| 196 | + fileCount: 1, |
| 197 | + recipeName: "recipe1", |
| 198 | + }, |
| 199 | + { |
| 200 | + kind: "codemodExecuted", |
| 201 | + codemodName: "codemod2", |
| 202 | + fileCount: 1, |
| 203 | + recipeName: "recipe1", |
| 204 | + }, |
| 205 | + { |
| 206 | + kind: "codemodExecuted", |
| 207 | + codemodName: "recipe1", |
| 208 | + fileCount: 2, |
| 209 | + recipeName: "recipe1", |
| 210 | + }, |
| 211 | + ]); |
| 212 | + }); |
| 213 | + |
| 214 | + it("Should properly track single codemod", async () => { |
| 215 | + vol.fromJSON(memfsVolumeJSON); |
| 216 | + |
| 217 | + mocks.CodemodDownloader.mockReturnValue({ |
| 218 | + download() { |
| 219 | + return mockedCodemod; |
| 220 | + }, |
| 221 | + }); |
| 222 | + |
| 223 | + await handleRunCliCommand({ |
| 224 | + printer: mockedPrinter, |
| 225 | + args: { |
| 226 | + ...mockedArgs, |
| 227 | + _: ["codemod1"], |
| 228 | + }, |
| 229 | + telemetry: mockedTelemetry, |
| 230 | + }); |
| 231 | + |
| 232 | + const { executionId, ...event } = mockedSendDangerousEvent.mock.calls[0][0]; |
| 233 | + |
| 234 | + expect(event).toStrictEqual({ |
| 235 | + kind: "codemodExecuted", |
| 236 | + codemodName: "codemod1", |
| 237 | + fileCount: 1, |
| 238 | + }); |
| 239 | + }); |
| 240 | +}); |
0 commit comments