ic-mops 2.3.2 → 2.5.0

package/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## Next
 
+## 2.5.0
+- Add support for `MOPS_REGISTRY_HOST` and `MOPS_REGISTRY_CANISTER_ID` environment variables for custom registry endpoints
+- Fix `mops build` crashing with `__wbindgen_malloc` error in bundled CLI distribution
+- Fix `parallel()` swallowing errors from concurrent tasks (e.g. `mops publish` uploads), which could hang or leave failures unreported
+
+## 2.4.0
+- Support `[build].outputDir` config in `mops.toml` for custom build output directory
+- Fix `mops build --output` CLI option being silently ignored
+- Warn when canister `args` contain flags managed by `mops build` (e.g. `-o`, `-c`, `--idl`)
+- Support pocket-ic versions beyond 9.x.x (fixes #410)
+
 ## 2.3.2
 - Fix `mops check`, `mops build`, and `mops check-stable` failing to find canister entrypoints when run from a subdirectory
 

package/RELEASE.md

@@ -1,20 +1,8 @@
 # Mops CLI Release
 
-## Prerequisites
+## 1. Update changelog
 
-### Docker
-
-Docker (or OrbStack) must be installed and running. The on-chain release step builds the CLI inside a Docker container (`zenvoich/mops-builder:1.1.0`) for reproducibility.
-
-### dfx
-
-`dfx` must be installed with the `mops` identity configured (see [Adding the `mops` identity to dfx](#adding-the-mops-identity-to-dfx)).
-
-## Release Steps
-
-### 1. Update changelog
-
-Move items from the `## Next` section in `CHANGELOG.md` into a new version heading:
+Move items from `## Next` in `CHANGELOG.md` into a new version heading:
 
 ```markdown
 ## Next
@@ -24,16 +12,16 @@ Move items from the `## Next` section in `CHANGELOG.md` into a new version headi
 - Change 2
 ```
 
-The heading must contain the exact version string — the release workflow parses it to extract release notes for the GitHub Release.
+The heading must match the exact version string — the release workflow parses it to extract release notes.
 
-### 2. Bump version
+## 2. Bump version
 
 ```bash
 cd cli
-npm version minor --no-git-tag-version  # or: patch / major
+npm version patch --no-git-tag-version  # or: minor / major
 ```
 
-### 3. Create a release branch and PR
+## 3. Create a release PR
 
 ```bash
 git checkout -b <username>/release-X.Y.Z
@@ -43,11 +31,9 @@ git push -u origin <username>/release-X.Y.Z
 gh pr create --title "release: CLI vX.Y.Z" --body "..."
 ```
 
-Wait for CI to pass, then merge the PR.
-
-### 4. Tag and push
+Wait for CI to pass, then merge.
 
-After the PR is merged to `main`:
+## 4. Tag and push
 
 ```bash
 git checkout main && git pull
@@ -55,111 +41,20 @@ git tag cli-vX.Y.Z
 git push origin cli-vX.Y.Z
 ```
 
-This triggers the [`release.yml`](../.github/workflows/release.yml) workflow which automatically:
-1. Validates the tag is on `main` and version matches `package.json`
-2. Builds the CLI tarball in Docker (reproducible build)
-3. Computes and reports the SHA256 hash (visible in the workflow Step Summary)
-4. Publishes to npm via OIDC trusted publishing
-5. Creates a GitHub Release with the tarball attached and changelog as release notes
-
-Monitor the workflow run at [Actions → Release CLI](https://github.com/caffeinelabs/mops/actions/workflows/release.yml).
-
-### 5. Prepare on-chain release
-
-Run from the **repo root** (not `cli/`), with Docker running:
-
-```bash
-npm run release-cli
-```
-
-This runs `cli/release-cli.ts`, which:
-1. Calls `./build.sh` — full Docker build with the real version from `cli/package.json`
-2. Extracts release notes from `CHANGELOG.md` for that version
-3. Computes SHA256 of `bundle/cli.tgz`
-4. Copies the tarball to `cli-releases/versions/<version>.tgz`
-5. Creates tag copies: `latest.tgz` and `<major>.tgz`
-6. Updates `cli-releases/tags/latest` to the new version
-7. Updates `cli-releases/releases.json` with metadata (timestamp, size, hash, commit hash, download URL, release notes)
-
-### 6. Deploy the canister
+This triggers the [`release.yml`](../.github/workflows/release.yml) workflow which builds, publishes to npm, creates a GitHub Release, deploys canisters (`cli.mops.one` and `docs.mops.one`), and opens a PR with on-chain release artifacts.
 
-```bash
-dfx deploy --network ic --no-wallet cli --identity mops
-```
+Monitor at [Actions → Release CLI](https://github.com/caffeinelabs/mops/actions/workflows/release.yml).
 
-This deploys the `cli-releases` canister (serving `cli.mops.one`) to the Internet Computer mainnet.
+## 5. Merge artifacts PR
 
-### 7. Deploy the docs canister
-
-```bash
-dfx deploy --network ic --no-wallet docs --identity mops
-```
-
-This builds the Docusaurus site (`docs/`) and deploys the `docs` assets canister (serving `docs.mops.one`). Docs are not auto-deployed, so this step ensures any documentation changes from the release are published.
-
-### 8. Commit and push release artifacts
-
-Step 5 generates files in `cli-releases/` that must be committed and pushed:
-
-```bash
-git add cli-releases/
-git commit -m "cli-releases: v<version> artifacts"
-```
-
-Since direct pushes to `main` are not allowed, create a branch and PR:
-
-```bash
-git checkout -b <username>/release-X.Y.Z-artifacts
-git push -u origin <username>/release-X.Y.Z-artifacts
-gh pr create --title "cli-releases: vX.Y.Z artifacts" --body "Release artifacts generated by \`npm run release-cli\` for CLI vX.Y.Z."
-```
-
-Merge this PR after approval.
+After the workflow completes, merge the `cli-releases: vX.Y.Z artifacts` PR.
 
 ## Verify build
 
-Anyone can verify a released version by rebuilding from source. The SHA256 hash and verification instructions are included in each [GitHub Release](https://github.com/caffeinelabs/mops/releases).
+Anyone can verify a released version by rebuilding from source. Instructions are included in each [GitHub Release](https://github.com/caffeinelabs/mops/releases).
 
 ```bash
 cd cli
 docker build . --build-arg COMMIT_HASH=<commit_hash> --build-arg MOPS_VERSION=<mops_version> -t mops
 docker run --rm --env SHASUM=<build_hash> mops
 ```
-
-## Adding the `mops` identity to dfx
-
-Check if the identity already exists:
-```bash
-dfx identity list
-```
-
-If `mops` appears, verify it's the correct one:
-```bash
-dfx identity get-principal --identity mops
-```
-
-If it doesn't exist, import it from the PEM file stored in Bitwarden (`Mops identity (canisters and packages)`):
-
-1. Save the PEM key to a temporary file:
-```bash
-cat > /tmp/mops-identity.pem << 'EOF'
------BEGIN EC PRIVATE KEY-----
-<paste key from Bitwarden>
------END EC PRIVATE KEY-----
-EOF
-```
-
-2. Import into dfx:
-```bash
-dfx identity import mops /tmp/mops-identity.pem
-```
-
-3. Delete the temporary file:
-```bash
-rm /tmp/mops-identity.pem
-```
-
-4. Verify:
-```bash
-dfx identity get-principal --identity mops
-```

package/api/network.ts

@@ -3,20 +3,28 @@ export function getNetwork() {
 }
 
 export function getEndpoint(network: string) {
+  let endpoint: { host: string; canisterId: string };
   if (network === "staging") {
-    return {
+    endpoint = {
       host: "https://icp-api.io",
       canisterId: "2d2zu-vaaaa-aaaak-qb6pq-cai",
     };
   } else if (network === "ic") {
-    return {
+    endpoint = {
       host: "https://icp-api.io",
       canisterId: "oknww-riaaa-aaaam-qaf6a-cai",
     };
   } else {
-    return {
+    endpoint = {
       host: "http://127.0.0.1:4943",
       canisterId: "2d2zu-vaaaa-aaaak-qb6pq-cai",
     };
   }
+
+  const hostOverride = process.env["MOPS_REGISTRY_HOST"]?.trim();
+  const canisterOverride = process.env["MOPS_REGISTRY_CANISTER_ID"]?.trim();
+  return {
+    host: hostOverride || endpoint.host,
+    canisterId: canisterOverride || endpoint.canisterId,
+  };
 }

package/cli.ts

@@ -301,11 +301,7 @@ program
   .command("build [canisters...]")
   .description("Build a canister")
   .addOption(new Option("--verbose", "Verbose console output"))
-  .addOption(
-    new Option("--output, -o <output>", "Output directory").default(
-      DEFAULT_BUILD_OUTPUT_DIR,
-    ),
-  )
+  .addOption(new Option("--output, -o <output>", "Output directory"))
   .allowUnknownOption(true) // TODO: restrict unknown before "--"
   .action(async (canisters, options) => {
     checkConfigFile(true);
@@ -317,6 +313,7 @@ program
     });
     await build(args.length ? args : undefined, {
       ...options,
+      outputDir: options.output,
       extraArgs,
     });
   });

package/commands/bench-replica.ts

@@ -3,12 +3,13 @@ import { execSync } from "node:child_process";
 import path from "node:path";
 import fs from "node:fs";
 import { execaCommand } from "execa";
-import { PocketIc, PocketIcServer } from "pic-ic";
+import { getRootDir } from "../mops.js";
 import {
-  PocketIc as PocketIcMops,
-  PocketIcServer as PocketIcServerMops,
-} from "pic-js-mops";
-import { getRootDir, readConfig } from "../mops.js";
+  type AnyPocketIcServer,
+  type AnyPocketIc,
+  type AnySetupCanister,
+  startPocketIc,
+} from "../helpers/pocket-ic-client.js";
 import { createActor, idlFactory } from "../declarations/bench/index.js";
 import { toolchain } from "./toolchain/index.js";
 import { getDfxVersion } from "../helpers/get-dfx-version.js";
@@ -18,8 +19,8 @@ export class BenchReplica {
   verbose = false;
   canisters: Record<string, { cwd: string; canisterId: string; actor: any }> =
     {};
-  pocketIcServer?: PocketIcServer | PocketIcServerMops;
-  pocketIc?: PocketIc | PocketIcMops;
+  pocketIcServer?: AnyPocketIcServer;
+  pocketIc?: AnyPocketIc;
 
   constructor(type: "dfx" | "pocket-ic" | "dfx-pocket-ic", verbose = false) {
     this.type = type;
@@ -49,30 +50,10 @@ export class BenchReplica {
       );
     } else {
       let pocketIcBin = await toolchain.bin("pocket-ic");
-      let config = readConfig();
-      if (
-        config.toolchain?.["pocket-ic"] !== "4.0.0" &&
-        !config.toolchain?.["pocket-ic"]?.startsWith("9.")
-      ) {
-        console.error(
-          "Current Mops CLI only supports pocket-ic 9.x.x and 4.0.0",
-        );
-        process.exit(1);
-      }
-      // pocket-ic 9.x.x
-      if (config.toolchain?.["pocket-ic"]?.startsWith("9.")) {
-        this.pocketIcServer = await PocketIcServerMops.start({
-          binPath: pocketIcBin,
-        });
-        this.pocketIc = await PocketIcMops.create(this.pocketIcServer.getUrl());
-      }
-      // pocket-ic 4.0.0
-      else {
-        this.pocketIcServer = await PocketIcServer.start({
-          binPath: pocketIcBin,
-        });
-        this.pocketIc = await PocketIc.create(this.pocketIcServer.getUrl());
-      }
+
+      let pic = await startPocketIc({ binPath: pocketIcBin });
+      this.pocketIcServer = pic.server;
+      this.pocketIc = pic.client;
     }
   }
 
@@ -105,10 +86,8 @@ export class BenchReplica {
       });
       this.canisters[name] = { cwd, canisterId, actor };
     } else if (this.pocketIc) {
-      type PocketIcSetupCanister = PocketIcMops["setupCanister"] &
-        PocketIc["setupCanister"];
       let { canisterId, actor } = await (
-        this.pocketIc.setupCanister as PocketIcSetupCanister
+        this.pocketIc.setupCanister as AnySetupCanister
       )({ idlFactory, wasm });
       this.canisters[name] = {
         cwd,

package/commands/build.ts

@@ -6,6 +6,7 @@ import { join } from "node:path";
 import { cliError } from "../error.js";
 import { isCandidCompatible } from "../helpers/is-candid-compatible.js";
 import { resolveCanisterConfigs } from "../helpers/resolve-canisters.js";
+import { CanisterConfig, Config } from "../types.js";
 import { CustomSection, getWasmBindings } from "../wasm.js";
 import { getGlobalMocArgs, readConfig, resolveConfigPath } from "../mops.js";
 import { sourcesArgs } from "./sources.js";
@@ -27,9 +28,13 @@ export async function build(
     cliError("No canisters specified to build");
   }
 
-  let outputDir = options.outputDir ?? DEFAULT_BUILD_OUTPUT_DIR;
-  let mocPath = await toolchain.bin("moc", { fallback: true });
   let config = readConfig();
+  let configOutputDir = config.build?.outputDir
+    ? resolveConfigPath(config.build.outputDir)
+    : undefined;
+  let outputDir =
+    options.outputDir ?? configOutputDir ?? DEFAULT_BUILD_OUTPUT_DIR;
+  let mocPath = await toolchain.bin("moc", { fallback: true });
   let canisters = resolveCanisterConfigs(config);
   if (!Object.keys(canisters).length) {
     cliError(`No Motoko canisters found in mops.toml configuration`);
@@ -78,23 +83,10 @@ export async function build(
       ...(await sourcesArgs()).flat(),
       ...getGlobalMocArgs(config),
     ];
-    if (config.build?.args) {
-      if (typeof config.build.args === "string") {
-        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") {
-        cliError(
-          `Canister config 'args' should be an array of strings for canister ${canisterName}`,
-        );
-      }
-      args.push(...canister.args);
-    }
-    args.push(...(options.extraArgs ?? []));
+    args.push(
+      ...collectExtraArgs(config, canister, canisterName, options.extraArgs),
+    );
+
     const isPublicCandid = true; // always true for now to reduce corner cases
     const candidVisibility = isPublicCandid ? "icp:public" : "icp:private";
     if (isPublicCandid) {
@@ -196,3 +188,54 @@ export async function build(
     ),
   );
 }
+
+const managedFlags: Record<string, string> = {
+  "-o": "use [build].outputDir in mops.toml or --output flag instead",
+  "-c": "this flag is always set by mops build",
+  "--idl": "this flag is always set by mops build",
+  "--public-metadata": "this flag is managed by mops build",
+};
+
+function collectExtraArgs(
+  config: Config,
+  canister: CanisterConfig,
+  canisterName: string,
+  extraArgs?: string[],
+): string[] {
+  const args: string[] = [];
+
+  if (config.build?.args) {
+    if (typeof config.build.args === "string") {
+      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") {
+      cliError(
+        `Canister config 'args' should be an array of strings for canister ${canisterName}`,
+      );
+    }
+    args.push(...canister.args);
+  }
+  if (extraArgs) {
+    args.push(...extraArgs);
+  }
+
+  const warned = new Set<string>();
+  for (const arg of args) {
+    const hint = managedFlags[arg];
+    if (hint && !warned.has(arg)) {
+      warned.add(arg);
+      console.warn(
+        chalk.yellow(
+          `Warning: '${arg}' in args for canister ${canisterName} may conflict with mops build — ${hint}`,
+        ),
+      );
+    }
+  }
+
+  return args;
+}

package/commands/replica.ts

@@ -11,14 +11,14 @@ import { spawn as spawnAsync } from "promisify-child-process";
 
 import { IDL } from "@icp-sdk/core/candid";
 import { Actor, HttpAgent } from "@icp-sdk/core/agent";
-import { PocketIc, PocketIcServer } from "pic-ic";
-import {
-  PocketIc as PocketIcMops,
-  PocketIcServer as PocketIcServerMops,
-} from "pic-js-mops";
 import chalk from "chalk";
 
-import { readConfig } from "../mops.js";
+import {
+  type AnyPocketIcServer,
+  type AnyPocketIc,
+  type AnySetupCanister,
+  startPocketIc,
+} from "../helpers/pocket-ic-client.js";
 import { toolchain } from "./toolchain/index.js";
 import { getDfxVersion } from "../helpers/get-dfx-version.js";
 
@@ -36,8 +36,8 @@ export class Replica {
     string,
     { cwd: string; canisterId: string; actor: any; stream: PassThrough }
   > = {};
-  pocketIcServer?: PocketIcServer | PocketIcServerMops;
-  pocketIc?: PocketIc | PocketIcMops;
+  pocketIcServer?: AnyPocketIcServer;
+  pocketIc?: AnyPocketIc;
   dfxProcess?: ChildProcessWithoutNullStreams;
   dir: string = ""; // absolute path (/.../.mops/.test/)
   ttl = 60;
@@ -114,37 +114,14 @@ export class Replica {
     } else {
       let pocketIcBin = await toolchain.bin("pocket-ic");
 
-      let config = readConfig();
-      if (
-        config.toolchain?.["pocket-ic"] !== "4.0.0" &&
-        !config.toolchain?.["pocket-ic"]?.startsWith("9.")
-      ) {
-        console.error(
-          "Current Mops CLI only supports pocket-ic 9.x.x and 4.0.0",
-        );
-        process.exit(1);
-      }
-
-      // pocket-ic 9.x.x
-      if (config.toolchain?.["pocket-ic"]?.startsWith("9.")) {
-        this.pocketIcServer = await PocketIcServerMops.start({
-          showRuntimeLogs: false,
-          showCanisterLogs: false,
-          binPath: pocketIcBin,
-          ttl: this.ttl,
-        });
-        this.pocketIc = await PocketIcMops.create(this.pocketIcServer.getUrl());
-      }
-      // pocket-ic 4.0.0
-      else {
-        this.pocketIcServer = await PocketIcServer.start({
-          showRuntimeLogs: false,
-          showCanisterLogs: false,
-          binPath: pocketIcBin,
-          ttl: this.ttl,
-        });
-        this.pocketIc = await PocketIc.create(this.pocketIcServer.getUrl());
-      }
+      let pic = await startPocketIc({
+        binPath: pocketIcBin,
+        showRuntimeLogs: false,
+        showCanisterLogs: false,
+        ttl: this.ttl,
+      });
+      this.pocketIcServer = pic.server;
+      this.pocketIc = pic.client;
 
       // process canister logs
       this._attachCanisterLogHandler(
@@ -305,10 +282,8 @@ export class Replica {
         stream: new PassThrough(),
       };
     } else if (this.pocketIc) {
-      type PocketIcSetupCanister = PocketIcMops["setupCanister"] &
-        PocketIc["setupCanister"];
       let { canisterId, actor } = await (
-        this.pocketIc.setupCanister as PocketIcSetupCanister
+        this.pocketIc.setupCanister as AnySetupCanister
       )({
         wasm,
         idlFactory,

package/dist/api/network.js

@@ -2,22 +2,29 @@ export function getNetwork() {
     return globalThis.MOPS_NETWORK || "ic";
 }
 export function getEndpoint(network) {
+    let endpoint;
     if (network === "staging") {
-        return {
+        endpoint = {
             host: "https://icp-api.io",
             canisterId: "2d2zu-vaaaa-aaaak-qb6pq-cai",
         };
     }
     else if (network === "ic") {
-        return {
+        endpoint = {
             host: "https://icp-api.io",
             canisterId: "oknww-riaaa-aaaam-qaf6a-cai",
         };
     }
     else {
-        return {
+        endpoint = {
             host: "http://127.0.0.1:4943",
             canisterId: "2d2zu-vaaaa-aaaak-qb6pq-cai",
         };
     }
+    const hostOverride = process.env["MOPS_REGISTRY_HOST"]?.trim();
+    const canisterOverride = process.env["MOPS_REGISTRY_CANISTER_ID"]?.trim();
+    return {
+        host: hostOverride || endpoint.host,
+        canisterId: canisterOverride || endpoint.canisterId,
+    };
 }

package/dist/cli.js

@@ -7,7 +7,7 @@ import { getNetwork } from "./api/network.js";
 import { cacheSize, cleanCache, show } from "./cache.js";
 import { add } from "./commands/add.js";
 import { bench } from "./commands/bench.js";
-import { build, DEFAULT_BUILD_OUTPUT_DIR } from "./commands/build.js";
+import { build } from "./commands/build.js";
 import { bump } from "./commands/bump.js";
 import { check } from "./commands/check.js";
 import { checkCandid } from "./commands/check-candid.js";
@@ -236,7 +236,7 @@ program
     .command("build [canisters...]")
     .description("Build a canister")
     .addOption(new Option("--verbose", "Verbose console output"))
-    .addOption(new Option("--output, -o <output>", "Output directory").default(DEFAULT_BUILD_OUTPUT_DIR))
+    .addOption(new Option("--output, -o <output>", "Output directory"))
     .allowUnknownOption(true) // TODO: restrict unknown before "--"
     .action(async (canisters, options) => {
     checkConfigFile(true);
@@ -248,6 +248,7 @@ program
     });
     await build(args.length ? args : undefined, {
         ...options,
+        outputDir: options.output,
         extraArgs,
     });
 });

package/dist/commands/bench-replica.d.ts

@@ -1,5 +1,4 @@
-import { PocketIc, PocketIcServer } from "pic-ic";
-import { PocketIc as PocketIcMops, PocketIcServer as PocketIcServerMops } from "pic-js-mops";
+import { type AnyPocketIcServer, type AnyPocketIc } from "../helpers/pocket-ic-client.js";
 export declare class BenchReplica {
     type: "dfx" | "pocket-ic" | "dfx-pocket-ic";
     verbose: boolean;
@@ -8,8 +7,8 @@ export declare class BenchReplica {
         canisterId: string;
         actor: any;
     }>;
-    pocketIcServer?: PocketIcServer | PocketIcServerMops;
-    pocketIc?: PocketIc | PocketIcMops;
+    pocketIcServer?: AnyPocketIcServer;
+    pocketIc?: AnyPocketIc;
     constructor(type: "dfx" | "pocket-ic" | "dfx-pocket-ic", verbose?: boolean);
     start({ silent }?: {
         silent?: boolean | undefined;

package/dist/commands/bench-replica.js

@@ -3,9 +3,8 @@ import { execSync } from "node:child_process";
 import path from "node:path";
 import fs from "node:fs";
 import { execaCommand } from "execa";
-import { PocketIc, PocketIcServer } from "pic-ic";
-import { PocketIc as PocketIcMops, PocketIcServer as PocketIcServerMops, } from "pic-js-mops";
-import { getRootDir, readConfig } from "../mops.js";
+import { getRootDir } from "../mops.js";
+import { startPocketIc, } from "../helpers/pocket-ic-client.js";
 import { createActor, idlFactory } from "../declarations/bench/index.js";
 import { toolchain } from "./toolchain/index.js";
 import { getDfxVersion } from "../helpers/get-dfx-version.js";
@@ -36,26 +35,9 @@ export class BenchReplica {
         }
         else {
             let pocketIcBin = await toolchain.bin("pocket-ic");
-            let config = readConfig();
-            if (config.toolchain?.["pocket-ic"] !== "4.0.0" &&
-                !config.toolchain?.["pocket-ic"]?.startsWith("9.")) {
-                console.error("Current Mops CLI only supports pocket-ic 9.x.x and 4.0.0");
-                process.exit(1);
-            }
-            // pocket-ic 9.x.x
-            if (config.toolchain?.["pocket-ic"]?.startsWith("9.")) {
-                this.pocketIcServer = await PocketIcServerMops.start({
-                    binPath: pocketIcBin,
-                });
-                this.pocketIc = await PocketIcMops.create(this.pocketIcServer.getUrl());
-            }
-            // pocket-ic 4.0.0
-            else {
-                this.pocketIcServer = await PocketIcServer.start({
-                    binPath: pocketIcBin,
-                });
-                this.pocketIc = await PocketIc.create(this.pocketIcServer.getUrl());
-            }
+            let pic = await startPocketIc({ binPath: pocketIcBin });
+            this.pocketIcServer = pic.server;
+            this.pocketIc = pic.client;
         }
     }
     async stop() {