cli, sourcemap-tools: force snippet/comment generation (#219)

* sourcemap-tools: attempt to add snippets and comments if they do not exist

* cli: improve assets logging

* cli: trust sourceProcessor with finding sourcemap path

* cli: always process file with force passed to sourceProcessor

* cli: fix unit tests

* sourcemap-tools: add doc about regexp in DebugIdGenerator

---------

Co-authored-by: Sebastian Alex <sebastian.alex@saucelabs.com>

Author: perf2711

tools/cli/src/helpers/common.ts

@@ -119,7 +119,6 @@ function resolveSourceMapPath(sourceProcessor: SourceProcessor) {
         return pipe(
             asset.path,
             (path) => sourceProcessor.getSourceMapPathFromSourceFile(path),
-            R.map((result) => result ?? pathIfExists(`${asset.path}.map`)),
             R.map((path) => (path ? Ok(path) : Err('could not find source map for source'))),
             R.map((path) => ({
                 ...asset,

tools/cli/src/helpers/logs.ts

@@ -1,26 +1,21 @@
-import { Asset, log, LogLevel, ProcessAssetResult } from '@backtrace/sourcemap-tools';
+import { Asset, log, LogLevel } from '@backtrace/sourcemap-tools';
 import { CliLogger } from '../logger';
 import { SourceAndSourceMapPaths } from '../models/Asset';
 
 export function createAssetLogger(
     logger: CliLogger,
-): (level: LogLevel) => <T extends Asset | ProcessAssetResult>(message: string | ((t: T) => string)) => (asset: T) => T;
+): (level: LogLevel) => <T extends Asset>(message: string | ((t: T) => string)) => (asset: T) => T;
 export function createAssetLogger(
     logger: CliLogger,
     level: LogLevel,
-): <T extends Asset | ProcessAssetResult>(message: string | ((t: T) => string)) => (asset: T) => T;
+): <T extends Asset>(message: string | ((t: T) => string)) => (asset: T) => T;
 export function createAssetLogger(logger: CliLogger, level?: LogLevel) {
     function logAsset(level: LogLevel) {
         const logFn = log(logger, level);
 
-        return function logAsset<T extends Asset | ProcessAssetResult>(message: string | ((t: T) => string)) {
+        return function logAsset<T extends Asset>(message: string | ((t: T) => string)) {
             return function logAsset(asset: T) {
-                return logFn<T>(
-                    (t) =>
-                        `${'name' in t ? t.name : t.asset.name}: ${
-                            typeof message === 'function' ? message(asset) : message
-                        }`,
-                )(asset);
+                return logFn<T>((t) => `${t.name}: ${typeof message === 'function' ? message(asset) : message}`)(asset);
             };
         };
     }
@@ -32,4 +27,4 @@ export const logAssets =
     (logger: CliLogger, level: LogLevel) =>
     (message: string) =>
     <T extends SourceAndSourceMapPaths>(assets: T) =>
-        log(logger, level)<T>(`${assets.source.name}: ${message}`)(assets);
+        log(logger, level)<T>(`${assets.source.name}:${assets.sourceMap?.name ?? '?'}: ${message}`)(assets);

tools/cli/src/sourcemaps/process.ts

@@ -199,28 +199,24 @@ export function processSource(force: boolean) {
         sourceMapDebugId: getSourceMapDebugId(sourceAndSourceMap),
     });
 
-    const shouldProcess = (sourceDebugId: string | undefined, sourceMapDebugId: string | undefined) =>
-        force || !sourceDebugId || !sourceMapDebugId || sourceDebugId !== sourceMapDebugId;
-
     return async function processSource(asset: SourceAndSourceMap): Promise<ProcessedSourceAndSourceMap> {
         return pipe(asset, getDebugIds, ({ sourceDebugId, sourceMapDebugId }) =>
-            shouldProcess(sourceDebugId, sourceMapDebugId)
-                ? pipe(
-                      asset,
-                      (asset) =>
-                          sourceProcessor.processSourceAndSourceMap(
-                              asset.source.content,
-                              asset.sourceMap.content,
-                              sourceDebugId ?? sourceMapDebugId,
-                          ),
-                      (result) =>
-                          ({
-                              source: { ...asset.source, content: result.source },
-                              sourceMap: { ...asset.sourceMap, content: result.sourceMap },
-                              debugId: result.debugId,
-                          } as ProcessedSourceAndSourceMap),
-                  )
-                : ({ ...asset, debugId: sourceDebugId } as ProcessedSourceAndSourceMap),
+            pipe(
+                asset,
+                (asset) =>
+                    sourceProcessor.processSourceAndSourceMap(
+                        asset.source.content,
+                        asset.sourceMap.content,
+                        sourceDebugId ?? sourceMapDebugId,
+                        force,
+                    ),
+                (result) =>
+                    ({
+                        source: { ...asset.source, content: result.source },
+                        sourceMap: { ...asset.sourceMap, content: result.sourceMap },
+                        debugId: result.debugId,
+                    } as ProcessedSourceAndSourceMap),
+            ),
         );
     };
 }

tools/cli/tests/_files/processed-directory-linked-sourcemaps/entry1.js

@@ -1,4 +1,4 @@
-;!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._btDebugIds=e._btDebugIds||{},e._btDebugIds[n]="4fe9a5c9-ab48-b240-9469-04aa2db251b6")}catch(e){}}();
+;!function(){try{var k="_btDebugIds",u="undefined",v="4fe9a5c9-ab48-b240-9469-04aa2db251b6",a=function(x){try{x[k]=x[k]||{};x[k][n]=v}catch{}},n=(new Error).stack;n&&(u!=typeof window?a(window):u);n&&(u!=typeof global?a(global):u);n&&(u!=typeof self?a(self):u);n&&(u!=typeof globalThis?a(globalThis):u)}catch{}}();
 function doSomething() {
     console.log('Done something');
 }

tools/cli/tests/_files/processed-directory-linked-sourcemaps/entry2.js

@@ -1,4 +1,4 @@
-;!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._btDebugIds=e._btDebugIds||{},e._btDebugIds[n]="d538bdaa-8149-8111-25f0-b5c0f472366a")}catch(e){}}();
+;!function(){try{var k="_btDebugIds",u="undefined",v="d538bdaa-8149-8111-25f0-b5c0f472366a",a=function(x){try{x[k]=x[k]||{};x[k][n]=v}catch{}},n=(new Error).stack;n&&(u!=typeof window?a(window):u);n&&(u!=typeof global?a(global):u);n&&(u!=typeof self?a(self):u);n&&(u!=typeof globalThis?a(globalThis):u)}catch{}}();
 function doSomething() {
     console.log('Done something');
 }

