Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /*
Copyright 2015, Yahoo Inc.
Copyrights licensed under the New BSD License. See the accompanying LICENSE file for terms.
*/
import fs from "node:fs";
import path from "node:path";
import { TraceMap, sourceContentFor } from "@jridgewell/trace-mapping";
import type { EncodedSourceMap } from "@jridgewell/trace-mapping";
import type { CoverageMap, FileCoverageData } from "@vitest/istanbul-lib-coverage";
import { createDebug } from "obug";
import * as pathutils from "./pathutils";
import { SourceMapTransformer } from "./transformer";
const debug = createDebug("istanbuljs");
/** file coverage data optionally carrying an inline input source map */
export interface FileCoverageDataWithSourceMap extends FileCoverageData {
inputSourceMap?: EncodedSourceMap;
}
/** minimal storage contract used to keep original source text */
export interface SourceStore {
get(filePath: string): string | undefined;
set(filePath: string, sourceText: string): unknown;
clear(): void;
}
export interface MapStoreOptions {
/** verbose mode */
verbose?: boolean;
/** alternate base directory to resolve sourcemap files */
baseDir?: string | null;
/**
* class to use for SourceStore. Must support `get`, `set` and `clear`
* methods.
*/
SourceStore?: new (...args: any[]) => SourceStore;
/** arguments to use in the SourceStore constructor */
sourceStoreOpts?: unknown[];
}
/** a registered source map: a file path, encoded data or a source map object */
type SourceMapEntry =
| { type: "file"; data: string }
| { type: "encoded"; data: string }
| { type: "object"; data: EncodedSourceMap };
/**
* Tracks source maps for registered files
*/
export class MapStore {
baseDir: string | null;
verbose: boolean;
sourceStore: SourceStore;
data: Record<string, SourceMapEntry>;
/**
* @param {Object} opts [opts=undefined] options.
* @param {Boolean} opts.verbose [opts.verbose=false] verbose mode
* @param {String} opts.baseDir [opts.baseDir=null] alternate base directory
* to resolve sourcemap files
* @param {Class} opts.SourceStore [opts.SourceStore=Map] class to use for
* SourceStore. Must support `get`, `set` and `clear` methods.
* @param {Array} opts.sourceStoreOpts [opts.sourceStoreOpts=[]] arguments
* to use in the SourceStore constructor.
* @constructor
*/
constructor(opts?: MapStoreOptions) {
const options = {
baseDir: null,
verbose: false,
SourceStore: Map,
sourceStoreOpts: [],
...opts,
};
this.baseDir = options.baseDir;
this.verbose = options.verbose;
this.sourceStore = new options.SourceStore(...options.sourceStoreOpts);
this.data = Object.create(null);
this.sourceFinder = this.sourceFinder.bind(this);
}
/**
* Registers a source map URL with this store. It makes some input sanity checks
* and silently fails on malformed input.
* @param transformedFilePath - the file path for which the source map is valid.
* This must *exactly* match the path stashed for the coverage object to be
* useful.
* @param sourceMapUrl - the source map URL, **not** a comment
*/
registerURL(transformedFilePath: string, sourceMapUrl: string): void {
const d = "data:";
if (sourceMapUrl.length > d.length && sourceMapUrl.substring(0, d.length) === d) {
const b64 = "base64,";
const pos = sourceMapUrl.indexOf(b64);
if (pos > 0) {
this.data[transformedFilePath] = {
type: "encoded",
data: sourceMapUrl.substring(pos + b64.length),
};
} else {
debug(`Unable to interpret source map URL: ${sourceMapUrl}`);
}
return;
}
const dir = path.dirname(path.resolve(transformedFilePath));
const file = path.resolve(dir, sourceMapUrl);
this.data[transformedFilePath] = { type: "file", data: file };
}
/**
* Registers a source map object with this store. Makes some basic sanity checks
* and silently fails on malformed input.
* @param transformedFilePath - the file path for which the source map is valid
* @param sourceMap - the source map object
*/
registerMap(transformedFilePath: string, sourceMap: EncodedSourceMap | null | undefined): void {
if (sourceMap && sourceMap.version) {
this.data[transformedFilePath] = {
type: "object",
data: sourceMap,
};
} else {
debug("Invalid source map object: " + JSON.stringify(sourceMap, null, 2));
}
}
/**
* Retrieve a source map object from this store.
* @param filePath - the file path for which the source map is valid
* @returns a parsed source map object
*/
getSourceMapSync(filePath: string): EncodedSourceMap | undefined {
try {
if (!this.data[filePath]) {
return;
}
const d = this.data[filePath];
if (d.type === "file") {
return JSON.parse(fs.readFileSync(d.data, "utf8"));
}
if (d.type === "encoded") {
return JSON.parse(Buffer.from(d.data, "base64").toString());
}
/* The caller might delete properties */
return {
...d.data,
};
} catch (error) {
debug("Error returning source map for " + filePath);
debug((error as Error).stack);
return;
}
}
/**
* Add inputSourceMap property to coverage data
* @param coverageData - the __coverage__ object
*/
addInputSourceMapsSync(coverageData: Record<string, FileCoverageDataWithSourceMap>): void {
Object.entries(coverageData).forEach(([filePath, data]) => {
if (data.inputSourceMap) {
return;
}
const sourceMap = this.getSourceMapSync(filePath);
if (sourceMap) {
data.inputSourceMap = sourceMap;
/* This huge property is not needed. */
delete data.inputSourceMap.sourcesContent;
}
});
}
sourceFinder(filePath: string): string {
const content = this.sourceStore.get(filePath);
if (content !== undefined) {
return content;
}
if (path.isAbsolute(filePath)) {
return fs.readFileSync(filePath, "utf8");
}
return fs.readFileSync(pathutils.asAbsolute(filePath, this.baseDir), "utf8");
}
/**
* Transforms the coverage map provided into one that refers to original
* sources when valid mappings have been registered with this store.
* @param coverageMap - the coverage map to transform
* @returns the transformed coverage map
*/
async transformCoverage(coverageMap: CoverageMap): Promise<CoverageMap> {
const hasInputSourceMaps = coverageMap
.files()
.some(
(file) =>
(coverageMap.fileCoverageFor(file).data as FileCoverageDataWithSourceMap).inputSourceMap,
);
Iif (!hasInputSourceMaps && Object.keys(this.data).length === 0) {
return coverageMap;
}
const transformer = new SourceMapTransformer(async (filePath, coverage) => {
try {
const obj =
(coverage.data as FileCoverageDataWithSourceMap).inputSourceMap ||
this.getSourceMapSync(filePath);
Iif (!obj) {
return null;
}
const smc = new TraceMap(obj);
smc.sources.forEach((s) => {
Eif (s) {
const content = sourceContentFor(smc, s);
Iif (content) {
const sourceFilePath = pathutils.relativeTo(s, filePath);
this.sourceStore.set(sourceFilePath, content);
}
}
});
return smc;
} catch (error) {
debug("Error returning source map for " + filePath);
debug((error as Error).stack);
return null;
}
});
return await transformer.transform(coverageMap);
}
/**
* Disposes temporary resources allocated by this map store
*/
dispose(): void {
this.sourceStore.clear();
}
}
|