@sentry/cli 1.77.0 → 1.77.2

package/checksums.txt

@@ -1,9 +1,9 @@
-sentry-cli-Darwin-arm64=18c1972b79aeaeacb86a512076f355a7a1fd0cf7c0830d41e99ac579f12d6533
-sentry-cli-Darwin-universal=56973c245b5288de36d3fcb3420d67dc7f04e26c2c1cd35379ce617491f1d837
-sentry-cli-Darwin-x86_64=e60f59132433c1ec50e8570766a644a1abcf0e6fdf1f2bcca6de852daa260b62
-sentry-cli-Linux-aarch64=629e731a9dd2e925934eeab5e33f02ba2b60e8c2224b95321ab117a775ed6861
-sentry-cli-Linux-armv7=a8fbf4543d42372743ee8bc0ea7b43cb60b78d3e260d355ad4855c3bacf53f5c
-sentry-cli-Linux-i686=9b8982a2ebec0ba0b6199e070362f26e916e79e7d923cf2615f0af85afd1171b
-sentry-cli-Linux-x86_64=55fe5bdd1112bd6ff625df8cf97aca3e61df52293ab5b7d8f7466f334298bb27
-sentry-cli-Windows-i686.exe=fd53c35331d6208d9c1a2bdfc156235dcabb841c66162070470946215d4d79dd
-sentry-cli-Windows-x86_64.exe=e40cf0bde9c64f9e1f9936350b80e2e14708bca7744ecba0494d489c1ad56eba
+sentry-cli-Darwin-arm64=a69b907a4984a5d69fdb8fa018d08e45254e57a7038839a39deee09545137c9c
+sentry-cli-Darwin-universal=88648343df5e7e6bbf7e95fb8c67681b7949fdc919c00c0acaedf2ac8e258acc
+sentry-cli-Darwin-x86_64=26593639d98aa5e853951d1a4303ab578f1964545984b22e7f51feafcbe56152
+sentry-cli-Linux-aarch64=62f023ef7741facc7d4faead1717840aa83572991f9bcf42172b0ad82f27a820
+sentry-cli-Linux-armv7=23570b65e0c31428914d388b8e5e7ffb499627af810f60965517148cce0ac6fc
+sentry-cli-Linux-i686=a8e77f18ddadb5035d1c54b5978d7528b87fda62804a19a272f21761cdd0c889
+sentry-cli-Linux-x86_64=088ac6568445c4ebb5b82652190f51c711e13d40d5bd94a62cc37f2f1865412d
+sentry-cli-Windows-i686.exe=1d8a960afa3e6ef6f08125974d2ae2e79e8a7b38ae30f7c0b7a32db26f8b8e8b
+sentry-cli-Windows-x86_64.exe=6c30d85138bac891ba490a222870067c82c0617226bcd8b32768f11b7a5c9585

package/js/helper.js

@@ -1,21 +1,30 @@
 'use strict';
 
+const os = require('os');
 const path = require('path');
+const fs = require('fs');
 const childProcess = require('child_process');
 
+const BINARY_DISTRIBUTIONS = [
+  { packageName: '@sentry/cli-darwin', subpath: 'bin/sentry-cli' },
+  { packageName: '@sentry/cli-linux-x64', subpath: 'bin/sentry-cli' },
+  { packageName: '@sentry/cli-linux-i686', subpath: 'bin/sentry-cli' },
+  { packageName: '@sentry/cli-linux-arm64', subpath: 'bin/sentry-cli' },
+  { packageName: '@sentry/cli-linux-arm', subpath: 'bin/sentry-cli' },
+  { packageName: '@sentry/cli-win32-x64', subpath: 'bin/sentry-cli.exe' },
+  { packageName: '@sentry/cli-win32-i686', subpath: 'bin/sentry-cli.exe' },
+];
+
 /**
- * This convoluted function resolves the path to the `sentry-cli` binary in a
- * way that can't be analysed by @vercel/nft.
+ * This convoluted function resolves the path to the manually downloaded fallback
+ * `sentry-cli` binary in a way that can't be analysed by @vercel/nft.
  *
  * Without this, the binary can be detected as an asset and included by bundlers
  * that use @vercel/nft.
+ *
  * @returns {string} The path to the sentry-cli binary
  */
