@sentry/cli 2.58.2 → 2.58.3

package/js/helper.js

@@ -1,21 +1,27 @@
 'use strict';
-
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 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' },
-  { packageName: '@sentry/cli-win32-arm64', subpath: 'bin/sentry-cli.exe' },
+    { 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' },
+    { packageName: '@sentry/cli-win32-arm64', 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.
@@ -26,86 +32,80 @@ const BINARY_DISTRIBUTIONS = [
  * @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);
+    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();
-
-  let packageName = undefined;
-  if (platform === 'darwin') {
-    packageName = '@sentry/cli-darwin';
-  } else if (platform === 'linux' || platform === 'freebsd' || platform === 'android') {
-    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;
+    const arch = os.arch();
+    const platform = os.platform();
+    let packageName = undefined;
+    if (platform === 'darwin') {
+        packageName = '@sentry/cli-darwin';
     }
-  } else if (platform === 'win32') {
-    switch (arch) {
-      case 'x64':
-        packageName = '@sentry/cli-win32-x64';
-        break;
-      case 'x86':
-      case 'ia32':
-        packageName = '@sentry/cli-win32-i686';
-        break;
-      case 'arm64':
-        packageName = '@sentry/cli-win32-arm64';
-        break;
+    else if (platform === 'linux' || platform === 'freebsd' || platform === 'android') {
+        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;
+        }
     }
-  }
-
-  let subpath = undefined;
-  switch (platform) {
-    case 'win32':
-      subpath = 'bin/sentry-cli.exe';
-      break;
-    case 'darwin':
-    case 'linux':
-    case 'freebsd':
-    case 'android':
-      subpath = 'bin/sentry-cli';
-      break;
-    default:
-      subpath = 'bin/sentry-cli';
-      break;
-  }
-
-  return { packageName, subpath };
+    else if (platform === 'win32') {
+        switch (arch) {
+            case 'x64':
+                packageName = '@sentry/cli-win32-x64';
+                break;
+            case 'x86':
+            case 'ia32':
+                packageName = '@sentry/cli-win32-i686';
+                break;
+            case 'arm64':
+                packageName = '@sentry/cli-win32-arm64';
+                break;
+        }
+    }
+    let subpath = undefined;
+    switch (platform) {
+        case 'win32':
+            subpath = 'bin/sentry-cli.exe';
+            break;
+        case 'darwin':
+        case 'linux':
+        case 'freebsd':
+        case 'android':
+            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.
+    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`
-  );
+- 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.
@@ -113,58 +113,53 @@ Sentry CLI supports:
  * @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!
+    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!
+        }
+        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;
+    return compatibleBinaryPath;
 }
-
 /**
  * Will be used as the binary path when defined with `mockBinaryPath`.
  * @type {string | undefined}
  */
 let mockedBinaryPath;
-
 /**
  * Overrides the default binary path with a mock value, useful for testing.
  *
@@ -173,14 +168,12 @@ let mockedBinaryPath;
  */
 // TODO(v3): Remove this function
 function mockBinaryPath(mockPath) {
-  mockedBinaryPath = mockPath;
+    mockedBinaryPath = mockPath;
 }
-
 /**
  * The javascript type of a command line option.
  * @typedef {'array'|'string'|'boolean'|'inverted-boolean'} OptionType
  */
-
 /**
  * Schema definition of a command line option.
  * @typedef {object} OptionSchema
@@ -188,12 +181,10 @@ function mockBinaryPath(mockPath) {
  * @prop {OptionType} type The value type of the command line option.
  * @prop {string} [invertedParam] The flag of the command line option including dashes (optional).
  */
-
 /**
  * Schema definition for a command.
  * @typedef {Object.<string, OptionSchema>} OptionsSchema
  */
-
 /**
  * Serializes command line options into an arguments array.
  *
@@ -202,47 +193,35 @@ function mockBinaryPath(mockPath) {
  * @returns {string[]} An arguments array that can be passed via command line.
  */
 function serializeOptions(schema, options) {
-  return Object.keys(schema).reduce((newOptions, option) => {
-    const paramValue = options[option];
-    if (paramValue === undefined || paramValue === null) {
-      return newOptions;
-    }
-
-    const paramType = schema[option].type;
-    const paramName = schema[option].param;
-
-    if (paramType === 'array') {
-      if (!Array.isArray(paramValue)) {
-        throw new Error(`${option} should be an array`);
-      }
-
-      return newOptions.concat(
-        paramValue.reduce((acc, value) => acc.concat([paramName, String(value)]), [])
-      );
-    }
-
-    if (paramType === 'boolean') {
-      if (typeof paramValue !== 'boolean') {
-        throw new Error(`${option} should be a bool`);
-      }
-
-      const invertedParamName = schema[option].invertedParam;
-
-      if (paramValue && paramName !== undefined) {
-        return newOptions.concat([paramName]);
-      }
-
-      if (!paramValue && invertedParamName !== undefined) {
-        return newOptions.concat([invertedParamName]);
-      }
-
-      return newOptions;
-    }
-
-    return newOptions.concat(paramName, paramValue);
-  }, []);
+    return Object.keys(schema).reduce((newOptions, option) => {
+        const paramValue = options[option];
+        if (paramValue === undefined || paramValue === null) {
+            return newOptions;
+        }
+        const paramType = schema[option].type;
+        const paramName = schema[option].param;
+        if (paramType === 'array') {
+            if (!Array.isArray(paramValue)) {
+                throw new Error(`${option} should be an array`);
+            }
+            return newOptions.concat(paramValue.reduce((acc, value) => acc.concat([paramName, String(value)]), []));
+        }
+        if (paramType === 'boolean') {
+            if (typeof paramValue !== 'boolean') {
+                throw new Error(`${option} should be a bool`);
+            }
+            const invertedParamName = schema[option].invertedParam;
+            if (paramValue && paramName !== undefined) {
+                return newOptions.concat([paramName]);
+            }
+            if (!paramValue && invertedParamName !== undefined) {
+                return newOptions.concat([invertedParamName]);
+            }
+            return newOptions;
+        }
+        return newOptions.concat(paramName, paramValue);
+    }, []);
 }
-
 /**
  * Serializes the command and its options into an arguments array.
  *
@@ -252,17 +231,15 @@ function serializeOptions(schema, options) {
  * @returns {string[]} An arguments array that can be passed via command line.
  */
 function prepareCommand(command, schema, options) {
-  return command.concat(serializeOptions(schema || {}, options || {}));
+    return command.concat(serializeOptions(schema || {}, options || {}));
 }
-
 /**
  * Returns the absolute path to the `sentry-cli` binary.
  * @returns {string}
  */
 function getPath() {
-  return mockedBinaryPath !== undefined ? mockedBinaryPath : getBinaryPath();
+    return mockedBinaryPath !== undefined ? mockedBinaryPath : getBinaryPath();
 }
-
 /**
  * Runs `sentry-cli` with the given command line arguments.
  *
@@ -288,91 +265,93 @@ function getPath() {
  *    exits with a non-zero exit code.
  * @param {boolean} silent Disable stdout for silents build (CI/Webpack Stats, ...)
  * @param {string} [configFile] Relative or absolute path to the configuration file.
- * @param {Object} [config] More configuration to pass to the CLI
- * @returns {Promise.<string>} A promise that resolves to the standard output.
+ * @param {import('./index').SentryCliOptions} [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 = {}) {
-  const env = { ...process.env };
-  if (configFile) {
-    env.SENTRY_PROPERTIES = configFile;
-  }
-  if (config.url) {
-    env.SENTRY_URL = config.url;
-  }
-  if (config.authToken) {
-    env.SENTRY_AUTH_TOKEN = config.authToken;
-  }
-  if (config.apiKey) {
-    env.SENTRY_API_KEY = config.apiKey;
-  }
-  if (config.dsn) {
-    env.SENTRY_DSN = config.dsn;
-  }
-  if (config.org) {
-    env.SENTRY_ORG = config.org;
-  }
-  if (config.project) {
-    env.SENTRY_PROJECT = config.project;
-  }
-  if (config.vcsRemote) {
-    env.SENTRY_VCS_REMOTE = config.vcsRemote;
-  }
-  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 || live === 'rejectOnError') {
-      const output = silent ? 'ignore' : 'inherit';
-      const pid = childProcess.spawn(getPath(), args, {
-        env,
-        // stdin, stdout, stderr
-        stdio: ['ignore', output, output],
-      });
-      pid.on('exit', (exitCode) => {
-        if (live === 'rejectOnError') {
-          if (exitCode === 0) {
-            resolve('success (live mode)');
-          }
-          reject(new Error(`Command ${args.join(' ')} failed with exit code ${exitCode}`));
+function execute(args_1, live_1, silent_1, configFile_1) {
+    return __awaiter(this, arguments, void 0, function* (args, live, silent, configFile, config = {}) {
+        const env = Object.assign({}, process.env);
+        if (configFile) {
+            env.SENTRY_PROPERTIES = configFile;
         }
-        // According to the type definition, resolving with void is not allowed.
-        // However, for backwards compatibility, we resolve void here to
-        // avoid a behaviour-breaking change.
-        // TODO (v3): Clean this up and always resolve a string (or change the type definition)
-        // @ts-expect-error - see comment above
-        resolve();
-      });
-    } else {
-      childProcess.execFile(getPath(), args, { env }, (err, stdout) => {
-        if (err) {
-          reject(err);
-        } else {
-          resolve(stdout);
+        if (config.url) {
+            env.SENTRY_URL = config.url;
         }
-      });
-    }
-  });
+        if (config.authToken) {
+            env.SENTRY_AUTH_TOKEN = config.authToken;
+        }
+        if (config.apiKey) {
+            env.SENTRY_API_KEY = config.apiKey;
+        }
+        if (config.dsn) {
+            env.SENTRY_DSN = config.dsn;
+        }
+        if (config.org) {
+            env.SENTRY_ORG = config.org;
+        }
+        if (config.project) {
+            env.SENTRY_PROJECT = config.project;
+        }
+        if (config.vcsRemote) {
+            env.SENTRY_VCS_REMOTE = config.vcsRemote;
+        }
+        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 || live === 'rejectOnError') {
+                const output = silent ? 'ignore' : 'inherit';
+                const pid = childProcess.spawn(getPath(), args, {
+                    env,
+                    // stdin, stdout, stderr
+                    stdio: ['ignore', output, output],
+                });
+                pid.on('exit', (exitCode) => {
+                    if (live === 'rejectOnError') {
+                        if (exitCode === 0) {
+                            resolve('success (live mode)');
+                        }
+                        reject(new Error(`Command ${args.join(' ')} failed with exit code ${exitCode}`));
+                    }
+                    // According to the type definition, resolving with void is not allowed.
+                    // However, for backwards compatibility, we resolve void here to
+                    // avoid a behaviour-breaking change.
+                    // TODO (v3): Clean this up and always resolve a string (or change the type definition)
+                    // @ts-expect-error - see comment above
+                    resolve();
+                });
+            }
+            else {
+                childProcess.execFile(getPath(), args, { env }, (err, stdout) => {
+                    if (err) {
+                        reject(err);
+                    }
+                    else {
+                        resolve(stdout);
+                    }
+                });
+            }
+        });
+    });
 }
-
 function getProjectFlagsFromOptions({ projects = [] } = {}) {
-  return projects.reduce((flags, project) => flags.concat('-p', project), []);
+    return projects.reduce((flags, project) => flags.concat('-p', project), []);
 }
-
 module.exports = {
-  execute,
-  getPath,
-  getProjectFlagsFromOptions,
-  mockBinaryPath,
-  prepareCommand,
-  serializeOptions,
-  getDistributionForThisPlatform,
-  throwUnsupportedPlatformError,
-  getFallbackBinaryPath,
+    execute,
+    getPath,
+    getProjectFlagsFromOptions,
+    mockBinaryPath,
+    prepareCommand,
+    serializeOptions,
+    getDistributionForThisPlatform,
+    throwUnsupportedPlatformError,
+    getFallbackBinaryPath,
 };