feat(core): Implements rewrite sources for debug ID upload (#243)

Author: Luca Forstner

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

@@ -206,6 +206,7 @@ export function sentryUnpluginFactory({
             releaseName: options.release.name,
             logger: logger,
             handleRecoverableError: handleRecoverableError,
+            rewriteSourcesHook: options.sourcemaps.rewriteSources,
             sentryHub,
             sentryClient,
             sentryCliOptions: {

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

@@ -9,12 +9,17 @@ import { promisify } from "util";
 import { Hub, NodeClient } from "@sentry/node";
 import SentryCli from "@sentry/cli";
 
+interface RewriteSourcesHook {
+  (source: string, map: any): string;
+}
+
 interface DebugIdUploadPluginOptions {
   logger: Logger;
   assets: string | string[];
   ignore?: string | string[];
   releaseName?: string;
   dist?: string;
+  rewriteSourcesHook?: RewriteSourcesHook;
   handleRecoverableError: (error: unknown) => void;
   sentryHub: Hub;
   sentryClient: NodeClient;
@@ -40,6 +45,7 @@ export function debugIdUploadPlugin({
   sentryHub,
   sentryClient,
   sentryCliOptions,
+  rewriteSourcesHook,
   deleteFilesAfterUpload,
 }: DebugIdUploadPluginOptions): UnpluginOptions {
   return {
@@ -75,7 +81,8 @@ export function debugIdUploadPlugin({
               chunkFilePath,
               tmpUploadFolder,
               String(chunkIndex),
-              logger
+              logger,
+              rewriteSourcesHook ?? defaultRewriteSourcesHook
             );
           })
         );
@@ -124,7 +131,8 @@ export async function prepareBundleForDebugIdUpload(
   bundleFilePath: string,
   uploadFolder: string,
   uniqueUploadName: string,
-  logger: Logger
+  logger: Logger,
+  rewriteSourcesHook: RewriteSourcesHook
 ) {
   let bundleContent;
   try {
@@ -162,6 +170,7 @@ export async function prepareBundleForDebugIdUpload(
         sourceMapPath,
         path.join(uploadFolder, `${uniqueUploadName}.js.map`),
         debugId,
+        rewriteSourcesHook,
         logger
       );
     }
@@ -229,6 +238,7 @@ async function prepareSourceMapForDebugIdUpload(
   sourceMapPath: string,
   targetPath: string,
   debugId: string,
+  rewriteSourcesHook: RewriteSourcesHook,
   logger: Logger
 ): Promise<void> {
   let sourceMapFileContent: string;
@@ -241,9 +251,9 @@ async function prepareSourceMapForDebugIdUpload(
     return;
   }
 
-  let map: Record<string, string>;
+  let map: Record<string, unknown>;
   try {
-    map = JSON.parse(sourceMapFileContent) as Record<string, string>;
+    map = JSON.parse(sourceMapFileContent) as { sources: unknown; [key: string]: unknown };
     // For now we write both fields until we know what will become the standard - if ever.
     map["debug_id"] = debugId;
     map["debugId"] = debugId;
@@ -252,6 +262,10 @@ async function prepareSourceMapForDebugIdUpload(
     return;
   }
 
+  if (map["sources"] && Array.isArray(map["sources"])) {
+    map["sources"].map((source: string) => rewriteSourcesHook(source, map));
+  }
+
   try {
     await util.promisify(fs.writeFile)(targetPath, JSON.stringify(map), {
       encoding: "utf8",
@@ -261,3 +275,12 @@ async function prepareSourceMapForDebugIdUpload(
     return;
   }
 }
+
+const PROTOCOL_REGEX = /^[a-zA-Z][a-zA-Z0-9+\-.]*:\/\//;
+function defaultRewriteSourcesHook(source: string): string {
+  if (source.match(PROTOCOL_REGEX)) {
+    return source.replace(PROTOCOL_REGEX, "");
+  } else {
+    return path.relative(process.cwd(), path.normalize(source));
+  }
+}

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

@@ -114,8 +114,6 @@ export interface Options {
      * Hook to rewrite the `sources` field inside the source map before being uploaded to Sentry. Does not modify the actual source map.
      *
      * Defaults to making all sources relative to `process.cwd()` while building.
-     *
-     * @hidden Not yet implemented.
      */
     rewriteSources?: (source: string, map: any) => string;