-function getBinaryPath() {
-  if (process.env.SENTRY_BINARY_PATH) {
-    return process.env.SENTRY_BINARY_PATH;
-  }
-
+function getFallbackBinaryPath() {
   const parts = [];
   parts.push(__dirname);
   parts.push('..');
@@ -23,19 +32,143 @@ function getBinaryPath() {
   return path.resolve(...parts);
 }
 
+function getDistributionForThisPlatform() {
+  const arch = os.arch();
+  const platform = os.platform();
+
+  let packageName = undefined;
+  if (platform === 'darwin') {
+    packageName = '@sentry/cli-darwin';
+  } else if (platform === 'linux' || platform === 'freebsd') {
+    switch (arch) {
+      case 'x64':
+        packageName = '@sentry/cli-linux-x64';
+        break;
+      case 'x86':
+      case 'ia32':
+        packageName = '@sentry/cli-linux-i686';
+        break;
+      case 'arm64':
+        packageName = '@sentry/cli-linux-arm64';
+        break;
+      case 'arm':
+        packageName = '@sentry/cli-linux-arm';
+        break;
+    }
+  } else if (platform === 'win32') {
+    switch (arch) {
+      case 'x64':
+        packageName = '@sentry/cli-win32-x64';
+        break;
+      case 'x86':
+      case 'ia32':
+        packageName = '@sentry/cli-win32-i686';
+        break;
+    }
+  }
+
+  let subpath = undefined;
+  switch (platform) {
+    case 'win32':
+      subpath = 'bin/sentry-cli.exe';
+      break;
+    case 'darwin':
+    case 'linux':
+    case 'freebsd':
+      subpath = 'bin/sentry-cli';
+      break;
+    default:
+      subpath = 'bin/sentry-cli';
+      break;
+  }
+
+  return { packageName, subpath };
+}
+
+/**
+ * Throws an error with a message stating that Sentry CLI doesn't support the current platform.
+ *
+ * @returns {never} nothing. It throws.
+ */
+function throwUnsupportedPlatformError() {
+  throw new Error(
+    `Unsupported operating system or architecture! Sentry CLI does not work on this architecture.
+
+Sentry CLI supports:
+- Darwin (macOS)
+- Linux and FreeBSD on x64, x86, ia32, arm64, and arm architectures
+- Windows x64, x86, and ia32 architectures`
+  );
+}
+
+/**
+ * Tries to find the installed Sentry CLI binary - either by looking into the relevant
+ * optional dependencies or by trying to resolve the fallback binary.
+ *
+ * @returns {string} The path to the sentry-cli binary
+ */
+function getBinaryPath() {
+  if (process.env.SENTRY_BINARY_PATH) {
+    return process.env.SENTRY_BINARY_PATH;
+  }
+
+  const { packageName, subpath } = getDistributionForThisPlatform();
+
+  if (packageName === undefined) {
+    throwUnsupportedPlatformError();
+  }
+
+  let fallbackBinaryPath = getFallbackBinaryPath();
+  if (fs.existsSync(fallbackBinaryPath)) {
+    // Since the fallback got installed, the optional dependencies likely didn't get installed, so we just default to the fallback.
+    return fallbackBinaryPath;
+  }
+
+  let compatibleBinaryPath;
+  try {
+    compatibleBinaryPath = require.resolve(`${packageName}/${subpath}`);
+  } catch (e) {
+    const otherInstalledDistribution = BINARY_DISTRIBUTIONS.find(({ packageName, subpath }) => {
+      try {
+        require.resolve(`${packageName}/${subpath}`);
+        return true;
+      } catch (e) {
+        return false;
+      }
+    });
+
+    // These error messages are heavily inspired by esbuild's error messages: https://github.com/evanw/esbuild/blob/f3d535262e3998d845d0f102b944ecd5a9efda57/lib/npm/node-platform.ts#L150
+    if (otherInstalledDistribution) {
+      throw new Error(`Sentry CLI binary for this platform/architecture not found!
+
+The "${otherInstalledDistribution.packageName}" package is installed, but for the current platform, you should have the "${packageName}" package installed instead. This usually happens if the "@sentry/cli" package is installed on one platform (for example Windows or MacOS) and then the "node_modules" folder is reused on another operating system (for example Linux in Docker).
+
+To fix this, avoid copying the "node_modules" folder, and instead freshly install your dependencies on the target system. You can also configure your package manager to install the right package. For example, yarn has the "supportedArchitectures" feature: https://yarnpkg.com/configuration/yarnrc/#supportedArchitecture.`);
+    } else {
+      throw new Error(`Sentry CLI binary for this platform/architecture not found!
+
+It seems like none of the "@sentry/cli" package's optional dependencies got installed. Please make sure your package manager is configured to install optional dependencies. If you are using npm to install your dependencies, please don't set the "--no-optional", "--ignore-optional", or "--omit=optional" flags. Sentry CLI needs the "optionalDependencies" feature in order to install its binary.`);
+    }
+  }
+
+  return compatibleBinaryPath;
+}
+
 /**
- * Absolute path to the sentry-cli binary (platform dependent).
- * @type {string}
+ * Will be used as the binary path when defined with `mockBinaryPath`.
+ * @type {string | undefined}
  */
-let binaryPath = getBinaryPath();
+let mockedBinaryPath;
 
 /**
  * Overrides the default binary path with a mock value, useful for testing.
  *
  * @param {string} mockPath The new path to the mock sentry-cli binary
+ * @deprecated This was used in tests internally and will be removed in the next major version.
  */
+// TODO(v3): Remove this function
 function mockBinaryPath(mockPath) {
-  binaryPath = mockPath;
+  mockedBinaryPath = mockPath;
 }
 
 /**
@@ -121,7 +254,7 @@ function prepareCommand(command, schema, options) {
  * @returns {string}
  */
 function getPath() {
-  return binaryPath;
+  return mockedBinaryPath !== undefined ? mockedBinaryPath : getBinaryPath();
 }
 
 /**
@@ -217,4 +350,7 @@ module.exports = {
   mockBinaryPath,
   prepareCommand,
   serializeOptions,
+  getDistributionForThisPlatform,
+  throwUnsupportedPlatformError,
+  getFallbackBinaryPath,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/cli",
-  "version": "1.77.0",
+  "version": "1.77.2",
   "description": "A command line utility to work with Sentry. https://docs.sentry.io/hosted/learn/cli/",
   "repository": "git://github.com/getsentry/sentry-cli.git",
   "homepage": "https://docs.sentry.io/hosted/learn/cli/",
@@ -27,10 +27,19 @@
     "eslint-config-prettier": "^8.5.0",
     "jest": "^27.5.1",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.6.2"
+    "prettier": "2.8.8"
+  },
+  "optionalDependencies": {
+    "@sentry/cli-darwin": "1.77.2",
+    "@sentry/cli-linux-arm": "1.77.2",
+    "@sentry/cli-linux-arm64": "1.77.2",
+    "@sentry/cli-linux-i686": "1.77.2",
+    "@sentry/cli-linux-x64": "1.77.2",
+    "@sentry/cli-win32-i686": "1.77.2",
+    "@sentry/cli-win32-x64": "1.77.2"
   },
   "scripts": {
-    "install": "node ./scripts/install.js",
+    "postinstall": "node ./scripts/install.js",
     "fix": "npm-run-all fix:eslint fix:prettier",
     "fix:eslint": "eslint --fix bin/* scripts/**/*.js js/**/*.js",
     "fix:prettier": "prettier --write bin/* scripts/**/*.js js/**/*.js",
@@ -49,7 +58,7 @@
     ]
   },
   "volta": {
-    "node": "10.24.1",
+    "node": "20.10.0",
     "yarn": "1.22.19"
   }
 }

