fix: Wait for tasks depending on sourcemaps before deleting

Author: lforst

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

@@ -24,7 +24,6 @@ interface DebugIdUploadPluginOptions {
   handleRecoverableError: (error: unknown) => void;
   sentryHub: Hub;
   sentryClient: NodeClient;
-  deleteFilesUpForDeletion: () => Promise<void>;
   sentryCliOptions: {
     url: string;
     authToken: string;
@@ -34,6 +33,7 @@ interface DebugIdUploadPluginOptions {
     silent: boolean;
     headers?: Record<string, string>;
   };
+  completeTaskDependingOnSourcemaps: () => void;
 }
 
 export function createDebugIdUploadFunction({
@@ -47,7 +47,7 @@ export function createDebugIdUploadFunction({
   sentryClient,
   sentryCliOptions,
   rewriteSourcesHook,
-  deleteFilesUpForDeletion,
+  completeTaskDependingOnSourcemaps,
 }: DebugIdUploadPluginOptions) {
   return async (buildArtifactPaths: string[]) => {
     const artifactBundleUploadTransaction = sentryHub.startTransaction({
@@ -179,8 +179,6 @@ export function createDebugIdUploadFunction({
         uploadSpan.finish();
         logger.info("Successfully uploaded source maps to Sentry");
       }
-
-      await deleteFilesUpForDeletion();
     } catch (e) {
       sentryHub.withScope((scope) => {
         scope.setSpan(artifactBundleUploadTransaction);
@@ -196,6 +194,7 @@ export function createDebugIdUploadFunction({
         cleanupSpan.finish();
       }
       artifactBundleUploadTransaction.finish();
+      completeTaskDependingOnSourcemaps();
       await safeFlushTelemetry(sentryClient);
     }
   };

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

@@ -185,7 +185,37 @@ export function sentryUnpluginFactory({
       })
     );
 
+    const tasks = new Set<symbol>();
+    const subscribers: (() => void)[] = [];
+
+    function notifySubscribers() {
+      subscribers.forEach((subscriber) => {
+        subscriber();
+      });
+    }
+
+    function createTaskDependingOnSourcemaps() {
+      const taskIdentifier = Symbol();
+      tasks.add(taskIdentifier);
+      return function completeTaskDependingOnSourcemaps() {
+        tasks.delete(taskIdentifier);
+        notifySubscribers();
+      };
+    }
+
     async function deleteFilesUpForDeletion() {
+      await new Promise<void>((resolve) => {
+        subscribers.push(() => {
+          if (tasks.size === 0) {
+            resolve();
+          }
+        });
+
+        if (tasks.size === 0) {
+          resolve();
+        }
+      });
+
       const filesToDeleteAfterUpload =
         options.sourcemaps?.filesToDeleteAfterUpload ?? options.sourcemaps?.deleteFilesAfterUpload;
 
@@ -326,22 +356,13 @@ export function sentryUnpluginFactory({
             vcsRemote: options.release.vcsRemote,
             headers: options.headers,
           },
-          deleteFilesUpForDeletion,
+          completeTaskDependingOnSourcemaps: createTaskDependingOnSourcemaps(),
         })
       );
     }
 
     plugins.push(debugIdInjectionPlugin(logger));
 
-    plugins.push(
-      fileDeletionPlugin({
-        deleteFilesUpForDeletion,
-        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/"
@@ -360,7 +381,7 @@ export function sentryUnpluginFactory({
           createDebugIdUploadFunction({
             assets: options.sourcemaps?.assets,
             ignore: options.sourcemaps?.ignore,
-            deleteFilesUpForDeletion,
+            completeTaskDependingOnSourcemaps: createTaskDependingOnSourcemaps(),
             dist: options.release.dist,
             releaseName: options.release.name,
             logger: logger,
@@ -396,6 +417,15 @@ export function sentryUnpluginFactory({
       }
     }
 
+    plugins.push(
+      fileDeletionPlugin({
+        deleteFilesUpForDeletion,
+        handleRecoverableError,
+        sentryHub,
+        sentryClient,
+      })
+    );
+
     return plugins;
   });
 }

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

@@ -27,7 +27,7 @@ interface ReleaseManagementPluginOptions {
     silent: boolean;
     headers?: Record<string, string>;
   };
-  deleteFilesUpForDeletion: () => Promise<void>;
+  completeTaskDependingOnSourcemaps: () => void;
 }
 
 export function releaseManagementPlugin({
@@ -42,7 +42,7 @@ export function releaseManagementPlugin({
   sentryHub,
   sentryClient,
   sentryCliOptions,
-  deleteFilesUpForDeletion,
+  completeTaskDependingOnSourcemaps,
 }: ReleaseManagementPluginOptions): UnpluginOptions {
   return {
     name: "sentry-debug-id-upload-plugin",
@@ -85,12 +85,12 @@ 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);
         handleRecoverableError(e);
+      } finally {
+        completeTaskDependingOnSourcemaps();
       }
     },
   };