@sentry/cli 2.21.4 → 2.22.1

package/checksums.txt

@@ -1,9 +1,9 @@
-sentry-cli-Darwin-arm64=5ac4778bb4ee9ad3cc95bc1083858559104017397e7fbd90b31cca508450d732
-sentry-cli-Darwin-universal=f23634d75c8d1bc3795b5bd51e37a5cb54d3384d28fca9a5d689c92108c81504
-sentry-cli-Darwin-x86_64=73e7c8d6ee289d190a1de662f3cf49666e4a4c65221a15ce09af2618c9a883c3
-sentry-cli-Linux-aarch64=73f2c494c8d2c70b787993eedb0b31c9741c19381bd340081457ab386c4b646f
-sentry-cli-Linux-armv7=49ad9690e5277c4a4927cbbf0564addd0bd3d12d31358d13f32c0d72a8390ecb
-sentry-cli-Linux-i686=3cb5f769281ceb64b3524cc27268de3786afd4dd9bbfe3ab4f0f499faa79e746
-sentry-cli-Linux-x86_64=1dfd60c8c26a68bc42f612bef19655c86de0b0e291813d02b1498506e36f1bed
-sentry-cli-Windows-i686.exe=d1aafe8c0ccf8ee615b867b7135b192562d5313393cb646a2b0999ebed347bde
-sentry-cli-Windows-x86_64.exe=9c9bfc1f35bd038bafb5390926de3e800891fa8aa576e11d46995ed06ad1ceea
+sentry-cli-Darwin-arm64=744dfe9b9502c4c3a35a224838a1bce7db0132c122f8615417cc9d32217f7fa9
+sentry-cli-Darwin-universal=508f76bd7ce43cdbab9e0b2ce068917ef95c0ea9c5a57ddd5546f95f8cdd8a3b
+sentry-cli-Darwin-x86_64=a16caaa9fc7405ba50aed5d576042ee1c3a91eee13d2b1da0f59fd9dec665655
+sentry-cli-Linux-aarch64=c7ed4c6586692ed56ce84db202aa5e5dee48e5d56dcd45b42b45eb5384dcbffa
+sentry-cli-Linux-armv7=aa69ed00523ead7448dddb679e0c5a0f599a5808adff5205cb1397e1004f3203
+sentry-cli-Linux-i686=d8aeee45ae41a104d2cb1586eca953dbd697a6d1c92cb00ef45e3bf7c31bc70c
+sentry-cli-Linux-x86_64=0a34cf9b3d3069b7a5c816650fa9cf07963ccc77e881629a6ed82db9727bdf91
+sentry-cli-Windows-i686.exe=fe57cc17abcf8bd50f6ded08dc36fc723a5a2ddfd93dbc18edaf00856d6bfa36
+sentry-cli-Windows-x86_64.exe=49ae8dfa38d11d234c9816001e3c1af0741e780860eebaf89a971c8c6f49c7f4

package/js/helper.js

@@ -1,8 +1,72 @@
 'use strict';
 
+const os = require('os');
 const path = require('path');
 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' },
+];
+
+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 };
+}
+
 /**
  * This convoluted function resolves the path to the `sentry-cli` binary in a
  * way that can't be analysed by @vercel/nft.
@@ -16,11 +80,55 @@ function getBinaryPath() {
     return process.env.SENTRY_BINARY_PATH;
   }
 
-  const parts = [];
-  parts.push(__dirname);
-  parts.push('..');
-  parts.push(`sentry-cli${process.platform === 'win32' ? '.exe' : ''}`);
-  return path.resolve(...parts);
+  if (!process.env.USE_SENTRY_BINARY_NPM_DISTRIBUTION) {
+    const parts = [];
+    parts.push(__dirname);
+    parts.push('..');
+    parts.push(`sentry-cli${process.platform === 'win32' ? '.exe' : ''}`);
+    return path.resolve(...parts);
+  }
+
+  const { packageName, subpath } = getDistributionForThisPlatform();
+
+  if (packageName === undefined) {
+    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`
+    );
+  }
+
+  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" or "--omit=optional" flags. Sentry CLI needs the "optionalDependencies" feature in order to install its binary.`);
+    }
+  }
+
+  return compatibleBinaryPath;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/cli",
-  "version": "2.21.4",
+  "version": "2.22.1",
   "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/",
@@ -29,6 +29,15 @@
     "npm-run-all": "^4.1.5",
     "prettier": "^2.6.2"
   },
+  "optionalDependencies": {
+    "@sentry/cli-darwin": "2.22.1",
+    "@sentry/cli-linux-arm": "2.22.1",
+    "@sentry/cli-linux-arm64": "2.22.1",
+    "@sentry/cli-linux-i686": "2.22.1",
+    "@sentry/cli-linux-x64": "2.22.1",
+    "@sentry/cli-win32-i686": "2.22.1",
+    "@sentry/cli-win32-x64": "2.22.1"
+  },
   "scripts": {
     "install": "node ./scripts/install.js",
     "fix": "npm-run-all fix:eslint fix:prettier",

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