fix: Always delete files when sourcemaps.filesToDeleteAfterUpload is set

Author: lforst

packages/bundler-plugin-core/src/debug-id-upload.ts

@@ -24,7 +24,7 @@ interface DebugIdUploadPluginOptions {
   handleRecoverableError: (error: unknown) => void;
   sentryHub: Hub;
   sentryClient: NodeClient;
-  filesToDeleteAfterUpload?: string | string[];
+  deleteFilesUpForDeletion: () => Promise<void>;
   sentryCliOptions: {
     url: string;
     authToken: string;
@@ -47,7 +47,7 @@ export function createDebugIdUploadFunction({
   sentryClient,
   sentryCliOptions,
   rewriteSourcesHook,
-  filesToDeleteAfterUpload,
+  deleteFilesUpForDeletion,
 }: DebugIdUploadPluginOptions) {
   return async (buildArtifactPaths: string[]) => {
     const artifactBundleUploadTransaction = sentryHub.startTransaction({
@@ -180,36 +180,7 @@ export function createDebugIdUploadFunction({
         logger.info("Successfully uploaded source maps to Sentry");
       }
 
-      if (filesToDeleteAfterUpload) {
-        const deleteGlobSpan = artifactBundleUploadTransaction.startChild({
-          description: "delete-glob",
-        });
-        const filePathsToDelete = await glob(filesToDeleteAfterUpload, {
-          absolute: true,
-          nodir: true,
-        });
-        deleteGlobSpan.finish();
-
-        filePathsToDelete.forEach((filePathToDelete) => {
-          logger.debug(`Deleting asset after upload: ${filePathToDelete}`);
-        });
-
-        const deleteSpan = artifactBundleUploadTransaction.startChild({
-          description: "delete-files-after-upload",
-        });
-        await Promise.all(
-          filePathsToDelete.map((filePathToDelete) =>
-            fs.promises.rm(filePathToDelete, { force: true }).catch((e) => {
-              // This is allowed to fail - we just don't do anything
-              logger.debug(
-                `An error occured while attempting to delete asset: ${filePathToDelete}`,
-                e
-              );
-            })
-          )
-        );
-        deleteSpan.finish();
-      }
+      await deleteFilesUpForDeletion();
     } catch (e) {
       sentryHub.withScope((scope) => {
         scope.setSpan(artifactBundleUploadTransaction);

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

@@ -25,6 +25,7 @@ import {
 import * as dotenv from "dotenv";
 import { glob } from "glob";
 import { logger } from "@sentry/utils";
+import { fileDeletionPlugin } from "./plugins/sourcemap-deletion";
 
 interface SentryUnpluginFactoryOptions {
   releaseInjectionPlugin: (injectionCode: string) => UnpluginOptions;
@@ -180,6 +181,34 @@ export function sentryUnpluginFactory({
       })
     );
 
+    async function deleteFilesUpForDeletion() {
+      const filesToDeleteAfterUpload =
+        options.sourcemaps?.filesToDeleteAfterUpload ?? options.sourcemaps?.deleteFilesAfterUpload;
+
+      if (filesToDeleteAfterUpload) {
+        const filePathsToDelete = await glob(filesToDeleteAfterUpload, {
+          absolute: true,
+          nodir: true,
+        });
+
+        filePathsToDelete.forEach((filePathToDelete) => {
+          logger.debug(`Deleting asset after upload: ${filePathToDelete}`);
+        });
+
+        await Promise.all(
+          filePathsToDelete.map((filePathToDelete) =>
+            fs.promises.rm(filePathToDelete, { force: true }).catch((e) => {
+              // This is allowed to fail - we just don't do anything
+              logger.debug(
+                `An error occurred while attempting to delete asset: ${filePathToDelete}`,
+                e
+              );
+            })
+          )
+        );
+      }
+    }
+
     if (options.bundleSizeOptimizations) {
       const { bundleSizeOptimizations } = options;
       const replacementValues: SentrySDKBuildFlags = {};
@@ -293,12 +322,22 @@ export function sentryUnpluginFactory({
             vcsRemote: options.release.vcsRemote,
             headers: options.headers,
           },
+          deleteFilesUpForDeletion,
         })
       );
     }
 
     plugins.push(debugIdInjectionPlugin(logger));
 
+    plugins.push(
+      fileDeletionPlugin({
+        deleteFilesUpForDeletion,
+        handleRecoverableError: handleRecoverableError,
+        sentryHub,
+        sentryClient,
+      })
+    );
+
     if (!options.authToken) {
       logger.warn(
         "No auth token provided. Will not upload source maps. Please set the `authToken` option. You can find information on how to generate a Sentry auth token here: https://docs.sentry.io/api/auth/"
@@ -317,9 +356,7 @@ export function sentryUnpluginFactory({
           createDebugIdUploadFunction({
             assets: options.sourcemaps?.assets,
             ignore: options.sourcemaps?.ignore,
-            filesToDeleteAfterUpload:
-              options.sourcemaps?.filesToDeleteAfterUpload ??
-              options.sourcemaps?.deleteFilesAfterUpload,
+            deleteFilesUpForDeletion,
             dist: options.release.dist,
             releaseName: options.release.name,
             logger: logger,

packages/bundler-plugin-core/src/plugins/release-management.ts

@@ -27,6 +27,7 @@ interface ReleaseManagementPluginOptions {
     silent: boolean;
     headers?: Record<string, string>;
   };
+  deleteFilesUpForDeletion: () => Promise<void>;
 }
 
 export function releaseManagementPlugin({
@@ -41,6 +42,7 @@ export function releaseManagementPlugin({
   sentryHub,
   sentryClient,
   sentryCliOptions,
+  deleteFilesUpForDeletion,
 }: ReleaseManagementPluginOptions): UnpluginOptions {
   return {
     name: "sentry-debug-id-upload-plugin",
@@ -83,6 +85,8 @@ export function releaseManagementPlugin({
         if (deployOptions) {
           await cliInstance.releases.newDeploy(releaseName, deployOptions);
         }
+
+        await deleteFilesUpForDeletion();
       } catch (e) {
         sentryHub.captureException('Error in "releaseManagementPlugin" writeBundle hook');
         await safeFlushTelemetry(sentryClient);

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

@@ -0,0 +1,30 @@
+import { Hub, NodeClient } from "@sentry/node";
+import { UnpluginOptions } from "unplugin";
+import { safeFlushTelemetry } from "../sentry/telemetry";
+
+interface FileDeletionPlugin {
+  handleRecoverableError: (error: unknown) => void;
+  deleteFilesUpForDeletion: () => Promise<void>;
+  sentryHub: Hub;
+  sentryClient: NodeClient;
+}
+
+export function fileDeletionPlugin({
+  handleRecoverableError,
+  sentryHub,
+  sentryClient,
+  deleteFilesUpForDeletion,
+}: FileDeletionPlugin): UnpluginOptions {
+  return {
+    name: "sentry-file-deletion-plugin",
+    async buildEnd() {
+      try {
+        await deleteFilesUpForDeletion();
+      } catch (e) {
+        sentryHub.captureException('Error in "sentry-file-deletion-plugin" buildEnd hook');
+        await safeFlushTelemetry(sentryClient);
+        handleRecoverableError(e);
+      }
+    },
+  };
+}