d493a83b2b
Before the introduction of the Ivy renderer, users would compile their applications and use the resulting factories for SSR, since these post-compilation artifacts ensured faster delivery. Thus, using the original module as the rendering entrypoint was considered suboptimal and was discouraged. However, with the introduction of Ivy, this guidance is no longer applicable since these factories are no longer generated. Comparable speed is achieved using the factory-less module renderer, and so we update the guiance in the docs for the method. PR Close #37296
126 lines
4.5 KiB
TypeScript
126 lines
4.5 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 {ApplicationRef, NgModuleFactory, NgModuleRef, PlatformRef, StaticProvider, Type, ɵisPromise} from '@angular/core';
|
|
import {ɵTRANSITION_ID} from '@angular/platform-browser';
|
|
import {first} from 'rxjs/operators';
|
|
|
|
import {PlatformState} from './platform_state';
|
|
import {platformDynamicServer, platformServer} from './server';
|
|
import {BEFORE_APP_SERIALIZED, INITIAL_CONFIG} from './tokens';
|
|
|
|
interface PlatformOptions {
|
|
document?: string;
|
|
url?: string;
|
|
extraProviders?: StaticProvider[];
|
|
}
|
|
|
|
function _getPlatform(
|
|
platformFactory: (extraProviders: StaticProvider[]) => PlatformRef,
|
|
options: PlatformOptions): PlatformRef {
|
|
const extraProviders = options.extraProviders ? options.extraProviders : [];
|
|
return platformFactory([
|
|
{provide: INITIAL_CONFIG, useValue: {document: options.document, url: options.url}},
|
|
extraProviders
|
|
]);
|
|
}
|
|
|
|
function _render<T>(
|
|
platform: PlatformRef, moduleRefPromise: Promise<NgModuleRef<T>>): Promise<string> {
|
|
return moduleRefPromise.then((moduleRef) => {
|
|
const transitionId = moduleRef.injector.get(ɵTRANSITION_ID, null);
|
|
if (!transitionId) {
|
|
throw new Error(
|
|
`renderModule[Factory]() requires the use of BrowserModule.withServerTransition() to ensure
|
|
the server-rendered app can be properly bootstrapped into a client app.`);
|
|
}
|
|
const applicationRef: ApplicationRef = moduleRef.injector.get(ApplicationRef);
|
|
return applicationRef.isStable.pipe((first((isStable: boolean) => isStable)))
|
|
.toPromise()
|
|
.then(() => {
|
|
const platformState = platform.injector.get(PlatformState);
|
|
|
|
const asyncPromises: Promise<any>[] = [];
|
|
|
|
// Run any BEFORE_APP_SERIALIZED callbacks just before rendering to string.
|
|
const callbacks = moduleRef.injector.get(BEFORE_APP_SERIALIZED, null);
|
|
if (callbacks) {
|
|
for (const callback of callbacks) {
|
|
try {
|
|
const callbackResult = callback();
|
|
if (ɵisPromise(callbackResult)) {
|
|
// TODO: in TS3.7, callbackResult is void.
|
|
asyncPromises.push(callbackResult as any);
|
|
}
|
|
|
|
} catch (e) {
|
|
// Ignore exceptions.
|
|
console.warn('Ignoring BEFORE_APP_SERIALIZED Exception: ', e);
|
|
}
|
|
}
|
|
}
|
|
|
|
const complete = () => {
|
|
const output = platformState.renderToString();
|
|
platform.destroy();
|
|
return output;
|
|
};
|
|
|
|
if (asyncPromises.length === 0) {
|
|
return complete();
|
|
}
|
|
|
|
return Promise
|
|
.all(asyncPromises.map(asyncPromise => {
|
|
return asyncPromise.catch(e => {
|
|
console.warn('Ignoring BEFORE_APP_SERIALIZED Exception: ', e);
|
|
});
|
|
}))
|
|
.then(complete);
|
|
});
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Renders a Module to string.
|
|
*
|
|
* `document` is the full document HTML of the page to render, as a string.
|
|
* `url` is the URL for the current render request.
|
|
* `extraProviders` are the platform level providers for the current render request.
|
|
*
|
|
* If compiling with the ViewEngine renderer, do not use this in a production server environment.
|
|
* Use pre-compiled {@link NgModuleFactory} with {@link renderModuleFactory} instead. If
|
|
* compiling with the Ivy renderer, this method is the recommended rendering method for
|
|
* platform-server.
|
|
*
|
|
* @publicApi
|
|
*/
|
|
export function renderModule<T>(
|
|
module: Type<T>, options: {document?: string, url?: string, extraProviders?: StaticProvider[]}):
|
|
Promise<string> {
|
|
const platform = _getPlatform(platformDynamicServer, options);
|
|
return _render(platform, platform.bootstrapModule(module));
|
|
}
|
|
|
|
/**
|
|
* Renders a {@link NgModuleFactory} to string.
|
|
*
|
|
* `document` is the full document HTML of the page to render, as a string.
|
|
* `url` is the URL for the current render request.
|
|
* `extraProviders` are the platform level providers for the current render request.
|
|
*
|
|
* @publicApi
|
|
*/
|
|
export function renderModuleFactory<T>(
|
|
moduleFactory: NgModuleFactory<T>,
|
|
options: {document?: string, url?: string, extraProviders?: StaticProvider[]}):
|
|
Promise<string> {
|
|
const platform = _getPlatform(platformServer, options);
|
|
return _render(platform, platform.bootstrapModuleFactory(moduleFactory));
|
|
}
|