fix(esbuild): Don't inject debug IDs into injected modules

getsentry · Oct 5, 2023 · 864dfea · 864dfea
1 parent 8a74c87
commit 864dfea
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/packages/esbuild-plugin/src/index.ts b/packages/esbuild-plugin/src/index.ts
@@ -44,11 +44,17 @@ function esbuildDebugIdInjectionPlugin(): UnpluginOptions {
     name: pluginName,
 
     esbuild: {
-      setup({ onLoad, onResolve }) {
+      setup({ initialOptions, onLoad, onResolve }) {
         onResolve({ filter: /.*/ }, (args) => {
           if (args.kind !== "entry-point") {
             return;
           } else {
+            // Injected modules via the esbuild `inject` option do also have `kind == "entry-point"`.
+            // We do not want to inject debug IDs into those files because they are already bundled into the entrypoints
+            if (initialOptions.inject?.includes(args.path)) {
+              return;
+            }
+
             return {
               pluginName,
               // needs to be an abs path, otherwise esbuild will complain
@@ -123,11 +129,17 @@ function esbuildModuleMetadataInjectionPlugin(injectionCode: string): UnpluginOp
     name: pluginName,
 
     esbuild: {
-      setup({ onLoad, onResolve }) {
+      setup({ initialOptions, onLoad, onResolve }) {
         onResolve({ filter: /.*/ }, (args) => {
           if (args.kind !== "entry-point") {
             return;
           } else {
+            // Injected modules via the esbuild `inject` option do also have `kind == "entry-point"`.
+            // We do not want to inject debug IDs into those files because they are already bundled into the entrypoints
+            if (initialOptions.inject?.includes(args.path)) {
+              return;
+            }
+
             return {
               pluginName,
               // needs to be an abs path, otherwise esbuild will complain

diff --git a/packages/integration-tests/fixtures/esbuild-inject-compat/esbuild-inject-compat.test.ts b/packages/integration-tests/fixtures/esbuild-inject-compat/esbuild-inject-compat.test.ts
@@ -1,9 +1,16 @@
 import childProcess from "child_process";
 import path from "path";
+import fs from "fs";
 
 const outputBundlePath = path.join(__dirname, "out", "index.js");
 
 test("check functionality", () => {
   const processOutput = childProcess.execSync(`node ${outputBundlePath}`, { encoding: "utf-8" });
   expect(processOutput).toMatch(/injected fallback/);
 });
+
+test("check that output only contains one debug ID reference", async () => {
+  const bundleContent = await fs.promises.readFile(outputBundlePath, "utf-8");
+  const debugIdReferences = bundleContent.match(/sentry-dbid-/g) ?? [];
+  expect(debugIdReferences).toHaveLength(1);
+});