ic-mops 0.39.2 → 0.41.0

package/commands/bench.ts

@@ -8,7 +8,7 @@ import logUpdate from 'log-update';
 import {execaCommand} from 'execa';
 import stringWidth from 'string-width';
 
-import {getRootDir} from '../mops.js';
+import {getRootDir, readConfig} from '../mops.js';
 import {parallel} from '../parallel.js';
 import {absToRel} from './test/utils.js';
 import {getMocVersion} from '../helpers/get-moc-version.js';
@@ -16,7 +16,8 @@ import {getDfxVersion} from '../helpers/get-dfx-version.js';
 import {getMocPath} from '../helpers/get-moc-path.js';
 import {sources} from './sources.js';
 
-import {BenchResult, BenchSchema, _SERVICE} from '../declarations/bench/bench.did.js';
+import {Benchmark, Benchmarks} from '../declarations/main/main.did.js';
+import {BenchResult, _SERVICE} from '../declarations/bench/bench.did.js';
 import {BenchReplica} from './bench-replica.js';
 
 let ignore = [
@@ -32,31 +33,42 @@ let globConfig = {
 };
 
 type BenchOptions = {
-	replica: 'dfx' | 'pocket-ic',
-	replicaVersion: string,
-	moc: string,
-	gc: 'copying' | 'compacting' | 'generational' | 'incremental',
-	forceGc: boolean,
-	save: boolean,
-	compare: boolean,
-	verbose: boolean,
+	replica : 'dfx' | 'pocket-ic',
+	replicaVersion : string,
+	compiler : 'moc',
+	compilerVersion : string,
+	gc : 'copying' | 'compacting' | 'generational' | 'incremental',
+	forceGc : boolean,
+	save : boolean,
+	compare : boolean,
+	verbose : boolean,
+	silent : boolean,
+
 };
 
-export async function bench(filter = '', optionsArg: Partial<BenchOptions> = {}): Promise<boolean> {
-	let defaultOptions: BenchOptions = {
+export async function bench(filter = '', optionsArg : Partial<BenchOptions> = {}) : Promise<Benchmarks> {
+	let defaultOptions : BenchOptions = {
 		replica: 'dfx',
-		moc: getMocVersion(),
-		replicaVersion: '0.0.0',
+		replicaVersion: '',
+		compiler: 'moc',
+		compilerVersion: getMocVersion(),
 		gc: 'copying',
 		forceGc: true,
 		save: false,
 		compare: false,
 		verbose: false,
+		silent: false,
 	};
 
-	let options: BenchOptions = {...defaultOptions, ...optionsArg};
+	let options : BenchOptions = {...defaultOptions, ...optionsArg};
 
-	options.replicaVersion = options.replica == 'dfx' ? getDfxVersion() : '1.0.0';
+	if (options.replica == 'dfx') {
+		options.replicaVersion = getDfxVersion();
+	}
+	else if (options.replica == 'pocket-ic') {
+		let config = readConfig();
+		options.replicaVersion = config.toolchain?.['pocket-ic'] || '';
+	}
 
 	options.verbose && console.log(options);
 
@@ -70,12 +82,14 @@ export async function bench(filter = '', optionsArg: Partial<BenchOptions> = {})
 	let files = globSync(path.join(rootDir, globStr), globConfig);
 	if (!files.length) {
 		if (filter) {
-			console.log(`No benchmark files found for filter '${filter}'`);
-			return false;
+			options.silent || console.log(`No benchmark files found for filter '${filter}'`);
+			return [];
+		}
+		if (!options.silent) {
+			console.log('No *.bench.mo files found');
+			console.log('Put your benchmark code in \'bench\' directory in *.bench.mo files');
 		}
-		console.log('No *.bench.mo files found');
-		console.log('Put your benchmark code in \'bench\' directory in *.bench.mo files');
-		return false;
+		return [];
 	}
 
 	files.sort();
@@ -84,18 +98,20 @@ export async function bench(filter = '', optionsArg: Partial<BenchOptions> = {})
 	fs.rmSync(benchDir, {recursive: true, force: true});
 	fs.mkdirSync(benchDir, {recursive: true});
 
-	console.log('Benchmark files:');
-	for (let file of files) {
-		console.log(chalk.gray(`• ${absToRel(file)}`));
+	if (!options.silent) {
+		console.log('Benchmark files:');
+		for (let file of files) {
+			console.log(chalk.gray(`• ${absToRel(file)}`));
+		}
+		console.log('');
+		console.log('='.repeat(50));
+		console.log('');
 	}
-	console.log('');
-	console.log('='.repeat(50));
-	console.log('');
 
-	await replica.start();
+	await replica.start({silent: options.silent});
 
-	console.log('Deploying canisters...');
-	await parallel(os.cpus().length, files, async (file: string) => {
+	options.silent || console.log('Deploying canisters...');
+	await parallel(os.cpus().length, files, async (file : string) => {
 		try {
 			await deployBenchFile(file, options, replica);
 		}
@@ -106,12 +122,17 @@ export async function bench(filter = '', optionsArg: Partial<BenchOptions> = {})
 		}
 	});
 
-	await parallel(1, files, async (file: string) => {
-		console.log('\n' + '—'.repeat(50));
-		console.log(`\nRunning ${chalk.gray(absToRel(file))}...`);
-		console.log('');
+	let benchResults : Benchmarks = [];
+
+	await parallel(1, files, async (file : string) => {
+		if (!options.silent) {
+			console.log('\n' + '—'.repeat(50));
+			console.log(`\nRunning ${chalk.gray(absToRel(file))}...`);
+			console.log('');
+		}
 		try {
-			await runBenchFile(file, options, replica);
+			let benchResult = await runBenchFile(file, options, replica);
+			benchResults.push(benchResult);
 		}
 		catch (err) {
 			console.error('Unexpected error. Stopping replica...');
@@ -120,15 +141,15 @@ export async function bench(filter = '', optionsArg: Partial<BenchOptions> = {})
 		}
 	});
 
-	console.log('Stopping replica...');
+	options.silent || console.log('Stopping replica...');
 	await replica.stop();
 
 	fs.rmSync(benchDir, {recursive: true, force: true});
 
-	return true;
+	return benchResults;
 }
 
-function getMocArgs(options: BenchOptions): string {
+function getMocArgs(options : BenchOptions) : string {
 	let args = '';
 	if (options.forceGc) {
 		args += ' --force-gc';
@@ -139,7 +160,7 @@ function getMocArgs(options: BenchOptions): string {
 	return args;
 }
 
-async function deployBenchFile(file: string, options: BenchOptions, replica: BenchReplica): Promise<void> {
+async function deployBenchFile(file : string, options : BenchOptions, replica : BenchReplica) : Promise<void> {
 	let rootDir = getRootDir();
 	let tempDir = path.join(rootDir, '.mops/.bench/', path.parse(file).name);
 	let canisterName = path.parse(file).name;
@@ -173,12 +194,7 @@ async function deployBenchFile(file: string, options: BenchOptions, replica: Ben
 	options.verbose && console.timeEnd(`init ${canisterName}`);
 }
 
-type RunBenchFileResult = {
-	schema: BenchSchema,
-	results: Map<string, BenchResult>,
-};
-
-async function runBenchFile(file: string, options: BenchOptions, replica: BenchReplica): Promise<RunBenchFileResult> {
+async function runBenchFile(file : string, options : BenchOptions, replica : BenchReplica) : Promise<Benchmark> {
 	let rootDir = getRootDir();
 	let canisterName = path.parse(file).name;
 
@@ -186,7 +202,7 @@ async function runBenchFile(file: string, options: BenchOptions, replica: BenchR
 	let schema = await actor.getSchema();
 
 	// load previous results
-	let prevResults: Map<string, BenchResult> | undefined;
+	let prevResults : Map<string, BenchResult> | undefined;
 	let resultsJsonFile = path.join(rootDir, '.bench', `${path.parse(file).name}.json`);
 	if (options.compare) {
 		if (fs.existsSync(resultsJsonFile)) {
@@ -200,11 +216,14 @@ async function runBenchFile(file: string, options: BenchOptions, replica: BenchR
 
 	let results = new Map<string, BenchResult>();
 
-	let formatNumber = (n: bigint | number): string => {
+	let instructionsCells : bigint[][] = Array.from({length: schema.rows.length}, () => []);
+	let heapCells : bigint[][] = Array.from({length: schema.rows.length}, () => []);
+
+	let formatNumber = (n : bigint | number) : string => {
 		return n.toLocaleString('en-US').replaceAll(',', '_');
 	};
 
-	let getTable = (prop: keyof BenchResult): string => {
+	let getTable = (prop : keyof BenchResult) : string => {
 		let resArr = [['', ...schema.cols]];
 
 		for (let [_rowIndex, row] of schema.rows.entries()) {
@@ -222,7 +241,7 @@ async function runBenchFile(file: string, options: BenchOptions, replica: BenchR
 							let percent = (Number(res[prop]) - Number(prevRes[prop])) / Number(prevRes[prop]) * 100;
 							let sign = percent > 0 ? '+' : '';
 							let percentText = percent == 0 ? '0%' : sign + percent.toFixed(2) + '%';
-							let color: keyof typeof chalk = percent == 0 ? 'gray' : (percent > 0 ? 'red' : 'green');
+							let color : keyof typeof chalk = percent == 0 ? 'gray' : (percent > 0 ? 'red' : 'green');
 							diff = ` (${chalk[color](percentText)})`;
 						}
 						else {
@@ -255,18 +274,22 @@ async function runBenchFile(file: string, options: BenchOptions, replica: BenchR
 		`);
 	};
 
-	if (!process.env.CI) {
+	if (!process.env.CI && !options.silent) {
 		printResults();
 	}
 
 	// run all cells
 	for (let [rowIndex, row] of schema.rows.entries()) {
 		for (let [colIndex, col] of schema.cols.entries()) {
-			// let res = await actor.runCellQuery(BigInt(rowIndex), BigInt(colIndex));
-			// let res = await actor.runCellUpdate(BigInt(rowIndex), BigInt(colIndex));
 			let res = await actor.runCellUpdateAwait(BigInt(rowIndex), BigInt(colIndex));
 			results.set(`${row}:${col}`, res);
-			if (!process.env.CI) {
+
+			// @ts-ignore
+			instructionsCells[rowIndex][colIndex] = res.instructions;
+			// @ts-ignore
+			heapCells[rowIndex][colIndex] = res.rts_heap_size;
+
+			if (!process.env.CI && !options.silent) {
 				printResults();
 			}
 		}
@@ -280,9 +303,9 @@ async function runBenchFile(file: string, options: BenchOptions, replica: BenchR
 	// save results
 	if (options.save) {
 		console.log(`Saving results to ${chalk.gray(absToRel(resultsJsonFile))}`);
-		let json: Record<any, any> = {
+		let json : Record<any, any> = {
 			version: 1,
-			moc: options.moc,
+			moc: options.compilerVersion,
 			replica: options.replica,
 			replicaVersion: options.replicaVersion,
 			gc: options.gc,
@@ -300,5 +323,22 @@ async function runBenchFile(file: string, options: BenchOptions, replica: BenchR
 		}, 2));
 	}
 
-	return {schema, results};
+	// for backend
+	return {
+		name: schema.name,
+		description: schema.description,
+		file: absToRel(file),
+		gc: options.gc,
+		forceGC: options.forceGc,
+		replica: options.replica,
+		replicaVersion: options.replicaVersion,
+		compiler: options.compiler,
+		compilerVersion: options.compilerVersion,
+		rows: schema.rows,
+		cols: schema.cols,
+		metrics: [
+			['instructions', instructionsCells],
+			['rts_heap_size', heapCells],
+		],
+	};
 }

package/commands/bump.ts

@@ -2,7 +2,7 @@ import prompts from 'prompts';
 import chalk from 'chalk';
 import {checkConfigFile, readConfig, writeConfig} from '../mops.js';
 
-export async function bump(part: string) {
+export async function bump(part : string) {
 	if (!checkConfigFile()) {
 		return;
 	}
@@ -44,7 +44,7 @@ export async function bump(part: string) {
 	console.log(`Updated version: ${chalk.green.bold(config.package.version)}`);
 }
 
-function updateVersion(version: string, part: string) {
+function updateVersion(version : string, part : string) {
 	let parts = version.split('.');
 	let idx = ['major', 'minor', 'patch'].indexOf(part);
 	if (!parts[idx]) {

package/commands/docs.ts

@@ -10,7 +10,7 @@ import streamToPromise from 'stream-to-promise';
 import {getRootDir} from '../mops.js';
 import {toolchain} from './toolchain/index.js';
 
-let moDocPath: string;
+let moDocPath : string;
 
 export async function docs({silent = false} = {}) {
 	let rootDir = getRootDir();

package/commands/import-identity.ts

@@ -7,10 +7,10 @@ import {globalConfigDir} from '../mops.js';
 import {encrypt} from '../pem.js';
 
 type ImportIdentityOptions = {
-	encrypt: boolean;
+	encrypt : boolean;
 };
 
-export async function importPem(data: string, options: ImportIdentityOptions = {encrypt: true}) {
+export async function importPem(data : string, options : ImportIdentityOptions = {encrypt: true}) {
 	try {
 		if (!fs.existsSync(globalConfigDir)) {
 			fs.mkdirSync(globalConfigDir);

package/commands/init.ts

@@ -21,7 +21,7 @@ export async function init({yes = false} = {}) {
 
 	console.log('Initializing...');
 
-	let config: Config = {};
+	let config : Config = {};
 
 	if (yes) {
 		await applyInit({
@@ -36,7 +36,7 @@ export async function init({yes = false} = {}) {
 
 	// migrate from vessel
 	let vesselFile = path.join(process.cwd(), 'vessel.dhall');
-	let vesselConfig: VesselConfig = {dependencies: [], 'dev-dependencies': []};
+	let vesselConfig : VesselConfig = {dependencies: [], 'dev-dependencies': []};
 
 	if (existsSync(vesselFile)) {
 		console.log('Reading vessel.dhall file');
@@ -47,7 +47,7 @@ export async function init({yes = false} = {}) {
 	}
 
 	if (vesselConfig.dependencies) {
-		let deps: Dependencies = {};
+		let deps : Dependencies = {};
 		deps = {};
 
 		for (const dep of (vesselConfig.dependencies || [])) {
@@ -63,7 +63,7 @@ export async function init({yes = false} = {}) {
 		onCancel() {
 			console.log('aborted');
 			process.exit(0);
-		}
+		},
 	};
 
 	// type
@@ -162,11 +162,11 @@ export async function init({yes = false} = {}) {
 }
 
 type ApplyInitOptions = {
-	type: 'project' | 'package';
-	config: Config;
-	setupWorkflow: boolean;
-	addTest: boolean;
-	copyrightOwner: string;
+	type : 'project' | 'package';
+	config : Config;
+	setupWorkflow : boolean;
+	addTest : boolean;
+	copyrightOwner : string;
 }
 
 async function applyInit({type, config, setupWorkflow, addTest, copyrightOwner} : ApplyInitOptions) {

package/commands/install-all.ts

@@ -9,12 +9,12 @@ import {checkIntegrity} from '../integrity.js';
 import {installLocal} from './install-local.js';
 
 type InstallAllOptions = {
-	verbose?: boolean;
-	silent?: boolean;
-	lock?: 'check' | 'update' | 'ignore';
+	verbose ?: boolean;
+	silent ?: boolean;
+	lock ?: 'check' | 'update' | 'ignore';
 }
 
-export async function installAll({verbose = false, silent = false, lock}: InstallAllOptions = {}) {
+export async function installAll({verbose = false, silent = false, lock} : InstallAllOptions = {}) {
 	if (!checkConfigFile()) {
 		return;
 	}

package/commands/install-local.ts

@@ -6,7 +6,7 @@ import {install} from './install.js';
 
 // skip install and just find non-local dependencies to install
 // pkgPath should be relative to the current root dir or absolute
-export async function installLocal(pkg: string, pkgPath = '', {verbose = false, silent = false} = {}): Promise<Record<string, string> | false> {
+export async function installLocal(pkg : string, pkgPath = '', {verbose = false, silent = false} = {}) : Promise<Record<string, string> | false> {
 	if (!checkConfigFile()) {
 		return false;
 	}

package/commands/install.ts

@@ -11,7 +11,7 @@ import {addCache, copyCache, isCached} from '../cache.js';
 import {downloadFile, getPackageFilesInfo} from '../api/downloadPackageFiles.js';
 import {installLocal} from './install-local.js';
 
-export async function install(pkg: string, version = '', {verbose = false, silent = false, dep = false} = {}): Promise<Record<string, string> | false> {
+export async function install(pkg : string, version = '', {verbose = false, silent = false, dep = false} = {}) : Promise<Record<string, string> | false> {
 	if (!checkConfigFile()) {
 		return false;
 	}
@@ -65,7 +65,7 @@ export async function install(pkg: string, version = '', {verbose = false, silen
 			let filesData = new Map;
 			let storage = await storageActor(storageId);
 
-			await parallel(threads, fileIds, async (fileId: string) => {
+			await parallel(threads, fileIds, async (fileId : string) => {
 				let {path, data} = await downloadFile(storage, fileId);
 				filesData.set(path, data);
 				progress();

package/commands/publish.ts

@@ -5,19 +5,19 @@ import logUpdate from 'log-update';
 import {globbySync} from 'globby';
 import {minimatch} from 'minimatch';
 import prompts from 'prompts';
-import {fromMarkdown} from 'mdast-util-from-markdown';
-import {toMarkdown} from 'mdast-util-to-markdown';
 
 import {checkConfigFile, getIdentity, getRootDir, progressBar, readConfig} from '../mops.js';
 import {mainActor} from '../api/actors.js';
 import {parallel} from '../parallel.js';
 import {docs} from './docs.js';
-import {DependencyV2, PackageConfigV2} from '../declarations/main/main.did.js';
+import {Benchmarks, DependencyV2, PackageConfigV2} from '../declarations/main/main.did.js';
 import {Dependency} from '../types.js';
 import {testWithReporter} from './test/test.js';
 import {SilentReporter} from './test/reporters/silent-reporter.js';
+import {findChangelogEntry} from '../helpers/find-changelog-entry.js';
+import {bench} from './bench.js';
 
-export async function publish(options: {docs?: boolean, test?: boolean} = {}) {
+export async function publish(options : {docs ?: boolean, test ?: boolean, bench ?: boolean} = {}) {
 	if (!checkConfigFile()) {
 		return;
 	}
@@ -160,16 +160,16 @@ export async function publish(options: {docs?: boolean, test?: boolean} = {}) {
 		}
 	}
 
-	let toBackendDep = (dep: Dependency): DependencyV2 => {
+	let toBackendDep = (dep : Dependency) : DependencyV2 => {
 		return {
 			...dep,
 			version: dep.version || '',
-			repo: dep.repo || ''
+			repo: dep.repo || '',
 		};
 	};
 
 	// map fields
-	let backendPkgConfig: PackageConfigV2 = {
+	let backendPkgConfig : PackageConfigV2 = {
 		name: config.package.name,
 		version: config.package.version,
 		keywords: config.package.keywords || [],
@@ -258,6 +258,25 @@ export async function publish(options: {docs?: boolean, test?: boolean} = {}) {
 		}
 	}
 
+	// bench
+	let benchmarks : Benchmarks = [];
+	if (options.bench) {
+		console.log('Running benchmarks...');
+		try {
+			benchmarks = await bench('', {
+				replica: config.toolchain?.['pocket-ic'] ? 'pocket-ic' : 'dfx',
+				gc: 'copying',
+				forceGc: true,
+				silent: true,
+			});
+		}
+		catch (err) {
+			console.error(err);
+			console.log(chalk.red('Error: ') + 'benchmarks failed');
+			process.exit(1);
+		}
+	}
+
 	// progress
 	let total = files.length + 2;
 	let step = 0;
@@ -286,13 +305,18 @@ export async function publish(options: {docs?: boolean, test?: boolean} = {}) {
 		});
 	}
 
+	// upload benchmarks
+	if (options.bench) {
+		await actor.uploadBenchmarks(puiblishingId, benchmarks);
+	}
+
 	// upload changelog
 	if (changelog) {
 		await actor.uploadNotes(puiblishingId, changelog);
 	}
 
 	// upload files
-	await parallel(8, files, async (file: string) => {
+	await parallel(8, files, async (file : string) => {
 		progress();
 
 		let chunkSize = 1024 * 1024 + 512 * 1024; // 1.5mb
@@ -338,7 +362,7 @@ export async function publish(options: {docs?: boolean, test?: boolean} = {}) {
 	console.log(chalk.green('Published ') + `${config.package.name}@${config.package.version}`);
 }
 
-function parseChangelog(version: string): string {
+function parseChangelog(version : string) : string {
 	let rootDir = getRootDir();
 	let changelogFile = '';
 
@@ -365,7 +389,7 @@ function parseChangelog(version: string): string {
 	return changelog || '';
 }
 
-async function fetchGitHubReleaseNotes(repo: string, version: string): Promise<string> {
+async function fetchGitHubReleaseNotes(repo : string, version : string) : Promise<string> {
 	let repoPath = new URL(repo).pathname;
 	let res = await fetch(`https://api.github.com/repos${repoPath}/releases/tags/${version}`);
 	let release = await res.json();
@@ -381,29 +405,4 @@ async function fetchGitHubReleaseNotes(repo: string, version: string): Promise<s
 	}
 
 	return release.body;
-}
-
-function findChangelogEntry(changelog: string, version: string): string {
-	let tree = fromMarkdown(changelog);
-	let found = false;
-	let nodes = [];
-
-	for (let node of tree.children) {
-		if (found) {
-			if (node.type === 'heading') {
-				break;
-			}
-			else {
-				nodes.push(node);
-			}
-		}
-		else if (node.type === 'heading' && toMarkdown(node).match(new RegExp(`\\b${version}\\b`))) {
-			found = true;
-		}
-	}
-
-	return toMarkdown({
-		type: 'root',
-		children: nodes,
-	});
 }

package/commands/remove.ts

@@ -6,19 +6,19 @@ import {Config, Dependency} from '../types.js';
 import {checkIntegrity} from '../integrity.js';
 
 type RemoveOptions = {
-	verbose?: boolean;
-	dev?: boolean;
-	dryRun?: boolean;
-	lock?: 'update' | 'ignore';
+	verbose ?: boolean;
+	dev ?: boolean;
+	dryRun ?: boolean;
+	lock ?: 'update' | 'ignore';
 };
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-export async function remove(name: string, {dev = false, verbose = false, dryRun = false, lock}: RemoveOptions = {}) {
+export async function remove(name : string, {dev = false, verbose = false, dryRun = false, lock} : RemoveOptions = {}) {
 	if (!checkConfigFile()) {
 		return;
 	}
 
-	function getTransitiveDependencies(config: Config, exceptPkgId: string) {
+	function getTransitiveDependencies(config : Config, exceptPkgId : string) {
 		let deps = Object.values(config.dependencies || {});
 		let devDeps = Object.values(config['dev-dependencies'] || {});
 		return [...deps, ...devDeps]
@@ -30,7 +30,7 @@ export async function remove(name: string, {dev = false, verbose = false, dryRun
 			}).flat();
 	}
 
-	function getTransitiveDependenciesOf(name: string, version: string | undefined, repo?: string) {
+	function getTransitiveDependenciesOf(name : string, version : string | undefined, repo ?: string) {
 		let pkgDir = '';
 		if (repo) {
 			pkgDir = formatGithubDir(name, repo);
@@ -44,7 +44,7 @@ export async function remove(name: string, {dev = false, verbose = false, dryRun
 			return [];
 		}
 		let config = readConfig(configFile);
-		let deps: Dependency[] = Object.values(config.dependencies || {}).map((dep) => {
+		let deps : Dependency[] = Object.values(config.dependencies || {}).map((dep) => {
 			return [dep, ...getTransitiveDependenciesOf(dep.name, dep.version)];
 		}).flat();
 		return deps;

package/commands/search.ts

@@ -2,7 +2,7 @@ import asTable from 'as-table';
 import chalk from 'chalk';
 import {mainActor} from '../api/actors.js';
 
-export async function search(text: string) {
+export async function search(text : string) {
 	let actor = await mainActor();
 	let [packages, _pageCount] = await actor.search(text, [], []);
 
@@ -11,7 +11,7 @@ export async function search(text: string) {
 		return;
 	}
 
-	let ellipsis = (text: string, max: number) => {
+	let ellipsis = (text : string, max : number) => {
 		if (text.length <= max) {
 			return text;
 		}