ic-mops 0.36.1 → 0.37.0

package/bin/moc-wrapper.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+mocPath="$(mops toolchain bin moc --fallback)"
+$mocPath "$@"

package/bin/mops.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import '../cli.js';

package/cache.ts

@@ -39,7 +39,7 @@ export let copyCache = (pkgId: string, dest: string) => {
 };
 
 export let cacheSize = async () => {
-	let dir = path.join(globalCacheDir, 'packages');
+	let dir = path.join(globalCacheDir);
 	fs.mkdirSync(dir, {recursive: true});
 
 	let size = await getFolderSize.strict(dir);
@@ -50,6 +50,6 @@ export let cacheSize = async () => {
 };
 
 export let cleanCache = async () => {
-	let dir = path.join(globalCacheDir, 'packages');
+	let dir = path.join(globalCacheDir);
 	fs.rmSync(dir, {recursive: true, force: true});
 };

package/cli.ts

@@ -1,7 +1,5 @@
-#!/usr/bin/env node
-
 import fs from 'node:fs';
-import {program, Argument, Option} from 'commander';
+import {Command, Argument, Option} from 'commander';
 import chalk from 'chalk';
 
 import {init} from './commands/init.js';
@@ -26,6 +24,8 @@ import {outdated} from './commands/outdated.js';
 import {update} from './commands/update.js';
 import {bench} from './commands/bench.js';
 import {transferOwnership} from './commands/transfer-ownership.js';
+import {toolchain} from './commands/toolchain/index.js';
+import {Tool} from './types.js';
 // import {docs} from './commands/docs.js';
 
 declare global {
@@ -38,6 +38,7 @@ if (fs.existsSync(networkFile)) {
 	globalThis.MOPS_NETWORK = fs.readFileSync(networkFile).toString() || 'ic';
 }
 
+let program = new Command();
 
 program.name('mops');
 
@@ -58,7 +59,7 @@ program
 program
 	.command('add <pkg>')
 	.description('Install the package and save it to mops.toml')
-	.option('--dev')
+	.option('--dev', 'Add to [dev-dependencies] section')
 	.option('--verbose')
 	.addOption(new Option('--lock <action>', 'Lockfile action').choices(['update', 'ignore']))
 	.action(async (pkg, options) => {
@@ -101,6 +102,8 @@ program
 			return;
 		}
 
+		await toolchain.ensureToolchainInited({strict: false});
+
 		if (pkg) {
 			// @deprecated
 			console.log(chalk.yellow('Consider using the \'mops add\' command to install a specific package.'));
@@ -108,6 +111,7 @@ program
 		}
 		else {
 			await installAll(options);
+			await toolchain.installAll(options);
 		}
 	});
 
@@ -166,6 +170,7 @@ program
 			process.exit(1);
 		}
 		await installAll({silent: true, lock: 'ignore'});
+		await toolchain.ensureToolchainInited({strict: false});
 		let sourcesArr = await sources(options);
 		console.log(sourcesArr.join('\n'));
 	});
@@ -328,4 +333,56 @@ program
 		await transferOwnership(toPrincipal);
 	});
 
+// toolchain
+const toolchainCommand = new Command('toolchain').description('Toolchain management');
+
+toolchainCommand
+	.command('init')
+	.description('One-time initialization of toolchain management')
+	.action(async () => {
+		await toolchain.init();
+	});
+
+toolchainCommand
+	.command('reset')
+	.description('Uninstall toolchain management')
+	.action(async () => {
+		await toolchain.init({reset: true});
+	});
+
+toolchainCommand
+	.command('use')
+	.description('Install specified tool version and update mops.toml')
+	.addArgument(new Argument('<tool>').choices(['moc', 'wasmtime', 'pocket-ic']))
+	.addArgument(new Argument('[version]'))
+	.action(async (tool, version) => {
+		if (!checkConfigFile()) {
+			process.exit(1);
+		}
+		await toolchain.use(tool, version);
+	});
+
+toolchainCommand
+	.command('update')
+	.description('Update specified tool or all tools to the latest version and update mops.toml')
+	.addArgument(new Argument('[tool]').choices(['moc', 'wasmtime', 'pocket-ic']))
+	.action(async (tool?: Tool) => {
+		if (!checkConfigFile()) {
+			process.exit(1);
+		}
+		await toolchain.update(tool);
+	});
+
+toolchainCommand
+	.command('bin')
+	.description('Get path to the tool binary\n<tool> can be one of "moc", "wasmtime", "pocket-ic"')
+	.addArgument(new Argument('<tool>').choices(['moc', 'wasmtime', 'pocket-ic']))
+	.addOption(new Option('--fallback', 'Fallback to the moc that comes with dfx if moc is not specified in the [toolchain] section'))
+	.action(async (tool, options) => {
+		let bin = await toolchain.bin(tool, options);
+		console.log(bin);
+	});
+
+program.addCommand(toolchainCommand);
+
 program.parse();

