magicbell-cli 1.2.0 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # magicbell-cli
 
+## 1.4.0
+
+### Minor Changes
+
+- [#7414](https://github.com/magicbell/magicbell/pull/7414) [`fb44a37`](https://github.com/magicbell/magicbell/commit/fb44a37b479b32c08501b8f653e323a0836cc3cc) Thanks [@smeijer](https://github.com/smeijer)! - fix windows installer
+
+## 1.3.0
+
+### Minor Changes
+
+- [#7410](https://github.com/magicbell/magicbell/pull/7410) [`0554378`](https://github.com/magicbell/magicbell/commit/05543786fcbb67db85079f3a5a920bcfdd54aea8) Thanks [@smeijer](https://github.com/smeijer)! - regen
+
 ## 1.2.0
 
 ### Minor Changes

package/package.json

@@ -1,20 +1,16 @@
 {
   "name": "magicbell-cli",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "description": "MagicBell CLI",
   "type": "module",
   "dependencies": {
-    "node-fetch": "^3.3.2",
-    "tar": "^7.5.2"
+    "tar": "^7.5.2",
+    "unzipper": "^0.11.4"
   },
   "bin": {
-    "magicbell": "bin/magicbell"
+    "magicbell": "src/cli.js"
   },
   "scripts": {
-    "postinstall": "node src/install.js install",
-    "preuninstall": "node src/install.js uninstall",
-    "prepack": "npx -y pinst --enable",
-    "postpack": "npx -y pinst --disable",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "MagicBell",
@@ -26,6 +22,6 @@
   "goBinary": {
     "name": "magicbell",
     "path": "./bin",
-    "url": "https://github.com/magicbell/homebrew-tap/releases/download/v{{version}}/magicbell-cli_{{platform}}_{{arch}}.tar.gz"
+    "url": "https://github.com/magicbell/homebrew-tap/releases/download/v{{version}}/magicbell-cli_{{platform}}_{{arch}}{{archive_ext}}"
   }
 }

package/src/cli.js

@@ -0,0 +1,95 @@
+#!/usr/bin/env node
+import { spawn } from 'child_process';
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+import { installBinary } from './install.js';
+import { createDebugLogger } from './log.js';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const BIN_DIR = path.resolve(__dirname, '../bin');
+const BINARY_NAME = process.platform === 'win32' ? 'magicbell.exe' : 'magicbell';
+const BINARY_PATH = path.join(BIN_DIR, BINARY_NAME);
+const SPAWN_RETRY_ATTEMPTS = 5;
+const SPAWN_RETRY_DELAY_MS = 200;
+const debug = createDebugLogger('cli');
+
+async function ensureBinary() {
+  if (fs.existsSync(BINARY_PATH)) {
+    debug('Binary already present at', BINARY_PATH);
+    return;
+  }
+
+  debug('Binary missing, installing');
+  await installBinary();
+  debug('Installation finished');
+
+  if (!fs.existsSync(BINARY_PATH)) {
+    throw new Error(`MagicBell binary is missing at ${BINARY_PATH} even after installation.`);
+  }
+}
+
+function delay(ms) {
+  return new Promise((resolve) => {
+    setTimeout(resolve, ms);
+  });
+}
+
+async function spawnWithRetry(args) {
+  for (let attempt = 1; attempt <= SPAWN_RETRY_ATTEMPTS; attempt += 1) {
+    try {
+      debug('Spawning binary', { args, attempt });
+      return spawn(BINARY_PATH, args, {
+        stdio: 'inherit',
+      });
+    } catch (error) {
+      if (error && error.code === 'EBUSY' && attempt < SPAWN_RETRY_ATTEMPTS) {
+        debug('Spawn failed with EBUSY, retrying', { attempt, delayMs: SPAWN_RETRY_DELAY_MS * attempt });
+        await delay(SPAWN_RETRY_DELAY_MS * attempt);
+        continue;
+      }
+
+      debug('Spawn failed with fatal error', error);
+      throw error;
+    }
+  }
+
+  throw new Error('Unable to spawn MagicBell CLI binary after multiple attempts.');
+}
+
+async function run() {
+  try {
+    await ensureBinary();
+    debug('Binary ready, invoking CLI', { args: process.argv.slice(2) });
+  } catch (err) {
+    console.error(err instanceof Error ? err.message : err);
+    process.exit(1);
+  }
+
+  let child;
+  try {
+    child = await spawnWithRetry(process.argv.slice(2));
+  } catch (error) {
+    const message = error instanceof Error ? error.message : error;
+    console.error('Failed to start the MagicBell binary:', message);
+    process.exit(1);
+  }
+
+  child.on('error', (error) => {
+    console.error('Failed to start the MagicBell binary:', error.message);
+    process.exit(1);
+  });
+
+  child.on('exit', (code, signal) => {
+    debug('Child exited', { code, signal });
+    if (signal) {
+      process.kill(process.pid, signal);
+      return;
+    }
+
+    process.exit(code ?? 0);
+  });
+}
+
+run();

package/src/install.js

@@ -1,18 +1,22 @@
-#!/usr/bin/env node
-'use strict';
+// based on https://github.com/Nelwhix/go-npm/blob/main/src/index.js
+// adjustments made so bin is installed to ./bin,
+// and used via a lazy-load mechanism instead of during postinstall
 
-/* eslint-disable no-console */
-
-// copy from https://github.com/Nelwhix/go-npm/blob/main/src/index.js
-// adjustments made so bin is installed to ./bin instead of node global .bin folder
-
-import { exec } from 'child_process';
 import fs from 'fs';
-import fetch from 'node-fetch';
 import path from 'path';
+import { pipeline, Readable } from 'stream';
 import * as tar from 'tar';
+import unzipper from 'unzipper';
+import { fileURLToPath } from 'url';
 import zlib from 'zlib';
 
+import { createDebugLogger, isDebugEnabled } from './log.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const PACKAGE_ROOT = path.resolve(__dirname, '..');
+const debug = createDebugLogger('install');
+
 // Mapping from Node's `process.arch` to Golang's `$GOARCH`
 const ARCH_MAPPING = {
   ia32: '386',
@@ -29,43 +33,7 @@ const PLATFORM_MAPPING = {
   freebsd: 'freebsd',
 };
 
-// to get the path where npm binaries are stored
-function getInstallationPath(callback) {
-  exec('npm --v', (err, stdout, _stderr) => {
-    const npmVersion = parseFloat(stdout.trim());
-
-    // npm bin was deprecated after v9 https://github.blog/changelog/2022-10-24-npm-v9-0-0-released/
-    if (npmVersion < 9) {
-      exec('npm bin -g', (err, stdout, stderr) => {
-        let dir = null;
-
-        if (err || stderr || !stdout || stdout.length === 0) {
-          throw new Error('Could not get installation path');
-        } else {
-          dir = stdout.trim();
-        }
-
-        fs.mkdirSync(dir, { recursive: true });
-        callback(null, dir);
-      });
-    } else {
-      exec('npm prefix -g', (err, stdout, stderr) => {
-        let dir = null;
-
-        if (err || stderr || !stdout || stdout.length === 0) {
-          throw new Error('Could not get installation path');
-        } else {
-          dir = stdout.trim() + '/bin';
-        }
-
-        fs.mkdirSync(dir, { recursive: true });
-        callback(null, dir);
-      });
-    }
-  });
-}
-
-function verifyAndPlaceBinary(binName, binPath, callback) {
+function verifyAndPlaceBinary(binName, binPath) {
   const targetPath = path.join(binPath, binName);
 
   if (!fs.existsSync(targetPath)) {
@@ -77,8 +45,6 @@ function verifyAndPlaceBinary(binName, binPath, callback) {
   } catch (err) {
     // ignore on Windows
   }
-
-  callback();
 }
 
 function validateConfiguration(packageJson) {
@@ -103,39 +69,35 @@ function validateConfiguration(packageJson) {
   }
 }
 
-function parsePackageJson() {
+function loadConfiguration() {
+  debug('Loading configuration', { platform: process.platform, arch: process.arch });
+  const isWindows = process.platform === 'win32';
   if (!(process.arch in ARCH_MAPPING)) {
-    console.error('Installation is not supported for this architecture: ' + process.arch);
-    return;
+    throw new Error('Installation is not supported for this architecture: ' + process.arch);
   }
 
   if (!(process.platform in PLATFORM_MAPPING)) {
-    console.error('Installation is not supported for this platform: ' + process.platform);
-    return;
+    throw new Error('Installation is not supported for this platform: ' + process.platform);
   }
 
-  const packageJsonPath = path.join('.', 'package.json');
+  const packageJsonPath = path.join(PACKAGE_ROOT, 'package.json');
   if (!fs.existsSync(packageJsonPath)) {
-    console.error(
-      'Unable to find package.json. ' + 'Please run this script at root of the package you want to be installed',
-    );
-    return;
+    throw new Error('Unable to find package.json. Please run this script at the root of the package.');
   }
 
-  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath));
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
   const error = validateConfiguration(packageJson);
   if (error && error.length > 0) {
-    console.error('Invalid package.json: ' + error);
-    return;
+    throw new Error('Invalid package.json: ' + error);
   }
 
   let binName = packageJson.goBinary.name;
-  const binPath = packageJson.goBinary.path;
+  const binPath = path.resolve(PACKAGE_ROOT, packageJson.goBinary.path);
   let url = packageJson.goBinary.url;
   let version = packageJson.goBinary.binaryVersion || packageJson.version;
   if (version[0] === 'v') version = version.substr(1);
 
-  if (process.platform === 'win32') {
+  if (isWindows) {
     binName += '.exe';
   }
 
@@ -144,12 +106,16 @@ function parsePackageJson() {
   url = url.replace(/{{platform}}/g, PLATFORM_MAPPING[process.platform]);
   url = url.replace(/{{version}}/g, version);
   url = url.replace(/{{bin_name}}/g, binName);
+  const archiveExtension = isWindows ? '.zip' : '.tar.gz';
+  url = url.replace(/{{archive_ext}}/g, archiveExtension);
+  debug('Resolved download URL', url);
 
   return {
-    binName: binName,
-    binPath: binPath,
-    url: url,
-    version: version,
+    binName,
+    binPath,
+    url,
+    version,
+    archiveType: isWindows ? 'zip' : 'tar',
   };
 }
 
@@ -161,66 +127,65 @@ function parsePackageJson() {
  *
  *  See: https://docs.npmjs.com/files/package.json#bin
  */
-const INVALID_INPUT = 'Invalid inputs';
-function install(callback) {
-  const options = parsePackageJson();
-  if (!options) {
-    throw new Error(INVALID_INPUT);
-  }
+export function installBinary() {
+  const options = loadConfiguration();
 
   fs.mkdirSync(options.binPath, { recursive: true });
-  const ungz = zlib.createGunzip();
-  const untar = tar.x({ cwd: options.binPath });
-
-  // First we will Un-GZip, then we will untar. So once untar is completed,
-  // binary is downloaded into `binPath`. Verify the binary and call it good
-  untar.on('end', () => {
-    verifyAndPlaceBinary(options.binName, options.binPath, callback);
-  });
-
-  console.log('Downloading from URL: ' + options.url);
-
-  fetch(options.url).then((res) => {
-    if (!res.ok) {
-      throw new Error('Error downloading binary. HTTP Status Code: ' + res.status);
-    }
-
-    res.body.pipe(ungz).pipe(untar);
-  });
-}
+  debug('Prepared bin path', options.binPath);
+
+  return new Promise((resolve, reject) => {
+    let settled = false;
+    const finish = (action, value) => {
+      if (settled) return;
+      settled = true;
+      action(value);
+    };
+
+    const handleError = (err) => {
+      if (isDebugEnabled) {
+        console.error('[magicbell:install] Installation error:', err);
+      }
+      finish(reject, err);
+    };
+    const handleSuccess = () => finish(resolve);
+
+    debug('Fetching binary', { url: options.url, archiveType: options.archiveType });
+    fetch(options.url)
+      .then((res) => {
+        if (!res.ok) {
+          throw new Error(`Error downloading binary from: '${options.url}'. HTTP Status Code: ${res.status}`);
+        }
 
-function uninstall(callback) {
-  const options = parsePackageJson();
+        const streams = [];
+        if (options.archiveType === 'zip') {
+          debug('Using zip extractor');
+          streams.push(unzipper.Extract({ path: options.binPath }));
+        } else {
+          debug('Using gzip+tar extractor');
+          streams.push(zlib.createGunzip(), tar.x({ cwd: options.binPath }));
+        }
 
-  getInstallationPath(function (err, installationPath) {
-    if (err) {
-      throw new Error('Error finding binary installation directory');
-    }
+        if (!res.body) {
+          throw new Error('Download response did not include a body.');
+        }
 
-    fs.unlinkSync(path.join(installationPath, options.binName));
-    callback();
+        const bodyStream = typeof res.body.getReader === 'function' ? Readable.fromWeb(res.body) : res.body;
+        pipeline(bodyStream, ...streams, (err) => {
+          if (err) {
+            handleError(err);
+            return;
+          }
+
+          try {
+            debug('Verifying downloaded binary');
+            verifyAndPlaceBinary(options.binName, options.binPath);
+            debug('Binary verification successful');
+            handleSuccess();
+          } catch (verificationError) {
+            handleError(verificationError);
+          }
+        });
+      })
+      .catch(handleError);
   });
 }
-
-const actions = {
-  install: install,
-  uninstall: uninstall,
-};
-
-const argv = process.argv;
-if (argv && argv.length > 2) {
-  const cmd = process.argv[2];
-  if (!actions[cmd]) {
-    console.log('Invalid command to go-npm. `install` and `uninstall` are the only supported commands');
-    process.exit(1);
-  }
-
-  try {
-    actions[cmd](() => {
-      process.exit(0);
-    });
-  } catch (err) {
-    console.error(err);
-    process.exit(1);
-  }
-}

package/src/log.js

@@ -0,0 +1,11 @@
+const DEBUG_ENABLED = Boolean(process.env.DEBUG);
+
+export function createDebugLogger(scope) {
+  return (...args) => {
+    if (!DEBUG_ENABLED) return;
+    // write to stderr, so it doesn't litter stdout
+    console.error(`[magicbell:${scope}]`, args);
+  };
+}
+
+export const isDebugEnabled = DEBUG_ENABLED;