feat(core): Add SENTRY_RELEASES variable injection

Author: Lms24

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

@@ -13,7 +13,7 @@ import "@sentry/tracing";
 import { addSpanToTransaction, captureMinimalError, makeSentryClient } from "./sentry/telemetry";
 import { Span, Transaction } from "@sentry/types";
 import { createLogger } from "./sentry/logger";
-import { normalizeUserOptions } from "./options-mapping";
+import { InternalOptions, normalizeUserOptions } from "./options-mapping";
 import { getSentryCli } from "./sentry/cli";
 
 // We prefix the polyfill id with \0 to tell other plugins not to try to load or transform it.
@@ -185,7 +185,11 @@ const unplugin = createUnplugin<Options>((options, unpluginMetaContext) => {
       });
 
       if (id === RELEASE_INJECTOR_ID) {
-        return generateGlobalInjectorCode({ release: internalOptions.release });
+        return generateGlobalInjectorCode({
+          release: internalOptions.release,
+          org: internalOptions.org,
+          project: internalOptions.project,
+        });
       } else {
         return undefined;
       }
@@ -320,10 +324,18 @@ const unplugin = createUnplugin<Options>((options, unpluginMetaContext) => {
  * Generates code for the "sentry-release-injector" which is responsible for setting the global `SENTRY_RELEASE`
  * variable.
  */
-function generateGlobalInjectorCode({ release }: { release: string }) {
+function generateGlobalInjectorCode({
+  release,
+  org,
+  project,
+}: {
+  release: string;
+  org?: string;
+  project?: string;
+}) {
   // The code below is mostly ternary operators because it saves bundle size.
   // The checks are to support as many environments as possible. (Node.js, Browser, webworkers, etc.)
-  return `
+  let code = `
     var _global =
       typeof window !== 'undefined' ?
         window :
@@ -334,6 +346,16 @@ function generateGlobalInjectorCode({ release }: { release: string }) {
             {};
 
     _global.SENTRY_RELEASE={id:"${release}"};`;
+
+  if (project) {
+    const key = org ? `${project}@${org}` : project;
+    code += `
+      _global.SENTRY_RELEASES=_global.SENTRY_RELEASES || {};
+      _global.SENTRY_RELEASES["${key}"]={id:"${release}"};
+      `;
+  }
+
+  return code;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

packages/integration-tests/fixtures/releases-injection/input/entrypoint.js

@@ -0,0 +1,2 @@
+// eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
+process.stdout.write(global.SENTRY_RELEASES["releasesProject@releasesOrg"].id.toString());

packages/integration-tests/fixtures/releases-injection/releases-injection.test.ts

@@ -0,0 +1,38 @@
+import childProcess from "child_process";
+import path from "path";
+
+/**
+ * Runs a node file in a seprate process.
+ *
+ * @param bundlePath Path of node file to run
+ * @returns Stdout of the process
+ */
+function checkBundle(bundlePath: string): void {
+  const processOutput = childProcess.execSync(`node ${bundlePath}`, { encoding: "utf-8" });
+  expect(processOutput).toBe("I AM A RELEASE!");
+}
+
+test("esbuild bundle", () => {
+  expect.assertions(1);
+  checkBundle(path.join(__dirname, "./out/esbuild/index.js"));
+});
+
+test("rollup bundle", () => {
+  expect.assertions(1);
+  checkBundle(path.join(__dirname, "./out/rollup/index.js"));
+});
+
+test("vite bundle", () => {
+  expect.assertions(1);
+  checkBundle(path.join(__dirname, "./out/vite/index.js"));
+});
+
+test("webpack 4 bundle", () => {
+  expect.assertions(1);
+  checkBundle(path.join(__dirname, "./out/webpack4/index.js"));
+});
+
+test("webpack 5 bundle", () => {
+  expect.assertions(1);
+  checkBundle(path.join(__dirname, "./out/webpack5/index.js"));
+});

packages/integration-tests/fixtures/releases-injection/setup.ts

@@ -0,0 +1,14 @@
+import { Options } from "@sentry/bundler-plugin-core";
+import * as path from "path";
+import { createCjsBundles } from "../../utils/create-cjs-bundles";
+
+const entryPointPath = path.resolve(__dirname, "./input/entrypoint.js");
+const outputDir = path.resolve(__dirname, "./out");
+
+createCjsBundles({ index: entryPointPath }, outputDir, {
+  release: "I AM A RELEASE!",
+  project: "releasesProject",
+  org: "releasesOrg",
+  include: outputDir,
+  dryRun: true,
+} as Options);