@sentry/cli 1.77.2 → 1.77.3

package/README.md

@@ -1,11 +1,6 @@
 <p align="center">
-  <a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
-    <picture>
-      <source srcset="https://sentry-brand.storage.googleapis.com/sentry-logo-white.png" media="(prefers-color-scheme: dark)" />
-      <source srcset="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" />
-      <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" alt="Sentry" width="280">
-    </picture>
-  </a>
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+    <br />
 </p>
 
 # Official Sentry Command Line Interface
@@ -17,7 +12,7 @@
 
 This is a Sentry command line client for some generic tasks. Right now this is
 primarily used to upload debug symbols to Sentry if you are not using the
-Fastlane tools.
+fastlane tools.
 
 * Downloads can be found under
   [Releases](https://github.com/getsentry/sentry-cli/releases/)
@@ -25,34 +20,13 @@ Fastlane tools.
 
 ## Installation
 
-If you are on OS X or Linux, you can use the automated downloader which will fetch the latest release version for you and install it:
+The recommended way to install is with everybody's favorite curl to bash:
 
     curl -sL https://sentry.io/get-cli/ | bash
 
-We do, however, encourage you to pin the specific version of the CLI, so your builds are always reproducible.
-To do that, you can use the exact same method, with an additional version specifier:
-
-    curl -sL https://sentry.io/get-cli/ | SENTRY_CLI_VERSION=2.0.4 bash
-
-This will automatically download the correct version of `sentry-cli` for your operating system and install it. If necessary, it will prompt for your admin password for `sudo`. For a different installation location or for systems without `sudo` (like Windows), you can `export INSTALL_DIR=/custom/installation/path` before running this command.
-
-If you are using `sentry-cli` on Windows environments, [Microsoft Visual C++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist) is required.
-
-To verify it’s installed correctly you can bring up the help:
-
-    sentry-cli --help
-
-### pip
-
-_New in 2.14.3_: `sentry-cli` can also be installed using `pip`:
-
-```bash
-pip install sentry-cli
-```
-
 ### Node
 
-Additionally, you can also install this binary via npm:
+Additionally you can also install this binary via npm:
 
     npm install @sentry/cli
 
@@ -77,22 +51,14 @@ Or add property into your `.npmrc` file (https://www.npmjs.org/doc/files/npmrc.h
 sentrycli_cdnurl=https://mymirror.local/path
 ```
 
-There are a few environment variables that you can provide to control the npm installation:
+Another option is to use the environment variable `SENTRYCLI_CDNURL`.
 
-```
-SENTRYCLI_CDNURL=<url> # Use alternative cdn url for downloading binary
-SENTRYCLI_USE_LOCAL=1 # Use local instance of sentry-cli binary (looked up via $PATH environment)
-SENTRYCLI_SKIP_DOWNLOAD=1 # Skip downloading binary entirely
-SENTRYCLI_NO_PROGRESS_BAR=1 # Do not print the progress bar when downloading binary (default for non-TTY environments like CI)
-SENTRYCLI_LOG_STREAM=<stdout|stderr> # Changes where to redirect install script output
+```sh
+SENTRYCLI_CDNURL=https://mymirror.local/path npm install @sentry/cli
 ```
 
-When using `sentry-cli` via JavaScript API or any 3rd party plugin that is consuming said API,
-you can also use `SENTRY_BINARY_PATH=<path>` alongside `SENTRYCLI_SKIP_DOWNLOAD=1` to completely
-control what binaries are downloaded and used throughout the whole process.
-
 If you're installing the CLI with NPM from behind a proxy, the install script will
-use either NPM's configured HTTPS proxy server or the value from your `HTTPS_PROXY`
+use either NPM's configured HTTPS proxy server, or the value from your `HTTPS_PROXY`
 environment variable.
 
 ### Homebrew
@@ -113,23 +79,6 @@ docker pull getsentry/sentry-cli
 docker run --rm -v $(pwd):/work getsentry/sentry-cli --help
 ```
 
-Starting version _`2.8.0`_, in case you see `"error: config value 'safe.directory' was not found;"` message,
-you also need to correctly set UID and GID of mounted volumes like so:
-
-```sh
-docker run --rm -u "$(id -u):$(id -g)" -v $(pwd):/work getsentry/sentry-cli --help
-```
-
-This is required due to security issue in older `git` implementations. See [here](https://github.blog/2022-04-12-git-security-vulnerability-announced/) for more details.
-
-## Update
-
-To update sentry-cli to the latest version run:
-
-```sh
-sentry-cli update
-```
-
 ## Compiling
 
 In case you want to compile this yourself, you need to install at minimum the

package/bin/sentry-cli

@@ -3,17 +3,17 @@
 'use strict';
 
 const childProcess = require('child_process');
-const SentryCli = require('../js');
+const cli = require('../js');
 
 const child = childProcess
-  .spawn(SentryCli.getPath(), process.argv.slice(2), {
+  .spawn(cli.getPath(), process.argv.slice(2), {
     stdio: 'inherit',
   })
-  .on('error', (err) => {
+  .on('error', err => {
     console.error(err); // eslint-disable-line no-console
     process.exit(1);
   })
-  .on('exit', (code) => process.exit(code));
+  .on('exit', code => process.exit(code));
 
 process.on('SIGTERM', () => child.kill('SIGTERM'));
 process.on('SIGINT', () => child.kill('SIGINT'));

package/checksums.txt

@@ -1,9 +1,16 @@
-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
+sentry-cli-Darwin-arm64=940be414d1c4a49d36ada2893f66feabe358d4d386d42069abd13adec40b89da
+sentry-cli-Darwin-universal=6d88b76f393e2e7d28fdd47e38b967b120cffd63c23f9bcf957bd9649249d819
+sentry-cli-Darwin-x86_64=ed0a4656c3748c71b409f6c232ae63c119c8d303cade1ae004e9ca1a4750da7a
+sentry-cli-Linux-aarch64=f36e03cfcf93eebc73c93ebf9772afc34bca30ca70e808d964d0e44b7a63c425
+sentry-cli-Linux-armv7=ab1d464c92713b06f9156014ac0c075d179aa227416e99a2602ecadce7350ab7
+sentry-cli-Linux-i686=ba52347c977fb6d2124fd188da5d3b6c54de59dc98036c27a24f1e7666fe6606
+sentry-cli-Linux-x86_64=3188668e55aad1fec58d13ca695d2c31131ba90f30ea39885778cfba64429288
+sentry-cli-Windows-i686.exe=42142f6477b09c5ea4a65bc93648ae4897196bf478f3aeb561a97ddabc525567
+sentry-cli-Windows-x86_64.exe=c6365ff2bd6b067cdd3d24d36ba62c8aefaf1dce7f23b2cdc3c70b8f7e9058d2
+sentry-cli-darwin-0.placeholder.tgz=a4bd6f16aa88eba11edf12887810f6e59b264c13f68fc4588a586c1518a7de5d
+sentry-cli-linux-arm-0.placeholder.tgz=a4bd6f16aa88eba11edf12887810f6e59b264c13f68fc4588a586c1518a7de5d
+sentry-cli-linux-arm64-0.placeholder.tgz=a4bd6f16aa88eba11edf12887810f6e59b264c13f68fc4588a586c1518a7de5d
+sentry-cli-linux-i686-0.placeholder.tgz=a4bd6f16aa88eba11edf12887810f6e59b264c13f68fc4588a586c1518a7de5d
+sentry-cli-linux-x64-0.placeholder.tgz=a4bd6f16aa88eba11edf12887810f6e59b264c13f68fc4588a586c1518a7de5d
+sentry-cli-win32-i686-0.placeholder.tgz=a4bd6f16aa88eba11edf12887810f6e59b264c13f68fc4588a586c1518a7de5d
+sentry-cli-win32-x64-0.placeholder.tgz=a4bd6f16aa88eba11edf12887810f6e59b264c13f68fc4588a586c1518a7de5d

package/js/helper.js

@@ -1,30 +1,17 @@
 '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 manually downloaded fallback
- * `sentry-cli` binary in a way that can't be analysed by @vercel/nft.
+ * This convoluted function resolves the path to the `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() {
+function getBinaryPath() {
   const parts = [];
   parts.push(__dirname);
   parts.push('..');
@@ -32,143 +19,19 @@ function getFallbackBinaryPath() {
   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;
-}
-
 /**
- * Will be used as the binary path when defined with `mockBinaryPath`.
- * @type {string | undefined}
+ * Absolute path to the sentry-cli binary (platform dependent).
+ * @type {string}
  */
-let mockedBinaryPath;
+let binaryPath = getBinaryPath();
 
 /**
  * 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) {
-  mockedBinaryPath = mockPath;
+  binaryPath = mockPath;
 }
 
 /**
@@ -198,7 +61,7 @@ function mockBinaryPath(mockPath) {
 function serializeOptions(schema, options) {
   return Object.keys(schema).reduce((newOptions, option) => {
     const paramValue = options[option];
-    if (paramValue === undefined || paramValue === null) {
+    if (paramValue === undefined) {
       return newOptions;
     }
 
@@ -254,7 +117,7 @@ function prepareCommand(command, schema, options) {
  * @returns {string}
  */
 function getPath() {
-  return mockedBinaryPath !== undefined ? mockedBinaryPath : getBinaryPath();
+  return binaryPath;
 }
 
 /**
@@ -281,7 +144,7 @@ function getPath() {
  * @param {Object} [config] More configuration to pass to the CLI
  * @returns {Promise.<string>} A promise that resolves to the standard output.
  */
-async function execute(args, live, silent, configFile, config = {}) {
+function execute(args, live, silent, configFile, config = {}) {
   const env = { ...process.env };
   if (configFile) {
     env.SENTRY_PROPERTIES = configFile;
@@ -309,12 +172,6 @@ async function execute(args, live, silent, configFile, config = {}) {
   }
   if (config.customHeader) {
     env.CUSTOM_HEADER = config.customHeader;
-  } else if (config.headers) {
-    const headers = Object.entries(config.headers).flatMap(([key, value]) => [
-      '--header',
-      `${key}:${value}`,
-    ]);
-    args = [...headers, ...args];
   }
   return new Promise((resolve, reject) => {
     if (live === true) {
@@ -350,7 +207,4 @@ module.exports = {
   mockBinaryPath,
   prepareCommand,
   serializeOptions,
-  getDistributionForThisPlatform,
-  throwUnsupportedPlatformError,
-  getFallbackBinaryPath,
 };

package/js/index.d.ts

@@ -38,6 +38,11 @@ declare module '@sentry/cli' {
      * This value will update `SENTRY_VCS_REMOTE` env variable.
      */
     vcsRemote?: string;
+    /**
+     * Unique identifier for the distribution, used to further segment your release.
+     * Usually your build number.
+     */
+    dist?: string;
     /**
      * If true, all logs are suppressed.
      */
@@ -47,11 +52,6 @@ declare module '@sentry/cli' {
      * This value will update `CUSTOM_HEADER` env variable.
      */
     customHeader?: string;
-    /**
-     * Headers added to every outgoing network request.
-     * This value does not set any env variable, and is overridden by `customHeader`.
-     */
-    headers?: Record<string, string>;
   }
 
   /**
@@ -59,9 +59,7 @@ declare module '@sentry/cli' {
    * case `paths` takes the place of `include` in the options so as to make it
    * clear that this is not recursive.
    */
-  export type SourceMapsPathDescriptor = Omit<SentryCliUploadSourceMapsOptions, 'include'> & {
-    paths: string[];
-  };
+  export type SourceMapsPathDescriptor = Omit<SentryCliUploadSourceMapsOptions, 'include'> & { paths: string[] }
 
   export interface SentryCliUploadSourceMapsOptions {
     /**
@@ -87,15 +85,6 @@ declare module '@sentry/cli' {
      * This prevents the automatic detection of sourcemap references.
      */
     sourceMapReference?: boolean;
-    /**
-     * Enables files gzip decompression prior to uploading. Defaults to `false`.
-     */
-    decompress?: boolean;
-    /**
-     * Enable artifacts deduplication prior to uploading. This will skip uploading
-     * any artifacts that are already present on the server. Defaults to `true`.
-     */
-    dedupe?: boolean;
     /**
      * When paired with the rewrite option this will remove a prefix from uploaded files.
      * For instance you can use this to remove a path that is build machine specific.
@@ -127,15 +116,6 @@ declare module '@sentry/cli' {
      * By default the following file extensions are processed: js, map, jsbundle and bundle.
      */
     ext?: string[];
-    /**
-     * Unique identifier for the distribution, used to further segment your release.
-     * Usually your build number.
-     */
-    dist?: string;
-    /**
-     * Use new Artifact Bundles upload, that enables use of Debug ID for Source Maps discovery.
-     */
-    useArtifactBundle?: boolean;
   }
 
   export interface SentryCliNewDeployOptions {
@@ -196,19 +176,31 @@ declare module '@sentry/cli' {
   }
 
   export interface SentryCliReleases {
-    ['new'](release: string, options?: { projects: string[] } | string[]): Promise<string>;
+    ['new'](
+      release: string,
+      options?: { projects: string[] } | string[]
+    ): Promise<string>;
 
-    setCommits(release: string, options: SentryCliCommitsOptions): Promise<string>;
+    setCommits(
+      release: string,
+      options: SentryCliCommitsOptions
+    ): Promise<string>;
 
-    finalize(release: string): Promise<string>;
+    finalize(release: string): Promise<string>
 
-    proposeVersion(): Promise<string>;
+    proposeVersion(): Promise<string>
 
-    uploadSourceMaps(release: string, options: SentryCliUploadSourceMapsOptions): Promise<string>;
+    uploadSourceMaps(
+      release: string,
+      options: SentryCliUploadSourceMapsOptions
+    ): Promise<string>
 
     listDeploys(release: string): Promise<string>;
 
-    newDeploy(release: string, options: SentryCliNewDeployOptions): Promise<string>;
+    newDeploy(
+      release: string,
+      options: SentryCliNewDeployOptions
+    ): Promise<string>
 
     execute(args: string[], live: boolean): Promise<string>;
   }
@@ -222,14 +214,21 @@ declare module '@sentry/cli' {
      * This value will update `SENTRY_PROPERTIES` env variable.
      * @param options {@link SentryCliOptions}
      */
-    constructor(configFile?: string | null, options?: SentryCliOptions);
+    constructor(configFile?: string | null, options?: SentryCliOptions)
 
     public configFile?: string;
     public options?: SentryCliOptions;
-    public releases: SentryCliReleases;
+    public releases: SentryCliReleases
+
+    public static getVersion(): string
+    public static getPath(): string
+
+    /**
+     * Downloads the CLI binary.
+     * @returns {Promise<void>}
+     */
+    static downloadBinary(logger: { log(...args: unknown[]): void }): Promise<void>;
 
-    public static getVersion(): string;
-    public static getPath(): string;
-    public execute(args: string[], live: boolean): Promise<string>;
+    public execute(args: string[], live: boolean): Promise<string>
   }
 }

package/js/index.js

@@ -3,6 +3,7 @@
 const pkgInfo = require('../package.json');
 const helper = require('./helper');
 const Releases = require('./releases');
+const install = require('./install');
 
 /**
  * Interface to and wrapper around the `sentry-cli` executable.
@@ -54,6 +55,15 @@ class SentryCli {
     return helper.getPath();
   }
 
+  /**
+   * Downloads the CLI binary.
+   * @param {any} [configFile] Optional logger to log installation information. Defaults to printing to the terminal.
+   * @returns {Promise<void>}
+   */
+  static downloadBinary(logger) {
+    return install.downloadBinary(logger);
+  }
+
   /**
    * See {helper.execute} docs.
    * @param {string[]} args Command line arguments passed to `sentry-cli`.