ic-mops 2.14.1 → 2.15.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/bundle/cli.tgz +0 -0
  3. package/cli.ts +149 -4
  4. package/commands/bench-replica.ts +2 -1
  5. package/commands/bench.ts +32 -9
  6. package/commands/build.ts +30 -77
  7. package/commands/check-stable.ts +4 -0
  8. package/commands/check.ts +26 -22
  9. package/commands/deployed.ts +162 -0
  10. package/commands/generate.ts +201 -0
  11. package/commands/lint.ts +6 -3
  12. package/dist/cli.js +76 -4
  13. package/dist/commands/bench-replica.js +3 -1
  14. package/dist/commands/bench.js +21 -4
  15. package/dist/commands/build.d.ts +6 -0
  16. package/dist/commands/build.js +26 -52
  17. package/dist/commands/check-stable.d.ts +2 -0
  18. package/dist/commands/check-stable.js +2 -2
  19. package/dist/commands/check.d.ts +2 -0
  20. package/dist/commands/check.js +20 -21
  21. package/dist/commands/deployed.d.ts +10 -0
  22. package/dist/commands/deployed.js +97 -0
  23. package/dist/commands/generate.d.ts +6 -0
  24. package/dist/commands/generate.js +124 -0
  25. package/dist/commands/lint.d.ts +2 -0
  26. package/dist/commands/lint.js +1 -1
  27. package/dist/helpers/autofix-motoko.d.ts +2 -0
  28. package/dist/helpers/autofix-motoko.js +71 -51
  29. package/dist/helpers/migrations.d.ts +1 -1
  30. package/dist/helpers/migrations.js +8 -4
  31. package/dist/helpers/moc-args.d.ts +25 -0
  32. package/dist/helpers/moc-args.js +58 -0
  33. package/dist/helpers/pocket-ic-client.d.ts +2 -2
  34. package/dist/helpers/pocket-ic-client.js +8 -4
  35. package/dist/package.json +6 -6
  36. package/dist/tests/check-fix-utf8.test.d.ts +1 -0
  37. package/dist/tests/check-fix-utf8.test.js +38 -0
  38. package/dist/tests/check-fix.test.js +14 -2
  39. package/dist/tests/check.test.js +21 -6
  40. package/dist/tests/deployed.test.d.ts +1 -0
  41. package/dist/tests/deployed.test.js +173 -0
  42. package/dist/tests/generate.test.d.ts +1 -0
  43. package/dist/tests/generate.test.js +107 -0
  44. package/dist/tests/helpers.d.ts +8 -0
  45. package/dist/tests/helpers.js +28 -3
  46. package/dist/tests/migrate.test.js +5 -19
  47. package/dist/types.d.ts +3 -0
  48. package/helpers/autofix-motoko.ts +96 -66
  49. package/helpers/migrations.ts +8 -3
  50. package/helpers/moc-args.ts +123 -0
  51. package/helpers/pocket-ic-client.ts +11 -5
  52. package/package.json +6 -6
  53. package/tests/__snapshots__/check-fix-utf8.test.ts.snap +27 -0
  54. package/tests/__snapshots__/check.test.ts.snap +4 -17
  55. package/tests/__snapshots__/deployed.test.ts.snap +10 -0
  56. package/tests/__snapshots__/generate.test.ts.snap +39 -0
  57. package/tests/check/fix-utf8/mops.toml +5 -0
  58. package/tests/check/fix-utf8/multibyte.mo +15 -0
  59. package/tests/check-fix-utf8.test.ts +51 -0
  60. package/tests/check-fix.test.ts +26 -2
  61. package/tests/check.test.ts +24 -11
  62. package/tests/deployed/basic/main.mo +4 -0
  63. package/tests/deployed/basic/mops.toml +8 -0
  64. package/tests/deployed/multi/bar.mo +1 -0
  65. package/tests/deployed/multi/foo.mo +1 -0
  66. package/tests/deployed/multi/mops.toml +11 -0
  67. package/tests/deployed.test.ts +249 -0
  68. package/tests/generate/basic/candid/bar.did +4 -0
  69. package/tests/generate/basic/mops.toml +12 -0
  70. package/tests/generate/basic/src/Bar.mo +5 -0
  71. package/tests/generate/basic/src/Foo.mo +5 -0
  72. package/tests/generate/error/mops.toml +8 -0
  73. package/tests/generate/error/src/Broken.mo +5 -0
  74. package/tests/generate.test.ts +140 -0
  75. package/tests/helpers.ts +31 -3
  76. package/tests/migrate.test.ts +7 -22
  77. package/types.ts +3 -0
