{refactor} use convert-source-map instead of trying to parse sourcemappingUrls

Author: bgotink

.pnp.cjs

@@ -30,6 +30,7 @@
   "devDependencies": {
     "@jridgewell/trace-mapping": "^0.3.17",
     "@playwright/test": "^1.14.1",
+    "@types/convert-source-map": "^2.0.3",
     "@types/istanbul-lib-coverage": "^2.0.3",
     "@types/istanbul-lib-report": "^3.0.0",
     "@types/istanbul-reports": "^3.0.1",
@@ -42,6 +43,7 @@
   "dependencies": {
     "@bcoe/v8-coverage": "^0.2.3",
     "comlink": "^4.4.2",
+    "convert-source-map": "^2.0.0",
     "istanbul-lib-coverage": "^3.2.2",
     "istanbul-lib-report": "^3.0.1",
     "istanbul-reports": "^3.1.7",

package.json

@@ -7,6 +7,7 @@ import {isMatch} from 'micromatch';
 import {join, posix} from 'path';
 import {pathToFileURL, URL} from 'url';
 import v8ToIstanbul from 'v8-to-istanbul';
+import * as convertSourceMap from 'convert-source-map';
 
 export const attachmentName = '@bgotink/playwright-coverage';
 
@@ -44,55 +45,62 @@ export async function getSourceMap(
   url: string,
   source: string,
 ): Promise<EncodedSourceMap | undefined> {
-  const match = source.match(/\/\/# *sourceMappingURL=(.*)/);
-
-  if (match == null) {
-    try {
-      const response = await (
-        await fetch
-      ).default(`${url}.map`, {
-        method: 'GET',
-      });
-
-      return (await response.json()) as EncodedSourceMap;
-    } catch {
-      return undefined;
-    }
+  const inlineMap = convertSourceMap.fromSource(source);
+  if (inlineMap != null) {
+    return inlineMap.sourcemap;
   }
 
-  const resolved = new URL(match[1]!, url);
-
   try {
-    switch (resolved.protocol) {
-      case 'file:':
-        return JSON.parse(await fs.readFile(resolved, 'utf8'));
-      case 'data:': {
-        if (!/^application\/json[,;]/.test(resolved.pathname)) {
-          return undefined;
+    const linkedMap = await convertSourceMap.fromMapFileSource(
+      source,
+      async (file: string): Promise<string> => {
+        const resolved = new URL(file, url);
+
+        switch (resolved.protocol) {
+          case 'file:':
+            return await fs.readFile(resolved, 'utf8');
+          case 'data:': {
+            const comma = resolved.pathname.indexOf(',');
+            const rawData = resolved.pathname.slice(comma + 1);
+            const between = resolved.pathname
+              .slice('application/json;'.length, comma)
+              .split(';');
+
+            const dataString = between.includes('base64')
+              ? Buffer.from(rawData, 'base64url').toString('utf8')
+              : rawData;
+
+            return dataString;
+          }
+          default: {
+            const response = await (
+              await fetch
+            ).default(resolved.href, {
+              method: 'GET',
+            });
+
+            return await response.text();
+          }
         }
+      },
+    );
 
-        const comma = resolved.pathname.indexOf(',');
-        const rawData = resolved.pathname.slice(comma + 1);
-        const between = resolved.pathname
-          .slice('application/json;'.length, comma)
-          .split(';');
+    if (linkedMap != null) {
+      return linkedMap.sourcemap;
+    }
+  } catch {
+    return null!;
+  }
 
-        const dataString = between.includes('base64')
-          ? Buffer.from(rawData, 'base64url').toString('utf8')
-          : rawData;
+  // No source map comments, try to find an implicit sourcemap at `${url}.map`
+  try {
+    const response = await (
+      await fetch
+    ).default(`${url}.map`, {
+      method: 'GET',
+    });
 
-        return JSON.parse(dataString);
-      }
-      default: {
-        const response = await (
-          await fetch
-        ).default(resolved.href, {
-          method: 'GET',
-        });
-
-        return (await response.json()) as EncodedSourceMap;
-      }
-    }
+    return (await response.json()) as EncodedSourceMap;
   } catch {
     return undefined;
   }
@@ -163,10 +171,16 @@ export async function convertToIstanbulCoverage(
       // This path is used to resolve files, but the filename doesn't matter
       join(sourceRoot, 'unused.js'),
       0,
-      {
-        source,
-        sourceMap: {sourcemap: sourceMap},
-      },
+      sourceMap?.mappings
+        ? {
+            source,
+            sourceMap: {sourcemap: sourceMap},
+          }
+        : {
+            source: convertSourceMap.removeMapFileComments(
+              convertSourceMap.removeComments(source),
+            ),
+          },
       path => {
         let isExcluded = isExcludedCache.get(path);
 

src/data.ts

@@ -592,13 +592,15 @@ __metadata:
     "@bcoe/v8-coverage": ^0.2.3
     "@jridgewell/trace-mapping": ^0.3.17
     "@playwright/test": ^1.14.1
+    "@types/convert-source-map": ^2.0.3
     "@types/istanbul-lib-coverage": ^2.0.3
     "@types/istanbul-lib-report": ^3.0.0
     "@types/istanbul-reports": ^3.0.1
     "@types/micromatch": ^4.0.2
     "@types/node": ^16.9.3
     "@types/node-fetch": ^2
     comlink: ^4.4.2
+    convert-source-map: ^2.0.0
     istanbul-lib-coverage: ^3.2.2
     istanbul-lib-report: ^3.0.1
     istanbul-reports: ^3.1.7
@@ -704,6 +706,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/convert-source-map@npm:^2.0.3":
+  version: 2.0.3
+  resolution: "@types/convert-source-map@npm:2.0.3"
+  checksum: 411cf9a02cf5dbe204e325dd5ebf50de00b58b38d1d2a3064c6ea28417c23bae956206eaa9ed3a75a994909b4ab3f9c6389073d0636a62500fa6d6333c64d45a
+  languageName: node
+  linkType: hard
+
 "@types/istanbul-lib-coverage@npm:*, @types/istanbul-lib-coverage@npm:^2.0.0, @types/istanbul-lib-coverage@npm:^2.0.1, @types/istanbul-lib-coverage@npm:^2.0.3":
   version: 2.0.3
   resolution: "@types/istanbul-lib-coverage@npm:2.0.3"