feat: Candid interface compatibility checks

.eslintrc.json

@@ -22,7 +22,8 @@
     "dist/",
     "cli-releases/dist/",
     "cli-releases/frontend/dist/",
-    "bundle/"
+    "bundle/",
+    "cli/wasm/"
   ],
   "rules": {
     "linebreak-style": ["error", "unix"],

.github/workflows/build-hash.yml

@@ -14,7 +14,7 @@ jobs:
     steps:
       - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       - name: Set up Docker
-        uses: docker/setup-docker-action@b60f85385d03ac8acfca6d9996982511d8620a19 # v4.3.0
+        uses: docker/setup-docker-action@efe9e3891a4f7307e689f2100b33a155b900a608 # v4.5.0
       - name: Build using Docker
         run: |
           # MOPS_VERSION=$(cd cli && npm pkg get version | tr -d \")

.prettierignore

@@ -1,8 +1,11 @@
+/cli/wasm
+
 .svelte-kit/
 declarations/
+target/
 
 *.md
 *.did
 *.js
 *.d.ts
-*.svelte
+*.svelte

DEVELOPMENT.md

@@ -29,11 +29,11 @@ npm install -g tsx
 
 2. Add `mops-local` alias to your shell (`~/.zshrc`, `~/.bashrc`)
 ```bash
-alias mops-local="tsx /<path-to-local-mops>/cli/cli.ts"
+alias mops-local="tsx /<path-to-local-mops>/cli/environments/nodejs/cli.ts"
 ```
 or
 ```bash
-alias mops-local="bun /<path-to-local-mops>/cli/cli.ts"
+alias mops-local="bun /<path-to-local-mops>/cli/environments/nodejs/cli.ts"
 ```
 
 

cli/Dockerfile

@@ -1,5 +1,9 @@
 FROM --platform=linux/amd64 zenvoich/mops-builder:1.1.0@sha256:9bb87e843a90f1c12ece4ba91ca703e19cd0d79522beb562f45b1f8a14cb05b6
 
+# install Wasm build dependencies
+RUN apk add --no-cache curl gcc musl-dev
+RUN curl -sSf https://sh.rustup.rs/ | sh -s -- --default-toolchain=1.91.1 -y
+
 # clone repository
 ARG COMMIT_HASH
 RUN git clone https://github.com/dfinity/mops.git
@@ -13,7 +17,7 @@ RUN bun i --ignore-scripts
 # build
 ARG MOPS_VERSION
 RUN npm version $MOPS_VERSION --allow-same-version
-RUN npm run build
+RUN . "$HOME/.cargo/env" && npm run build
 
 # verify
 ARG SHASUM

cli/cli.ts

@@ -10,6 +10,7 @@ import { add } from "./commands/add.js";
 import { bench } from "./commands/bench.js";
 import { build, DEFAULT_BUILD_OUTPUT_DIR } from "./commands/build.js";
 import { bump } from "./commands/bump.js";
+import { checkCandid } from "./commands/check-candid.js";
 import { docsCoverage } from "./commands/docs-coverage.js";
 import { docs } from "./commands/docs.js";
 import { format } from "./commands/format.js";
@@ -286,6 +287,20 @@ program
     });
   });
 
+// check-candid
+program
+  .command("check-candid <new-candid> <original-candid>")
+  .description("Check Candid interface compatibility between two Candid files")
+  .action(async (newCandid, originalCandid) => {
+    checkConfigFile(true);
+    await installAll({
+      silent: true,
+      lock: "ignore",
+      installFromLockFile: true,
+    });
+    await checkCandid(newCandid, originalCandid);
+  });
+
 // test
 program
   .command("test [filter]")

cli/commands/build.ts

@@ -7,6 +7,8 @@ import { getMocPath } from "../helpers/get-moc-path.js";
 import { readConfig } from "../mops.js";
 import { CanisterConfig } from "../types.js";
 import { sourcesArgs } from "./sources.js";