tools/cli/tests/_files/processed-not-linked-different-name-sourcemaps/entry1.js

@@ -1,4 +1,4 @@
-;!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._btDebugIds=e._btDebugIds||{},e._btDebugIds[n]="4fe9a5c9-ab48-b240-9469-04aa2db251b6")}catch(e){}}();
+;!function(){try{var k="_btDebugIds",u="undefined",v="4fe9a5c9-ab48-b240-9469-04aa2db251b6",a=function(x){try{x[k]=x[k]||{};x[k][n]=v}catch{}},n=(new Error).stack;n&&(u!=typeof window?a(window):u);n&&(u!=typeof global?a(global):u);n&&(u!=typeof self?a(self):u);n&&(u!=typeof globalThis?a(globalThis):u)}catch{}}();
 function doSomething() {
     console.log('Done something');
 }

tools/cli/tests/_files/processed-not-linked-different-name-sourcemaps/entry2.js

@@ -1,4 +1,4 @@
-;!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._btDebugIds=e._btDebugIds||{},e._btDebugIds[n]="d538bdaa-8149-8111-25f0-b5c0f472366a")}catch(e){}}();
+;!function(){try{var k="_btDebugIds",u="undefined",v="d538bdaa-8149-8111-25f0-b5c0f472366a",a=function(x){try{x[k]=x[k]||{};x[k][n]=v}catch{}},n=(new Error).stack;n&&(u!=typeof window?a(window):u);n&&(u!=typeof global?a(global):u);n&&(u!=typeof self?a(self):u);n&&(u!=typeof globalThis?a(globalThis):u)}catch{}}();
 function doSomething() {
     console.log('Done something');
 }