/** * @license * Copyright Google Inc. 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 * as fs from 'fs'; import * as ts from 'typescript'; import MagicString from 'magic-string'; import {fromObject, generateMapFileComment} from 'convert-source-map'; import {makeProgram} from '../helpers/utils'; import {AnalyzedClass, Analyzer} from '../../src/analyzer'; import {Esm2015ReflectionHost} from '../../src/host/esm2015_host'; import {Esm2015FileParser} from '../../src/parsing/esm2015_parser'; import {Renderer} from '../../src/rendering/renderer'; class TestRenderer extends Renderer { addImports(output: MagicString, imports: {name: string, as: string}[]) { output.prepend('\n// ADD IMPORTS\n'); } addConstants(output: MagicString, constants: string, file: ts.SourceFile): void { output.prepend('\n// ADD CONSTANTS\n'); } addDefinitions(output: MagicString, analyzedClass: AnalyzedClass, definitions: string) { output.prepend('\n// ADD DEFINITIONS\n'); } removeDecorators(output: MagicString, decoratorsToRemove: Map) { output.prepend('\n// REMOVE DECORATORS\n'); } } function createTestRenderer() { const renderer = new TestRenderer(); spyOn(renderer, 'addImports').and.callThrough(); spyOn(renderer, 'addDefinitions').and.callThrough(); spyOn(renderer, 'removeDecorators').and.callThrough(); return renderer as jasmine.SpyObj; } function analyze(file: {name: string, contents: string}) { const program = makeProgram(file); const host = new Esm2015ReflectionHost(program.getTypeChecker()); const parser = new Esm2015FileParser(program, host); const analyzer = new Analyzer(program.getTypeChecker(), host); const parsedFiles = parser.parseFile(program.getSourceFile(file.name) !); return parsedFiles.map(file => analyzer.analyzeFile(file)); } describe('Renderer', () => { const INPUT_PROGRAM = { name: '/file.js', contents: `import { Directive } from '@angular/core';\nexport class A {\n foo(x) {\n return x;\n }\n}\nA.decorators = [\n { type: Directive, args: [{ selector: '[a]' }] }\n];\n` }; const INPUT_PROGRAM_MAP = fromObject({ 'version': 3, 'file': '/file.js', 'sourceRoot': '', 'sources': ['/file.ts'], 'names': [], 'mappings': 'AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,MAAM;IACF,GAAG,CAAC,CAAS;QACT,OAAO,CAAC,CAAC;IACb,CAAC;;AACM,YAAU,GAAG;IAChB,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE;CACnD,CAAC', 'sourcesContent': [ 'import { Directive } from \'@angular/core\';\nexport class A {\n foo(x: string): string {\n return x;\n }\n static decorators = [\n { type: Directive, args: [{ selector: \'[a]\' }] }\n ];\n}' ] }); const RENDERED_CONTENTS = `\n// REMOVE DECORATORS\n\n// ADD IMPORTS\n\n// ADD CONSTANTS\n\n// ADD DEFINITIONS\n` + INPUT_PROGRAM.contents; const OUTPUT_PROGRAM_MAP = fromObject({ 'version': 3, 'file': '/output_file.js', 'sources': ['/file.js'], 'sourcesContent': [ 'import { Directive } from \'@angular/core\';\nexport class A {\n foo(x) {\n return x;\n }\n}\nA.decorators = [\n { type: Directive, args: [{ selector: \'[a]\' }] }\n];\n' ], 'names': [], 'mappings': ';;;;;;;;AAAA;;;;;;;;;' }); const MERGED_OUTPUT_PROGRAM_MAP = fromObject({ 'version': 3, 'sources': ['/file.ts'], 'names': [], 'mappings': ';;;;;;;;AAAA', 'file': '/output_file.js', 'sourcesContent': [ 'import { Directive } from \'@angular/core\';\nexport class A {\n foo(x: string): string {\n return x;\n }\n static decorators = [\n { type: Directive, args: [{ selector: \'[a]\' }] }\n ];\n}' ] }); describe('renderFile()', () => { it('should render the modified contents; and a new map file, if the original provided no map file.', () => { const renderer = createTestRenderer(); const analyzedFiles = analyze(INPUT_PROGRAM); const result = renderer.renderFile(analyzedFiles[0], '/output_file.js'); expect(result.source.path).toEqual('/output_file.js'); expect(result.source.contents) .toEqual(RENDERED_CONTENTS + '\n' + generateMapFileComment('/output_file.js.map')); expect(result.map !.path).toEqual('/output_file.js.map'); expect(result.map !.contents).toEqual(OUTPUT_PROGRAM_MAP.toJSON()); }); it('should call addImports with the source code and info about the core Angular library.', () => { const renderer = createTestRenderer(); const analyzedFiles = analyze(INPUT_PROGRAM); renderer.renderFile(analyzedFiles[0], '/output_file.js'); expect(renderer.addImports.calls.first().args[0].toString()).toEqual(RENDERED_CONTENTS); expect(renderer.addImports.calls.first().args[1]).toEqual([ {name: '@angular/core', as: 'ɵngcc0'} ]); }); it('should call addDefinitions with the source code, the analyzed class and the renderered definitions.', () => { const renderer = createTestRenderer(); const analyzedFile = analyze(INPUT_PROGRAM)[0]; renderer.renderFile(analyzedFile, '/output_file.js'); expect(renderer.addDefinitions.calls.first().args[0].toString()) .toEqual(RENDERED_CONTENTS); expect(renderer.addDefinitions.calls.first().args[1]) .toBe(analyzedFile.analyzedClasses[0]); expect(renderer.addDefinitions.calls.first().args[2]) .toEqual( `A.ngDirectiveDef = ɵngcc0.ɵdefineDirective({ type: A, selectors: [["", "a", ""]], factory: function A_Factory() { return new A(); }, features: [ɵngcc0.ɵPublicFeature] });`); }); it('should call removeDecorators with the source code, a map of class decorators that have been analyzed', () => { const renderer = createTestRenderer(); const analyzedFile = analyze(INPUT_PROGRAM)[0]; renderer.renderFile(analyzedFile, '/output_file.js'); expect(renderer.removeDecorators.calls.first().args[0].toString()) .toEqual(RENDERED_CONTENTS); // Each map key is the TS node of the decorator container // Each map value is an array of TS nodes that are the decorators to remove const map = renderer.removeDecorators.calls.first().args[1] as Map; const keys = Array.from(map.keys()); expect(keys.length).toEqual(1); expect(keys[0].getText()) .toEqual(`[\n { type: Directive, args: [{ selector: '[a]' }] }\n]`); const values = Array.from(map.values()); expect(values.length).toEqual(1); expect(values[0].length).toEqual(1); expect(values[0][0].getText()).toEqual(`{ type: Directive, args: [{ selector: '[a]' }] }`); }); it('should merge any inline source map from the original file and write the output as an inline source map', () => { const renderer = createTestRenderer(); const analyzedFiles = analyze({ ...INPUT_PROGRAM, contents: INPUT_PROGRAM.contents + '\n' + INPUT_PROGRAM_MAP.toComment() }); const result = renderer.renderFile(analyzedFiles[0], '/output_file.js'); expect(result.source.path).toEqual('/output_file.js'); expect(result.source.contents) .toEqual(RENDERED_CONTENTS + '\n' + MERGED_OUTPUT_PROGRAM_MAP.toComment()); expect(result.map).toBe(null); }); it('should merge any external source map from the original file and write the output to an external source map', () => { // Mock out reading the map file from disk const readFileSyncSpy = spyOn(fs, 'readFileSync').and.returnValue(INPUT_PROGRAM_MAP.toJSON()); const renderer = createTestRenderer(); const analyzedFiles = analyze({ ...INPUT_PROGRAM, contents: INPUT_PROGRAM.contents + '\n//# sourceMappingURL=file.js.map' }); const result = renderer.renderFile(analyzedFiles[0], '/output_file.js'); expect(result.source.path).toEqual('/output_file.js'); expect(result.source.contents) .toEqual(RENDERED_CONTENTS + '\n' + generateMapFileComment('/output_file.js.map')); expect(result.map !.path).toEqual('/output_file.js.map'); expect(result.map !.contents).toEqual(MERGED_OUTPUT_PROGRAM_MAP.toJSON()); }); }); });