feat(core): Accept and await a promise in sourcemaps.filesToDeleteAfterUpload

Author: Lms24

packages/bundler-plugin-core/src/plugins/sourcemap-deletion.ts

@@ -11,7 +11,7 @@ interface FileDeletionPlugin {
   waitUntilSourcemapFileDependenciesAreFreed: () => Promise<void>;
   sentryScope: Scope;
   sentryClient: Client;
-  filesToDeleteAfterUpload: string | string[] | undefined;
+  filesToDeleteAfterUpload: string | string[] | Promise<string | string[]> | undefined;
   logger: Logger;
 }
 
@@ -28,7 +28,9 @@ export function fileDeletionPlugin({
     async writeBundle() {
       try {
         if (filesToDeleteAfterUpload !== undefined) {
-          const filePathsToDelete = await glob(filesToDeleteAfterUpload, {
+          const filesToDelete = await filesToDeleteAfterUpload;
+
+          const filePathsToDelete = await glob(filesToDelete, {
             absolute: true,
             nodir: true,
           });

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

@@ -132,9 +132,13 @@ export interface Options {
      *
      * The globbing patterns follow the implementation of the `glob` package. (https://www.npmjs.com/package/glob)
      *
+     * Note: If you pass in a promise that resolves to a string or array, the plugin will await the promise and use
+     * the resolved value globs. This is useful if you need to dynamically determine the files to delete. Some
+     * higher-level Sentry SDKs or options use this feature (e.g. SvelteKit).
+     *
      * Use the `debug` option to print information about which files end up being deleted.
      */
-    filesToDeleteAfterUpload?: string | string[];
+    filesToDeleteAfterUpload?: string | string[] | Promise<string | string[]>;
   };
 
   /**

packages/integration-tests/fixtures/after-upload-deletion-promise/after-upload-deletion.test.ts

@@ -0,0 +1,27 @@
+/* eslint-disable jest/no-standalone-expect */
+/* eslint-disable jest/expect-expect */
+import path from "path";
+import fs from "fs";
+import { testIfNodeMajorVersionIsLessThan18 } from "../../utils/testIf";
+
+describe("Deletes files with `filesToDeleteAfterUpload` set to a promise", () => {
+  testIfNodeMajorVersionIsLessThan18("webpack 4 bundle", () => {
+    expect(fs.existsSync(path.join(__dirname, "out", "webpack4", "bundle.js.map"))).toBe(false);
+  });
+
+  test("webpack 5 bundle", () => {
+    expect(fs.existsSync(path.join(__dirname, "out", "webpack5", "bundle.js.map"))).toBe(false);
+  });
+
+  test("esbuild bundle", () => {
+    expect(fs.existsSync(path.join(__dirname, "out", "esbuild", "bundle.js.map"))).toBe(false);
+  });
+
+  test("rollup bundle", () => {
+    expect(fs.existsSync(path.join(__dirname, "out", "rollup", "bundle.js.map"))).toBe(false);
+  });
+
+  test("vite bundle", () => {
+    expect(fs.existsSync(path.join(__dirname, "out", "vite", "bundle.js.map"))).toBe(false);
+  });
+});

packages/integration-tests/fixtures/after-upload-deletion-promise/input/bundle.js

@@ -0,0 +1,2 @@
+// eslint-disable-next-line no-console
+console.log("whatever");

packages/integration-tests/fixtures/after-upload-deletion-promise/setup.ts

@@ -0,0 +1,25 @@
+import * as path from "path";
+import { createCjsBundles } from "../../utils/create-cjs-bundles";
+
+const outputDir = path.resolve(__dirname, "out");
+
+["webpack4", "webpack5", "esbuild", "rollup", "vite"].forEach((bundler) => {
+  const fileDeletionGlobPromise = new Promise<string[]>((resolve) => {
+    setTimeout(() => {
+      resolve([path.join(__dirname, "out", bundler, "bundle.js.map")]);
+    }, 1000);
+  });
+
+  createCjsBundles(
+    {
+      bundle: path.resolve(__dirname, "input", "bundle.js"),
+    },
+    outputDir,
+    {
+      sourcemaps: {
+        filesToDeleteAfterUpload: fileDeletionGlobPromise,
+      },
+    },
+    [bundler]
+  );
+});