@sentry/cli 2.47.1 → 2.49.0

package/checksums.txt

@@ -1,10 +1,10 @@
-sentry-cli-Darwin-arm64=8fe16710e3b6a377541f9697d430810b46fda5caef15c07086184427051d78c5
-sentry-cli-Darwin-universal=08d43e66fabade2d3b385c74f78e3be50f96846c5f8702400d7b81b3c672e4b2
-sentry-cli-Darwin-x86_64=02319109c31868c04e31ae3d701715dc76d57cb90569bc08ecc4ab830facbff5
-sentry-cli-Linux-aarch64=6ce920ff84c68d2c7b7cfd093adc35cf731adcdc5ccb2dc962505b44f31a3429
-sentry-cli-Linux-armv7=bc97edf7f5b776ca4f034a6d35b18934eb5fef3b4a030933bbdb3d6d38e10c4c
-sentry-cli-Linux-i686=a627aa2d4a985ff8d6ec4f01b27bdd411893b673c86d6446c23fbba18db80b7f
-sentry-cli-Linux-x86_64=6613872f1b21240fb5732be62620ef2bb40a436ce93955ca96393e6046947951
-sentry-cli-Windows-aarch64.exe=0bfcf84f8ce9aaa0ebfa4d87f1cec47b09193e307bdeb5f5555d81fc6e34bb0c
-sentry-cli-Windows-i686.exe=410f622253c1faa5e6991ad76790db4068db4e2ffd5e20cad1aa15343776c00e
-sentry-cli-Windows-x86_64.exe=23f5a4d98931729af8cc46eab49ad5defc5d2567c6ce9306673200e87b0d2ddc
+sentry-cli-Darwin-arm64=a259aae5190a4b74a9f10be0e4945977da15d5af4628f9c79a5a8e63f3089aa3
+sentry-cli-Darwin-universal=1206cd2890cc085b062497f406c361fc04b8c109a93f34cb0abfbb1884d702e3
+sentry-cli-Darwin-x86_64=2a1993992bc4aaee528192fca3a91f6b638940844df57cd326580cbec7f01f63
+sentry-cli-Linux-aarch64=7af5d3cd3e5bfc60af6446c0e51a48e26aae44565d37da9b558db7536a2dc1ca
+sentry-cli-Linux-armv7=37a5cee041d6033f5692d7c0b0c4faa64b4e518775fbc0519d5a730a97f13a59
+sentry-cli-Linux-i686=4279f33dc30f0c85dda9284eb77f5226d9a9095e17f5dc9e210b1d0af371a1bd
+sentry-cli-Linux-x86_64=be4a9b22e8ac782728b2bf62a3bc61b2dcf20dae9c68acfc94ebaa8019ed5d78
+sentry-cli-Windows-aarch64.exe=8ba2cb06c2c303b2a4823653a90c2455f01bda432254ee3c820137af5b549beb
+sentry-cli-Windows-i686.exe=29d2203ea976821a8b975e8be68534600674aeb035262a1d209e33707eead10a
+sentry-cli-Windows-x86_64.exe=6bf6eb9e8dcf8ad882515716deed554d9ec1a375ace6113a2d1c4dc7bee23d87

package/js/helper.js

