@sentry/cli 2.7.0 → 2.8.1

package/checksums.txt

@@ -1,9 +1,9 @@
-sentry-cli-Darwin-arm64=d9ea5cbb53c3809558007f6b3af809b3ad186d4a2014929d63099633d44d9765
-sentry-cli-Darwin-universal=a757a3700bcb16c16485f15d0a187c12ac1edd40b4aa29f5cb955f9a4fa9ae96
-sentry-cli-Darwin-x86_64=d56d1a4e793d2cceb4cd9614794241a34332c3bc1a217972c019165c3d146e3d
-sentry-cli-Linux-aarch64=9908b947a7a2c393e8c115665d972fbe3eb67e540b1ee0b07fedce78e7a712cf
-sentry-cli-Linux-armv7=0f240f47f6b38a3b7c4025cd3d4e53c746e9b6a05f210ecd7d41bc09512e0b77
-sentry-cli-Linux-i686=dc08351e062a2d30309cb1f94173f79b2b7cf2e23d122adbfbdd71a1afb88d9c
-sentry-cli-Linux-x86_64=6a57a418b34c5ad71b5dddc73b8d63b5662b8a11713ac0d92377b64976507d82
-sentry-cli-Windows-i686.exe=f4877fca56d94c56784baca8140dd5e7552db1dae646c0b107be350b3b5f5209
-sentry-cli-Windows-x86_64.exe=76f3bf7c8edca9b660b82f53d5b94e9dc0505075d5cfb2ace09d807f9ed22bf0
+sentry-cli-Darwin-arm64=e363c62099ae29a0cb18fca7d1fce11c9d9912a12fdafb6b581d8fa85e3a75dc
+sentry-cli-Darwin-universal=aded269c5e6448bdc18fefdd8bb2e3aafc14d7b62f786f224f1a005320d10fc6
+sentry-cli-Darwin-x86_64=0a2511a1db4df9297efb03d154d3af57c6fac942c64b3d8b494f931d0ced2469
+sentry-cli-Linux-aarch64=8607277dd4e672abec3d1f65a7b108e7f76c506467392141ce7b727f85e8a648
+sentry-cli-Linux-armv7=d472cfe971606d824ec03fb6950e3a7807a55933deaa91199c2b5e8dad59f495
+sentry-cli-Linux-i686=e01b420d9371e29e3796faeb5cb5070de93e2d65deb94dd20d14f4bb90be2032
+sentry-cli-Linux-x86_64=517e07749123f3b30c388a6e9347c6e7f99ed86808110e916c27d6a5638032ad
+sentry-cli-Windows-i686.exe=4eaa6c3d40dc5924b51b05f5a9831cb1136dd8abe51ce45ba921f1d07d32d450
+sentry-cli-Windows-x86_64.exe=e9b90852b0120f00f3462fecf870d8872ec5ee8fa263ba075abd8fcd573c58fb

package/js/helper.js

@@ -1,21 +1,29 @@
 'use strict';
 
+const path = require('path');
 const childProcess = require('child_process');
 
 /**
- * Absolute path to the sentry-cli binary (platform dependent).
- * @type {string}
+ * 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
  */
-let binaryPath = eval(
-  "require('path').resolve(__dirname, require('os').platform() === 'win32' ? '..\\sentry-cli.exe' : '../sentry-cli')"
-);
+function getBinaryPath() {
+  const parts = [];
+  parts.push(__dirname);
+  parts.push('..');
+  parts.push(`sentry-cli${process.platform === 'win32' ? '.exe' : ''}`);
+  return path.resolve(...parts);
+}
 
 /**
- * NOTE: `eval` usage is a workaround for @vercel/nft detecting the binary itself as the hard dependency
- *       and effectively always including it in the bundle, which is not what we want.
- * ref: https://github.com/getsentry/sentry-javascript/issues/3865
- * ref: https://github.com/vercel/nft/issues/203
+ * Absolute path to the sentry-cli binary (platform dependent).
+ * @type {string}
  */
+let binaryPath = getBinaryPath();
 
 /**
  * Overrides the default binary path with a mock value, useful for testing.
@@ -164,6 +172,12 @@ 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) {

package/js/index.d.ts

@@ -47,6 +47,11 @@ 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>;
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/cli",
-  "version": "2.7.0",
+  "version": "2.8.1",
   "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/",
@@ -23,6 +23,7 @@
     "which": "^2.0.2"
   },
   "devDependencies": {
+    "@vercel/nft": "^0.22.1",
     "eslint": "^8.13.0",
     "eslint-config-prettier": "^8.5.0",
     "jest": "^27.5.1",
@@ -34,11 +35,12 @@
     "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",
-    "test": "npm-run-all test:jest test:eslint test:prettier",
+    "test": "npm-run-all test:jest test:eslint test:prettier test:vercel-nft",
     "test:jest": "jest",
     "test:watch": "jest --watch --notify",
     "test:eslint": "eslint bin/* scripts/**/*.js js/**/*.js",
-    "test:prettier": "prettier --check  bin/* scripts/**/*.js js/**/*.js"
+    "test:prettier": "prettier --check  bin/* scripts/**/*.js js/**/*.js",
+    "test:vercel-nft": "node scripts/test-vercel-nft.js"
   },
   "jest": {
     "collectCoverage": true,

package/scripts/test-vercel-nft.js

@@ -0,0 +1,16 @@
+const { nodeFileTrace } = require('@vercel/nft');
+
+const entryPoint = require.resolve('..');
+
+// Trace the module entrypoint
+nodeFileTrace([entryPoint]).then((result) => {
+  console.log('@vercel/nft traced dependencies:', Array.from(result.fileList));
+
+  // If either binary is picked up, fail the test
+  if (result.fileList.has('sentry-cli') || result.fileList.has('sentry-cli.exe')) {
+    console.error('ERROR: The sentry-cli binary should not be found by @vercel/nft');
+    process.exit(-1);
+  } else {
+    console.log('The sentry-cli binary was not traced by @vercel/nft');
+  }
+});