@@ -0,0 +1,173 @@
1
+ import { describe, expect, test } from "@jest/globals";
2
+ import { existsSync, readFileSync } from "node:fs";
3
+ import { mkdir, writeFile } from "node:fs/promises";
4
+ import path from "node:path";
5
+ import { cli, normalizePaths, useTempFixtures } from "./helpers";
6
+ describe("deployed", () => {
7
+ const makeTempFixture = useTempFixtures(path.join(import.meta.dirname, "deployed"));
8
+ describe("init", () => {
9
+ test("creates baseline .most and sets [check-stable].path", async () => {
10
+ const cwd = await makeTempFixture("basic");
11
+ const result = await cli(["deployed", "init"], { cwd });
12
+ expect(result.exitCode).toBe(0);
13
+ const baseline = path.join(cwd, "deployed", "backend.most");
14
+ expect(existsSync(baseline)).toBe(true);
15
+ expect(readFileSync(baseline, "utf-8")).toBe("// Version: 1.0.0\nactor { };\n");
16
+ const toml = readFileSync(path.join(cwd, "mops.toml"), "utf-8");
17
+ expect(toml).toMatch(/\[canisters\.backend\.check-stable\]/);
18
+ expect(toml).toMatch(/path\s*=\s*"deployed\/backend\.most"/);
19
+ expect({
20
+ exitCode: result.exitCode,
21
+ stdout: normalizePaths(result.stdout),
22
+ stderr: normalizePaths(result.stderr),
23
+ }).toMatchSnapshot();
24
+ });
25
+ test("idempotent — second run is a no-op", async () => {
26
+ const cwd = await makeTempFixture("basic");
27
+ await cli(["deployed", "init"], { cwd });
28
+ const tomlBefore = readFileSync(path.join(cwd, "mops.toml"), "utf-8");
29
+ const result = await cli(["deployed", "init"], { cwd });
30
+ expect(result.exitCode).toBe(0);
31
+ const tomlAfter = readFileSync(path.join(cwd, "mops.toml"), "utf-8");
32
+ expect(tomlAfter).toBe(tomlBefore);
33
+ });
34
+ test("warns when [check-stable].path is set elsewhere", async () => {
35
+ const cwd = await makeTempFixture("basic");
36
+ const tomlPath = path.join(cwd, "mops.toml");
37
+ const toml = readFileSync(tomlPath, "utf-8");
38
+ await writeFile(tomlPath, toml +
39
+ '\n[canisters.backend.check-stable]\npath = "elsewhere/backend.most"\n');
40
+ const result = await cli(["deployed", "init"], { cwd });
41
+ expect(result.exitCode).toBe(0);
42
+ expect(result.stderr).toMatch(/check-stable\]\.path = "elsewhere\/backend\.most"/);
43
+ expect(result.stderr).toMatch(/does not match where `mops deployed`/);
44
+ expect(existsSync(path.join(cwd, "deployed", "backend.most"))).toBe(true);
45
+ // mops.toml should not have been rewritten
46
+ expect(readFileSync(tomlPath, "utf-8")).toBe(toml +
47
+ '\n[canisters.backend.check-stable]\npath = "elsewhere/backend.most"\n');
48
+ });
49
+ test("respects [deployed].dir", async () => {
50
+ const cwd = await makeTempFixture("basic");
51
+ const tomlPath = path.join(cwd, "mops.toml");
52
+ const toml = readFileSync(tomlPath, "utf-8");
53
+ await writeFile(tomlPath, `${toml}\n[deployed]\ndir = "snapshots"\n`);
54
+ const result = await cli(["deployed", "init"], { cwd });
55
+ expect(result.exitCode).toBe(0);
56
+ expect(existsSync(path.join(cwd, "snapshots", "backend.most"))).toBe(true);
57
+ expect(readFileSync(tomlPath, "utf-8")).toMatch(/path\s*=\s*"snapshots\/backend\.most"/);
58
+ });
59
+ test("init for shorthand canister entry promotes it to a table", async () => {
60
+ const cwd = await makeTempFixture("basic");
61
+ const tomlPath = path.join(cwd, "mops.toml");
62
+ await writeFile(tomlPath, '[toolchain]\nmoc = "1.5.0"\n\n[canisters]\nbackend = "main.mo"\n');
63
+ const result = await cli(["deployed", "init"], { cwd });
64
+ expect(result.exitCode).toBe(0);
65
+ const after = readFileSync(tomlPath, "utf-8");
66
+ expect(after).toMatch(/\[canisters\.backend\]/);
67
+ expect(after).toMatch(/main\s*=\s*"main\.mo"/);
68
+ expect(after).toMatch(/\[canisters\.backend\.check-stable\]/);
69
+ expect(after).toMatch(/path\s*=\s*"deployed\/backend\.most"/);
70
+ });
71
+ test("errors on unknown canister name", async () => {
72
+ const cwd = await makeTempFixture("basic");
73
+ const result = await cli(["deployed", "init", "ghost"], { cwd });
74
+ expect(result.exitCode).toBe(1);
75
+ expect(result.stderr).toMatch(/not found in mops\.toml/);
76
+ });
77
+ test("preserves an existing baseline file when wiring [check-stable].path", async () => {
78
+ const cwd = await makeTempFixture("basic");
79
+ const baseline = path.join(cwd, "deployed", "backend.most");
80
+ const customMost = "// Version: 1.0.0\nactor {\n stable var x : Nat\n};\n";
81
+ // pre-create the baseline (e.g. real prod snapshot copied in by the user)
82
+ await mkdir(path.join(cwd, "deployed"), { recursive: true });
83
+ await writeFile(baseline, customMost);
84
+ const result = await cli(["deployed", "init"], { cwd });
85
+ expect(result.exitCode).toBe(0);
86
+ expect(readFileSync(baseline, "utf-8")).toBe(customMost);
87
+ expect(readFileSync(path.join(cwd, "mops.toml"), "utf-8")).toMatch(/\[canisters\.backend\.check-stable\][\s\S]*path\s*=\s*"deployed\/backend\.most"/);
88
+ });
89
+ });
90
+ describe("post-deploy hook", () => {
91
+ test("copies built .most into deployed/", async () => {
92
+ const cwd = await makeTempFixture("basic");
93
+ const buildResult = await cli(["build"], { cwd });
94
+ expect(buildResult.exitCode).toBe(0);
95
+ const result = await cli(["deployed"], { cwd });
96
+ expect(result.exitCode).toBe(0);
97
+ const built = path.join(cwd, ".mops", ".build", "backend.most");
98
+ const promoted = path.join(cwd, "deployed", "backend.most");
99
+ expect(existsSync(promoted)).toBe(true);
100
+ expect(readFileSync(promoted, "utf-8")).toBe(readFileSync(built, "utf-8"));
101
+ });
102
+ test("errors when source .most is missing", async () => {
103
+ const cwd = await makeTempFixture("basic");
104
+ const result = await cli(["deployed", "backend"], { cwd });
105
+ expect(result.exitCode).toBe(1);
106
+ expect(result.stderr).toMatch(/No built \.most/);
107
+ expect(result.stderr).toMatch(/Run `mops build backend` first/);
108
+ });
109
+ test("warns when [check-stable].path differs from <dir>/<name>.most", async () => {
110
+ const cwd = await makeTempFixture("basic");
111
+ const tomlPath = path.join(cwd, "mops.toml");
112
+ const toml = readFileSync(tomlPath, "utf-8");
113
+ await writeFile(tomlPath, toml +
114
+ '\n[canisters.backend.check-stable]\npath = "elsewhere/backend.most"\n');
115
+ const buildResult = await cli(["build"], { cwd });
116
+ expect(buildResult.exitCode).toBe(0);
117
+ const result = await cli(["deployed"], { cwd });
118
+ expect(result.exitCode).toBe(0);
119
+ expect(result.stderr).toMatch(/check-stable\]\.path = "elsewhere\/backend\.most"/);
120
+ expect(result.stderr).toMatch(/won't see updates from `mops deployed`/);
121
+ });
122
+ test("respects [deployed].dir from config", async () => {
123
+ const cwd = await makeTempFixture("basic");
124
+ const tomlPath = path.join(cwd, "mops.toml");
125
+ const toml = readFileSync(tomlPath, "utf-8");
126
+ await writeFile(tomlPath, `${toml}\n[deployed]\ndir = "snapshots"\n`);
127
+ await cli(["build"], { cwd });
128
+ const result = await cli(["deployed"], { cwd });
129
+ expect(result.exitCode).toBe(0);
130
+ expect(existsSync(path.join(cwd, "snapshots", "backend.most"))).toBe(true);
131
+ expect(existsSync(path.join(cwd, "deployed", "backend.most"))).toBe(false);
132
+ });
133
+ test("--build-dir and --dir overrides", async () => {
134
+ const cwd = await makeTempFixture("basic");
135
+ const customOut = "custom-build";
136
+ const customDir = "snapshots";
137
+ const buildResult = await cli(["build", "backend", "--output", customOut], { cwd });
138
+ expect(buildResult.exitCode).toBe(0);
139
+ const result = await cli(["deployed", "--build-dir", customOut, "--dir", customDir], { cwd });
140
+ expect(result.exitCode).toBe(0);
141
+ expect(existsSync(path.join(cwd, customDir, "backend.most"))).toBe(true);
142
+ });
143
+ test("with no canister names promotes all canisters", async () => {
144
+ const cwd = await makeTempFixture("multi");
145
+ const buildResult = await cli(["build"], { cwd });
146
+ expect(buildResult.exitCode).toBe(0);
147
+ const result = await cli(["deployed"], { cwd });
148
+ expect(result.exitCode).toBe(0);
149
+ expect(existsSync(path.join(cwd, "deployed", "foo.most"))).toBe(true);
150
+ expect(existsSync(path.join(cwd, "deployed", "bar.most"))).toBe(true);
151
+ });
152
+ test("named canister filters to that canister only", async () => {
153
+ const cwd = await makeTempFixture("multi");
154
+ await cli(["build"], { cwd });
155
+ const result = await cli(["deployed", "foo"], { cwd });
156
+ expect(result.exitCode).toBe(0);
157
+ expect(existsSync(path.join(cwd, "deployed", "foo.most"))).toBe(true);
158
+ expect(existsSync(path.join(cwd, "deployed", "bar.most"))).toBe(false);
159
+ });
160
+ });
161
+ describe("end-to-end with check-stable", () => {
162
+ test("init + build + deployed wires the check-stable baseline", async () => {
163
+ const cwd = await makeTempFixture("basic");
164
+ await cli(["deployed", "init"], { cwd });
165
+ await cli(["build"], { cwd });
166
+ const promoteResult = await cli(["deployed"], { cwd });
167
+ expect(promoteResult.exitCode).toBe(0);
168
+ const checkResult = await cli(["check-stable"], { cwd });
169
+ expect(checkResult.exitCode).toBe(0);
170
+ expect(checkResult.stdout).toMatch(/Stable compatibility check passed/);
171
+ });
172
+ });
173
+ });
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,107 @@
1
+ import { afterEach, describe, expect, jest, test } from "@jest/globals";
2
+ import { existsSync, readFileSync } from "node:fs";
3
+ import { cp, rm } from "node:fs/promises";
4
+ import path from "path";
5
+ import { cli, cliSnapshot } from "./helpers";
6
+ const fixturesDir = path.join(import.meta.dirname, "generate");
7
+ describe("generate candid", () => {
8
+ jest.setTimeout(120_000);
9
+ const tempDirs = [];
10
+ async function makeTempFixture(fixture) {
11
+ const src = path.join(fixturesDir, fixture);
12
+ const dest = path.join(fixturesDir, `_tmp_${fixture}_${Date.now()}`);
13
+ await cp(src, dest, { recursive: true });
14
+ tempDirs.push(dest);
15
+ return dest;
16
+ }
17
+ afterEach(async () => {
18
+ for (const dir of tempDirs) {
19
+ await rm(dir, { recursive: true, force: true });
20
+ }
21
+ tempDirs.length = 0;
22
+ });
23
+ test("default path: writes <main-dir>/<name>.did and sets [canisters.<name>].candid", async () => {
24
+ const cwd = await makeTempFixture("basic");
25
+ const tomlBefore = readFileSync(path.join(cwd, "mops.toml"), "utf-8");
26
+ expect(tomlBefore).not.toMatch(/"src\/foo\.did"/);
27
+ await cliSnapshot(["generate", "candid", "foo"], { cwd }, 0);
28
+ const did = readFileSync(path.join(cwd, "src/foo.did"), "utf-8");
29
+ expect(did).toMatchSnapshot("src/foo.did");
30
+ const tomlAfter = readFileSync(path.join(cwd, "mops.toml"), "utf-8");
31
+ expect(tomlAfter).toMatch(/candid\s*=\s*"src\/foo\.did"/);
32
+ });
33
+ test("configured path: overwrites in place and does not touch mops.toml", async () => {
34
+ const cwd = await makeTempFixture("basic");
35
+ const tomlBefore = readFileSync(path.join(cwd, "mops.toml"), "utf-8");
36
+ const didBefore = readFileSync(path.join(cwd, "candid/bar.did"), "utf-8");
37
+ expect(didBefore).toMatch(/Hand-curated/);
38
+ await cliSnapshot(["generate", "candid", "bar"], { cwd }, 0);
39
+ const didAfter = readFileSync(path.join(cwd, "candid/bar.did"), "utf-8");
40
+ expect(didAfter).not.toMatch(/Hand-curated/);
41
+ expect(didAfter).toMatch(/greet/);
42
+ expect(readFileSync(path.join(cwd, "mops.toml"), "utf-8")).toBe(tomlBefore);
43
+ });
44
+ test("no canister names: processes all canisters", async () => {
45
+ const cwd = await makeTempFixture("basic");
46
+ await cliSnapshot(["generate", "candid"], { cwd }, 0);
47
+ expect(existsSync(path.join(cwd, "src/foo.did"))).toBe(true);
48
+ const barDid = readFileSync(path.join(cwd, "candid/bar.did"), "utf-8");
49
+ expect(barDid).toMatch(/greet/);
50
+ expect(barDid).not.toMatch(/Hand-curated/);
51
+ });
52
+ test("--output writes to the given path and does not touch mops.toml", async () => {
53
+ const cwd = await makeTempFixture("basic");
54
+ const outPath = path.join(cwd, "out/custom.did");
55
+ const tomlBefore = readFileSync(path.join(cwd, "mops.toml"), "utf-8");
56
+ const result = await cli(["generate", "candid", "foo", "-o", outPath], {
57
+ cwd,
58
+ });
59
+ expect(result.exitCode).toBe(0);
60
+ expect(existsSync(outPath)).toBe(true);
61
+ expect(readFileSync(outPath, "utf-8")).toMatch(/call/);
62
+ expect(existsSync(path.join(cwd, "src/foo.did"))).toBe(false);
63
+ expect(readFileSync(path.join(cwd, "mops.toml"), "utf-8")).toBe(tomlBefore);
64
+ });
65
+ test("--output rejected with multiple canisters", async () => {
66
+ const cwd = await makeTempFixture("basic");
67
+ const result = await cli(["generate", "candid", "foo", "bar", "-o", "x.did"], { cwd });
68
+ expect(result.exitCode).toBe(1);
69
+ expect(result.stderr).toMatch(/single canister/i);
70
+ });
71
+ test("unknown canister name errors", async () => {
72
+ const cwd = await makeTempFixture("basic");
73
+ const result = await cli(["generate", "candid", "nope"], { cwd });
74
+ expect(result.exitCode).toBe(1);
75
+ expect(result.stderr).toMatch(/not found in mops\.toml/i);
76
+ });
77
+ test("moc failure: leaves destination and mops.toml untouched", async () => {
78
+ const cwd = await makeTempFixture("error");
79
+ const tomlBefore = readFileSync(path.join(cwd, "mops.toml"), "utf-8");
80
+ const result = await cli(["generate", "candid", "broken"], { cwd });
81
+ expect(result.exitCode).toBe(1);
82
+ expect(result.stderr).toMatch(/Failed to generate Candid/);
83
+ expect(existsSync(path.join(cwd, "src/broken.did"))).toBe(false);
84
+ expect(readFileSync(path.join(cwd, "mops.toml"), "utf-8")).toBe(tomlBefore);
85
+ });
86
+ test("rejects destination inside .mops/", async () => {
87
+ const cwd = await makeTempFixture("basic");
88
+ const result = await cli(["generate", "candid", "foo", "-o", ".mops/foo.did"], { cwd });
89
+ expect(result.exitCode).toBe(1);
90
+ expect(result.stderr).toMatch(/\.mops\//);
91
+ expect(result.stderr).toMatch(/Refusing/i);
92
+ });
93
+ test("creates file when [canisters.<name>].candid points to a missing path", async () => {
94
+ const cwd = await makeTempFixture("basic");
95
+ // bar's candid path points to candid/bar.did — delete it first
96
+ await rm(path.join(cwd, "candid/bar.did"));
97
+ const result = await cli(["generate", "candid", "bar"], { cwd });
98
+ expect(result.exitCode).toBe(0);
99
+ expect(existsSync(path.join(cwd, "candid/bar.did"))).toBe(true);
100
+ });
101
+ test("--output collision with another canister's candid prints a warning", async () => {
102
+ const cwd = await makeTempFixture("basic");
103
+ const result = await cli(["generate", "candid", "foo", "-o", "candid/bar.did"], { cwd });
104
+ expect(result.exitCode).toBe(0);
105
+ expect(result.stderr).toMatch(/collides with \[canisters\.bar\]\.candid/);
106
+ });
107
+ });
@@ -21,3 +21,11 @@ export declare const cliSnapshot: (args: string[], options: CliOptions, exitCode
21
21
  TZ?: string;
22
22
  };
23
23
  }>>;
