iSharkFly-Docs
/
angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refactor(compiler-cli): avoid free-standing `FileSystem` functions (#39006) 

These free standing functions rely upon the "current" `FileSystem`,
but it is safer to explicitly pass the `FileSystem` into functions or
classes that need it.

PR Close #39006
This commit is contained in:
Pete Bacon Darwin 2020-09-26 13:58:47 +01:00 committed by Joey Perrott
parent 23e2188192
commit ac3aa046e5
3 changed files with 47 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
packages/compiler-cli/src/ngtsc/sourcemaps/src/source_file.ts
View File

@ -8,7 +8,7 @@
import {removeComments, removeMapFileComments} from 'convert-source-map'; import {removeComments, removeMapFileComments} from 'convert-source-map';
import {decode, encode, SourceMapMappings, SourceMapSegment} from 'sourcemap-codec'; import {decode, encode, SourceMapMappings, SourceMapSegment} from 'sourcemap-codec';
import {AbsoluteFsPath, dirname, relative} from '../../file_system'; import {AbsoluteFsPath, FileSystem} from '../../file_system';
import {RawSourceMap} from './raw_source_map'; import {RawSourceMap} from './raw_source_map';
import {compareSegments, offsetSegment, SegmentMarker} from './segment_marker'; import {compareSegments, offsetSegment, SegmentMarker} from './segment_marker';
@ -38,7 +38,9 @@ export class SourceFile {
/** Whether this source file's source map was inline or external. */ /** Whether this source file's source map was inline or external. */
readonly inline: boolean, readonly inline: boolean,
/** Any source files referenced by the raw source map associated with this source file. */ /** Any source files referenced by the raw source map associated with this source file. */
readonly sources: (SourceFile|null)[]) { readonly sources: (SourceFile|null)[],
private fs: FileSystem,
) {
this.contents = removeSourceMapComments(contents); this.contents = removeSourceMapComments(contents);
this.startOfLinePositions = computeStartOfLinePositions(this.contents); this.startOfLinePositions = computeStartOfLinePositions(this.contents);
this.flattenedMappings = this.flattenMappings(); this.flattenedMappings = this.flattenMappings();
@ -75,11 +77,11 @@ export class SourceFile {
mappings[line].push(mappingArray); mappings[line].push(mappingArray);
} }
const sourcePathDir = dirname(this.sourcePath); const sourcePathDir = this.fs.dirname(this.sourcePath);
const sourceMap: RawSourceMap = { const sourceMap: RawSourceMap = {
version: 3, version: 3,
file: relative(sourcePathDir, this.sourcePath), file: this.fs.relative(sourcePathDir, this.sourcePath),
sources: sources.map(sf => relative(sourcePathDir, sf.sourcePath)), sources: sources.map(sf => this.fs.relative(sourcePathDir, sf.sourcePath)),
names, names,
mappings: encode(mappings), mappings: encode(mappings),
sourcesContent: sources.map(sf => sf.contents), sourcesContent: sources.map(sf => sf.contents),

6
packages/compiler-cli/src/ngtsc/sourcemaps/src/source_file_loader.ts
View File

@ -7,7 +7,7 @@
*/ */
import {commentRegex, fromComment, mapFileCommentRegex} from 'convert-source-map'; import {commentRegex, fromComment, mapFileCommentRegex} from 'convert-source-map';
import {absoluteFrom, AbsoluteFsPath, FileSystem} from '../../file_system'; import {AbsoluteFsPath, FileSystem} from '../../file_system';
import {Logger} from '../../logging'; import {Logger} from '../../logging';
import {RawSourceMap} from './raw_source_map'; import {RawSourceMap} from './raw_source_map';
@ -83,7 +83,7 @@ export class SourceFileLoader {
inline = mapAndPath.mapPath === null; inline = mapAndPath.mapPath === null;
} }
return new SourceFile(sourcePath, contents, map, inline, sources); return new SourceFile(sourcePath, contents, map, inline, sources, this.fs);
} catch (e) { } catch (e) {
this.logger.warn( this.logger.warn(
`Unable to fully load ${sourcePath} for source-map flattening: ${e.message}`); `Unable to fully load ${sourcePath} for source-map flattening: ${e.message}`);
@ -124,7 +124,7 @@ export class SourceFileLoader {
} }
} }
const impliedMapPath = absoluteFrom(sourcePath + '.map'); const impliedMapPath = this.fs.resolve(sourcePath + '.map');
if (this.fs.exists(impliedMapPath)) { if (this.fs.exists(impliedMapPath)) {
return {map: this.readRawSourceMap(impliedMapPath), mapPath: impliedMapPath}; return {map: this.readRawSourceMap(impliedMapPath), mapPath: impliedMapPath};
} }

