/** * @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 {animate, AnimationBuilder, state, style, transition, trigger} from '@angular/animations'; import {DOCUMENT, isPlatformServer, PlatformLocation, ɵgetDOM as getDOM} from '@angular/common'; import {HTTP_INTERCEPTORS, HttpClient, HttpClientModule, HttpEvent, HttpHandler, HttpInterceptor, HttpRequest} from '@angular/common/http'; import {HttpClientTestingModule, HttpTestingController} from '@angular/common/http/testing'; import {ApplicationRef, CompilerFactory, Component, destroyPlatform, getPlatform, HostListener, Inject, Injectable, Input, NgModule, NgZone, PLATFORM_ID, PlatformRef, ViewEncapsulation} from '@angular/core'; import {inject, TestBed, waitForAsync} from '@angular/core/testing'; import {BrowserModule, Title} from '@angular/platform-browser'; import {BEFORE_APP_SERIALIZED, INITIAL_CONFIG, platformDynamicServer, PlatformState, renderModule, renderModuleFactory, ServerModule} from '@angular/platform-server'; import {Observable} from 'rxjs'; import {first} from 'rxjs/operators'; import {renderApplication, SERVER_CONTEXT} from '../src/utils'; function createMyServerApp(standalone: boolean) { @Component({ standalone, selector: 'app', template: `Works!`, }) class MyServerApp { } return MyServerApp; } const MyServerApp = createMyServerApp(false); const MyServerAppStandalone = createMyServerApp(true); @NgModule({ declarations: [MyServerApp], exports: [MyServerApp], }) export class MyServerAppModule { } @NgModule({ bootstrap: [MyServerApp], imports: [MyServerAppModule, ServerModule], }) class ExampleModule { } function getTitleRenderHook(doc: any) { return () => { // Set the title as part of the render hook. doc.title = 'RenderHook'; }; } function exceptionRenderHook() { throw new Error('error'); } function getMetaRenderHook(doc: any) { return () => { // Add a meta tag before rendering the document. const metaElement = doc.createElement('meta'); metaElement.setAttribute('name', 'description'); doc.head.appendChild(metaElement); }; } function getAsyncTitleRenderHook(doc: any) { return () => { // Async set the title as part of the render hook. return new Promise(resolve => { setTimeout(() => { doc.title = 'AsyncRenderHook'; resolve(); }); }); }; } function asyncRejectRenderHook() { return () => { return new Promise((_resolve, reject) => { setTimeout(() => { reject('reject'); }); }); }; } const RenderHookProviders = [ {provide: BEFORE_APP_SERIALIZED, useFactory: getTitleRenderHook, multi: true, deps: [DOCUMENT]} ]; @NgModule({ bootstrap: [MyServerApp], imports: [MyServerAppModule, BrowserModule.withServerTransition({appId: 'render-hook'}), ServerModule], providers: [...RenderHookProviders], }) class RenderHookModule { } const MultiRenderHookProviders = [ {provide: BEFORE_APP_SERIALIZED, useFactory: getTitleRenderHook, multi: true, deps: [DOCUMENT]}, {provide: BEFORE_APP_SERIALIZED, useValue: exceptionRenderHook, multi: true}, {provide: BEFORE_APP_SERIALIZED, useFactory: getMetaRenderHook, multi: true, deps: [DOCUMENT]}, ]; @NgModule({ bootstrap: [MyServerApp], imports: [MyServerAppModule, BrowserModule.withServerTransition({appId: 'render-hook'}), ServerModule], providers: [...MultiRenderHookProviders], }) class MultiRenderHookModule { } const AsyncRenderHookProviders = [ { provide: BEFORE_APP_SERIALIZED, useFactory: getAsyncTitleRenderHook, multi: true, deps: [DOCUMENT] }, ]; @NgModule({ bootstrap: [MyServerApp], imports: [MyServerAppModule, BrowserModule.withServerTransition({appId: 'render-hook'}), ServerModule], providers: [...AsyncRenderHookProviders], }) class AsyncRenderHookModule { } const AsyncMultiRenderHookProviders = [ {provide: BEFORE_APP_SERIALIZED, useFactory: getMetaRenderHook, multi: true, deps: [DOCUMENT]}, { provide: BEFORE_APP_SERIALIZED, useFactory: getAsyncTitleRenderHook, multi: true, deps: [DOCUMENT] }, {provide: BEFORE_APP_SERIALIZED, useFactory: asyncRejectRenderHook, multi: true}, ]; @NgModule({ bootstrap: [MyServerApp], imports: [MyServerAppModule, BrowserModule.withServerTransition({appId: 'render-hook'}), ServerModule], providers: [...AsyncMultiRenderHookProviders], }) class AsyncMultiRenderHookModule { } @Component({selector: 'app', template: `Works too!`}) class MyServerApp2 { } @NgModule({declarations: [MyServerApp2], imports: [ServerModule], bootstrap: [MyServerApp2]}) class ExampleModule2 { } @Component({selector: 'app', template: ``}) class TitleApp { constructor(private title: Title) {} ngOnInit() { this.title.setTitle('Test App Title'); } } @NgModule({declarations: [TitleApp], imports: [ServerModule], bootstrap: [TitleApp]}) class TitleAppModule { } function createMyAsyncServerApp(standalone: boolean) { @Component({ selector: 'app', template: '{{text}}

', standalone, }) class MyAsyncServerApp { text = ''; h1 = ''; @HostListener('window:scroll') track() { console.error('scroll'); } ngOnInit() { Promise.resolve(null).then(() => setTimeout(() => { this.text = 'Works!'; this.h1 = 'fine'; }, 10)); } } return MyAsyncServerApp; } const MyAsyncServerApp = createMyAsyncServerApp(false); const MyAsyncServerAppStandalone = createMyAsyncServerApp(true); @NgModule({ declarations: [MyAsyncServerApp], imports: [BrowserModule.withServerTransition({appId: 'async-server'}), ServerModule], bootstrap: [MyAsyncServerApp] }) class AsyncServerModule { } function createSVGComponent(standalone: boolean) { @Component({ selector: 'app', template: '', standalone, }) class SVGComponent { } return SVGComponent; } const SVGComponent = createSVGComponent(false); const SVGComponentStandalone = createSVGComponent(true); @NgModule({ declarations: [SVGComponent], imports: [BrowserModule.withServerTransition({appId: 'svg-server'}), ServerModule], bootstrap: [SVGComponent] }) class SVGServerModule { } function createMyAnimationApp(standalone: boolean) { @Component({ standalone, selector: 'app', template: `
{{text}}
`, animations: [trigger( 'myAnimation', [ state('void', style({'opacity': '0'})), state('active', style({ 'opacity': '1', // simple supported property 'font-weight': 'bold', // property with dashed name 'transform': 'translate3d(0, 0, 0)', // not natively supported by Domino })), transition('void => *', [animate('0ms')]), ], )] }) class MyAnimationApp { state = 'active'; constructor(private builder: AnimationBuilder) {} text = 'Works!'; } return MyAnimationApp; } const MyAnimationApp = createMyAnimationApp(false); const MyAnimationAppStandalone = createMyAnimationApp(true); @NgModule({ declarations: [MyAnimationApp], imports: [BrowserModule.withServerTransition({appId: 'anim-server'}), ServerModule], bootstrap: [MyAnimationApp] }) class AnimationServerModule { } function createMyStylesApp(standalone: boolean) { @Component({ standalone, selector: 'app', template: `
Works!
`, styles: ['div {color: blue; } :host { color: red; }'] }) class MyStylesApp { } return MyStylesApp; } const MyStylesApp = createMyStylesApp(false); const MyStylesAppStandalone = createMyStylesApp(true); @NgModule({ declarations: [MyStylesApp], imports: [BrowserModule.withServerTransition({appId: 'example-styles'}), ServerModule], bootstrap: [MyStylesApp] }) class ExampleStylesModule { } @NgModule({ bootstrap: [MyServerApp], imports: [MyServerAppModule, ServerModule, HttpClientModule, HttpClientTestingModule], }) export class HttpClientExampleModule { } @Injectable() export class MyHttpInterceptor implements HttpInterceptor { constructor(private http: HttpClient) {} intercept(req: HttpRequest, next: HttpHandler): Observable> { return next.handle(req); } } @NgModule({ bootstrap: [MyServerApp], imports: [MyServerAppModule, ServerModule, HttpClientModule, HttpClientTestingModule], providers: [ {provide: HTTP_INTERCEPTORS, multi: true, useClass: MyHttpInterceptor}, ], }) export class HttpInterceptorExampleModule { } @Component({selector: 'app', template: ``}) class ImageApp { } @NgModule({declarations: [ImageApp], imports: [ServerModule], bootstrap: [ImageApp]}) class ImageExampleModule { } function createShadowDomEncapsulationApp(standalone: boolean) { @Component({ standalone, selector: 'app', template: 'Shadow DOM works', encapsulation: ViewEncapsulation.ShadowDom, styles: [':host { color: red; }'] }) class ShadowDomEncapsulationApp { } return ShadowDomEncapsulationApp; } const ShadowDomEncapsulationApp = createShadowDomEncapsulationApp(false); const ShadowDomEncapsulationAppStandalone = createShadowDomEncapsulationApp(true); @NgModule({ declarations: [ShadowDomEncapsulationApp], imports: [BrowserModule.withServerTransition({appId: 'test'}), ServerModule], bootstrap: [ShadowDomEncapsulationApp] }) class ShadowDomExampleModule { } function createFalseAttributesComponents(standalone: boolean) { @Component({ standalone, selector: 'my-child', template: 'Works!', }) class MyChildComponent { // TODO(issue/24571): remove '!'. @Input() public attr!: boolean; } @Component({ standalone, selector: 'app', template: '', imports: standalone ? [MyChildComponent] : [], }) class MyHostComponent { } return [MyHostComponent, MyChildComponent]; } const [MyHostComponent, MyChildComponent] = createFalseAttributesComponents(false); const [MyHostComponentStandalone, _] = createFalseAttributesComponents(true); @NgModule({ declarations: [MyHostComponent, MyChildComponent], bootstrap: [MyHostComponent], imports: [ServerModule, BrowserModule.withServerTransition({appId: 'false-attributes'})] }) class FalseAttributesModule { } function createMyInputComponent(standalone: boolean) { @Component({ standalone, selector: 'app', template: '', }) class MyInputComponent { @Input() name = ''; } return MyInputComponent; } const MyInputComponent = createMyInputComponent(false); const MyInputComponentStandalone = createMyInputComponent(true); @NgModule({ declarations: [MyInputComponent], bootstrap: [MyInputComponent], imports: [ServerModule, BrowserModule.withServerTransition({appId: 'name-attributes'})] }) class NameModule { } function createHTMLTypesApp(standalone: boolean) { @Component({ standalone, selector: 'app', template: '
', }) class HTMLTypesApp { html = 'foo bar'; constructor(@Inject(DOCUMENT) doc: Document) {} } return HTMLTypesApp; } const HTMLTypesApp = createHTMLTypesApp(false); const HTMLTypesAppStandalone = createHTMLTypesApp(true); @NgModule({ declarations: [HTMLTypesApp], imports: [BrowserModule.withServerTransition({appId: 'inner-html'}), ServerModule], bootstrap: [HTMLTypesApp] }) class HTMLTypesModule { } function createMyHiddenComponent(standalone: boolean) { @Component({ standalone, selector: 'app', template: '', }) class MyHiddenComponent { @Input() name = ''; } return MyHiddenComponent; } const MyHiddenComponent = createMyHiddenComponent(false); const MyHiddenComponentStandalone = createMyHiddenComponent(true); @NgModule({ declarations: [MyHiddenComponent], bootstrap: [MyHiddenComponent], imports: [ServerModule, BrowserModule.withServerTransition({appId: 'hidden-attributes'})] }) class HiddenModule { } (function() { if (getDOM().supportsDOMEvents) return; // NODE only describe('platform-server integration', () => { beforeEach(() => { if (getPlatform()) destroyPlatform(); }); it('should bootstrap', waitForAsync(() => { const platform = platformDynamicServer([{provide: INITIAL_CONFIG, useValue: {document: ''}}]); platform.bootstrapModule(ExampleModule).then((moduleRef) => { expect(isPlatformServer(moduleRef.injector.get(PLATFORM_ID))).toBe(true); const doc = moduleRef.injector.get(DOCUMENT); expect(doc.head).toBe(doc.querySelector('head')!); expect(doc.body).toBe(doc.querySelector('body')!); expect(doc.documentElement.textContent).toEqual('Works!'); platform.destroy(); }); })); it('should allow multiple platform instances', waitForAsync(() => { const platform = platformDynamicServer([{provide: INITIAL_CONFIG, useValue: {document: ''}}]); const platform2 = platformDynamicServer([{provide: INITIAL_CONFIG, useValue: {document: ''}}]); platform.bootstrapModule(ExampleModule).then((moduleRef) => { const doc = moduleRef.injector.get(DOCUMENT); expect(doc.documentElement.textContent).toEqual('Works!'); platform.destroy(); }); platform2.bootstrapModule(ExampleModule2).then((moduleRef) => { const doc = moduleRef.injector.get(DOCUMENT); expect(doc.documentElement.textContent).toEqual('Works too!'); platform2.destroy(); }); })); it('adds title to the document using Title service', waitForAsync(() => { const platform = platformDynamicServer([{ provide: INITIAL_CONFIG, useValue: {document: ''} }]); platform.bootstrapModule(TitleAppModule).then(ref => { const state = ref.injector.get(PlatformState); const doc = ref.injector.get(DOCUMENT); const title = doc.querySelector('title')!; expect(title.textContent).toBe('Test App Title'); expect(state.renderToString()).toContain('Test App Title'); }); })); it('should get base href from document', waitForAsync(() => { const platform = platformDynamicServer([{ provide: INITIAL_CONFIG, useValue: {document: ''} }]); platform.bootstrapModule(ExampleModule).then((moduleRef) => { const location = moduleRef.injector.get(PlatformLocation); expect(location.getBaseHrefFromDOM()).toEqual('/'); platform.destroy(); }); })); it('adds styles with ng-transition attribute', waitForAsync(() => { const platform = platformDynamicServer([{ provide: INITIAL_CONFIG, useValue: {document: ''} }]); platform.bootstrapModule(ExampleStylesModule).then(ref => { const doc = ref.injector.get(DOCUMENT); const head = doc.getElementsByTagName('head')[0]; const styles: any[] = head.children as any; expect(styles.length).toBe(1); expect(styles[0].textContent).toContain('color: red'); expect(styles[0].getAttribute('ng-transition')).toBe('example-styles'); }); })); it('copies known properties to attributes', waitForAsync(() => { const platform = platformDynamicServer([{provide: INITIAL_CONFIG, useValue: {document: ''}}]); platform.bootstrapModule(ImageExampleModule).then(ref => { const appRef: ApplicationRef = ref.injector.get(ApplicationRef); const app = appRef.components[0].location.nativeElement; const img = app.getElementsByTagName('img')[0] as any; expect(img.attributes['src'].value).toEqual('link'); }); })); describe('PlatformLocation', () => { it('is injectable', waitForAsync(() => { const platform = platformDynamicServer( [{provide: INITIAL_CONFIG, useValue: {document: ''}}]); platform.bootstrapModule(ExampleModule).then(appRef => { const location: PlatformLocation = appRef.injector.get(PlatformLocation); expect(location.pathname).toBe('/'); platform.destroy(); }); })); it('is configurable via INITIAL_CONFIG', () => { platformDynamicServer([{ provide: INITIAL_CONFIG, useValue: {document: '', url: 'http://test.com/deep/path?query#hash'} }]) .bootstrapModule(ExampleModule) .then(appRef => { const location: PlatformLocation = appRef.injector.get(PlatformLocation); expect(location.pathname).toBe('/deep/path'); expect(location.search).toBe('?query'); expect(location.hash).toBe('#hash'); }); }); it('parses component pieces of a URL', () => { platformDynamicServer([{ provide: INITIAL_CONFIG, useValue: {document: '', url: 'http://test.com:80/deep/path?query#hash'} }]) .bootstrapModule(ExampleModule) .then(appRef => { const location: PlatformLocation = appRef.injector.get(PlatformLocation); expect(location.hostname).toBe('test.com'); expect(location.protocol).toBe('http:'); expect(location.port).toBe('80'); expect(location.pathname).toBe('/deep/path'); expect(location.search).toBe('?query'); expect(location.hash).toBe('#hash'); }); }); it('handles empty search and hash portions of the url', () => { platformDynamicServer([{ provide: INITIAL_CONFIG, useValue: {document: '', url: 'http://test.com/deep/path'} }]) .bootstrapModule(ExampleModule) .then(appRef => { const location: PlatformLocation = appRef.injector.get(PlatformLocation); expect(location.pathname).toBe('/deep/path'); expect(location.search).toBe(''); expect(location.hash).toBe(''); }); }); it('pushState causes the URL to update', waitForAsync(() => { const platform = platformDynamicServer( [{provide: INITIAL_CONFIG, useValue: {document: ''}}]); platform.bootstrapModule(ExampleModule).then(appRef => { const location: PlatformLocation = appRef.injector.get(PlatformLocation); location.pushState(null, 'Test', '/foo#bar'); expect(location.pathname).toBe('/foo'); expect(location.hash).toBe('#bar'); platform.destroy(); }); })); it('allows subscription to the hash state', done => { const platform = platformDynamicServer([{provide: INITIAL_CONFIG, useValue: {document: ''}}]); platform.bootstrapModule(ExampleModule).then(appRef => { const location: PlatformLocation = appRef.injector.get(PlatformLocation); expect(location.pathname).toBe('/'); location.onHashChange((e: any) => { expect(e.type).toBe('hashchange'); expect(e.oldUrl).toBe('/'); expect(e.newUrl).toBe('/foo#bar'); platform.destroy(); done(); }); location.pushState(null, 'Test', '/foo#bar'); }); }); }); describe('render', () => { let doc: string; let called: boolean; let expectedOutput = 'Works!

fine

'; beforeEach(() => { // PlatformConfig takes in a parsed document so that it can be cached across requests. doc = ''; called = false; }); afterEach(() => { expect(called).toBe(true); }); it('using long form should work', waitForAsync(() => { const platform = platformDynamicServer([{provide: INITIAL_CONFIG, useValue: {document: doc}}]); platform.bootstrapModule(AsyncServerModule) .then((moduleRef) => { const applicationRef = moduleRef.injector.get(ApplicationRef); return applicationRef.isStable.pipe(first((isStable: boolean) => isStable)) .toPromise(); }) .then((b) => { // Note: the `ng-server-context` is not present in this output, since // `renderModule` or `renderApplication` functions are not used here. const expectedOutput = '' + 'Works!

fine

'; expect(platform.injector.get(PlatformState).renderToString()).toBe(expectedOutput); platform.destroy(); called = true; }); })); it('using renderModuleFactory should work', waitForAsync(inject([PlatformRef], (defaultPlatform: PlatformRef) => { const compilerFactory: CompilerFactory = defaultPlatform.injector.get(CompilerFactory, null)!; const moduleFactory = compilerFactory.createCompiler().compileModuleSync(AsyncServerModule); renderModuleFactory(moduleFactory, {document: doc}).then(output => { expect(output).toBe(expectedOutput); called = true; }); }))); // Run the set of tests with regular and standalone components. [true, false].forEach((isStandalone: boolean) => { it(`using ${isStandalone ? 'renderApplication' : 'renderModule'} should work`, waitForAsync(() => { const options = {document: doc}; const bootstrap = isStandalone ? renderApplication(MyAsyncServerAppStandalone, {...options, appId: 'simple-cmp'}) : renderModule(AsyncServerModule, options); bootstrap.then(output => { expect(output).toBe(expectedOutput); called = true; }); })); it(`using ${isStandalone ? 'renderApplication' : 'renderModule'} ` + `should allow passing a document reference`, waitForAsync(() => { const document = TestBed.inject(DOCUMENT); // Append root element based on the app selector. const rootEl = document.createElement('app'); document.body.appendChild(rootEl); // Append a special marker to verify that we use a correct instance // of the document for rendering. const markerEl = document.createComment('test marker'); document.body.appendChild(markerEl); const options = {document}; const bootstrap = isStandalone ? renderApplication(MyAsyncServerAppStandalone, {document, appId: 'simple-cmp'}) : renderModule(AsyncServerModule, options); bootstrap .then(output => { expect(output).toBe( 'fakeTitle' + '' + 'Works!

fine

' + ''); called = true; }) .finally(() => { rootEl.remove(); markerEl.remove(); }); })); it('works with SVG elements', waitForAsync(() => { const options = {document: doc}; const bootstrap = isStandalone ? renderApplication(SVGComponentStandalone, {...options, appId: 'simple-cmp'}) : renderModule(SVGServerModule, options); bootstrap.then(output => { expect(output).toBe( '' + ''); called = true; }); })); it('works with animation', waitForAsync(() => { const options = {document: doc}; const bootstrap = isStandalone ? renderApplication(MyAnimationAppStandalone, {...options, appId: 'simple-cmp'}) : renderModule(AnimationServerModule, options); bootstrap.then(output => { expect(output).toContain('Works!'); expect(output).toContain('ng-trigger-myAnimation'); expect(output).toContain('opacity:1;'); expect(output).toContain('transform:translate3d(0 , 0 , 0);'); expect(output).toContain('font-weight:bold;'); called = true; }); })); it('should handle ViewEncapsulation.ShadowDom', waitForAsync(() => { const options = {document: doc}; const bootstrap = isStandalone ? renderApplication( ShadowDomEncapsulationAppStandalone, {...options, appId: 'simple-cmp'}) : renderModule(ShadowDomExampleModule, options); bootstrap.then(output => { expect(output).not.toBe(''); expect(output).toContain('color: red'); called = true; }); })); it('sets a prefix for the _nghost and _ngcontent attributes', waitForAsync(() => { const options = {document: doc}; const bootstrap = isStandalone ? renderApplication(MyStylesAppStandalone, {...options, appId: 'example-styles'}) : renderModule(ExampleStylesModule, options); bootstrap.then(output => { expect(output).toMatch( /