mirror of
https://github.com/angular/angular
synced 2026-05-24 09:28:37 +00:00
dc06873c72
When a source-map has an inline source, any source-map linked from that source should only be loaded if itself is also inline; it should not attempt to load a source-map from the file-system. Otherwise we can find ourselves with inadvertent infinite cyclic dependencies. For example, if a transpiler takes a file (e.g. index.js) and generates a new file overwriting the original file - capturing the original source inline in the new source-map (index.js.map) - the source file loader might read the inline original file (also index.js) and then try to load the `index.js.map` file from disk - ad infinitum. Note that the first call to `loadSourceFile()` is special, since you can pass in the source-file and source-map contents directly as in-memory strrngs. This is common if the transpiler has just generated these and has not yet written them to disk. When the contents are passed into `loadSourceFile()` directly, they are not treated as "inline" for the purposes described above since there is no chance of these "in-memory" source and source-map contents being caught up in a cyclic dependency. Fixes #40408 PR Close #40435
72 lines
3.1 KiB
TypeScript
72 lines
3.1 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
import {fromObject, generateMapFileComment, SourceMapConverter} from 'convert-source-map';
|
|
import MagicString from 'magic-string';
|
|
import * as ts from 'typescript';
|
|
|
|
import {absoluteFrom, absoluteFromSourceFile, ReadonlyFileSystem} from '../../../src/ngtsc/file_system';
|
|
import {Logger} from '../../../src/ngtsc/logging';
|
|
import {ContentOrigin, RawSourceMap, SourceFileLoader} from '../../../src/ngtsc/sourcemaps';
|
|
|
|
import {FileToWrite} from './utils';
|
|
|
|
export interface SourceMapInfo {
|
|
source: string;
|
|
map: SourceMapConverter|null;
|
|
isInline: boolean;
|
|
}
|
|
|
|
/**
|
|
* Merge the input and output source-maps, replacing the source-map comment in the output file
|
|
* with an appropriate source-map comment pointing to the merged source-map.
|
|
*/
|
|
export function renderSourceAndMap(
|
|
logger: Logger, fs: ReadonlyFileSystem, sourceFile: ts.SourceFile,
|
|
generatedMagicString: MagicString): FileToWrite[] {
|
|
const sourceFilePath = absoluteFromSourceFile(sourceFile);
|
|
const sourceMapPath = absoluteFrom(`${sourceFilePath}.map`);
|
|
const generatedContent = generatedMagicString.toString();
|
|
const generatedMap: RawSourceMap = generatedMagicString.generateMap(
|
|
{file: sourceFilePath, source: sourceFilePath, includeContent: true});
|
|
|
|
try {
|
|
const loader = new SourceFileLoader(fs, logger, {});
|
|
const generatedFile = loader.loadSourceFile(
|
|
sourceFilePath, generatedContent, {map: generatedMap, mapPath: sourceMapPath});
|
|
|
|
const rawMergedMap: RawSourceMap = generatedFile.renderFlattenedSourceMap();
|
|
const mergedMap = fromObject(rawMergedMap);
|
|
const originalFile = loader.loadSourceFile(sourceFilePath, generatedMagicString.original);
|
|
if (originalFile.rawMap === null && !sourceFile.isDeclarationFile ||
|
|
originalFile.rawMap?.origin === ContentOrigin.Inline) {
|
|
// We render an inline source map if one of:
|
|
// * there was no input source map and this is not a typings file;
|
|
// * the input source map exists and was inline.
|
|
//
|
|
// We do not generate inline source maps for typings files unless there explicitly was one in
|
|
// the input file because these inline source maps can be very large and it impacts on the
|
|
// performance of IDEs that need to read them to provide intellisense etc.
|
|
return [
|
|
{path: sourceFilePath, contents: `${generatedFile.contents}\n${mergedMap.toComment()}`}
|
|
];
|
|
}
|
|
|
|
const sourceMapComment = generateMapFileComment(`${fs.basename(sourceFilePath)}.map`);
|
|
return [
|
|
{path: sourceFilePath, contents: `${generatedFile.contents}\n${sourceMapComment}`},
|
|
{path: sourceMapPath, contents: mergedMap.toJSON()}
|
|
];
|
|
} catch (e) {
|
|
logger.error(`Error when flattening the source-map "${sourceMapPath}" for "${
|
|
sourceFilePath}": ${e.toString()}`);
|
|
return [
|
|
{path: sourceFilePath, contents: generatedContent},
|
|
{path: sourceMapPath, contents: fromObject(generatedMap).toJSON()},
|
|
];
|
|
}
|
|
}
|