feat(core): Import release injection code from each module

Author: Luca Forstner

packages/bundler-plugin-core/package.json

@@ -12,12 +12,6 @@
   "files": [
     "dist"
   ],
-  "exports": {
-    ".": {
-      "import": "./dist/esm/index.mjs",
-      "require": "./dist/cjs/index.js"
-    }
-  },
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.mjs",
   "types": "dist/types/index.d.ts",

packages/bundler-plugin-core/rollup.config.js

@@ -10,34 +10,48 @@ const input = ["src/index.ts"];
 
 const extensions = [".js", ".ts"];
 
-export default {
-  input,
-  external: [...Object.keys(packageJson.dependencies), ...modulePackage.builtinModules],
-  plugins: [
-    resolve({ extensions, preferBuiltins: true }),
-    commonjs(),
-    json(),
-    replace({
-      __PACKAGE_VERSION__: JSON.stringify(packageJson.version),
-    }),
-    babel({
-      extensions,
-      babelHelpers: "bundled",
-      include: ["src/**/*"],
-    }),
-  ],
-  output: [
-    {
-      file: packageJson.module,
-      format: "esm",
-      exports: "named",
-      sourcemap: true,
-    },
-    {
-      file: packageJson.main,
+export default [
+  {
+    input,
+    external: [...Object.keys(packageJson.dependencies), ...modulePackage.builtinModules],
+    plugins: [
+      resolve({ extensions, preferBuiltins: true }),
+      commonjs(),
+      json(),
+      replace({
+        preventAssignment: true,
+        values: {
+          __PACKAGE_VERSION__: JSON.stringify(packageJson.version),
+        },
+      }),
+      babel({
+        extensions,
+        babelHelpers: "bundled",
+        include: ["src/**/*"],
+      }),
+    ],
+    output: [
+      {
+        file: packageJson.module,
+        format: "esm",
+        exports: "named",
+        sourcemap: true,
+      },
+      {
+        file: packageJson.main,
+        format: "cjs",
+        exports: "named",
+        sourcemap: true,
+      },
+    ],
+  },
+  {
+    input: "src/release-injection-file.ts",
+    output: {
+      file: "dist/release-injection-file.js",
       format: "cjs",
       exports: "named",
       sourcemap: true,
     },
-  ],
-};
+  },
+];

packages/bundler-plugin-core/src/index.ts

@@ -34,11 +34,11 @@ const ALLOWED_TRANSFORMATION_FILE_ENDINGS = [".js", ".ts", ".jsx", ".tsx", ".mjs
  * - Sourcemaps upload
  *
  * Release injection:
- * Per default the sentry bundler plugin will inject a global `SENTRY_RELEASE` into
- * each JavaScript/TypeScript entrypoint. On a technical level this is done by identifying
- * entrypoints in the `resolveId` hook and prepending user code in the `transform` hook.
- * If a user wants to inject the release into a particular set of modules instead,
- * they can use the `releaseInjectionTargets` option.
+ * Per default the sentry bundler plugin will inject a global `SENTRY_RELEASE` into each JavaScript/TypeScript module
+ * that is part of the bundle. On a technical level this is done by appending an import (`import "sentry-release-injector;"`)
+ * to all entrypoint files of the user code (see `transformInclude` and `transform` hooks). This import is then resolved
+ * by the sentry plugin to a virtual module that sets the global variable (see `resolveId` and `load` hooks).
+ * If a user wants to inject the release into a particular set of modules they can use the `releaseInjectionTargets` option.
  *
  * Source maps upload:
  *
@@ -102,8 +102,6 @@ const unplugin = createUnplugin<Options>((options, unpluginMetaContext) => {
   let transaction: Transaction | undefined;
   let releaseInjectionSpan: Span | undefined;
 
-  const absolueEntrypointPaths = new Set<string>();
-
   return {
     name: "sentry-plugin",
     enforce: "pre", // needed for Vite to call resolveId hook
@@ -164,11 +162,6 @@ const unplugin = createUnplugin<Options>((options, unpluginMetaContext) => {
      */
     resolveId(id, importer, { isEntry }) {
       logger.debug('Called "resolveId":', { id, importer, isEntry });
-
-      if (isEntry) {
-        absolueEntrypointPaths.add(path.resolve(path.normalize(id)));
-      }
-
       return undefined;
     },
 
@@ -187,6 +180,10 @@ const unplugin = createUnplugin<Options>((options, unpluginMetaContext) => {
       // a windows style path to `releaseInjectionTargets`
       const normalizedId = path.normalize(id);
 
+      if (id.includes("release-injection-file")) {
+        return true;
+      }
+
       if (internalOptions.releaseInjectionTargets) {
         // If there's an `releaseInjectionTargets` option transform (ie. inject the release varible) when the file path matches the option.
         if (typeof internalOptions.releaseInjectionTargets === "function") {
@@ -201,16 +198,14 @@ const unplugin = createUnplugin<Options>((options, unpluginMetaContext) => {
             return normalizedId === normalizedEntry;
           }
         });
-      } else if (absolueEntrypointPaths.has(normalizedId)) {
+      } else {
         const pathIsOrdinary = !normalizedId.includes("?") && !normalizedId.includes("#");
 
         const pathHasAllowedFileEnding = ALLOWED_TRANSFORMATION_FILE_ENDINGS.some(
           (allowedFileEnding) => normalizedId.endsWith(allowedFileEnding)
         );
 
         return pathIsOrdinary && pathHasAllowedFileEnding;
-      } else {
-        return false;
       }
     },
 
@@ -228,15 +223,22 @@ const unplugin = createUnplugin<Options>((options, unpluginMetaContext) => {
       // The MagicString library allows us to generate sourcemaps for the changes we make to the user code.
       const ms = new MagicString(code);
 
-      ms.prepend(
-        generateGlobalInjectorCode({
-          release: await releaseNamePromise,
-          injectReleasesMap: internalOptions.injectReleasesMap,
-          injectBuildInformation: internalOptions._experiments.injectBuildInformation || false,
-          org: internalOptions.org,
-          project: internalOptions.project,
-        })
-      );
+      if (code.includes("_sentry_release_injection_file")) {
+        // Appending instead of prepending has less probability of mucking with user's source maps.
+        ms.append(
+          generateGlobalInjectorCode({
+            release: await releaseNamePromise,
+            injectReleasesMap: internalOptions.injectReleasesMap,
+            injectBuildInformation: internalOptions._experiments.injectBuildInformation || false,
+            org: internalOptions.org,
+            project: internalOptions.project,
+          })
+        );
+      } else {
+        // Appending instead of prepending has less probability of mucking with user's source maps.
+        // Luckily import statements get hoisted to the top anyways.
+        ms.append(`;\nimport "@sentry/bundler-plugin-core/dist/release-injection-file";`);
+      }
 
       if (unpluginMetaContext.framework === "esbuild") {
         // esbuild + unplugin is buggy at the moment when we return an object with a `map` (sourcemap) property.

packages/bundler-plugin-core/src/release-injection-file.ts

@@ -0,0 +1,3 @@
+// This const is used for nothing except to make this file identifiable via its content.
+// We search for "_sentry_release_injection_file" in the plugin.
+export const _sentry_release_injection_file = true;