24
+ /**
25
+ * Set up `afterEach` cleanup and return a `makeTempFixture(name)` function
26
+ * that copies a fixture subtree into a unique scratch dir under `fixturesDir`.
27
+ *
28
+ * Use in tests that mutate fixture files (toml edits, baseline file creation, etc.)
29
+ * so they don't pollute the source-controlled fixture.
30
+ */
31
+ export declare function useTempFixtures(fixturesDir: string): (fixture: string) => Promise<string>;
@@ -1,7 +1,8 @@
1
- import { expect } from "@jest/globals";
1
+ import { afterEach, expect } from "@jest/globals";
2
2
  import { execa } from "execa";
3
- import { dirname } from "path";
4
- import { fileURLToPath } from "url";
3
+ import { cp, rm } from "node:fs/promises";
4
+ import path, { dirname } from "node:path";
5
+ import { fileURLToPath } from "node:url";
5
6
  // When MOPS_TEST_GLOBAL is set, invoke the globally-installed `mops` binary
6
7
  // directly rather than the npm script. This exercises the real global-install
7
8
  // code path where the binary lives outside the project tree.
@@ -52,3 +53,27 @@ export const cliSnapshot = async (args, options, exitCode) => {
52
53
  }).toMatchSnapshot();
53
54
  return result;
