Skip to content

feat(@angular-devkit/build-angular): add ng-server-context when using app-shell builder #23951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
clydin merged 1 commit into from
Sep 23, 2022
Merged

feat(@angular-devkit/build-angular): add ng-server-context when using app-shell builder #23951

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions packages/angular_devkit/build_angular/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ ts_library(
"@npm//@angular/compiler-cli",
"@npm//@angular/core",
"@npm//@angular/localize",
"@npm//@angular/platform-server",
"@npm//@angular/service-worker",
"@npm//@babel/core",
"@npm//@babel/generator",
Expand Down Expand Up @@ -282,9 +283,6 @@ ts_library(

LARGE_SPECS = {
"app-shell": {
"extra_deps": [
"@npm//@angular/platform-server",
],
"tags": [
# TODO: node crashes with an internal error on node16
"node16-broken",
Expand Down
3 changes: 2 additions & 1 deletion packages/angular_devkit/build_angular/src/builders/app-shell/app-shell_spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,8 @@ describe('AppShell Builder', () => {

const fileName = 'dist/index.html';
const content = virtualFs.fileBufferToString(host.scopedSync().read(normalize(fileName)));
expect(content).toMatch(/Welcome to app!/);
expect(content).toMatch('Welcome to app');
expect(content).toMatch('ng-server-context="app-shell"');
});

it('works with route', async () => {
Expand Down
31 changes: 19 additions & 12 deletions packages/angular_devkit/build_angular/src/builders/app-shell/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ import {
targetFromTargetString,
} from '@angular-devkit/architect';
import { JsonObject } from '@angular-devkit/core';
import type { Type } from '@angular/core';
import type * as platformServer from '@angular/platform-server';
import assert from 'assert';
import * as fs from 'fs';
import * as path from 'path';
import { normalizeOptimization } from '../../utils';
Expand Down Expand Up @@ -74,24 +77,28 @@ async function _renderUniversal(
localeDirectory,
);

const { AppServerModule, renderModule } = await import(serverBundlePath);
const { AppServerModule, renderModule, ɵSERVER_CONTEXT } = (await import(serverBundlePath)) as {
renderModule: typeof platformServer.renderModule | undefined;
ɵSERVER_CONTEXT: typeof platformServer.ɵSERVER_CONTEXT | undefined;
AppServerModule: Type<unknown> | undefined;
};

const renderModuleFn: ((module: unknown, options: {}) => Promise<string>) | undefined =
renderModule;

if (!(renderModuleFn && AppServerModule)) {
throw new Error(
`renderModule method and/or AppServerModule were not exported from: ${serverBundlePath}.`,
);
}
assert(renderModule, `renderModule was not exported from: ${serverBundlePath}.`);
assert(AppServerModule, `AppServerModule was not exported from: ${serverBundlePath}.`);
assert(ɵSERVER_CONTEXT, `ɵSERVER_CONTEXT was not exported from: ${serverBundlePath}.`);

// Load platform server module renderer
const renderOpts = {
let html = await renderModule(AppServerModule, {
document: indexHtml,
url: options.route,
};
extraProviders: [
{
provide: ɵSERVER_CONTEXT,
useValue: 'app-shell',
},
],
});

let html = await renderModuleFn(AppServerModule, renderOpts);
// Overwrite the client index file.
const outputIndexPath = options.outputIndexPath
? path.join(root, options.outputIndexPath)
Expand Down