magicbell-cli 1.2.0 → 1.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # magicbell-cli
 
+## 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,6 +1,6 @@
 {
   "name": "magicbell-cli",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "MagicBell CLI",
   "type": "module",
   "dependencies": {
@@ -8,13 +8,9 @@
     "tar": "^7.5.2"
   },
   "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",

package/src/cli.js

@@ -0,0 +1,50 @@
+#!/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';
+
+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);
+
+async function ensureBinary() {
+  if (fs.existsSync(BINARY_PATH)) return;
+  await installBinary();
+
+  if (!fs.existsSync(BINARY_PATH)) {
+    throw new Error(`MagicBell binary is missing at ${BINARY_PATH} even after installation.`);
+  }
+}
+
+async function run() {
+  try {
+    await ensureBinary();
+  } catch (err) {
+    console.error(err instanceof Error ? err.message : err);
+    process.exit(1);
+  }
+
+  const child = spawn(BINARY_PATH, process.argv.slice(2), {
+    stdio: 'inherit',
+  });
+
+  child.on('error', (error) => {
+    console.error('Failed to start the MagicBell binary:', error.message);
+    process.exit(1);
+  });
+
+  child.on('exit', (code, signal) => {
+    if (signal) {
+      process.kill(process.pid, signal);
+      return;
+    }
+
+    process.exit(code ?? 0);
+  });
+}
+
+run();

package/src/install.js

@@ -1,18 +1,18 @@
-#!/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 * as tar from 'tar';
+import { fileURLToPath } from 'url';
 import zlib from 'zlib';
 
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const PACKAGE_ROOT = path.resolve(__dirname, '..');
+
 // Mapping from Node's `process.arch` to Golang's `$GOARCH`
 const ARCH_MAPPING = {
   ia32: '386',
@@ -29,43 +29,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 +41,6 @@ function verifyAndPlaceBinary(binName, binPath, callback) {
   } catch (err) {
     // ignore on Windows
   }
-
-  callback();
 }
 
 function validateConfiguration(packageJson) {
@@ -103,34 +65,28 @@ function validateConfiguration(packageJson) {
   }
 }
 
-function parsePackageJson() {
+function loadConfiguration() {
   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);
@@ -146,10 +102,10 @@ function parsePackageJson() {
   url = url.replace(/{{bin_name}}/g, binName);
 
   return {
-    binName: binName,
-    binPath: binPath,
-    url: url,
-    version: version,
+    binName,
+    binPath,
+    url,
+    version,
   };
 }
 
@@ -161,66 +117,47 @@ 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);
-  });
-}
+  return new Promise((resolve, reject) => {
+    let settled = false;
+    const finish = (action, value) => {
+      if (settled) return;
+      settled = true;
+      action(value);
+    };
+
+    const handleError = (err) => finish(reject, err);
+    const handleSuccess = () => finish(resolve);
+
+    // 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', () => {
+      try {
+        verifyAndPlaceBinary(options.binName, options.binPath);
+        handleSuccess();
+      } catch (err) {
+        handleError(err);
+      }
+    });
 
-function uninstall(callback) {
-  const options = parsePackageJson();
+    ungz.on('error', handleError);
+    untar.on('error', handleError);
 
-  getInstallationPath(function (err, installationPath) {
-    if (err) {
-      throw new Error('Error finding binary installation directory');
-    }
+    fetch(options.url)
+      .then((res) => {
+        if (!res.ok) {
+          throw new Error('Error downloading binary. HTTP Status Code: ' + res.status);
+        }
 
-    fs.unlinkSync(path.join(installationPath, options.binName));
-    callback();
+        res.body.on('error', handleError);
+        res.body.pipe(ungz).pipe(untar);
+      })
+      .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);
-  }
-}