54
55
  };
56
+ /**
57
+ * Set up `afterEach` cleanup and return a `makeTempFixture(name)` function
58
+ * that copies a fixture subtree into a unique scratch dir under `fixturesDir`.
59
+ *
60
+ * Use in tests that mutate fixture files (toml edits, baseline file creation, etc.)
61
+ * so they don't pollute the source-controlled fixture.
62
+ */
63
+ export function useTempFixtures(fixturesDir) {
64
+ const tempDirs = [];
65
+ afterEach(async () => {
66
+ for (const dir of tempDirs) {
67
+ await rm(dir, { recursive: true, force: true });
68
+ }
69
+ tempDirs.length = 0;
70
+ });
71
+ return async (fixture) => {
72
+ const src = path.join(fixturesDir, fixture);
73
+ const suffix = `${Date.now()}_${Math.random().toString(36).slice(2, 8)}`;
74
+ const dest = path.join(fixturesDir, `_tmp_${fixture}_${suffix}`);
75
+ await cp(src, dest, { recursive: true });
76
+ tempDirs.push(dest);
77
+ return dest;
78
+ };
79
+ }
@@ -1,30 +1,16 @@
1
- import { describe, expect, test, afterEach } from "@jest/globals";
1
+ import { describe, expect, test } from "@jest/globals";
2
2
  import { readdirSync, readFileSync } from "node:fs";
