Merge branch 'main' into timfish/fix/use-renderChunk-for-release-injection

Author: timfish

CHANGELOG.md

@@ -4,6 +4,26 @@
 
 - "You know what they say ‘Fool me once, strike one, but fool me twice… strike three.’" — Michael Scott
 
+- fix(core): Make plugin inject ES5-friendly code ([#770](https://github.com/getsentry/sentry-javascript-bundler-plugins/pull/770))
+
+Work in this release was contributed by @grushetsky. Thank you for your contribution!
+
+## 4.0.0
+
+### Breaking Changes
+
+- (Type change) Vite plugin now returns `VitePlugin` type instead of `any`
+- Deprecated function `getBuildInformation` has been removed
+
+### List of Changes
+
+- feat(core)!: Remove `getBuildInformation` export ([#765](https://github.com/getsentry/sentry-javascript-bundler-plugins/pull/765))
+- feat(vite)!: Update return type of vite plugin ([#728](https://github.com/getsentry/sentry-javascript-bundler-plugins/pull/728))
+
+## 3.6.1
+
+- fix(core): Observe and handle Sentry CLI sourcemap upload failures ([#763](https://github.com/getsentry/sentry-javascript-bundler-plugins/pull/763))
+
 ## 3.6.0
 
 - feat(core): Don't add `debugIdUploadPlugin` when sourcemaps option is disabled ([#753](https://github.com/getsentry/sentry-javascript-bundler-plugins/pull/753))

lerna.json

@@ -1,6 +1,6 @@
 {
   "$schema": "node_modules/lerna/schemas/lerna-schema.json",
-  "version": "3.6.0",
+  "version": "4.0.0",
   "npmClient": "yarn",
   "useWorkspaces": true
 }

package.json

@@ -37,7 +37,7 @@
     "ts-node": "^10.9.2"
   },
   "volta": {
-    "node": "14.21.2",
+    "node": "18.20.8",
     "yarn": "1.22.19"
   }
 }

packages/babel-plugin-component-annotate/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/babel-plugin-component-annotate",
-  "version": "3.6.0",
+  "version": "4.0.0",
   "description": "A Babel plugin that annotates frontend components with additional data to enrich the experience in Sentry",
   "repository": "git://github.com/getsentry/sentry-javascript-bundler-plugins.git",
   "homepage": "https://github.com/getsentry/sentry-javascript-bundler-plugins/tree/main/packages/babel-plugin-component-annotate",
@@ -56,8 +56,8 @@
     "@babel/preset-typescript": "7.17.12",
     "@rollup/plugin-babel": "5.3.1",
     "@rollup/plugin-node-resolve": "13.3.0",
-    "@sentry-internal/eslint-config": "3.6.0",
-    "@sentry-internal/sentry-bundler-plugin-tsconfig": "3.6.0",
+    "@sentry-internal/eslint-config": "4.0.0",
+    "@sentry-internal/sentry-bundler-plugin-tsconfig": "4.0.0",
     "@swc/core": "^1.2.205",
     "@swc/jest": "^0.2.21",
     "@types/jest": "^28.1.3",

packages/bundler-plugin-core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/bundler-plugin-core",
-  "version": "3.6.0",
+  "version": "4.0.0",
   "description": "Sentry Bundler Plugin Core",
   "repository": "git://github.com/getsentry/sentry-javascript-bundler-plugins.git",
   "homepage": "https://github.com/getsentry/sentry-javascript-bundler-plugins/tree/main/packages/bundler-plugin-core",
@@ -53,8 +53,8 @@
   },
   "dependencies": {
     "@babel/core": "^7.18.5",
-    "@sentry/babel-plugin-component-annotate": "3.6.0",
-    "@sentry/cli": "^2.46.0",
+    "@sentry/babel-plugin-component-annotate": "4.0.0",
+    "@sentry/cli": "^2.49.0",
     "dotenv": "^16.3.1",
     "find-up": "^5.0.0",
     "glob": "^9.3.2",
@@ -68,8 +68,8 @@
     "@rollup/plugin-json": "4.1.0",
     "@rollup/plugin-node-resolve": "13.3.0",
     "@rollup/plugin-replace": "^4.0.0",
-    "@sentry-internal/eslint-config": "3.6.0",
-    "@sentry-internal/sentry-bundler-plugin-tsconfig": "3.6.0",
+    "@sentry-internal/eslint-config": "4.0.0",
+    "@sentry-internal/sentry-bundler-plugin-tsconfig": "4.0.0",
     "@sentry/core": "8.30.0",
     "@sentry/types": "8.30.0",
     "@sentry/utils": "8.30.0",

packages/bundler-plugin-core/src/build-plugin-manager.ts

@@ -455,6 +455,9 @@ export function createSentryBuildPluginManager(
           await cliInstance.releases.uploadSourceMaps(options.release.name, {
             include: normalizedInclude,
             dist: options.release.dist,
+            // We want this promise to throw if the sourcemaps fail to upload so that we know about it.
+            // see: https://github.com/getsentry/sentry-cli/pull/2605
+            live: "rejectOnError",
           });
         }
 
@@ -642,6 +645,9 @@ export function createSentryBuildPluginManager(
                             dist: options.release.dist,
                           },
                         ],
+                        // We want this promise to throw if the sourcemaps fail to upload so that we know about it.
+                        // see: https://github.com/getsentry/sentry-cli/pull/2605
+                        live: "rejectOnError",
                       }
                     );
                   });

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

@@ -14,7 +14,6 @@ import { Options, SentrySDKBuildFlags } from "./types";
 import {
   generateGlobalInjectorCode,
   generateModuleMetadataInjectorCode,
-  getBuildInformation as actualGetBuildInformation,
   replaceBooleanFlagsInCode,
   stringToUUID,
   stripQueryAndHashFromPath,
@@ -174,13 +173,6 @@ export function sentryUnpluginFactory({
   });
 }
 
-/**
- * @deprecated This will be removed in v4
- */
-// TODO(v4): Don't export this from the package but keep the utils version
-// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-export const getBuildInformation = actualGetBuildInformation;
-
 /**
  * Determines whether the Sentry CLI binary is in its expected location.
  * This function is useful since `@sentry/cli` installs the binary via a post-install
@@ -439,7 +431,7 @@ export function createComponentNameAnnotateHooks(ignoredComponents?: string[]):
 }
 
 export function getDebugIdSnippet(debugId: string): string {
-  return `;{try{let e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="${debugId}",e._sentryDebugIdIdentifier="sentry-dbid-${debugId}")}catch(e){}};`;
+  return `;{try{(function(){var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="${debugId}",e._sentryDebugIdIdentifier="sentry-dbid-${debugId}");})();}catch(e){}};`;
 }
 
 export type { Logger } from "./logger";

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

@@ -314,8 +314,8 @@ export function generateGlobalInjectorCode({
 }): 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.)
-  let code = `{
-    let _global =
+  let code = `(function(){
+    var _global =
       typeof window !== 'undefined' ?
         window :
         typeof global !== 'undefined' ?
@@ -332,10 +332,10 @@ export function generateGlobalInjectorCode({
     const buildInfo = getBuildInformation();
 
     code += `
-      _global.SENTRY_BUILD_INFO=${JSON.stringify(buildInfo)};`;
+    _global.SENTRY_BUILD_INFO=${JSON.stringify(buildInfo)};`;
   }
 
-  code += "}";
+  code += "})();";
 
   return code;
 }
@@ -345,8 +345,8 @@ export function generateModuleMetadataInjectorCode(metadata: any): 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.)
   // We are merging the metadata objects in case modules are bundled twice with the plugin
-  return `{
-  let _sentryModuleMetadataGlobal =
+  return `(function(){
+  var _sentryModuleMetadataGlobal =
     typeof window !== "undefined"
       ? window
       : typeof global !== "undefined"
@@ -366,7 +366,7 @@ export function generateModuleMetadataInjectorCode(metadata: any): string {
       _sentryModuleMetadataGlobal._sentryModuleMetadata[new _sentryModuleMetadataGlobal.Error().stack],
       ${JSON.stringify(metadata)}
     );
-}`;
+})();`;
 }
 
 export function getBuildInformation(): {

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

@@ -4,7 +4,7 @@ describe("getDebugIdSnippet", () => {
   it("returns the debugId injection snippet for a passed debugId", () => {
     const snippet = getDebugIdSnippet("1234");
     expect(snippet).toMatchInlineSnapshot(
-      `";{try{let e=\\"undefined\\"!=typeof window?window:\\"undefined\\"!=typeof global?global:\\"undefined\\"!=typeof globalThis?globalThis:\\"undefined\\"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]=\\"1234\\",e._sentryDebugIdIdentifier=\\"sentry-dbid-1234\\")}catch(e){}};"`
+      `";{try{(function(){var e=\\"undefined\\"!=typeof window?window:\\"undefined\\"!=typeof global?global:\\"undefined\\"!=typeof globalThis?globalThis:\\"undefined\\"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]=\\"1234\\",e._sentryDebugIdIdentifier=\\"sentry-dbid-1234\\");})();}catch(e){}};"`
     );
   });
 });

packages/bundler-plugin-core/test/utils.test.ts

@@ -1,11 +1,15 @@
 import {
+  generateGlobalInjectorCode,
   generateModuleMetadataInjectorCode,
   getDependencies,
   getPackageJson,
   parseMajorVersion,
   replaceBooleanFlagsInCode,
   stringToUUID,
 } from "../src/utils";
+
+import fs from "fs";
+
 import path from "node:path";
 
 type PackageJson = Record<string, unknown>;
@@ -216,12 +220,73 @@ if (false && true) {
   });
 });
 
+describe("generateGlobalInjectorCode", () => {
+  it("generates code with release", () => {
+    const generatedCode = generateGlobalInjectorCode({
+      release: "1.2.3",
+      injectBuildInformation: false,
+    });
+
+    expect(generatedCode).toMatchInlineSnapshot(`
+      "(function(){
+          var _global =
+            typeof window !== 'undefined' ?
+              window :
+              typeof global !== 'undefined' ?
+                global :
+                typeof globalThis !== 'undefined' ?
+                  globalThis :
+                  typeof self !== 'undefined' ?
+                    self :
+                    {};
+
+          _global.SENTRY_RELEASE={id:\\"1.2.3\\"};})();"
+    `);
+  });
+
+  it("generates code with release and build information", () => {
+    jest.spyOn(fs, "readFileSync").mockReturnValueOnce(
+      JSON.stringify({
+        name: "test-app",
+        dependencies: {
+          myDep: "^2.1.4",
+        },
+        devDependencies: {
+          rollup: "^3.1.4",
+        },
+      })
+    );
+
+    const generatedCode = generateGlobalInjectorCode({
+      release: "1.2.3",
+      injectBuildInformation: true,
+    });
+
+    expect(generatedCode).toMatchInlineSnapshot(`
+      "(function(){
+          var _global =
+            typeof window !== 'undefined' ?
+              window :
+              typeof global !== 'undefined' ?
+                global :
+                typeof globalThis !== 'undefined' ?
+                  globalThis :
+                  typeof self !== 'undefined' ?
+                    self :
+                    {};
+
+          _global.SENTRY_RELEASE={id:\\"1.2.3\\"};
+          _global.SENTRY_BUILD_INFO={\\"deps\\":[\\"myDep\\",\\"rollup\\"],\\"depsVersions\\":{\\"rollup\\":3},\\"nodeVersion\\":18};})();"
+    `);
+  });
+});
+
 describe("generateModuleMetadataInjectorCode", () => {
   it("generates code with empty metadata object", () => {
     const generatedCode = generateModuleMetadataInjectorCode({});
     expect(generatedCode).toMatchInlineSnapshot(`
-      "{
-        let _sentryModuleMetadataGlobal =
+      "(function(){
+        var _sentryModuleMetadataGlobal =
           typeof window !== \\"undefined\\"
             ? window
             : typeof global !== \\"undefined\\"
@@ -241,7 +306,7 @@ describe("generateModuleMetadataInjectorCode", () => {
             _sentryModuleMetadataGlobal._sentryModuleMetadata[new _sentryModuleMetadataGlobal.Error().stack],
             {}
           );
-      }"
+      })();"
     `);
   });
 
@@ -255,8 +320,8 @@ describe("generateModuleMetadataInjectorCode", () => {
       },
     });
     expect(generatedCode).toMatchInlineSnapshot(`
-      "{
-        let _sentryModuleMetadataGlobal =
+      "(function(){
+        var _sentryModuleMetadataGlobal =
           typeof window !== \\"undefined\\"
             ? window
             : typeof global !== \\"undefined\\"
@@ -276,7 +341,7 @@ describe("generateModuleMetadataInjectorCode", () => {
             _sentryModuleMetadataGlobal._sentryModuleMetadata[new _sentryModuleMetadataGlobal.Error().stack],
             {\\"file1.js\\":{\\"foo\\":\\"bar\\"},\\"file2.js\\":{\\"bar\\":\\"baz\\"}}
           );
-      }"
+      })();"
     `);
   });
 });