package/commands/add.ts

@@ -1,6 +1,6 @@
 import path from 'node:path';
 import chalk from 'chalk';
-import logUpdate from 'log-update';
+import {createLogUpdate} from 'log-update';
 import {checkConfigFile, getGithubCommit, parseGithubURL, readConfig, writeConfig} from '../mops.js';
 import {getHighestVersion} from '../api/getHighestVersion.js';
 import {installFromGithub} from '../vessel.js';
@@ -109,6 +109,8 @@ export async function add(name: string, {verbose = false, dev = false, lock}: Ad
 
 	writeConfig(config);
 
+	let logUpdate = createLogUpdate(process.stdout, {showCursor: true});
+
 	if (lock !== 'ignore') {
 		logUpdate('Checking integrity...');
 	}

package/commands/bench-replica.ts

@@ -2,9 +2,10 @@ import {execSync} from 'node:child_process';
 import path from 'node:path';
 import fs from 'node:fs';
 import {execaCommand} from 'execa';
-import {PocketIc} from '@hadronous/pic';
+import {PocketIc} from 'pic-ic';
 import {getRootDir} from '../mops.js';
 import {createActor, idlFactory} from '../declarations/bench/index.js';
+import {toolchain} from './toolchain/index.js';
 
 export class BenchReplica {
 	type : 'dfx' | 'pocket-ic';
@@ -27,7 +28,8 @@ export class BenchReplica {
 			execSync('dfx start --background --clean --artificial-delay 0' + (this.verbose ? '' : ' -qqqq'), {cwd: dir, stdio: ['inherit', this.verbose ? 'inherit' : 'ignore', 'inherit']});
 		}
 		else {
-			this.pocketIc = await PocketIc.create();
+			let pocketIcBin = await toolchain.bin('pocket-ic');
+			this.pocketIc = await PocketIc.create(pocketIcBin);
 		}
 	}
 
@@ -37,7 +39,7 @@ export class BenchReplica {
 			execSync('dfx stop' + (this.verbose ? '' : ' -qqqq'), {cwd: dir, stdio: ['pipe', this.verbose ? 'inherit' : 'ignore', 'pipe']});
 		}
 		else if (this.pocketIc) {
-			this.pocketIc.tearDown();
+			await this.pocketIc.tearDown();
 		}
 	}
 

package/commands/docs.ts

@@ -1,4 +1,4 @@
-import {spawn, execSync} from 'node:child_process';
+import {spawn} from 'node:child_process';
 import fs from 'node:fs';
 import path from 'node:path';
 import chalk from 'chalk';
@@ -8,8 +8,9 @@ import tar from 'tar';
 import streamToPromise from 'stream-to-promise';
 
 import {getRootDir} from '../mops.js';
+import {toolchain} from './toolchain/index.js';
 