3
- import { cp, rm, writeFile } from "node:fs/promises";
4
- import path from "path";
5
- import { cli, cliSnapshot, normalizePaths } from "./helpers";
3
+ import { rm, writeFile } from "node:fs/promises";
4
+ import path from "node:path";
5
+ import { cli, cliSnapshot, normalizePaths, useTempFixtures } from "./helpers";
6
6
  const normalizeTimestamp = (text) => text.replace(/\d{8}_\d{6}/g, "<TIMESTAMP>");
7
- const fixturesDir = path.join(import.meta.dirname, "migrate");
8
7
  describe("migrate", () => {
9
- const tempDirs = [];
10
- async function makeTempFixture(fixture) {
11
- const src = path.join(fixturesDir, fixture);
12
- const dest = path.join(fixturesDir, `_tmp_${fixture}_${Date.now()}`);
13
- await cp(src, dest, { recursive: true });
14
- tempDirs.push(dest);
15
- return dest;
16
- }
8
+ const makeTempFixture = useTempFixtures(path.join(import.meta.dirname, "migrate"));
17
9
  async function patchMigrations(cwd, extra) {
18
10
  const tomlPath = path.join(cwd, "mops.toml");
19
11
  const toml = readFileSync(tomlPath, "utf-8");
20
12
  await writeFile(tomlPath, toml.replace('next = "next-migration"', `next = "next-migration"\n${extra}`));
21
13
  }
22
- afterEach(async () => {
23
- for (const dir of tempDirs) {
24
- await rm(dir, { recursive: true, force: true });
25
- }
26
- tempDirs.length = 0;
27
- });
28
14
  describe("migrate new", () => {
29
15
  test("creates a migration file with timestamp and template", async () => {
30
16
  const cwd = await makeTempFixture("basic");
package/dist/types.d.ts CHANGED
@@ -27,6 +27,9 @@ export type Config = {
27
27
  outputDir?: string;
28
28
  args?: string[];
29
29
  };
30
+ deployed?: {
31
+ dir?: string;
32
+ };
30
33
  lint?: {
31
34
  args?: string[];
32
35
  rules?: string[];
@@ -1,13 +1,14 @@
1
1
  import { readFile, writeFile } from "node:fs/promises";
2
- import { resolve } from "node:path";
2
+ import { relative, resolve } from "node:path";
3
+ import chalk from "chalk";
3
4
  import { execa } from "execa";
4
- import {
5
- TextDocument,
6
- type TextEdit,
7
- } from "vscode-languageserver-textdocument";
5
+ import { TextDocument } from "vscode-languageserver-textdocument";
8
6
 
9
7
  interface MocSpan {
10
8
  file: string;
9
+ // Optional: older moc versions don't emit byte offsets.
10
+ byte_start?: number | null;
11
+ byte_end?: number | null;
11
12
  line_start: number;
12
13
  column_start: number;
13
14
  line_end: number;
@@ -43,9 +44,14 @@ export function parseDiagnostics(stdout: string | undefined): MocDiagnostic[] {
43
44
  .filter((d) => d !== null);
44
45
  }
45
46
 
47
+ interface Edit {
48
+ span: MocSpan;
49
+ newText: string;
50
+ }
51
+
46
52
  interface DiagnosticFix {
47
53
  code: string;
48
- edits: TextEdit[];
54
+ edits: Edit[];
49
55
  }
50
56
 
51
57
  function extractDiagnosticFixes(
@@ -54,30 +60,19 @@ function extractDiagnosticFixes(
54
60
  const result = new Map<string, DiagnosticFix[]>();
55
61
 
56
62
  for (const diag of diagnostics) {
57
- const editsByFile = new Map<string, TextEdit[]>();
63
+ const editsByFile = new Map<string, Edit[]>();
58
64
 
59
65
  for (const span of diag.spans) {
60
66
  if (
61
- span.suggestion_applicability === "MachineApplicable" &&
62
- span.suggested_replacement !== null
67
+ span.suggestion_applicability !== "MachineApplicable" ||
68
+ span.suggested_replacement === null
63
69
  ) {
64
- const file = resolve(span.file);
65
- const edits = editsByFile.get(file) ?? [];
66
- edits.push({
67
- range: {
68
- start: {
69
- line: span.line_start - 1,
70
- character: span.column_start - 1,
71
- },
72
- end: {
73
- line: span.line_end - 1,
74
- character: span.column_end - 1,
75
- },
76
- },
77
- newText: span.suggested_replacement,
78
- });
79
- editsByFile.set(file, edits);
70
+ continue;
80
71
  }
72
+ const file = resolve(span.file);
73
+ const edits = editsByFile.get(file) ?? [];
74
+ edits.push({ span, newText: span.suggested_replacement });
75
+ editsByFile.set(file, edits);
81
76
  }
82
77
 
83
78
  for (const [file, edits] of editsByFile) {
@@ -90,19 +85,6 @@ function extractDiagnosticFixes(
90
85
  return result;
91
86
  }
92
87
 
93
- type Range = TextEdit["range"];
94
-
95
- function normalizeRange(range: Range): Range {
96
- const { start, end } = range;
97
- if (
98
- start.line > end.line ||
99
- (start.line === end.line && start.character > end.character)
100
- ) {
101
- return { start: end, end: start };
102
- }
103
- return range;
104
- }
105
-
106
88
  interface OffsetEdit {
107
89
  start: number;
108
90
  end: number;
@@ -110,27 +92,53 @@ interface OffsetEdit {
110
92
  }
111
93
 
112
94
  /**
113
- * Applies diagnostic fixes to a document, processing each diagnostic as
95
+ * Applies diagnostic fixes to a file's contents, processing each diagnostic as
114
96
  * an atomic unit. If any edit from a diagnostic overlaps with an already-accepted
115
97
  * edit, the entire diagnostic is skipped (picked up in subsequent iterations).
116
98
  * Based on vscode-languageserver-textdocument's TextDocument.applyEdits.
99
+ *
100
+ * Edits prefer `byte_start`/`byte_end` (byte-accurate on any UTF-8 source);
101
+ * falls back to line+column for older moc, which mis-applies on non-ASCII
102
+ * lines since moc's `column_*` are bytes but LSP expects UTF-16 code units.
117
103
  */
118
104
  function applyDiagnosticFixes(
119
- doc: TextDocument,
105
+ content: string,
120
106
  fixes: DiagnosticFix[],
121
107
  ): { text: string; appliedCodes: string[] } {
108
+ let buf: Buffer | null = null;
109
+ const byteToOffset = (byteOffset: number): number => {
110
+ buf ??= Buffer.from(content, "utf8");
111
+ return buf.subarray(0, byteOffset).toString("utf8").length;
112
+ };
113
+ let doc: TextDocument | null = null;
114
+
115
+ const toOffsetEdit = ({ span, newText }: Edit): OffsetEdit => {
116
+ if (span.byte_start != null && span.byte_end != null) {
117
+ const [s, e] =
118
+ span.byte_start <= span.byte_end
119
+ ? [span.byte_start, span.byte_end]
120
+ : [span.byte_end, span.byte_start];
121
+ return { start: byteToOffset(s), end: byteToOffset(e), newText };
122
+ }
123
+ doc ??= TextDocument.create("inmemory://autofix", "motoko", 0, content);
124
+ const start = doc.offsetAt({
125
+ line: span.line_start - 1,
126
+ character: span.column_start - 1,
127
+ });
128
+ const end = doc.offsetAt({
129
+ line: span.line_end - 1,
130
+ character: span.column_end - 1,
131
+ });
132
+ return start <= end
133
+ ? { start, end, newText }
134
+ : { start: end, end: start, newText };
135
+ };
136
+
122
137
  const acceptedEdits: OffsetEdit[] = [];
123
138
  const appliedCodes: string[] = [];
124
139
 
125
140
  for (const fix of fixes) {
126
- const offsets: OffsetEdit[] = fix.edits.map((e) => {
127
- const range = normalizeRange(e.range);
128
- return {
129
- start: doc.offsetAt(range.start),
130
- end: doc.offsetAt(range.end),
131
- newText: e.newText,
132
- };
133
- });
141
+ const offsets = fix.edits.map(toOffsetEdit);
134
142
 
135
143
  const overlaps = offsets.some((o) =>
136
144
  acceptedEdits.some((a) => o.start < a.end && o.end > a.start),
@@ -145,7 +153,6 @@ function applyDiagnosticFixes(
145
153
 
146
154
  acceptedEdits.sort((a, b) => a.start - b.start);
147
155
 
148
- const text = doc.getText();
149
156
  const spans: string[] = [];
150
157
  let lastOffset = 0;
151
158
 
@@ -154,7 +161,7 @@ function applyDiagnosticFixes(
154
161
  continue;
155
162
  }
156
163
  if (edit.start > lastOffset) {
157
- spans.push(text.substring(lastOffset, edit.start));
164
+ spans.push(content.substring(lastOffset, edit.start));
158
165
  }
159
166
  if (edit.newText.length) {
160
167
  spans.push(edit.newText);
@@ -162,7 +169,7 @@ function applyDiagnosticFixes(
162
169
  lastOffset = edit.end;
163
170
  }
164
171
 
165
- spans.push(text.substring(lastOffset));
172
+ spans.push(content.substring(lastOffset));
166
173
  return { text: spans.join(""), appliedCodes };
167
174
  }
168
175
 
@@ -180,22 +187,26 @@ export async function autofixMotoko(
180
187
  mocArgs: string[],
181
188
  ): Promise<AutofixResult | null> {
182
189
  const fixedFilesCodes = new Map<string, string[]>();
190
+ // Frozen migration files are often chmod'd read-only; warn once and skip
191
+ // them rather than aborting the whole run on EACCES/EPERM.
192
+ const readOnlySkipped = new Set<string>();
183
193
 
184
194
  for (let iteration = 0; iteration < MAX_FIX_ITERATIONS; iteration++) {
185
195
  const fixesByFile = new Map<string, DiagnosticFix[]>();
186
196
 
187
- // Single invocation: moc dedups shared imports across all files.
188
- const result = await execa(
189
- mocPath,
190
- [...files, ...mocArgs, "--error-format=json"],
191
- { stdio: "pipe", reject: false },
192
- );
193
-
194
- const diagnostics = parseDiagnostics(result.stdout);
195
- for (const [targetFile, fixes] of extractDiagnosticFixes(diagnostics)) {
196
- const existing = fixesByFile.get(targetFile) ?? [];
197
- existing.push(...fixes);
198
- fixesByFile.set(targetFile, existing);
197
+ for (const file of files) {
198
+ const result = await execa(
199
+ mocPath,
200
+ [file, ...mocArgs, "--error-format=json"],
201
+ { stdio: "pipe", reject: false },
202
+ );
203
+
204
+ const diagnostics = parseDiagnostics(result.stdout);
205
+ for (const [targetFile, fixes] of extractDiagnosticFixes(diagnostics)) {
206
+ const existing = fixesByFile.get(targetFile) ?? [];
207
+ existing.push(...fixes);
208
+ fixesByFile.set(targetFile, existing);
209
+ }
199
210
  }
200
211
 
201
212
  if (fixesByFile.size === 0) {
@@ -205,15 +216,34 @@ export async function autofixMotoko(
205
216
  let progress = false;
206
217
 
207
218
  for (const [file, fixes] of fixesByFile) {
219
+ if (readOnlySkipped.has(file)) {
220
+ continue;
221
+ }
222
+
208
223
  const original = await readFile(file, "utf-8");
209
- const doc = TextDocument.create(`file://${file}`, "motoko", 0, original);
210
- const { text: result, appliedCodes } = applyDiagnosticFixes(doc, fixes);
224
+ const { text: result, appliedCodes } = applyDiagnosticFixes(
225
+ original,
226
+ fixes,
227
+ );
211
228
 
212
229
  if (result === original) {
213
230
  continue;
214
231
  }
215
232
 
216
- await writeFile(file, result, "utf-8");
233
+ try {
234
+ await writeFile(file, result, "utf-8");
235
+ } catch (err: any) {
236
+ if (err?.code === "EACCES" || err?.code === "EPERM") {
237
+ readOnlySkipped.add(file);
238
+ console.warn(
239
+ chalk.yellow(
240
+ `Skipped read-only file ${relative(process.cwd(), file)} (${appliedCodes.length} fix(es) not applied)`,
241
+ ),
242
+ );
243
+ continue;
244
+ }
245
+ throw err;
246
+ }
217
247
  progress = true;
218
248
 
219
249
  const existing = fixedFilesCodes.get(file) ?? [];