@sentry/cli 2.23.0 → 2.23.2

package/checksums.txt

@@ -1,9 +1,9 @@
-sentry-cli-Darwin-arm64=3714a30704eeee21456a60e75e044e4e3aa36bedeb084f8993ea089ff7577e99
-sentry-cli-Darwin-universal=042bf36aebe9081264a6d95a098712b4006b66df356ee4440851a3c26acbbbf4
-sentry-cli-Darwin-x86_64=5c4d0d3e9d5838a587bcca98163f779843c0207483493dda36630e8e03919331
-sentry-cli-Linux-aarch64=66d0b504d983ff2f7b5f60ebf5b3c933ba8a93c2a608f759863fd2b446b344fd
-sentry-cli-Linux-armv7=940b8844f60cc04c8aec65c38aedc20c2fde949f97576f7ae34f9febfb561d80
-sentry-cli-Linux-i686=180306e08e5ec10445aa2f0ce1abb07740dceb30685dc53cd8b26a35909db20f
-sentry-cli-Linux-x86_64=23d3fdb2e797a1f49917b13cd040874f6189aff3f24d56d3fb81d74c1f368372
-sentry-cli-Windows-i686.exe=a6cb2266418f418df0ce88f16086bbb60090805b9a5d38abee8f6ae1f7eba25f
-sentry-cli-Windows-x86_64.exe=bc51a87a60fa13a619ecaa93f9d442ae7e638a1718cb4616c6595ce7ab02ab25
+sentry-cli-Darwin-arm64=2661e69e85fde9b8c1dc6e6bf9f9a61abb7a8b6986df3ba19abf00c0f681aeb9
+sentry-cli-Darwin-universal=b8a1f6a855400e483a51e3c9efb2fc5c256879d88ded8cd2e2f97c5a3a0ee086
+sentry-cli-Darwin-x86_64=33c9718a63ee620fb5716674c9dfffa4d82636918202c8e054f5185167a1b188
+sentry-cli-Linux-aarch64=0caaa6ef000667a584ee4308a2c151ee9fb586d7d2ceef1f64837043e3b8bf79
+sentry-cli-Linux-armv7=83d95451a7c2e788a806531bd9d0ccf7e6e6292f9e74cd771021bf03abc584da
+sentry-cli-Linux-i686=d92e9d461db1bf0995abd48251490969ab955dc8a3bc525cf72d717a56fffac6
+sentry-cli-Linux-x86_64=ce0b62603da9fdc3d37aeb1f2af1b04c82efaf32a8d36114c950d7dc32ed11a8
+sentry-cli-Windows-i686.exe=392b59d3acb4d81504bb501a90ec0397a51cd1e090c897c1a10b274355585abd
+sentry-cli-Windows-x86_64.exe=8fdafca0a16eac1ba633549beceb569f5e63c1ec1f3fad4f6b3b539e23620b1e

package/js/helper.js

@@ -1,6 +1,8 @@
 'use strict';
 
 const os = require('os');
+const path = require('path');
+const fs = require('fs');
 const childProcess = require('child_process');
 
 const BINARY_DISTRIBUTIONS = [
@@ -13,6 +15,23 @@ const BINARY_DISTRIBUTIONS = [
   { packageName: '@sentry/cli-win32-i686', subpath: 'bin/sentry-cli.exe' },
 ];
 
+/**
+ * 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 getFallbackBinaryPath() {
+  const parts = [];
+  parts.push(__dirname);
+  parts.push('..');
+  parts.push(`sentry-cli${process.platform === 'win32' ? '.exe' : ''}`);
+  return path.resolve(...parts);
+}
+
 function getDistributionForThisPlatform() {
   const arch = os.arch();
   const platform = os.platform();
@@ -67,11 +86,25 @@ function getDistributionForThisPlatform() {
 }
 
 /**
- * This convoluted function resolves the path to the `sentry-cli` binary in a
- * way that can't be analysed by @vercel/nft.
+ * 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.
  *
- * 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() {
@@ -82,14 +115,13 @@ function getBinaryPath() {
   const { packageName, subpath } = getDistributionForThisPlatform();
 
   if (packageName === undefined) {
-    throw new Error(
-      `Unsupported operating system or architecture! Sentry CLI does not work on this architecture.
+    throwUnsupportedPlatformError();
+  }
 
-Sentry CLI supports:
-- Darwin (macOS)
-- Linux and FreeBSD on x64, x86, ia32, arm64, and arm architectures
-- Windows x64, x86, and ia32 architectures`
-    );
+  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;
@@ -115,7 +147,7 @@ To fix this, avoid copying the "node_modules" folder, and instead freshly instal
     } 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.`);
+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.`);
     }
   }
 
@@ -123,10 +155,10 @@ It seems like none of the "@sentry/cli" package's optional dependencies got inst
 }
 
 /**
- * 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.
@@ -136,7 +168,7 @@ let binaryPath = getBinaryPath();
  */
 // TODO(v3): Remove this function
 function mockBinaryPath(mockPath) {
-  binaryPath = mockPath;
+  mockedBinaryPath = mockPath;
 }
 
 /**
@@ -222,7 +254,7 @@ function prepareCommand(command, schema, options) {
  * @returns {string}
  */
 function getPath() {
-  return binaryPath;
+  return mockedBinaryPath !== undefined ? mockedBinaryPath : getBinaryPath();
 }
 
 /**
@@ -318,4 +350,7 @@ module.exports = {
   mockBinaryPath,
   prepareCommand,
   serializeOptions,
+  getDistributionForThisPlatform,
+  throwUnsupportedPlatformError,
+  getFallbackBinaryPath,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/cli",
-  "version": "2.23.0",
+  "version": "2.23.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/",
@@ -30,15 +30,16 @@
     "prettier": "2.8.8"
   },
   "optionalDependencies": {
-    "@sentry/cli-darwin": "2.23.0",
-    "@sentry/cli-linux-arm": "2.23.0",
-    "@sentry/cli-linux-arm64": "2.23.0",
-    "@sentry/cli-linux-i686": "2.23.0",
-    "@sentry/cli-linux-x64": "2.23.0",
-    "@sentry/cli-win32-i686": "2.23.0",
-    "@sentry/cli-win32-x64": "2.23.0"
+    "@sentry/cli-darwin": "2.23.2",
+    "@sentry/cli-linux-arm": "2.23.2",
+    "@sentry/cli-linux-arm64": "2.23.2",
+    "@sentry/cli-linux-i686": "2.23.2",
+    "@sentry/cli-linux-x64": "2.23.2",
+    "@sentry/cli-win32-i686": "2.23.2",
+    "@sentry/cli-win32-x64": "2.23.2"
   },
   "scripts": {
+    "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",

package/scripts/install.js

@@ -2,12 +2,6 @@
 
 'use strict';
 
-// TODO(v3): Remove this file
-
-console.log(
-  'DEPRECATION NOTICE: The Sentry CLI install script has been deprecated. The package now uses "optionalDependencies" instead to install architecture-compatible binaries distributed over npm.'
-);
-
 const fs = require('fs');
 const os = require('os');
 const path = require('path');
@@ -84,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':
@@ -194,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 {
@@ -319,14 +317,33 @@ if (process.env.SENTRYCLI_SKIP_DOWNLOAD === '1') {
   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);
+    });
+}