@sentry/bundler-plugin-core 3.2.1 → 3.2.3

package/dist/esm/index.mjs

@@ -705,7 +705,7 @@ function replaceBooleanFlagsInCode(code, replacementValues) {
 
 var SENTRY_SAAS_URL = "https://sentry.io";
 function normalizeUserOptions(userOptions) {
-  var _userOptions$org, _userOptions$project, _userOptions$authToke, _ref, _userOptions$url, _userOptions$debug, _userOptions$silent, _userOptions$telemetr, _userOptions$disable, _ref2, _userOptions$release$, _userOptions$release, _userOptions$release$2, _userOptions$release2, _userOptions$release$3, _userOptions$release3, _userOptions$release$4, _userOptions$release4, _ref3, _userOptions$release$5, _userOptions$release5, _userOptions$_metaOpt, _userOptions$_metaOpt2, _userOptions$_experim;
+  var _userOptions$org, _userOptions$project, _userOptions$authToke, _ref, _userOptions$url, _userOptions$debug, _userOptions$silent, _userOptions$telemetr, _userOptions$disable, _ref2, _userOptions$release$, _userOptions$release, _userOptions$release$2, _userOptions$release2, _userOptions$release$3, _userOptions$release3, _userOptions$release$4, _userOptions$release4, _ref3, _userOptions$release$5, _userOptions$release5, _userOptions$release6, _userOptions$_metaOpt, _userOptions$_metaOpt2, _userOptions$_experim;
   var options = {
     org: (_userOptions$org = userOptions.org) !== null && _userOptions$org !== void 0 ? _userOptions$org : process.env["SENTRY_ORG"],
     project: (_userOptions$project = userOptions.project) !== null && _userOptions$project !== void 0 ? _userOptions$project : process.env["SENTRY_PROJECT"],
@@ -723,7 +723,8 @@ function normalizeUserOptions(userOptions) {
       inject: (_userOptions$release$2 = (_userOptions$release2 = userOptions.release) === null || _userOptions$release2 === void 0 ? void 0 : _userOptions$release2.inject) !== null && _userOptions$release$2 !== void 0 ? _userOptions$release$2 : true,
       create: (_userOptions$release$3 = (_userOptions$release3 = userOptions.release) === null || _userOptions$release3 === void 0 ? void 0 : _userOptions$release3.create) !== null && _userOptions$release$3 !== void 0 ? _userOptions$release$3 : true,
       finalize: (_userOptions$release$4 = (_userOptions$release4 = userOptions.release) === null || _userOptions$release4 === void 0 ? void 0 : _userOptions$release4.finalize) !== null && _userOptions$release$4 !== void 0 ? _userOptions$release$4 : true,
-      vcsRemote: (_ref3 = (_userOptions$release$5 = (_userOptions$release5 = userOptions.release) === null || _userOptions$release5 === void 0 ? void 0 : _userOptions$release5.vcsRemote) !== null && _userOptions$release$5 !== void 0 ? _userOptions$release$5 : process.env["SENTRY_VSC_REMOTE"]) !== null && _ref3 !== void 0 ? _ref3 : "origin"
+      vcsRemote: (_ref3 = (_userOptions$release$5 = (_userOptions$release5 = userOptions.release) === null || _userOptions$release5 === void 0 ? void 0 : _userOptions$release5.vcsRemote) !== null && _userOptions$release$5 !== void 0 ? _userOptions$release$5 : process.env["SENTRY_VSC_REMOTE"]) !== null && _ref3 !== void 0 ? _ref3 : "origin",
+      setCommits: (_userOptions$release6 = userOptions.release) === null || _userOptions$release6 === void 0 ? void 0 : _userOptions$release6.setCommits
     }),
     bundleSizeOptimizations: userOptions.bundleSizeOptimizations,
     reactComponentAnnotation: userOptions.reactComponentAnnotation,
@@ -736,6 +737,31 @@ function normalizeUserOptions(userOptions) {
     moduleMetadata: userOptions.moduleMetadata,
     _experiments: (_userOptions$_experim = userOptions._experiments) !== null && _userOptions$_experim !== void 0 ? _userOptions$_experim : {}
   };
+  if (options.release.setCommits === undefined) {
+    if (process.env["VERCEL"] && process.env["VERCEL_GIT_COMMIT_SHA"] && process.env["VERCEL_GIT_REPO_SLUG"] && process.env["VERCEL_GIT_REPO_OWNER"]) {
+      options.release.setCommits = {
+        shouldNotThrowOnFailure: true,
+        commit: process.env["VERCEL_GIT_COMMIT_SHA"],
+        previousCommit: process.env["VERCEL_GIT_PREVIOUS_SHA"],
+        repo: "".concat(process.env["VERCEL_GIT_REPO_OWNER"], "/").concat(process.env["VERCEL_GIT_REPO_SLUG"]),
+        ignoreEmpty: true,
+        ignoreMissing: true
+      };
+    } else {
+      options.release.setCommits = {
+        shouldNotThrowOnFailure: true,
+        auto: true,
+        ignoreEmpty: true,
+        ignoreMissing: true
+      };
+    }
+  }
+  if (options.release.deploy === undefined && process.env["VERCEL"] && process.env["VERCEL_TARGET_ENV"]) {
+    options.release.deploy = {
+      env: "vercel-".concat(process.env["VERCEL_TARGET_ENV"]),
+      url: process.env["VERCEL_URL"] ? "https://".concat(process.env["VERCEL_URL"]) : undefined
+    };
+  }
   return options;
 }
 
@@ -8075,7 +8101,7 @@ function createSentryInstance(options, shouldSendTelemetry, bundler) {
     dsn: "https://4c2bae7d9fbc413e8f7385f55c515d51@o1.ingest.sentry.io/6690737",
     tracesSampleRate: 1,
     sampleRate: 1,
-    release: "3.2.1",
+    release: "3.2.3",
     integrations: [],
     tracePropagationTargets: ["sentry.io/api"],
     stackParser: stackParser,
@@ -8443,7 +8469,7 @@ function createDebugIdUploadFunction(_ref) {
                                         }));
                                         _context5.next = 3;
                                         return cliInstance.releases.uploadSourceMaps(releaseName !== null && releaseName !== void 0 ? releaseName : "undefined",
-                                        // unfortunetly this needs a value for now but it will not matter since debug IDs overpower releases anyhow
+                                        // unfortunately this needs a value for now but it will not matter since debug IDs overpower releases anyhow
                                         {
                                           include: [{
                                             paths: [tmpUploadFolder],
@@ -8481,7 +8507,7 @@ function createDebugIdUploadFunction(_ref) {
                     _context8.prev = 25;
                     _context8.t0 = _context8["catch"](1);
                     sentryScope.captureException('Error in "debugIdUploadPlugin" writeBundle hook');
-                    handleRecoverableError(_context8.t0);
+                    handleRecoverableError(_context8.t0, false);
                   case 29:
                     _context8.prev = 29;
                     if (folderToCleanUp) {
@@ -8534,16 +8560,9 @@ function createDebugIdUploadFunction(_ref) {
 function prepareBundleForDebugIdUpload(_x4, _x5, _x6, _x7, _x8) {
   return _prepareBundleForDebugIdUpload.apply(this, arguments);
 }
-
-/**
- * Looks for a particular string pattern (`sdbid-[debug ID]`) in the bundle
- * source and extracts the bundle's debug ID from it.
- *
- * The string pattern is injected via the debug ID injection snipped.
- */
 function _prepareBundleForDebugIdUpload() {
   _prepareBundleForDebugIdUpload = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee11(bundleFilePath, uploadFolder, chunkIndex, logger, rewriteSourcesHook) {
-    var bundleContent, debugId, uniqueUploadName, writeSourceFilePromise, writeSourceMapFilePromise;
+    var bundleContent, debugId, uniqueSourceFileUploadPath, writeSourceFilePromise, writeSourceMapFilePromise;
     return _regeneratorRuntime().wrap(function _callee11$(_context11) {
       while (1) switch (_context11.prev = _context11.next) {
         case 0:
@@ -8568,9 +8587,13 @@ function _prepareBundleForDebugIdUpload() {
           logger.debug("Could not determine debug ID from bundle. This can happen if you did not clean your output folder before installing the Sentry plugin. File will not be source mapped: ".concat(bundleFilePath));
           return _context11.abrupt("return");
         case 14:
-          uniqueUploadName = "".concat(debugId, "-").concat(chunkIndex);
+          uniqueSourceFileUploadPath = getUniqueUploadPath(uploadFolder, chunkIndex, bundleFilePath);
           bundleContent += "\n//# debugId=".concat(debugId);
-          writeSourceFilePromise = fs__default.promises.writeFile(path__default.join(uploadFolder, "".concat(uniqueUploadName, ".js")), bundleContent, "utf-8");
+          writeSourceFilePromise = fs__default.promises.mkdir(path__default.dirname(uniqueSourceFileUploadPath), {
+            recursive: true
+          }).then(function () {
+            return fs__default.promises.writeFile(uniqueSourceFileUploadPath, bundleContent, "utf-8");
+          });
           writeSourceMapFilePromise = determineSourceMapPathFromBundle(bundleFilePath, bundleContent, logger).then( /*#__PURE__*/function () {
             var _ref12 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee10(sourceMapPath) {
               return _regeneratorRuntime().wrap(function _callee10$(_context10) {
@@ -8581,7 +8604,7 @@ function _prepareBundleForDebugIdUpload() {
                       break;
                     }
                     _context10.next = 3;
-                    return prepareSourceMapForDebugIdUpload(sourceMapPath, path__default.join(uploadFolder, "".concat(uniqueUploadName, ".js.map")), debugId, rewriteSourcesHook, logger);
+                    return prepareSourceMapForDebugIdUpload(sourceMapPath, getUniqueUploadPath(uploadFolder, chunkIndex, sourceMapPath), debugId, rewriteSourcesHook, logger);
                   case 3:
                   case "end":
                     return _context10.stop();
@@ -8605,6 +8628,26 @@ function _prepareBundleForDebugIdUpload() {
   }));
   return _prepareBundleForDebugIdUpload.apply(this, arguments);
 }
+function getUniqueUploadPath(uploadFolder, chunkIndex, filePath) {
+  return path__default.join(uploadFolder, // We add a "chunk index" segment to the path that is a simple incrementing number to avoid name collisions.
+  // Name collisions can happen when files are located "outside" of the current working directory, at different levels but they share a subpath.
+  // Example:
+  // - CWD: /root/foo/cwd
+  // - File 1: /root/foo/index.js -> ../foo/index.js -> foo/index.js
+  // - File 2: /foo/index.js -> ../../foo/index.js -> foo/index.js
+  "".concat(chunkIndex), path__default.normalize(path__default.relative(process.cwd(), filePath).split(path__default.sep)
+  // We filter out these "navigation" segments because a) they look ugly b) they will cause us to break out of the upload folder.
+  .filter(function (segment) {
+    return segment !== ".." && segment !== ".";
+  }).join(path__default.sep)));
+}
+
+/**
+ * Looks for a particular string pattern (`sdbid-[debug ID]`) in the bundle
+ * source and extracts the bundle's debug ID from it.
+ *
+ * The string pattern is injected via the debug ID injection snipped.
+ */
 function determineDebugIdFromBundleSource(code) {
   var match = code.match(/sentry-dbid-([0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12})/);
   if (match) {
@@ -8731,22 +8774,27 @@ function _prepareSourceMapForDebugIdUpload() {
           }
           _context13.prev = 21;
           _context13.next = 24;
-          return util.promisify(fs__default.writeFile)(targetPath, JSON.stringify(map), {
-            encoding: "utf8"
+          return fs__default.promises.mkdir(path__default.dirname(targetPath), {
+            recursive: true
           });
         case 24:
-          _context13.next = 30;
-          break;
+          _context13.next = 26;
+          return fs__default.promises.writeFile(targetPath, JSON.stringify(map), {
+            encoding: "utf8"
+          });
         case 26:
-          _context13.prev = 26;
+          _context13.next = 32;
+          break;
+        case 28:
+          _context13.prev = 28;
           _context13.t2 = _context13["catch"](21);
           logger.error("Failed to prepare source map for debug ID upload: ".concat(sourceMapPath), _context13.t2);
           return _context13.abrupt("return");
-        case 30:
+        case 32:
         case "end":
           return _context13.stop();
       }
-    }, _callee13, null, [[0, 6], [10, 16], [21, 26]]);
+    }, _callee13, null, [[0, 6], [10, 16], [21, 28]]);
   }));
   return _prepareSourceMapForDebugIdUpload.apply(this, arguments);
 }
@@ -8765,7 +8813,8 @@ function defaultRewriteSourcesHook(source) {
  * Additionally, if legacy upload options are set, it uploads source maps in the legacy (non-debugId) way.
  */
 function releaseManagementPlugin(_ref) {
-  var releaseName = _ref.releaseName,
+  var logger = _ref.logger,
+    releaseName = _ref.releaseName,
     include = _ref.include,
     dist = _ref.dist,
     setCommitsOption = _ref.setCommitsOption,
@@ -8822,47 +8871,63 @@ function releaseManagementPlugin(_ref) {
                 dist: dist
               });
             case 10:
-              if (!setCommitsOption) {
-                _context.next = 13;
+              if (!(setCommitsOption !== false)) {
+                _context.next = 23;
                 break;
               }
-              _context.next = 13;
+              _context.prev = 11;
+              _context.next = 14;
               return cliInstance.releases.setCommits(releaseName, setCommitsOption);
-            case 13:
+            case 14:
+              _context.next = 23;
+              break;
+            case 16:
+              _context.prev = 16;
+              _context.t0 = _context["catch"](11);
+              if (!("shouldNotThrowOnFailure" in setCommitsOption && setCommitsOption.shouldNotThrowOnFailure)) {
+                _context.next = 22;
+                break;
+              }
+              logger.debug("An error occurred setting commits on release (this message can be ignored unless you commits on release are desired):", _context.t0);
+              _context.next = 23;
+              break;
+            case 22:
+              throw _context.t0;
+            case 23:
               if (!shouldFinalizeRelease) {
-                _context.next = 16;
+                _context.next = 26;
                 break;
               }
-              _context.next = 16;
+              _context.next = 26;
               return cliInstance.releases.finalize(releaseName);
-            case 16:
+            case 26:
               if (!deployOptions) {
-                _context.next = 19;
+                _context.next = 29;
                 break;
               }
-              _context.next = 19;
+              _context.next = 29;
               return cliInstance.releases.newDeploy(releaseName, deployOptions);
-            case 19:
-              _context.next = 27;
+            case 29:
+              _context.next = 37;
               break;
-            case 21:
-              _context.prev = 21;
-              _context.t0 = _context["catch"](1);
+            case 31:
+              _context.prev = 31;
+              _context.t1 = _context["catch"](1);
               sentryScope.captureException('Error in "releaseManagementPlugin" writeBundle hook');
-              _context.next = 26;
+              _context.next = 36;
               return safeFlushTelemetry(sentryClient);
-            case 26:
-              handleRecoverableError(_context.t0);
-            case 27:
-              _context.prev = 27;
+            case 36:
+              handleRecoverableError(_context.t1, false);
+            case 37:
+              _context.prev = 37;
               freeGlobalDependencyOnSourcemapFiles();
               freeWriteBundleInvocationDependencyOnSourcemapFiles();
-              return _context.finish(27);
-            case 31:
+              return _context.finish(37);
+            case 41:
             case "end":
               return _context.stop();
           }
-        }, _callee, null, [[1, 21, 27, 31]]);
+        }, _callee, null, [[1, 31, 37, 41], [11, 16]]);
       }))();
     }
   };
@@ -9009,7 +9074,9 @@ function fileDeletionPlugin(_ref) {
               _context.next = 21;
               return safeFlushTelemetry(sentryClient);
             case 21:
-              handleRecoverableError(_context.t0);
+              // We throw by default if we get here b/c not being able to delete
+              // source maps could leak them to production
+              handleRecoverableError(_context.t0, true);
             case 22:
             case "end":
               return _context.stop();
@@ -9120,8 +9187,18 @@ function sentryUnpluginFactory(_ref) {
     });
 
     // Set the User-Agent that Sentry CLI will use when interacting with Sentry
-    process.env["SENTRY_PIPELINE"] = "".concat(unpluginMetaContext.framework, "-plugin/", "3.2.1");
-    function handleRecoverableError(unknownError) {
+    process.env["SENTRY_PIPELINE"] = "".concat(unpluginMetaContext.framework, "-plugin/", "3.2.3");
+
+    /**
+     * Handles errors caught and emitted in various areas of the plugin.
+     *
+     * Also sets the sentry session status according to the error handling.
+     *
+     * If users specify their custom `errorHandler` we'll leave the decision to throw
+     * or continue up to them. By default, @param throwByDefault controls if the plugin
+     * should throw an error (which causes a build fail in most bundlers) or continue.
+     */
+    function handleRecoverableError(unknownError, throwByDefault) {
       sentrySession.status = "abnormal";
       try {
         if (options.errorHandler) {
@@ -9136,15 +9213,21 @@ function sentryUnpluginFactory(_ref) {
             throw e;
           }
         } else {
+          // setting the session to "crashed" b/c from a plugin perspective this run failed.
+          // However, we're intentionally not rethrowing the error to avoid breaking the user build.
           sentrySession.status = "crashed";
-          throw unknownError;
+          if (throwByDefault) {
+            throw unknownError;
+          }
+          logger.error("An error occurred. Couldn't finish all operations:", unknownError);
         }
       } finally {
         endSession();
       }
     }
     if (!validateOptions(options, logger)) {
-      handleRecoverableError(new Error("Options were not set correctly. See output above for more details."));
+      // Throwing by default to avoid a misconfigured plugin going unnoticed.
+      handleRecoverableError(new Error("Options were not set correctly. See output above for more details."), true);
     }
     if (process.cwd().match(/\\node_modules\\|\/node_modules\//)) {
       logger.warn("Running Sentry plugin from within a `node_modules` folder. Some features may not work.");
@@ -9259,16 +9342,21 @@ function sentryUnpluginFactory(_ref) {
       var _injectionCode2 = generateModuleMetadataInjectorCode(metadata);
       plugins.push(moduleMetadataInjectionPlugin(_injectionCode2));
     }
+    // https://turbo.build/repo/docs/reference/system-environment-variables#environment-variables-in-tasks
+    var isRunningInTurborepo = Boolean(process.env["TURBO_HASH"]);
+    var getTurborepoEnvPassthroughWarning = function getTurborepoEnvPassthroughWarning(envVarName) {
+      return isRunningInTurborepo ? "\nYou seem to be using Turborepo, did you forget to put ".concat(envVarName, " in `passThroughEnv`? https://turbo.build/repo/docs/reference/configuration#passthroughenv") : "";
+    };
     if (!options.release.name) {
       logger.debug("No release name provided. Will not create release. Please set the `release.name` option to identify your release.");
     } else if (isDevMode) {
       logger.debug("Running in development mode. Will not create release.");
     } else if (!options.authToken) {
-      logger.warn("No auth token provided. Will not create release. Please set the `authToken` option. You can find information on how to generate a Sentry auth token here: https://docs.sentry.io/api/auth/");
+      logger.warn("No auth token provided. Will not create release. Please set the `authToken` option. You can find information on how to generate a Sentry auth token here: https://docs.sentry.io/api/auth/" + getTurborepoEnvPassthroughWarning("SENTRY_AUTH_TOKEN"));
     } else if (!options.org && !options.authToken.startsWith("sntrys_")) {
-      logger.warn("No organization slug provided. Will not create release. Please set the `org` option to your Sentry organization slug.");
+      logger.warn("No organization slug provided. Will not create release. Please set the `org` option to your Sentry organization slug." + getTurborepoEnvPassthroughWarning("SENTRY_ORG"));
     } else if (!options.project) {
-      logger.warn("No project provided. Will not create release. Please set the `project` option to your Sentry project slug.");
+      logger.warn("No project provided. Will not create release. Please set the `project` option to your Sentry project slug." + getTurborepoEnvPassthroughWarning("SENTRY_PROJECT"));
     } else {
       plugins.push(releaseManagementPlugin({
         logger: logger,
@@ -9276,6 +9364,8 @@ function sentryUnpluginFactory(_ref) {
         shouldCreateRelease: options.release.create,
         shouldFinalizeRelease: options.release.finalize,
         include: options.release.uploadLegacySourcemaps,
+        // setCommits has a default defined by the options mappings
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         setCommitsOption: options.release.setCommits,
         deployOptions: options.release.deploy,
         dist: options.release.dist,
@@ -9302,11 +9392,11 @@ function sentryUnpluginFactory(_ref) {
     } else if (isDevMode) {
       logger.debug("Running in development mode. Will not upload sourcemaps.");
     } else if (!options.authToken) {
-      logger.warn("No auth token provided. Will not upload source maps. Please set the `authToken` option. You can find information on how to generate a Sentry auth token here: https://docs.sentry.io/api/auth/");
+      logger.warn("No auth token provided. Will not upload source maps. Please set the `authToken` option. You can find information on how to generate a Sentry auth token here: https://docs.sentry.io/api/auth/" + getTurborepoEnvPassthroughWarning("SENTRY_AUTH_TOKEN"));
     } else if (!options.org && !options.authToken.startsWith("sntrys_")) {
-      logger.warn("No org provided. Will not upload source maps. Please set the `org` option to your Sentry organization slug.");
+      logger.warn("No org provided. Will not upload source maps. Please set the `org` option to your Sentry organization slug." + getTurborepoEnvPassthroughWarning("SENTRY_ORG"));
     } else if (!options.project) {
-      logger.warn("No project provided. Will not upload source maps. Please set the `project` option to your Sentry project slug.");
+      logger.warn("No project provided. Will not upload source maps. Please set the `project` option to your Sentry project slug." + getTurborepoEnvPassthroughWarning("SENTRY_PROJECT"));
     } else {
       var _options$sourcemaps3, _options$sourcemaps4, _options$sourcemaps5;
       // This option is only strongly typed for the webpack plugin, where it is used. It has no effect on other plugins