package/scripts/bump-version.sh

@@ -21,4 +21,17 @@ cargo update -p sentry-cli
 
 # Do not tag and commit changes made by "npm version"
 export npm_config_git_tag_version=false
+
+# Bump main sentry cli npm package
 npm version "${TARGET}"
+
+# Bump the binary npm distributions
+for dir in $SCRIPT_DIR/../npm-binary-distributions/*; do
+    cd $dir
+    npm version "${TARGET}"
+    cd -
+done
+
+# Update the optional deps in the main cli npm package
+# Requires jq to be installed - should be installed ootb on github runners
+jq '.optionalDependencies |= map_values("'"${TARGET}"'")' $SCRIPT_DIR/../package.json > package.json.tmp && mv package.json.tmp $SCRIPT_DIR/../package.json

package/scripts/install.js

@@ -3,7 +3,6 @@
 'use strict';
 
 const fs = require('fs');
-const http = require('http');
 const os = require('os');
 const path = require('path');
 const crypto = require('crypto');
@@ -79,6 +78,10 @@ function getDownloadUrl(platform, arch) {
     case 'darwin':
       return `${releasesUrl}-Darwin-universal`;
     case 'win32':
+      // Windows arm machines can run x64 binaries
+      if (arch === 'arm64') {
+        archString = 'x86_64';
+      }
       return `${releasesUrl}-Windows-${archString}.exe`;
     case 'linux':
     case 'freebsd':
@@ -189,7 +192,7 @@ function validateChecksum(tempPath, name) {
 async function downloadBinary() {
   const arch = os.arch();
   const platform = os.platform();
-  const outputPath = helper.getPath();
+  const outputPath = helper.getFallbackBinaryPath();
 
   if (process.env.SENTRYCLI_USE_LOCAL === '1') {
     try {
@@ -303,40 +306,44 @@ async function downloadBinary() {
 async function checkVersion() {
   const output = await helper.execute(['--version']);
   const version = output.replace('sentry-cli ', '').trim();
-  const expected = process.env.SENTRYCLI_LOCAL_CDNURL ? 'DEV' : pkgInfo.version;
+  const expected = pkgInfo.version;
   if (version !== expected) {
     throw new Error(`Unexpected sentry-cli version "${version}", expected "${expected}"`);
   }
 }
 
-if (process.env.SENTRYCLI_LOCAL_CDNURL) {
-  // For testing, mock the CDN by spawning a local server
-  const server = http.createServer((request, response) => {
-    const contents = fs.readFileSync(path.join(__dirname, '../js/__mocks__/sentry-cli'));
-    response.writeHead(200, {
-      'Content-Type': 'application/octet-stream',
-      'Content-Length': String(contents.byteLength),
-    });
-    response.end(contents);
-  });
-
-  server.listen(8999);
-  process.on('exit', () => server.close());
-}
-
 if (process.env.SENTRYCLI_SKIP_DOWNLOAD === '1') {
   logger.log(`Skipping download because SENTRYCLI_SKIP_DOWNLOAD=1 detected.`);
   process.exit(0);
 }
 
-(async () => {
-  try {
-    await downloadBinary();
-    await checkVersion();
-    process.exit(0);
-  } catch (e) {
-    // eslint-disable-next-line no-console
-    console.error(e.toString());
-    process.exit(1);
-  }
-})();
+const { packageName: distributionPackageName, subpath: distributionSubpath } =
+  helper.getDistributionForThisPlatform();
+
+if (distributionPackageName === undefined) {
+  helper.throwUnsupportedPlatformError();
+}
+
+try {
+  require.resolve(`${distributionPackageName}/${distributionSubpath}`);
+  // If the `resolve` call succeeds it means a binary was installed successfully via optional dependencies so we can skip the manual postinstall download.
+  process.exit(0);
+} catch (e) {
+  // Optional dependencies likely didn't get installed - proceed with fallback downloading manually
+  // Log message inspired by esbuild: https://github.com/evanw/esbuild/blob/914f6080c77cfe32a54888caa51ca6ea13873ce9/lib/npm/node-install.ts#L253
+  logger.log(
+    `Sentry CLI failed to locate the "${distributionPackageName}" package after installation!
+
+This can happen if you use an option to disable optional dependencies during installation, like "--no-optional", "--ignore-optional", or "--omit=optional". Sentry CLI uses the "optionalDependencies" package.json feature to install the correct binary for your platform and operating system. This post-install script will now try to work around this by manually downloading the Sentry CLI binary from the Sentry CDN. If this fails, you need to remove the "--no-optional", "--ignore-optional", and "--omit=optional" flags for Sentry CLI to work.`
+  );
+
+  downloadBinary()
+    .then(() => checkVersion())
+    .then(() => {
+      process.exit(0);
+    })
+    .catch((e) => {
+      console.error(e);
+      process.exit(1);
+    });
+}