69
packages/compiler-cli/src/ngtsc/sourcemaps/test/source_file_spec.ts
View File

@ -7,7 +7,7 @@
*/ */
import {encode} from 'sourcemap-codec'; import {encode} from 'sourcemap-codec';
import {absoluteFrom} from '../../file_system'; import {absoluteFrom, FileSystem, getFileSystem} from '../../file_system';
import {runInEachFileSystem} from '../../file_system/testing'; import {runInEachFileSystem} from '../../file_system/testing';
import {RawSourceMap} from '../src/raw_source_map'; import {RawSourceMap} from '../src/raw_source_map';
import {SegmentMarker} from '../src/segment_marker'; import {SegmentMarker} from '../src/segment_marker';
@ -15,9 +15,11 @@ import {computeStartOfLinePositions, ensureOriginalSegmentLinks, extractOriginal
runInEachFileSystem(() => { runInEachFileSystem(() => {
describe('SourceFile and utilities', () => { describe('SourceFile and utilities', () => {
let fs: FileSystem;
let _: typeof absoluteFrom; let _: typeof absoluteFrom;
beforeEach(() => { beforeEach(() => {
fs = getFileSystem();
_ = absoluteFrom; _ = absoluteFrom;
}); });
@ -40,7 +42,7 @@ runInEachFileSystem(() => {
sources: ['a.js'], sources: ['a.js'],
version: 3 version: 3
}; };
const originalSource = new SourceFile(_('/foo/src/a.js'), 'abcdefg', null, false, []); const originalSource = new SourceFile(_('/foo/src/a.js'), 'abcdefg', null, false, [], fs);
const mappings = parseMappings(rawSourceMap, [originalSource], [0, 8]); const mappings = parseMappings(rawSourceMap, [originalSource], [0, 8]);
expect(mappings).toEqual([ expect(mappings).toEqual([
{ {
@ -71,7 +73,8 @@ runInEachFileSystem(() => {
it('should parse the segments in ascending order of original position from the raw source map', it('should parse the segments in ascending order of original position from the raw source map',
() => { () => {
const originalSource = new SourceFile(_('/foo/src/a.js'), 'abcdefg', null, false, []); const originalSource =
new SourceFile(_('/foo/src/a.js'), 'abcdefg', null, false, [], fs);
const rawSourceMap: RawSourceMap = { const rawSourceMap: RawSourceMap = {
mappings: encode([[[0, 0, 0, 0], [2, 0, 0, 3], [4, 0, 0, 2]]]), mappings: encode([[[0, 0, 0, 0], [2, 0, 0, 3], [4, 0, 0, 2]]]),
names: [], names: [],
@ -88,8 +91,8 @@ runInEachFileSystem(() => {
}); });
it('should create separate arrays for each original source file', () => { it('should create separate arrays for each original source file', () => {
const sourceA = new SourceFile(_('/foo/src/a.js'), 'abcdefg', null, false, []); const sourceA = new SourceFile(_('/foo/src/a.js'), 'abcdefg', null, false, [], fs);
const sourceB = new SourceFile(_('/foo/src/b.js'), '1234567', null, false, []); const sourceB = new SourceFile(_('/foo/src/b.js'), '1234567', null, false, [], fs);
const rawSourceMap: RawSourceMap = { const rawSourceMap: RawSourceMap = {
mappings: mappings:
encode([[[0, 0, 0, 0], [2, 1, 0, 3], [4, 0, 0, 2], [5, 1, 0, 5], [6, 1, 0, 2]]]), encode([[[0, 0, 0, 0], [2, 1, 0, 3], [4, 0, 0, 2], [5, 1, 0, 5], [6, 1, 0, 2]]]),
@ -313,8 +316,8 @@ runInEachFileSystem(() => {
describe('ensureOriginalSegmentLinks', () => { describe('ensureOriginalSegmentLinks', () => {
it('should add `next` properties to each segment that point to the next segment in the same source file', it('should add `next` properties to each segment that point to the next segment in the same source file',
() => { () => {
const sourceA = new SourceFile(_('/foo/src/a.js'), 'abcdefg', null, false, []); const sourceA = new SourceFile(_('/foo/src/a.js'), 'abcdefg', null, false, [], fs);
const sourceB = new SourceFile(_('/foo/src/b.js'), '1234567', null, false, []); const sourceB = new SourceFile(_('/foo/src/b.js'), '1234567', null, false, [], fs);
const rawSourceMap: RawSourceMap = { const rawSourceMap: RawSourceMap = {
mappings: mappings:
encode([[[0, 0, 0, 0], [2, 1, 0, 3], [4, 0, 0, 2], [5, 1, 0, 5], [6, 1, 0, 2]]]), encode([[[0, 0, 0, 0], [2, 1, 0, 3], [4, 0, 0, 2], [5, 1, 0, 5], [6, 1, 0, 2]]]),
@ -336,14 +339,14 @@ runInEachFileSystem(() => {
describe('flattenedMappings', () => { describe('flattenedMappings', () => {
it('should be an empty array for source files with no source map', () => { it('should be an empty array for source files with no source map', () => {
const sourceFile = const sourceFile =
new SourceFile(_('/foo/src/index.js'), 'index contents', null, false, []); new SourceFile(_('/foo/src/index.js'), 'index contents', null, false, [], fs);
expect(sourceFile.flattenedMappings).toEqual([]); expect(sourceFile.flattenedMappings).toEqual([]);
}); });
it('should be empty array for source files with no source map mappings', () => { it('should be empty array for source files with no source map mappings', () => {
const rawSourceMap: RawSourceMap = {mappings: '', names: [], sources: [], version: 3}; const rawSourceMap: RawSourceMap = {mappings: '', names: [], sources: [], version: 3};
const sourceFile = const sourceFile =
new SourceFile(_('/foo/src/index.js'), 'index contents', rawSourceMap, false, []); new SourceFile(_('/foo/src/index.js'), 'index contents', rawSourceMap, false, [], fs);
expect(sourceFile.flattenedMappings).toEqual([]); expect(sourceFile.flattenedMappings).toEqual([]);
}); });
@ -355,16 +358,17 @@ runInEachFileSystem(() => {
sources: ['a.js'], sources: ['a.js'],
version: 3 version: 3
}; };
const originalSource = new SourceFile(_('/foo/src/a.js'), 'abcdefg', null, false, []); const originalSource =
new SourceFile(_('/foo/src/a.js'), 'abcdefg', null, false, [], fs);
const sourceFile = new SourceFile( const sourceFile = new SourceFile(
_('/foo/src/index.js'), 'abc123defg', rawSourceMap, false, [originalSource]); _('/foo/src/index.js'), 'abc123defg', rawSourceMap, false, [originalSource], fs);
expect(removeOriginalSegmentLinks(sourceFile.flattenedMappings)) expect(removeOriginalSegmentLinks(sourceFile.flattenedMappings))
.toEqual(parseMappings(rawSourceMap, [originalSource], [0, 11])); .toEqual(parseMappings(rawSourceMap, [originalSource], [0, 11]));
}); });
it('should merge mappings from flattened original source files', () => { it('should merge mappings from flattened original source files', () => {
const cSource = new SourceFile(_('/foo/src/c.js'), 'bcd123', null, false, []); const cSource = new SourceFile(_('/foo/src/c.js'), 'bcd123', null, false, [], fs);
const dSource = new SourceFile(_('/foo/src/d.js'), 'aef', null, false, []); const dSource = new SourceFile(_('/foo/src/d.js'), 'aef', null, false, [], fs);
const bSourceMap: RawSourceMap = { const bSourceMap: RawSourceMap = {
mappings: encode([[[0, 1, 0, 0], [1, 0, 0, 0], [4, 1, 0, 1]]]), mappings: encode([[[0, 1, 0, 0], [1, 0, 0, 0], [4, 1, 0, 1]]]),
@ -372,8 +376,8 @@ runInEachFileSystem(() => {
sources: ['c.js', 'd.js'], sources: ['c.js', 'd.js'],
version: 3 version: 3
}; };
const bSource = const bSource = new SourceFile(
new SourceFile(_('/foo/src/b.js'), 'abcdef', bSourceMap, false, [cSource, dSource]); _('/foo/src/b.js'), 'abcdef', bSourceMap, false, [cSource, dSource], fs);
const aSourceMap: RawSourceMap = { const aSourceMap: RawSourceMap = {
mappings: encode([[[0, 0, 0, 0], [2, 0, 0, 3], [4, 0, 0, 2], [5, 0, 0, 5]]]), mappings: encode([[[0, 0, 0, 0], [2, 0, 0, 3], [4, 0, 0, 2], [5, 0, 0, 5]]]),
@ -382,7 +386,7 @@ runInEachFileSystem(() => {
version: 3 version: 3
}; };
const aSource = const aSource =
new SourceFile(_('/foo/src/a.js'), 'abdecf', aSourceMap, false, [bSource]); new SourceFile(_('/foo/src/a.js'), 'abdecf', aSourceMap, false, [bSource], fs);
expect(removeOriginalSegmentLinks(aSource.flattenedMappings)).toEqual([ expect(removeOriginalSegmentLinks(aSource.flattenedMappings)).toEqual([
{ {
@ -431,7 +435,8 @@ runInEachFileSystem(() => {
sources: ['c.js'], sources: ['c.js'],
version: 3 version: 3
}; };
const bSource = new SourceFile(_('/foo/src/b.js'), 'abcdef', bSourceMap, false, [null]); const bSource =
new SourceFile(_('/foo/src/b.js'), 'abcdef', bSourceMap, false, [null], fs);
const aSourceMap: RawSourceMap = { const aSourceMap: RawSourceMap = {
mappings: encode([[[0, 0, 0, 0], [2, 0, 0, 3], [4, 0, 0, 2], [5, 0, 0, 5]]]), mappings: encode([[[0, 0, 0, 0], [2, 0, 0, 3], [4, 0, 0, 2], [5, 0, 0, 5]]]),
names: [], names: [],
@ -439,7 +444,7 @@ runInEachFileSystem(() => {
version: 3 version: 3
}; };
const aSource = const aSource =
new SourceFile(_('/foo/src/a.js'), 'abdecf', aSourceMap, false, [bSource]); new SourceFile(_('/foo/src/a.js'), 'abdecf', aSourceMap, false, [bSource], fs);
// These flattened mappings are just the mappings from a to b. // These flattened mappings are just the mappings from a to b.
// (The mappings to c are dropped since there is no source file to map to.) // (The mappings to c are dropped since there is no source file to map to.)
@ -462,7 +467,7 @@ runInEachFileSystem(() => {
describe('renderFlattenedSourceMap()', () => { describe('renderFlattenedSourceMap()', () => {
it('should convert the flattenedMappings into a raw source-map object', () => { it('should convert the flattenedMappings into a raw source-map object', () => {
const cSource = new SourceFile(_('/foo/src/c.js'), 'bcd123e', null, false, []); const cSource = new SourceFile(_('/foo/src/c.js'), 'bcd123e', null, false, [], fs);
const bToCSourceMap: RawSourceMap = { const bToCSourceMap: RawSourceMap = {
mappings: encode([[[1, 0, 0, 0], [4, 0, 0, 3], [4, 0, 0, 6], [5, 0, 0, 7]]]), mappings: encode([[[1, 0, 0, 0], [4, 0, 0, 3], [4, 0, 0, 6], [5, 0, 0, 7]]]),
names: [], names: [],
@ -470,7 +475,7 @@ runInEachFileSystem(() => {
version: 3 version: 3
}; };
const bSource = const bSource =
new SourceFile(_('/foo/src/b.js'), 'abcdef', bToCSourceMap, false, [cSource]); new SourceFile(_('/foo/src/b.js'), 'abcdef', bToCSourceMap, false, [cSource], fs);
const aToBSourceMap: RawSourceMap = { const aToBSourceMap: RawSourceMap = {
mappings: encode([[[0, 0, 0, 0], [2, 0, 0, 3], [4, 0, 0, 2], [5, 0, 0, 5]]]), mappings: encode([[[0, 0, 0, 0], [2, 0, 0, 3], [4, 0, 0, 2], [5, 0, 0, 5]]]),
names: [], names: [],
@ -478,7 +483,7 @@ runInEachFileSystem(() => {
version: 3 version: 3
}; };
const aSource = const aSource =
new SourceFile(_('/foo/src/a.js'), 'abdecf', aToBSourceMap, false, [bSource]); new SourceFile(_('/foo/src/a.js'), 'abdecf', aToBSourceMap, false, [bSource], fs);
const aTocSourceMap = aSource.renderFlattenedSourceMap(); const aTocSourceMap = aSource.renderFlattenedSourceMap();
expect(aTocSourceMap.version).toEqual(3); expect(aTocSourceMap.version).toEqual(3);
@ -493,7 +498,7 @@ runInEachFileSystem(() => {
}); });
it('should handle mappings that map from lines outside of the actual content lines', () => { it('should handle mappings that map from lines outside of the actual content lines', () => {
const bSource = new SourceFile(_('/foo/src/b.js'), 'abcdef', null, false, []); const bSource = new SourceFile(_('/foo/src/b.js'), 'abcdef', null, false, [], fs);
const aToBSourceMap: RawSourceMap = { const aToBSourceMap: RawSourceMap = {
mappings: encode([ mappings: encode([
[[0, 0, 0, 0], [2, 0, 0, 3], [4, 0, 0, 2], [5, 0, 0, 5]], [[0, 0, 0, 0], [2, 0, 0, 3], [4, 0, 0, 2], [5, 0, 0, 5]],
@ -506,7 +511,7 @@ runInEachFileSystem(() => {
version: 3 version: 3
}; };
const aSource = const aSource =
new SourceFile(_('/foo/src/a.js'), 'abdecf', aToBSourceMap, false, [bSource]); new SourceFile(_('/foo/src/a.js'), 'abdecf', aToBSourceMap, false, [bSource], fs);
const aTocSourceMap = aSource.renderFlattenedSourceMap(); const aTocSourceMap = aSource.renderFlattenedSourceMap();
expect(aTocSourceMap.version).toEqual(3); expect(aTocSourceMap.version).toEqual(3);
@ -522,13 +527,13 @@ runInEachFileSystem(() => {
describe('getOriginalLocation()', () => { describe('getOriginalLocation()', () => {
it('should return null for source files with no flattened mappings', () => { it('should return null for source files with no flattened mappings', () => {
const sourceFile = const sourceFile =
new SourceFile(_('/foo/src/index.js'), 'index contents', null, false, []); new SourceFile(_('/foo/src/index.js'), 'index contents', null, false, [], fs);
expect(sourceFile.getOriginalLocation(1, 1)).toEqual(null); expect(sourceFile.getOriginalLocation(1, 1)).toEqual(null);
}); });
it('should return offset locations in multiple flattened original source files', () => { it('should return offset locations in multiple flattened original source files', () => {
const cSource = new SourceFile(_('/foo/src/c.js'), 'bcd123', null, false, []); const cSource = new SourceFile(_('/foo/src/c.js'), 'bcd123', null, false, [], fs);
const dSource = new SourceFile(_('/foo/src/d.js'), 'aef', null, false, []); const dSource = new SourceFile(_('/foo/src/d.js'), 'aef', null, false, [], fs);
const bSourceMap: RawSourceMap = { const bSourceMap: RawSourceMap = {
mappings: encode([ mappings: encode([
@ -542,8 +547,8 @@ runInEachFileSystem(() => {
sources: ['c.js', 'd.js'], sources: ['c.js', 'd.js'],
version: 3 version: 3
}; };
const bSource = const bSource = new SourceFile(
new SourceFile(_('/foo/src/b.js'), 'abcdef', bSourceMap, false, [cSource, dSource]); _('/foo/src/b.js'), 'abcdef', bSourceMap, false, [cSource, dSource], fs);
const aSourceMap: RawSourceMap = { const aSourceMap: RawSourceMap = {
mappings: encode([ mappings: encode([
@ -560,7 +565,7 @@ runInEachFileSystem(() => {
version: 3 version: 3
}; };
const aSource = const aSource =
new SourceFile(_('/foo/src/a.js'), 'abde\n cf', aSourceMap, false, [bSource]); new SourceFile(_('/foo/src/a.js'), 'abde\n cf', aSourceMap, false, [bSource], fs);
// Line 0 // Line 0
expect(aSource.getOriginalLocation(0, 0)) // a expect(aSource.getOriginalLocation(0, 0)) // a
@ -592,8 +597,8 @@ runInEachFileSystem(() => {
}); });
it('should return offset locations across multiple lines', () => { it('should return offset locations across multiple lines', () => {
const originalSource = const originalSource = new SourceFile(
new SourceFile(_('/foo/src/original.js'), 'abcdef\nghijk\nlmnop', null, false, []); _('/foo/src/original.js'), 'abcdef\nghijk\nlmnop', null, false, [], fs);
const generatedSourceMap: RawSourceMap = { const generatedSourceMap: RawSourceMap = {
mappings: encode([ mappings: encode([
[ [
@ -614,7 +619,7 @@ runInEachFileSystem(() => {
}; };
const generatedSource = new SourceFile( const generatedSource = new SourceFile(
_('/foo/src/generated.js'), 'ABC\nGHIJDEFK\nLMNOP', generatedSourceMap, false, _('/foo/src/generated.js'), 'ABC\nGHIJDEFK\nLMNOP', generatedSourceMap, false,
[originalSource]); [originalSource], fs);
// Line 0 // Line 0
expect(generatedSource.getOriginalLocation(0, 0)) // A expect(generatedSource.getOriginalLocation(0, 0)) // A