feat: help messages and upgrade options (#4)

* feat: print help

* feat: upgrade with local file

Author: peterpeterparker

src/commands/help.ts

@@ -5,8 +5,10 @@ const JUNO_LOGO = `  __  __ __  __  _  ____
 __) ||  |  ||  \\| |/    \\
 \\___/ \\___/ |_|\\__|\\____/`;
 
+const title = `${JUNO_LOGO} CLI ${grey(`v${version}`)}`;
+
 export const help = `
-${JUNO_LOGO} CLI ${grey(`v${version}`)}
+${title}
 
 Usage: ${cyan('juno [command]')}
 
@@ -21,3 +23,22 @@ Commands:
   ${cyan('upgrade')}             upgrade your satellite to a specific version code
   ${cyan('version')}             check the version of a satellite
 `;
+
+export const helpUpgrade = `
+${title}
+
+Usage: ${cyan('juno upgrade [options]')}
+
+Options:
+  ${cyan('-s, --src')}           a local wasm file to upgrade your satellite
+  ${cyan('-h, --help')}          output usage information
+`;
+
+export const helpCommand = (command: string) => `
+${title}
+
+Usage: ${cyan(`juno ${command}`)}
+
+Options:
+  ${cyan('-h, --help')}          output usage information
+`;

src/commands/upgrade.ts

@@ -1,12 +1,13 @@
-import {satelliteVersion, upgradeSatellite} from '@junobuild/admin';
+import {SatelliteParameters, satelliteVersion, upgradeSatellite} from '@junobuild/admin';
 import {red} from 'kleur';
 import prompts from 'prompts';
 import {compare} from 'semver';
 import {SATELLITE_WASM_NAME} from '../constants/constants';
+import {hasArgs, nextArg} from '../utils/args.utils';
 import {GitHubAsset, GitHubRelease, githubReleases} from '../utils/github.utils';
 import {junoConfigExist, readSatelliteConfig} from '../utils/satellite.config.utils';
 import {satelliteParameters} from '../utils/satellite.utils';
-import {upgradeWasm} from '../utils/wasm.utils';
+import {upgradeWasmGitHub, upgradeWasmLocal} from '../utils/wasm.utils';
 
 const promptReleases = async (
   githubReleases: GitHubRelease[]
@@ -27,7 +28,7 @@ const promptReleases = async (
   return assets?.find(({name}) => name === SATELLITE_WASM_NAME);
 };
 
-export const upgrade = async () => {
+export const upgrade = async (args?: string[]) => {
   if (!(await junoConfigExist())) {
     console.log(`${red('No configuration found.')}`);
     return;
@@ -37,6 +38,15 @@ export const upgrade = async () => {
 
   const satellite = satelliteParameters(satelliteId);
 
+  if (hasArgs({args, options: ['-s', '--src']})) {
+    await upgradeCustom({satellite, args});
+    return;
+  }
+
+  await upgradeRelease(satellite);
+};
+
+const upgradeRelease = async (satellite: SatelliteParameters) => {
   const currentVersion = await satelliteVersion({
     satellite
   });
@@ -79,5 +89,28 @@ export const upgrade = async () => {
       wasm_module
     });
 
-  await upgradeWasm({asset, upgrade: upgradeSatelliteWasm});
+  await upgradeWasmGitHub({asset, upgrade: upgradeSatelliteWasm});
+};
+
+const upgradeCustom = async ({
+  satellite,
+  args
+}: {
+  satellite: SatelliteParameters;
+  args?: string[];
+}) => {
+  const src = nextArg({args, option: '-s'}) ?? nextArg({args, option: '--src'});
+
+  if (src === undefined) {
+    console.log(`${red('No source file provided.')}`);
+    return;
+  }
+
+  const upgradeSatelliteWasm = async ({wasm_module}: {wasm_module: Array<number>}) =>
+    upgradeSatellite({
+      satellite,
+      wasm_module
+    });
+
+  await upgradeWasmLocal({src, upgrade: upgradeSatelliteWasm});
 };

src/commands/version.ts

@@ -13,7 +13,7 @@ import {GitHubAsset, githubLastRelease} from '../utils/github.utils';
 import {confirm, NEW_CMD_LINE} from '../utils/prompt.utils';
 import {junoConfigExist, readSatelliteConfig} from '../utils/satellite.config.utils';
 import {satelliteKey, satelliteParameters} from '../utils/satellite.utils';
-import {upgradeWasm} from '../utils/wasm.utils';
+import {upgradeWasmGitHub} from '../utils/wasm.utils';
 
 export const version = async () => {
   await missionControlVersion();
@@ -59,7 +59,7 @@ const missionControlVersion = async () => {
       wasm_module
     });
 
-  await upgradeWasm({asset, upgrade: upgradeMissionControlWasm});
+  await upgradeWasmGitHub({asset, upgrade: upgradeMissionControlWasm});
 };
 
 const satelliteVersion = async () => {
@@ -98,7 +98,7 @@ const satelliteVersion = async () => {
       wasm_module
     });
 
-  await upgradeWasm({asset, upgrade: upgradeSatelliteWasm});
+  await upgradeWasmGitHub({asset, upgrade: upgradeSatelliteWasm});
 };
 
 const shouldUpgradeVersion = async ({

src/index.ts

@@ -3,13 +3,25 @@ import {login, logout} from './commands/auth';
 import {clear} from './commands/clear';
 import {config} from './commands/config';
 import {deploy} from './commands/deploy';
-import {help} from './commands/help';
+import {help, helpCommand, helpUpgrade} from './commands/help';
 import {init} from './commands/init';
 import {upgrade} from './commands/upgrade';
 import {version as versionCommand} from './commands/version';
+import {hasArgs} from './utils/args.utils';
 
 export const run = async () => {
-  const [cmd, ...rest] = process.argv.slice(2);
+  const [cmd, ...args] = process.argv.slice(2);
+
+  if (hasArgs({args, options: ['-h', '--help']})) {
+    switch (cmd) {
+      case 'upgrade':
+        console.log(helpUpgrade);
+        break;
+      default:
+        console.log(helpCommand(cmd));
+    }
+    return;
+  }
 
   switch (cmd) {
     case 'login':
@@ -34,10 +46,7 @@ export const run = async () => {
       await versionCommand();
       break;
     case 'upgrade':
-      await upgrade();
-      break;
-    case 'help':
-      console.log(help);
+      await upgrade(args);
       break;
     default:
       console.log(`${red('Unknown command.')}`);

src/utils/args.utils.ts

@@ -0,0 +1,12 @@
+export const hasArgs = ({args, options}: {args?: string[]; options: string[]}): boolean =>
+  args?.find((arg) => options.includes(arg)) !== undefined;
+
+export const nextArg = ({args, option}: {args?: string[]; option: string}): string | undefined => {
+  const index = (args ?? []).findIndex((arg) => arg === option);
+
+  if (index === -1) {
+    return undefined;
+  }
+
+  return args?.[index + 1];
+};

src/utils/wasm.utils.ts

@@ -1,4 +1,5 @@
 import {createHash} from 'crypto';
+import {readFile} from 'fs/promises';
 import {cyan} from 'kleur';
 import ora from 'ora';
 import {downloadFromURL} from './download.utils';
@@ -7,11 +8,15 @@ import {confirmAndExit, NEW_CMD_LINE} from './prompt.utils';
 
 const executeUpgradeWasm = async ({
   upgrade,
-  wasm
+  wasm,
+  hash
 }: {
   wasm: Buffer;
+  hash: string;
   upgrade: ({wasm_module}: {wasm_module: Array<number>}) => Promise<void>;
 }) => {
+  await confirmAndExit(`Wasm hash is ${cyan(hash)}.${NEW_CMD_LINE}Start upgrade now?`);
+
   const spinner = ora('Upgrading Wasm...').start();
 
   try {
@@ -23,7 +28,37 @@ const executeUpgradeWasm = async ({
   }
 };
 
-export const upgradeWasm = async ({
+export const upgradeWasmLocal = async ({
+  src,
+  upgrade
+}: {
+  src: string;
+  upgrade: ({wasm_module}: {wasm_module: Array<number>}) => Promise<void>;
+}) => {
+  const loadWasm = async (file: string): Promise<{hash: string; wasm: Buffer}> => {
+    const wasm = await readFile(file);
+
+    return {
+      wasm,
+      hash: createHash('sha256').update(wasm).digest('hex')
+    };
+  };
+
+  const spinner = ora('Loading Wasm...').start();
+
+  try {
+    const {hash, wasm} = await loadWasm(src);
+
+    spinner.stop();
+
+    await executeUpgradeWasm({upgrade, wasm, hash});
+  } catch (err: unknown) {
+    spinner.stop();
+    throw err;
+  }
+};
+
+export const upgradeWasmGitHub = async ({
   asset,
   upgrade
 }: {
@@ -48,9 +83,7 @@ export const upgradeWasm = async ({
 
     spinner.stop();
 
-    await confirmAndExit(`Wasm hash is ${cyan(hash)}.${NEW_CMD_LINE}Start upgrade now?`);
-
-    await executeUpgradeWasm({upgrade, wasm});
+    await executeUpgradeWasm({upgrade, wasm, hash});
   } catch (err: unknown) {
     spinner.stop();
     throw err;