feat(console): use CLI upgrade wizard and snapshots before upgrade (#1716)

Author: peterpeterparker

scripts/console.snapshots.mjs

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+
+import { CONSOLE_ID } from './constants.mjs';
+import { listSnapshots } from './module.snapshots.mjs';
+
+await listSnapshots({
+	canisterId: CONSOLE_ID
+});

scripts/module.snapshots.mjs

@@ -0,0 +1,26 @@
+import { encodeSnapshotId, ICManagementCanister } from '@dfinity/ic-management';
+import { icAgent, localAgent } from './actor.mjs';
+import { targetMainnet } from './utils.mjs';
+
+const fnAgent = targetMainnet() ? icAgent : localAgent;
+const agent = await fnAgent();
+
+export const listSnapshots = async ({ canisterId }) => {
+	const { listCanisterSnapshots } = ICManagementCanister.create({
+		agent
+	});
+
+	const snapshots = await listCanisterSnapshots({ canisterId });
+
+	if (snapshots.length === 0) {
+		console.log('No snapshots found.');
+		return;
+	}
+
+	console.table(
+		snapshots.map((snapshot) => ({
+			...snapshot,
+			id: `0x${encodeSnapshotId(snapshot.id)}`
+		}))
+	);
+};

scripts/module.upgrade.mjs

@@ -1,13 +1,13 @@
 #!/usr/bin/env node
 
 import { IDL } from '@dfinity/candid';
-import { ICManagementCanister } from '@dfinity/ic-management';
-import { fromNullable, uint8ArrayToHexString } from '@dfinity/utils';
+import { UpgradeCodeProgressStep, upgradeModule } from '@junobuild/admin';
 import { fileExists } from '@junobuild/cli-tools';
 import { createHash } from 'crypto';
 import { readFile } from 'fs/promises';
 import { join } from 'node:path';
 import { icAgent, localAgent } from './actor.mjs';
+import { getIdentity } from './console.config.utils.mjs';
 import { targetMainnet } from './utils.mjs';
 
 const INSTALL_MODE_UPGRADE = {
@@ -20,46 +20,72 @@ const loadGzippedWasm = async (destination) => {
 	const buffer = await readFile(destination);
 
 	return {
-		wasm: [...new Uint8Array(buffer)],
+		wasm: buffer,
 		hash: createHash('sha256').update(buffer).digest('hex')
 	};
 };
 
-const fnAgent = targetMainnet() ? icAgent : localAgent;
+const mainnet = targetMainnet();
+
+const fnAgent = mainnet ? icAgent : localAgent;
 const agent = await fnAgent();
 
+const identity = await getIdentity(mainnet);
+
+const onProgress = ({ step, state }) => {
+	switch (step) {
+		case UpgradeCodeProgressStep.AssertingExistingCode:
+			console.log(`Validating: ${state}`);
+			break;
+		case UpgradeCodeProgressStep.StoppingCanister:
+			console.log(`Stopping: ${state}`);
+			break;
+		case UpgradeCodeProgressStep.TakingSnapshot:
+			console.log(`Creating a snapshot: ${state}`);
+			break;
+		case UpgradeCodeProgressStep.UpgradingCode:
+			console.log(`Upgrading: ${state}`);
+			break;
+		case UpgradeCodeProgressStep.RestartingCanister:
+			console.log(`Restarting: ${state}`);
+			break;
+	}
+};
+
 export const upgrade = async ({ sourceFilename, canisterId }) => {
 	const source = join(target, sourceFilename);
 
-	console.log(`About to upgrade module ${canisterId} with source ${source}...`);
+	console.log(`About to upgrade module ${canisterId.toText()} with source ${source}...`);
 
 	if (!(await fileExists(source))) {
 		throw new Error(`${source} not found.`);
 	}
 
-	const EMPTY_ARG = IDL.encode([], []);
-
-	const { installCode, canisterStatus } = ICManagementCanister.create({
-		agent
-	});
+	console.log('');
 
 	const { wasm, hash } = await loadGzippedWasm(source);
 
-	const { module_hash } = await canisterStatus(canisterId);
-
-	const currentHash = fromNullable(module_hash);
+	const EMPTY_ARG = IDL.encode([], []);
 
-	if (uint8ArrayToHexString(currentHash) === hash) {
-		console.log(`Module hash ${hash} already installed.`);
-		return;
+	try {
+		await upgradeModule({
+			actor: {
+				agent,
+				identity
+			},
+			mode: INSTALL_MODE_UPGRADE,
+			canisterId,
+			wasmModule: wasm,
+			arg: new Uint8Array(EMPTY_ARG),
+			takeSnapshot: true,
+			onProgress
+		});
+
+		console.log('');
+		console.log(`Module upgraded to hash ${hash}.`);
+	} catch (err) {
+		console.log('');
+		console.error('message' in err ? err.message : err);
+		process.exit(1);
 	}
-
-	await installCode({
-		mode: INSTALL_MODE_UPGRADE,
-		canisterId,
-		wasmModule: wasm,
-		arg: new Uint8Array(EMPTY_ARG)
-	});
-
-	console.log(`Module upgraded to hash ${hash}.`);
 };

scripts/observatory.snapshots.mjs

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+
+import { OBSERVATORY_ID } from './constants.mjs';
+import { listSnapshots } from './module.snapshots.mjs';
+
+await listSnapshots({
+	canisterId: OBSERVATORY_ID
+});