+import { isCandidCompatible } from "../helpers/is-candid-compatible.js";
+import { cliError } from "../error.js";
 
 export interface BuildOptions {
   outputDir: string;
@@ -21,7 +23,7 @@ export async function build(
   options: Partial<BuildOptions>,
 ): Promise<void> {
   if (canisterNames?.length == 0) {
-    throw new Error("No canisters specified to build");
+    cliError("No canisters specified to build");
   }
 
   let outputDir = options.outputDir ?? DEFAULT_BUILD_OUTPUT_DIR;
@@ -37,7 +39,7 @@ export async function build(
       ) ?? {};
   }
   if (!Object.keys(canisters).length) {
-    throw new Error(`No Motoko canisters found in mops.toml configuration`);
+    cliError(`No Motoko canisters found in mops.toml configuration`);
   }
 
   if (canisterNames) {
@@ -47,7 +49,7 @@ export async function build(
     }
     for (let name of canisterNames) {
       if (!(name in canisters)) {
-        throw new Error(
+        cliError(
           `Motoko canister '${name}' not found in mops.toml configuration`,
         );
       }
@@ -62,7 +64,7 @@ export async function build(
     console.log(chalk.blue("build canister"), chalk.bold(canisterName));
     let motokoPath = canister.main;
     if (!motokoPath) {
-      throw new Error(`No main file is specified for canister ${canisterName}`);
+      cliError(`No main file is specified for canister ${canisterName}`);
     }
     let args = [
       "-c",
@@ -75,15 +77,15 @@ export async function build(
     ];
     if (config.build?.args) {
       if (typeof config.build.args === "string") {
-        throw new Error(
+        cliError(
           `[build] config 'args' should be an array of strings in mops.toml config file`,
         );
       }
       args.push(...config.build.args);
     }
     if (canister.args) {
       if (typeof canister.args === "string") {
-        throw new Error(
+        cliError(
           `Canister config 'args' should be an array of strings for canister ${canisterName}`,
         );
       }
@@ -99,9 +101,6 @@ export async function build(
       });
 
       if (result.exitCode !== 0) {
-        console.error(
-          chalk.red(`Error: Failed to build canister ${canisterName}`),
-        );
         if (!options.verbose) {
           if (result.stderr) {
             console.error(chalk.red(result.stderr));
@@ -111,27 +110,52 @@ export async function build(
             console.error(result.stdout);
           }
         }
-        // throw new Error(
-        //   `Build failed for canister ${canisterName} (exit code: ${result.exitCode})`,
-        // );
-        process.exit(1);
+        cliError(
+          `Build failed for canister ${canisterName} (exit code: ${result.exitCode})`,
+        );
       }
 
       if (options.verbose && result.stdout && result.stdout.trim()) {
         console.log(result.stdout);
       }
-    } catch (error: any) {
-      if (error.message?.includes("Build failed for canister")) {
-        throw error;
+
+      if (canister.candid) {
+        const generatedDidPath = join(outputDir, `${canisterName}.did`);
+        const originalCandidPath = canister.candid;
+
+        try {
+          const compatible = await isCandidCompatible(
+            generatedDidPath,
+            originalCandidPath,
+          );
+
+          if (!compatible) {
+            cliError(
+              `Candid compatibility check failed for canister ${canisterName}`,
+            );
+          }
+
+          if (options.verbose) {
+            console.log(
+              chalk.green(
+                `Candid compatibility check passed for canister ${canisterName}`,
+              ),
+            );
+          }
+        } catch (candidError: any) {
+          cliError(
+            `Error during Candid compatibility check for canister ${canisterName}`,
+            candidError,
+          );
+        }
+      }
+    } catch (cliError: any) {
+      if (cliError.message?.includes("Build failed for canister")) {
+        throw cliError;
       }
-      console.error(
-        chalk.red(`Error while compiling canister ${canisterName}`),
+      cliError(
+        `Error while compiling canister ${canisterName}${cliError?.message ? `\n${cliError.message}` : ""}`,
       );
-      if (error.message) {
-        console.error(chalk.red(`Details: ${error.message}`));
-      }
-
-      throw new Error(`Build execution failed for canister ${canisterName}`);
     }
     options.verbose && console.timeEnd(`build canister ${canisterName}`);
   }

cli/commands/check-candid.ts

@@ -0,0 +1,24 @@
+import chalk from "chalk";
+import { isCandidCompatible } from "../helpers/is-candid-compatible.js";
+import { cliError } from "../error.js";
+
+export interface CheckCandidOptions {
+  verbose?: boolean;
+}
+
+export async function checkCandid(
+  newPath: string,
+  originalPath: string,
+): Promise<void> {
+  try {
+    const compatible = await isCandidCompatible(newPath, originalPath);
+    if (!compatible) {
+      cliError("✖ Candid compatibility check failed");
+    }
+    console.log(chalk.green("✓ Candid compatibility check passed"));
+  } catch (error: any) {
+    cliError(
+      `Error while checking Candid compatibility${error?.message ? `\n${error.message}` : ""}`,
+    );
+  }
+}

cli/environments/nodejs/cli.ts

@@ -0,0 +1,6 @@
+import * as wasm from "../../wasm/pkg/nodejs/wasm.js";
+import { setWasmBindings } from "../../wasm.js";
+
+setWasmBindings(wasm);
+
+export * from "../../cli.js";

cli/environments/web/cli.ts

@@ -0,0 +1,6 @@
+import * as wasm from "../../wasm/pkg/web/wasm.js";
+import { setWasmBindings } from "../../wasm.js";
+
+setWasmBindings(wasm);
+
+export * from "../../cli.js";

cli/error.ts

@@ -0,0 +1,6 @@
+import chalk from "chalk";
+
+export function cliError(...args: unknown[]) {
+  console.error(chalk.red(...args));
+  process.exit(1);
+}

cli/helpers/is-candid-compatible.ts

@@ -0,0 +1,22 @@
+import { readFile, access } from "node:fs/promises";
+import path from "node:path";
+import { getWasmBindings } from "../wasm.js";
+
+export async function isCandidCompatible(
+  newPath: string,
+  originalPath: string,
+): Promise<boolean> {
+  try {
+    await access(newPath);
+  } catch {
+    throw new Error(`Candid file not found: ${newPath}`);
+  }
+  try {
+    await access(originalPath);
+  } catch {
+    throw new Error(`Candid file not found: ${originalPath}`);
+  }
+  const newText = await readFile(path.resolve(newPath), "utf8");
+  const originalText = await readFile(path.resolve(originalPath), "utf8");
+  return getWasmBindings().is_candid_compatible(newText, originalText);
+}