@sentry/cli 1.74.2 → 2.0.0

package/bin/sentry-cli

@@ -3,17 +3,17 @@
 'use strict';
 
 const childProcess = require('child_process');
-const cli = require('../js');
+const SentryCli = require('../js');
 
 const child = childProcess
-  .spawn(cli.getPath(), process.argv.slice(2), {
+  .spawn(SentryCli.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,9 @@
-sentry-cli-Darwin-arm64=dd8341ed84333803e8e2bcc8fd9e7f2fa33a1eed63a784dfd68625ba553220a0
-sentry-cli-Darwin-universal=a4023a9ff8c79d73d81ff577299a5fb406676612bbdd95d02ffd76dd69966124
-sentry-cli-Darwin-x86_64=aab1203dba78738a7461b8329cf347417830754ae010218399a710d3e5d9424b
-sentry-cli-Linux-aarch64=f383d1b8197ebb8a129f3b2c80614d319cafd215d452c90868f6d71aa66f8a1c
-sentry-cli-Linux-armv7=ffea267165b98d0b43a1ccd4609e1f63d8d426c7c98b80f651dd822b0c1e2b94
-sentry-cli-Linux-i686=fa4cb3f36dd66d9def597dbb593c20f08a72c576a42d3e7c5ea72f9aa535b56a
-sentry-cli-Linux-x86_64=a136c3b48ee967852dabe909283a1e7f0640a0c332ae4f30c231d05ba82662dc
-sentry-cli-Windows-i686.exe=7c5c82a96727b9a9247562a2c34d7595ae0f8aa6db74e821f30d40c7fb772f11
-sentry-cli-Windows-x86_64.exe=54a02d175302e6d170e51afc5d096090df9d76e5bd11e71be3913fa04e596a45
+sentry-cli-Darwin-arm64=195df7af336ae6761ac160b57bcd9b43d304d2c48c6835d05d2dd203caf50a14
+sentry-cli-Darwin-universal=edeaf887e46fb7c8702463ab0821502bba2f41c3cb497507fb3bfbe4635727c4
+sentry-cli-Darwin-x86_64=5e5a7d7270ba9486744fc6c1846efba9276fa3a2732ded90daf185bb6ec461f3
+sentry-cli-Linux-aarch64=43d08d15409aec8925c84364a9976ef00ceed7bb78343151a6705c5fd735833f
+sentry-cli-Linux-armv7=850b0d0c0f1995c34fd9721cf83783d29ab7f32d486273c09348af42f66ecf87
+sentry-cli-Linux-i686=a83ce83846d8d7456212e3224b34e0da7213611e49d75e8aa58ccd2f3219220e
+sentry-cli-Linux-x86_64=f1231a5d8d2c0d2a96b61ddf85ad10274731cb904665593bc02427c130728084
+sentry-cli-Windows-i686.exe=7fac8c66defd3aea009a53678c625070557b437c8fb5a95670069bb36e656d2f
+sentry-cli-Windows-x86_64.exe=5c7eb3072edc4901d02095155b0d1b30c003c53b25e4aa0dd21b31e510c1bde2

package/js/helper.js

@@ -133,7 +133,7 @@ function getPath() {
  * @param {Object} [config] More configuration to pass to the CLI
  * @returns {Promise.<string>} A promise that resolves to the standard output.
  */
-function execute(args, live, silent, configFile, config = {}) {
+async function execute(args, live, silent, configFile, config = {}) {
   const env = { ...process.env };
   if (configFile) {
     env.SENTRY_PROPERTIES = configFile;

package/js/releases/index.js

@@ -50,7 +50,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the release has been created.
    * @memberof SentryReleases
    */
-  new(release, options) {
+  async new(release, options) {
     const args = ['releases', 'new', release].concat(helper.getProjectFlagsFromOptions(options));
     return this.execute(args, null);
   }
@@ -76,7 +76,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the commits have been associated
    * @memberof SentryReleases
    */
-  setCommits(release, options) {
+  async setCommits(release, options) {
     if (!options || (!options.auto && (!options.repo || !options.commit))) {
       throw new Error('options.auto, or options.repo and options.commit must be specified');
     }
@@ -95,10 +95,6 @@ class Releases {
       commitFlags.push('--ignore-missing');
     }
 
-    if (options.ignoreEmpty) {
-      commitFlags.push('--ignore-empty');
-    }
-
     return this.execute(['releases', 'set-commits', release].concat(commitFlags));
   }
 
@@ -110,7 +106,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the release has been finalized.
    * @memberof SentryReleases
    */
-  finalize(release) {
+  async finalize(release) {
     return this.execute(['releases', 'finalize', release], null);
   }
 
@@ -121,10 +117,9 @@ class Releases {
    * @returns {Promise.<string>} A promise that resolves to the version string.
    * @memberof SentryReleases
    */
-  proposeVersion() {
-    return this.execute(['releases', 'propose-version'], null).then(
-      version => version && version.trim()
-    );
+  async proposeVersion() {
+    const version = await this.execute(['releases', 'propose-version'], null);
+    return version.trim();
   }
 
   /**
@@ -159,7 +154,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the upload has completed successfully.
    * @memberof SentryReleases
    */
-  uploadSourceMaps(release, options) {
+  async uploadSourceMaps(release, options) {
     if (!options || !options.include || !Array.isArray(options.include)) {
       throw new Error(
         '`options.include` must be a vaild array of paths and/or path descriptor objects.'
@@ -169,7 +164,7 @@ class Releases {
     // Each entry in the `include` array will map to an array of promises, which
     // will in turn contain one promise per literal path value. Thus `uploads`
     // will be an array of Promise arrays, which we'll flatten later.
-    const uploads = options.include.map(includeEntry => {
+    const uploads = options.include.map((includeEntry) => {
       let pathOptions;
       let uploadPaths;
 
@@ -200,7 +195,7 @@ class Releases {
         .concat(helper.getProjectFlagsFromOptions(options))
         .concat(['files', release, 'upload-sourcemaps']);
 
-      return uploadPaths.map(path =>
+      return uploadPaths.map((path) =>
         // `execute()` is async and thus we're returning a promise here
         this.execute(helper.prepareCommand([...args, path], SOURCEMAPS_SCHEMA, newOptions), true)
       );
@@ -221,7 +216,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the list comes back from the server.
    * @memberof SentryReleases
    */
-  listDeploys(release) {
+  async listDeploys(release) {
     return this.execute(['releases', 'deploys', release, 'list'], null);
   }
 
@@ -247,7 +242,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the deploy has been created.
    * @memberof SentryReleases
    */
-  newDeploy(release, options) {
+  async newDeploy(release, options) {
     if (!options || !options.env) {
       throw new Error('options.env must be a vaild name');
     }
@@ -261,7 +256,7 @@ class Releases {
    * @param {boolean} live We inherit stdio to display `sentry-cli` output directly.
    * @returns {Promise.<string>} A promise that resolves to the standard output.
    */
-  execute(args, live) {
+  async execute(args, live) {
     return helper.execute(args, live, this.options.silent, this.configFile, this.options);
   }
 }

package/package.json

@@ -1,28 +1,34 @@
 {
   "name": "@sentry/cli",
-  "version": "1.74.2",
+  "version": "2.0.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/",
+  "author": "Sentry",
   "license": "BSD-3-Clause",
-  "keywords": [
-    "sentry",
-    "sentry-cli",
-    "cli"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/getsentry/sentry-cli"
-  },
-  "bugs": {
-    "url": "https://github.com/getsentry/sentry-cli/issues"
-  },
   "engines": {
-    "node": ">= 8"
+    "node": ">= 12"
   },
   "main": "js/index.js",
+  "types": "js/index.d.ts",
   "bin": {
     "sentry-cli": "bin/sentry-cli"
   },
+  "dependencies": {
+    "https-proxy-agent": "^5.0.0",
+    "node-fetch": "^3.2.3",
+    "npmlog": "^6.0.1",
+    "progress": "^2.0.3",
+    "proxy-from-env": "^1.1.0",
+    "which": "^2.0.2"
+  },
+  "devDependencies": {
+    "eslint": "^8.13.0",
+    "eslint-config-prettier": "^8.5.0",
+    "jest": "^27.5.1",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.6.2"
+  },
   "scripts": {
     "install": "node ./scripts/install.js",
     "fix": "npm-run-all fix:eslint fix:prettier",
@@ -34,29 +40,11 @@
     "test:eslint": "eslint bin/* scripts/**/*.js js/**/*.js",
     "test:prettier": "prettier --check  bin/* scripts/**/*.js js/**/*.js"
   },
-  "dependencies": {
-    "https-proxy-agent": "^5.0.0",
-    "mkdirp": "^0.5.5",
-    "node-fetch": "^2.6.7",
-    "npmlog": "^4.1.2",
-    "progress": "^2.0.3",
-    "proxy-from-env": "^1.1.0",
-    "which": "^2.0.2"
-  },
-  "devDependencies": {
-    "eslint": "^6.8.0",
-    "eslint-config-airbnb-base": "^14.1.0",
-    "eslint-config-prettier": "^6.10.1",
-    "eslint-plugin-import": "^2.20.2",
-    "jest": "^25.3.0",
-    "npm-run-all": "^4.1.5",
-    "prettier": "^1.19.1"
-  },
   "jest": {
     "collectCoverage": true,
     "testEnvironment": "node",
     "testPathIgnorePatterns": [
-      "src/utils"
+      "<rootDir>/src"
     ]
   }
 }

package/scripts/install.js

@@ -11,12 +11,10 @@ const zlib = require('zlib');
 const stream = require('stream');
 const process = require('process');
 
+const fetch = (...args) => import('node-fetch').then(({ default: fetch }) => fetch(...args));
 const HttpsProxyAgent = require('https-proxy-agent');
-const fetch = require('node-fetch');
 const ProgressBar = require('progress');
 const Proxy = require('proxy-from-env');
-// NOTE: Can be dropped in favor of `fs.mkdirSync(path, { recursive: true })` once we stop supporting Node 8.x
-const mkdirp = require('mkdirp');
 const npmLog = require('npmlog');
 const which = require('which');
 
@@ -46,10 +44,9 @@ function getLogStream(defaultStream) {
 }
 
 function shouldRenderProgressBar() {
-  const silentFlag = process.argv.some(v => v === '--silent');
+  const silentFlag = process.argv.some((v) => v === '--silent');
   const silentConfig = process.env.npm_config_loglevel === 'silent';
-  // Leave `SENTRY_NO_PROGRESS_BAR` for backwards compatibility
-  const silentEnv = process.env.SENTRYCLI_NO_PROGRESS_BAR || process.env.SENTRY_NO_PROGRESS_BAR;
+  const silentEnv = process.env.SENTRYCLI_NO_PROGRESS_BAR;
   const ciEnv = process.env.CI === 'true';
   // If any of possible options is set, skip rendering of progress bar
   return !(silentFlag || silentConfig || silentEnv || ciEnv);
@@ -111,7 +108,7 @@ function createProgressBar(name, total) {
   let pct = null;
   let current = 0;
   return {
-    tick: length => {
+    tick: (length) => {
       current += length;
       const next = Math.round((current / total) * 100);
       if (next > pct) {
@@ -133,11 +130,7 @@ function npmCache() {
 }
 
 function getCachedPath(url) {
-  const digest = crypto
-    .createHash('md5')
-    .update(url)
-    .digest('hex')
-    .slice(0, 6);
+  const digest = crypto.createHash('md5').update(url).digest('hex').slice(0, 6);
 
   return path.join(
     npmCache(),
@@ -147,9 +140,7 @@ function getCachedPath(url) {
 }
 
 function getTempFile(cached) {
-  return `${cached}.${process.pid}-${Math.random()
-    .toString(16)
-    .slice(2)}.tmp`;
+  return `${cached}.${process.pid}-${Math.random().toString(16).slice(2)}.tmp`;
 }
 
 function validateChecksum(tempPath, name) {
@@ -176,10 +167,7 @@ function validateChecksum(tempPath, name) {
     return;
   }
 
-  const currentHash = crypto
-    .createHash('sha256')
-    .update(fs.readFileSync(tempPath))
-    .digest('hex');
+  const currentHash = crypto.createHash('sha256').update(fs.readFileSync(tempPath)).digest('hex');
 
   if (storedHash !== currentHash) {
     fs.unlinkSync(tempPath);
@@ -191,7 +179,7 @@ function validateChecksum(tempPath, name) {
   }
 }
 
-function downloadBinary() {
+async function downloadBinary() {
   const arch = os.arch();
   const platform = os.platform();
   const outputPath = helper.getPath();
@@ -212,14 +200,14 @@ function downloadBinary() {
 
   const downloadUrl = getDownloadUrl(platform, arch);
   if (!downloadUrl) {
-    return Promise.reject(new Error(`Unsupported target ${platform}-${arch}`));
+    throw new Error(`Unsupported target ${platform}-${arch}`);
   }
 
   const cachedPath = getCachedPath(downloadUrl);
   if (fs.existsSync(cachedPath)) {
     npmLog.info('sentry-cli', `Using cached binary: ${cachedPath}`);
     fs.copyFileSync(cachedPath, outputPath);
-    return Promise.resolve();
+    return;
   }
 
   const proxyUrl = Proxy.getProxyForUrl(downloadUrl);
@@ -231,74 +219,77 @@ function downloadBinary() {
     npmLog.info('sentry-cli', `Using proxy URL: ${proxyUrl}`);
   }
 
-  return fetch(downloadUrl, {
-    agent,
-    compress: false,
-    headers: {
-      'accept-encoding': 'gzip, deflate, br',
-    },
-    redirect: 'follow',
-  })
-    .then(response => {
-      if (!response.ok) {
-        throw new Error(
-          `Unable to download sentry-cli binary from ${downloadUrl}.\nServer returned ${response.status}: ${response.statusText}.`
-        );
-      }
-
-      const contentEncoding = response.headers.get('content-encoding');
-      let decompressor;
-      if (/\bgzip\b/.test(contentEncoding)) {
-        decompressor = zlib.createGunzip();
-      } else if (/\bdeflate\b/.test(contentEncoding)) {
-        decompressor = zlib.createInflate();
-      } else if (/\bbr\b/.test(contentEncoding)) {
-        decompressor = zlib.createBrotliDecompress();
-      } else {
-        decompressor = new stream.PassThrough();
-      }
-      const name = downloadUrl.match(/.*\/(.*?)$/)[1];
-      const total = parseInt(response.headers.get('content-length'), 10);
-      const progressBar = createProgressBar(name, total);
-      const tempPath = getTempFile(cachedPath);
-      mkdirp.sync(path.dirname(tempPath));
-
-      return new Promise((resolve, reject) => {
-        response.body
-          .on('error', e => reject(e))
-          .on('data', chunk => progressBar.tick(chunk.length))
-          .pipe(decompressor)
-          .pipe(fs.createWriteStream(tempPath, { mode: '0755' }))
-          .on('error', e => reject(e))
-          .on('close', () => resolve());
-      }).then(() => {
-        if (process.env.SENTRYCLI_SKIP_CHECKSUM_VALIDATION !== '1') {
-          validateChecksum(tempPath, name);
-        }
-        fs.copyFileSync(tempPath, cachedPath);
-        fs.copyFileSync(tempPath, outputPath);
-        fs.unlinkSync(tempPath);
-      });
-    })
-    .catch(error => {
-      if (error instanceof fetch.FetchError) {
-        throw new Error(
-          `Unable to download sentry-cli binary from ${downloadUrl}.\nError code: ${error.code}`
-        );
-      } else {
-        throw error;
-      }
+  let response;
+  try {
+    response = await fetch(downloadUrl, {
+      agent,
+      compress: false,
+      headers: {
+        'accept-encoding': 'gzip, deflate, br',
+      },
+      redirect: 'follow',
     });
-}
-
-function checkVersion() {
-  return helper.execute(['--version']).then(output => {
-    const version = output.replace('sentry-cli ', '').trim();
-    const expected = process.env.SENTRYCLI_LOCAL_CDNURL ? 'DEV' : pkgInfo.version;
-    if (version !== expected) {
-      throw new Error(`Unexpected sentry-cli version "${version}", expected "${expected}"`);
+  } catch (error) {
+    if (error instanceof fetch.FetchError) {
+      throw new Error(
+        `Unable to download sentry-cli binary from ${downloadUrl}.\nError code: ${error.code}`
+      );
+    } else {
+      throw error;
     }
+  }
+
+  if (!response.ok) {
+    throw new Error(
+      `Unable to download sentry-cli binary from ${downloadUrl}.\nServer returned ${
+        response.status
+      }${response.statusText ? `: ${response.statusText}` : ''}.`
+    );
+  }
+
+  const contentEncoding = response.headers.get('content-encoding');
+  let decompressor;
+  if (/\bgzip\b/.test(contentEncoding)) {
+    decompressor = zlib.createGunzip();
+  } else if (/\bdeflate\b/.test(contentEncoding)) {
+    decompressor = zlib.createInflate();
+  } else if (/\bbr\b/.test(contentEncoding)) {
+    decompressor = zlib.createBrotliDecompress();
+  } else {
+    decompressor = new stream.PassThrough();
+  }
+  const name = downloadUrl.match(/.*\/(.*?)$/)[1];
+  const total = parseInt(response.headers.get('content-length'), 10);
+  const progressBar = createProgressBar(name, total);
+  const tempPath = getTempFile(cachedPath);
+  fs.mkdirSync(path.dirname(tempPath), { recursive: true });
+
+  await new Promise((resolve, reject) => {
+    response.body
+      .on('error', (e) => reject(e))
+      .on('data', (chunk) => progressBar.tick(chunk.length))
+      .pipe(decompressor)
+      .pipe(fs.createWriteStream(tempPath, { mode: '0755' }))
+      .on('error', (e) => reject(e))
+      .on('close', () => resolve());
   });
+
+  if (process.env.SENTRYCLI_SKIP_CHECKSUM_VALIDATION !== '1') {
+    validateChecksum(tempPath, name);
+  }
+
+  fs.copyFileSync(tempPath, cachedPath);
+  fs.copyFileSync(tempPath, outputPath);
+  fs.unlinkSync(tempPath);
+}
+
+async function checkVersion() {
+  const output = await helper.execute(['--version']);
+  const version = output.replace('sentry-cli ', '').trim();
+  const expected = process.env.SENTRYCLI_LOCAL_CDNURL ? 'DEV' : pkgInfo.version;
+  if (version !== expected) {
+    throw new Error(`Unexpected sentry-cli version "${version}", expected "${expected}"`);
+  }
 }
 
 if (process.env.SENTRYCLI_LOCAL_CDNURL) {
@@ -323,11 +314,14 @@ if (process.env.SENTRYCLI_SKIP_DOWNLOAD === '1') {
   process.exit(0);
 }
 
-downloadBinary()
-  .then(() => checkVersion())
-  .then(() => process.exit(0))
-  .catch(e => {
+(async () => {
+  try {
+    await downloadBinary();
+    await checkVersion();
+    process.exit(0);
+  } catch (e) {
     // eslint-disable-next-line no-console
     console.error(e.toString());
     process.exit(1);
-  });
+  }
+})();