@sentry/cli 2.23.1 → 2.24.0

package/checksums.txt

@@ -1,9 +1,9 @@
-sentry-cli-Darwin-arm64=80db99473013abbc312a6160c4c8eeac110d573560e632c5da9444fe44ae683d
-sentry-cli-Darwin-universal=21af0cd6375e7b0686b5d4808ea6035b0eaf8b5c64b8e024f7da87ec2aa986a3
-sentry-cli-Darwin-x86_64=6b3b2efd7f2e2fce2eef3a493676895fed90b5677dff780da813a2748f423ce9
-sentry-cli-Linux-aarch64=c780829bef1e4f3fde18f51adc747f4497077677289bae07bf1c0427ba9c1196
-sentry-cli-Linux-armv7=0e95c542dac19cd4077e20f506be0bec9a56dccd0dd08849ad63bf6cb77644e2
-sentry-cli-Linux-i686=6879f208ab9bde5417a5c1fa9ba113ed9ebaae4f3ee800c4155ff8dba9e2a82e
-sentry-cli-Linux-x86_64=e01de8640c4f7c19c8e9670d0269528beccbf196b2be32f9380b3f69eea51ac8
-sentry-cli-Windows-i686.exe=cdc09bff3d2958315f056fc87ebc365bca2663e966d116a777b7d599219bec47
-sentry-cli-Windows-x86_64.exe=8d877c6b31a87ce268ffebc2b071389f22ab642edfc5a42f2e4122e127325fe6
+sentry-cli-Darwin-arm64=0a39aec3289bb377494075059cbd64716d1a87dc72ed4f5daefb99f66397791c
+sentry-cli-Darwin-universal=055cb6cedb1d00a0eaf016e102f47dc2d62359f959dacb47ca13d7f31a8cf331
+sentry-cli-Darwin-x86_64=655b3242bfba4cdc1d99a7badee83509f54287e7eb4caffb4368b0e8db2c5ae1
+sentry-cli-Linux-aarch64=71ef47f50b1a89af96c3b24227bd52c65469a95cfeeacf8c3d8b987b9c3217e2
+sentry-cli-Linux-armv7=560d3dacc3f675b347efe33904bafecd0bcd021ff2f8f9de6527ab285d2c1431
+sentry-cli-Linux-i686=93e2f0c498d7dd17433a613fa98a2216000f1dd5491302399aff401874c84e05
+sentry-cli-Linux-x86_64=c1ee72ab611ddf5c1a78e4d9e1398cbcd7734118fb27b2c3790981298a80e203
+sentry-cli-Windows-i686.exe=47e9a7d29471f2b1ba72dc8221ad1eb48a75683b91f814d92249f43327ec1988
+sentry-cli-Windows-x86_64.exe=0524fb4409e03428ed89980c46ecc05f598660eb19a08e5b74f600f2ed3a3ab9

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.1",
+  "version": "2.24.0",
   "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.1",
-    "@sentry/cli-linux-arm": "2.23.1",
-    "@sentry/cli-linux-arm64": "2.23.1",
-    "@sentry/cli-linux-i686": "2.23.1",
-    "@sentry/cli-linux-x64": "2.23.1",
-    "@sentry/cli-win32-i686": "2.23.1",
-    "@sentry/cli-win32-x64": "2.23.1"
+    "@sentry/cli-darwin": "2.24.0",
+    "@sentry/cli-linux-arm": "2.24.0",
+    "@sentry/cli-linux-arm64": "2.24.0",
+    "@sentry/cli-linux-i686": "2.24.0",
+    "@sentry/cli-linux-x64": "2.24.0",
+    "@sentry/cli-win32-i686": "2.24.0",
+    "@sentry/cli-win32-x64": "2.24.0"
   },
   "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');
@@ -198,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 {
@@ -323,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);
+    });
+}