@@ -186,6 +186,7 @@ function mockBinaryPath(mockPath) {
  * @typedef {object} OptionSchema
  * @prop {string} param The flag of the command line option including dashes.
  * @prop {OptionType} type The value type of the command line option.
+ * @prop {string} [invertedParam] The flag of the command line option including dashes (optional).
  */
 
 /**
@@ -245,7 +246,7 @@ function serializeOptions(schema, options) {
 /**
  * Serializes the command and its options into an arguments array.
  *
- * @param {string} command The literal name of the command.
+ * @param {string[]} command The literal name of the command.
  * @param {OptionsSchema} [schema] An options schema required by the command.
  * @param {object} [options] An options object according to the schema.
  * @returns {string[]} An arguments array that can be passed via command line.
@@ -280,7 +281,11 @@ function getPath() {
  * expect(output.trim()).toBe('sentry-cli x.y.z');
  *
  * @param {string[]} args Command line arguments passed to `sentry-cli`.
- * @param {boolean} live We inherit stdio to display `sentry-cli` output directly.
+ * @param {boolean | 'rejectOnError'} live can be set to:
+ *  - `true` to inherit stdio to display `sentry-cli` output directly.
+ *  - `false` to not inherit stdio and return the output as a string.
+ *  - `'rejectOnError'` to inherit stdio and reject the promise if the command
+ *    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
@@ -321,15 +326,27 @@ async function execute(args, live, silent, configFile, config = {}) {
     ]);
     args = [...headers, ...args];
   }
+
   return new Promise((resolve, reject) => {
-    if (live === true) {
+    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', () => {
+      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 {

package/js/index.d.ts

@@ -208,7 +208,10 @@ declare module '@sentry/cli' {
 
     proposeVersion(): Promise<string>;
 
-    uploadSourceMaps(release: string, options: SentryCliUploadSourceMapsOptions): Promise<string>;
+    uploadSourceMaps(
+      release: string,
+      options: SentryCliUploadSourceMapsOptions & { live?: boolean | 'rejectOnError' }
+    ): Promise<string>;
 
     listDeploys(release: string): Promise<string>;
 

package/js/releases/index.js

@@ -10,13 +10,13 @@ const DEFAULT_IGNORE = ['node_modules'];
 
 /**
  * Schema for the `upload-sourcemaps` command.
- * @type {OptionsSchema}
+ * @type {import('../helper').OptionsSchema}
  */
 const SOURCEMAPS_SCHEMA = require('./options/uploadSourcemaps');
 
 /**
  * Schema for the `deploys new` command.
- * @type {OptionsSchema}
+ * @type {import('../helper').OptionsSchema}
  */
 const DEPLOYS_SCHEMA = require('./options/deploys');
 
@@ -95,7 +95,7 @@ class Releases {
       commitFlags.push('--ignore-missing');
     }
 
-    return this.execute(['releases', 'set-commits', release].concat(commitFlags));
+    return this.execute(['releases', 'set-commits', release].concat(commitFlags), false);
   }
 
   /**
@@ -149,6 +149,7 @@ class Releases {
    *   ext: ['js', 'map', 'jsbundle', 'bundle'],  // override file extensions to scan for
    *   projects: ['node'],        // provide a list of projects
    *   decompress: false          // decompress gzip files before uploading
+   *   live: true                 // whether to inherit stdio to display `sentry-cli` output directly.
    * });
    *
    * @param {string} release Unique name of the release.
@@ -199,7 +200,10 @@ class Releases {
 
       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)
+        this.execute(
+          helper.prepareCommand([...args, path], SOURCEMAPS_SCHEMA, newOptions),
+          options.live != null ? options.live : true
+        )
       );
     });
 
@@ -255,7 +259,11 @@ class Releases {
   /**
    * See {helper.execute} docs.
    * @param {string[]} args Command line arguments passed to `sentry-cli`.
-   * @param {boolean} live We inherit stdio to display `sentry-cli` output directly.
+   * @param {boolean | 'rejectOnError'} live can be set to:
+   *  - `true` to inherit stdio to display `sentry-cli` output directly.
+   *  - `false` to not inherit stdio and return the output as a string.
+   *  - `'rejectOnError'` to inherit stdio and reject the promise if the command
+   *    exits with a non-zero exit code.
    * @returns {Promise.<string>} A promise that resolves to the standard output.
    */
   async execute(args, live) {

package/js/releases/options/deploys.js

@@ -1,3 +1,6 @@
+/**
+ * @type {import('../../helper').OptionsSchema}
+ */
 module.exports = {
   env: {
     param: '--env',

package/js/releases/options/uploadSourcemaps.js

@@ -1,3 +1,6 @@
+/**
+ * @type {import('../../helper').OptionsSchema}
+ */
 module.exports = {
   ignore: {
     param: '--ignore',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/cli",
-  "version": "2.47.1",
+  "version": "2.49.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/",
@@ -22,22 +22,24 @@
     "which": "^2.0.2"
   },
   "devDependencies": {
+    "@types/node": "^20.10.0",
     "@vercel/nft": "^0.22.1",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.5.0",
     "jest": "^27.5.1",
     "npm-run-all": "^4.1.5",
-    "prettier": "2.8.8"
+    "prettier": "2.8.8",
+    "typescript": "~5.8.3"
   },
   "optionalDependencies": {
-    "@sentry/cli-darwin": "2.47.1",
-    "@sentry/cli-linux-arm": "2.47.1",
-    "@sentry/cli-linux-arm64": "2.47.1",
-    "@sentry/cli-linux-i686": "2.47.1",
-    "@sentry/cli-linux-x64": "2.47.1",
-    "@sentry/cli-win32-i686": "2.47.1",
-    "@sentry/cli-win32-x64": "2.47.1",
-    "@sentry/cli-win32-arm64": "2.47.1"
+    "@sentry/cli-darwin": "2.49.0",
+    "@sentry/cli-linux-arm": "2.49.0",
+    "@sentry/cli-linux-arm64": "2.49.0",
+    "@sentry/cli-linux-i686": "2.49.0",
+    "@sentry/cli-linux-x64": "2.49.0",
+    "@sentry/cli-win32-i686": "2.49.0",
+    "@sentry/cli-win32-x64": "2.49.0",
+    "@sentry/cli-win32-arm64": "2.49.0"
   },
   "scripts": {
     "postinstall": "node ./scripts/install.js",
@@ -49,6 +51,7 @@
     "test:watch": "jest --watch --notify",
     "test:eslint": "eslint bin/* scripts/**/*.js js/**/*.js",
     "test:prettier": "prettier --check  bin/* scripts/**/*.js js/**/*.js",
+    "check:types": "tsc --noEmit",
     "test:vercel-nft": "node scripts/test-vercel-nft.js"
   },
   "jest": {