-let moDoc: string;
+let moDocPath: string;
 
 export async function docs({silent = false} = {}) {
 	let rootDir = getRootDir();
@@ -18,17 +19,19 @@ export async function docs({silent = false} = {}) {
 
 	deleteSync([docsDir], {force: true});
 
-	// detect mocv
+	// detect mocv (legacy)
 	if (process.env.DFX_MOC_PATH && process.env.DFX_MOC_PATH.includes('mocv/versions')) {
-		moDoc = process.env.DFX_MOC_PATH.replace(/\/moc$/, '/mo-doc');
+		moDocPath = process.env.DFX_MOC_PATH.replace(/\/moc$/, '/mo-doc');
 	}
 	else {
-		moDoc = execSync('dfx cache show').toString().trim() + '/mo-doc';
+		// fallbacks to dfx moc if not specified in config
+		let mocPath = await toolchain.bin('moc');
+		moDocPath = mocPath.replace(/\/moc$/, '/mo-doc');
 	}
 
 	// generate docs
 	await new Promise<void>((resolve) => {
-		let proc = spawn(moDoc, [`--source=${path.join(rootDir, 'src')}`, `--output=${docsDirRelative}`, '--format=adoc']);
+		let proc = spawn(moDocPath, [`--source=${path.join(rootDir, 'src')}`, `--output=${docsDirRelative}`, '--format=adoc']);
 
 		// stdout
 		proc.stdout.on('data', (data) => {

package/commands/install-all.ts

@@ -1,5 +1,6 @@
 import chalk from 'chalk';
-import logUpdate from 'log-update';
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import {createLogUpdate} from 'log-update';
 import {checkConfigFile, readConfig} from '../mops.js';
 import {install} from './install.js';
 import {installFromGithub} from '../vessel.js';
@@ -36,9 +37,13 @@ export async function installAll({verbose = false, silent = false, lock}: Instal
 		}
 	}
 
+	let logUpdate = createLogUpdate(process.stdout, {showCursor: true});
+	// let logUpdate = l;
+
 	if (!silent && lock !== 'ignore') {
 		logUpdate('Checking integrity...');
 	}
+
 	await Promise.all([
 		notifyInstalls(Object.keys(installedPackages)),
 		checkIntegrity(lock),
@@ -46,6 +51,6 @@ export async function installAll({verbose = false, silent = false, lock}: Instal
 
 	if (!silent) {
 		logUpdate.clear();
-		console.log(chalk.green('All packages installed'));
+		console.log(chalk.green('Packages installed'));
 	}
 }

package/commands/install.ts

@@ -1,6 +1,6 @@
 import path from 'node:path';
 import fs from 'node:fs';
-import logUpdate from 'log-update';
+import {createLogUpdate} from 'log-update';
 import chalk from 'chalk';
 import {checkConfigFile, formatDir, progressBar, readConfig} from '../mops.js';
 import {getHighestVersion} from '../api/getHighestVersion.js';
@@ -14,6 +14,7 @@ export async function install(pkg: string, version = '', {verbose = false, silen
 	if (!checkConfigFile()) {
 		return false;
 	}
+	let logUpdate = createLogUpdate(process.stdout, {showCursor: true});
 
 	// progress
 	let total = Infinity;
@@ -89,6 +90,9 @@ export async function install(pkg: string, version = '', {verbose = false, silen
 	if (verbose) {
 		silent || logUpdate.done();
 	}
+	else {
+		logUpdate.clear();
+	}
 
 	// install dependencies
 	let ok = true;

package/commands/publish.ts

@@ -327,6 +327,8 @@ export async function publish(options: {docs?: boolean, test?: boolean} = {}) {
 
 	// finish
 	progress();
+	logUpdate.done();
+
 	let res = await actor.finishPublish(puiblishingId);
 	if ('err' in res) {
 		console.log(chalk.red('Error: ') + res.err);

package/commands/test/test.ts

@@ -1,4 +1,4 @@
-import {spawn, execSync, ChildProcessWithoutNullStreams} from 'node:child_process';
+import {spawn, ChildProcessWithoutNullStreams} from 'node:child_process';
 import path from 'node:path';
 import fs from 'node:fs';
 import os from 'node:os';
@@ -8,7 +8,7 @@ import chokidar from 'chokidar';
 import debounce from 'debounce';
 
 import {sources} from '../sources.js';
-import {getRootDir} from '../../mops.js';
+import {getRootDir, readConfig} from '../../mops.js';
 import {parallel} from '../../parallel.js';
 
 import {MMF1} from './mmf1.js';
@@ -18,6 +18,7 @@ import {VerboseReporter} from './reporters/verbose-reporter.js';
 import {FilesReporter} from './reporters/files-reporter.js';
 import {CompactReporter} from './reporters/compact-reporter.js';
 import {SilentReporter} from './reporters/silent-reporter.js';
+import {toolchain} from '../toolchain/index.js';
 
 let ignore = [
 	'**/node_modules/**',
@@ -70,7 +71,8 @@ export async function test(filter = '', {watch = false, reporter = 'verbose' as
 	}
 }
 
-let mocPath = process.env.DFX_MOC_PATH;
+let mocPath = '';
+let wasmtimePath = '';
 
 export async function runAll(reporterName: ReporterName = 'verbose', filter = '', mode: TestMode = 'interpreter'): Promise<boolean> {
 	let reporter: Reporter;
@@ -116,10 +118,11 @@ export async function testWithReporter(reporter: Reporter, filter = '', mode: Te
 
 	reporter.addFiles(files);
 
+	let config = readConfig();
 	let sourcesArr = await sources();
 
 	if (!mocPath) {
-		mocPath = execSync('dfx cache show').toString().trim() + '/moc';
+		mocPath = await toolchain.bin('moc');
 	}
 
 	let wasmDir = `${getRootDir()}/.mops/.test/`;
@@ -129,11 +132,20 @@ export async function testWithReporter(reporter: Reporter, filter = '', mode: Te
 		let mmf = new MMF1('store', absToRel(file));
 		let wasiMode = mode === 'wasi' || fs.readFileSync(file, 'utf8').startsWith('// @testmode wasi');
 
-		let promise = new Promise<void>((resolve) => {
-			if (!mocPath) {
-				mocPath = 'moc';
+		if (wasiMode && !wasmtimePath) {
+			// ensure wasmtime is installed or specified in config
+			if (config.toolchain?.wasmtime) {
+				wasmtimePath = await toolchain.bin('wasmtime');
+			}
+			// fallback wasmtime to global binary if not specified in config (legacy)
+			else {
+				wasmtimePath = 'wasmtime';
+				console.log(chalk.yellow('Warning:'), 'Wasmtime is not specified in config. Using global binary "wasmtime". This will be removed in the future.');
+				console.log(`Run ${chalk.green('mops toolchain use wasmtime')} or add ${chalk.green('wasmtime = "<version>"')} in mops.toml to avoid breaking changes with future versions of mops.`);
 			}
+		}
 
+		let promise = new Promise<void>((resolve) => {
 			let mocArgs = ['--hide-warnings', '--error-detail=2', ...sourcesArr.join(' ').split(' '), file].filter(x => x);
 
 			// build and run wasm
@@ -147,18 +159,29 @@ export async function testWithReporter(reporter: Reporter, filter = '', mode: Te
 						return;
 					}
 					// run
-					let proc = spawn('wasmtime', [
-						'--max-wasm-stack=2000000',
-						'--enable-cranelift-nan-canonicalization',
-						'--wasm-features',
-						'multi-memory,bulk-memory',
-						wasmFile,
-					], {
-						env: {
-							...process.env,
-							WASMTIME_NEW_CLI: '0',
-						}
-					});
+					let wasmtimeArgs = [];
+					if (config.toolchain?.wasmtime && config.toolchain?.wasmtime >= '14.0.0') {
+						wasmtimeArgs = [
+							'-S', 'preview2=n',
+							'-C', 'cache=n',
+							'-W', 'bulk-memory',
+							'-W', 'multi-memory',
+							'-W', 'max-wasm-stack=2000000',
+							'-W', 'nan-canonicalization=y',
+							wasmFile,
+						];
+					}
+					else {
+						wasmtimeArgs = [
+							'--max-wasm-stack=2000000',
+							'--enable-cranelift-nan-canonicalization',
+							'--wasm-features',
+							'multi-memory,bulk-memory',
+							wasmFile,
+						];
+					}
+
+					let proc = spawn(wasmtimePath, wasmtimeArgs);
 					await pipeMMF(proc, mmf);
 				}).finally(() => {
 					fs.rmSync(wasmFile, {force: true});