Skip to content

perf(@angular-devkit/build-angular): optimize server or browser only dependencies once #26219

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
merged 1 commit into from
Nov 3, 2023
Merged

perf(@angular-devkit/build-angular): optimize server or browser only dependencies once #26219

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
6 changes: 2 additions & 4 deletions packages/angular_devkit/build_angular/src/builders/application/execute-build.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,11 +169,9 @@ export async function executeBuild(

// Analyze external imports if external options are enabled
if (options.externalPackages || options.externalDependencies?.length) {
const { browser = new Set(), server = new Set() } = bundlingResult.externalImports;
// TODO: Filter externalImports to generate second argument to support wildcard externalDependency values
executionResult.setExternalMetadata(
[...bundlingResult.externalImports],
options.externalDependencies,
);
executionResult.setExternalMetadata([...browser], [...server], options.externalDependencies);
}

const { metafile, initialFiles, outputFiles } = bundlingResult;
Expand Down
27 changes: 12 additions & 15 deletions packages/angular_devkit/build_angular/src/builders/dev-server/vite-server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import { ServerResponse } from 'node:http';
import { dirname, extname, join, relative } from 'node:path';
import type { Connect, DepOptimizationConfig, InlineConfig, ViteDevServer } from 'vite';
import { BuildOutputFile, BuildOutputFileType } from '../../tools/esbuild/bundler-context';
import { ExternalResultMetadata } from '../../tools/esbuild/bundler-execution-result';
import { JavaScriptTransformer } from '../../tools/esbuild/javascript-transformer';
import { createRxjsEsmResolutionPlugin } from '../../tools/esbuild/rxjs-esm-resolution-plugin';
import { getFeatureSupport, transformSupportedBrowsersToTargets } from '../../tools/esbuild/utils';
Expand Down Expand Up @@ -123,8 +124,9 @@ export async function* serveWithVite(
let hadError = false;
const generatedFiles = new Map<string, OutputFileRecord>();
const assetFiles = new Map<string, string>();
const externalMetadata: { implicit: string[]; explicit: string[] } = {
implicit: [],
const externalMetadata: ExternalResultMetadata = {
implicitBrowser: [],
implicitServer: [],
explicit: [],
};
const build =
Expand Down Expand Up @@ -178,17 +180,12 @@ export async function* serveWithVite(
}
}

// To avoid disconnecting the array objects from the option, these arrays need to be mutated
// instead of replaced.
// TODO: split explicit imports by platform to avoid having Vite optimize server-only/browser-only
// dependencies twice when SSR is enabled.
// To avoid disconnecting the array objects from the option, these arrays need to be mutated instead of replaced.
if (result.externalMetadata) {
if (result.externalMetadata.explicit) {
externalMetadata.explicit.push(...result.externalMetadata.explicit);
}
if (result.externalMetadata.implicit) {
externalMetadata.implicit.push(...result.externalMetadata.implicit);
}
const { implicitBrowser, implicitServer, explicit } = result.externalMetadata;
externalMetadata.explicit.push(...explicit);
externalMetadata.implicitServer.push(...implicitServer);
externalMetadata.implicitBrowser.push(...implicitBrowser);
}

if (server) {
Expand Down Expand Up @@ -371,7 +368,7 @@ export async function setupServer(
outputFiles: Map<string, OutputFileRecord>,
assets: Map<string, string>,
preserveSymlinks: boolean | undefined,
externalMetadata: { implicit: string[]; explicit: string[] },
externalMetadata: ExternalResultMetadata,
ssr: boolean,
prebundleTransformer: JavaScriptTransformer,
target: string[],
Expand Down Expand Up @@ -437,7 +434,7 @@ export async function setupServer(
// Exclude any explicitly defined dependencies (currently build defined externals)
exclude: externalMetadata.explicit,
// Include all implict dependencies from the external packages internal option
include: externalMetadata.implicit,
include: externalMetadata.implicitServer,
ssr: true,
prebundleTransformer,
target,
Expand Down Expand Up @@ -698,7 +695,7 @@ export async function setupServer(
// Exclude any explicitly defined dependencies (currently build defined externals)
exclude: externalMetadata.explicit,
// Include all implict dependencies from the external packages internal option
include: externalMetadata.implicit,
include: externalMetadata.implicitBrowser,
ssr: false,
prebundleTransformer,
target,
Expand Down
29 changes: 19 additions & 10 deletions packages/angular_devkit/build_angular/src/tools/esbuild/bundler-context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,10 @@ export type BundleContextResult =
metafile: Metafile;
outputFiles: BuildOutputFile[];
initialFiles: Map<string, InitialFileRecord>;
externalImports: Set<string>;
externalImports: {
server?: Set<string>;
browser?: Set<string>;
};
};

export interface InitialFileRecord {
Expand Down Expand Up @@ -117,7 +120,9 @@ export class BundlerContext {
const warnings: Message[] = [];
const metafile: Metafile = { inputs: {}, outputs: {} };
const initialFiles = new Map<string, InitialFileRecord>();
const externalImports = new Set<string>();
const externalImportsBrowser = new Set<string>();
const externalImportsServer = new Set<string>();

const outputFiles = [];
for (const result of individualResults) {
warnings.push(...result.warnings);
Expand All @@ -135,7 +140,8 @@ export class BundlerContext {

result.initialFiles.forEach((value, key) => initialFiles.set(key, value));
outputFiles.push(...result.outputFiles);
result.externalImports.forEach((value) => externalImports.add(value));
result.externalImports.browser?.forEach((value) => externalImportsBrowser.add(value));
result.externalImports.server?.forEach((value) => externalImportsServer.add(value));
}

if (errors !== undefined) {
Expand All @@ -148,7 +154,10 @@ export class BundlerContext {
metafile,
initialFiles,
outputFiles,
externalImports,
externalImports: {
browser: externalImportsBrowser,
server: externalImportsServer,
},
};
}

Expand All @@ -175,7 +184,7 @@ export class BundlerContext {
return result;
}

async #performBundle() {
async #performBundle(): Promise<BundleContextResult> {
// Create esbuild options if not present
if (this.#esbuildOptions === undefined) {
if (this.incremental) {
Expand Down Expand Up @@ -313,15 +322,13 @@ export class BundlerContext {
}
}

const platformIsServer = this.#esbuildOptions?.platform === 'node';
const outputFiles = result.outputFiles.map((file) => {
let fileType: BuildOutputFileType;
if (dirname(file.path) === 'media') {
fileType = BuildOutputFileType.Media;
} else {
fileType =
this.#esbuildOptions?.platform === 'node'
? BuildOutputFileType.Server
: BuildOutputFileType.Browser;
fileType = platformIsServer ? BuildOutputFileType.Server : BuildOutputFileType.Browser;
}

return convertOutputFile(file, fileType);
Expand All @@ -332,7 +339,9 @@ export class BundlerContext {
...result,
outputFiles,
initialFiles,
externalImports,
externalImports: {
[platformIsServer ? 'server' : 'browser']: externalImports,
},
errors: undefined,
};
}
Expand Down
19 changes: 15 additions & 4 deletions packages/angular_devkit/build_angular/src/tools/esbuild/bundler-execution-result.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,20 @@ export interface RebuildState {
previousOutputHashes: Map<string, string>;
}

export interface ExternalResultMetadata {
implicitBrowser: string[];
implicitServer: string[];
explicit: string[];
}

/**
* Represents the result of a single builder execute call.
*/
export class ExecutionResult {
outputFiles: BuildOutputFile[] = [];
assetFiles: BuildOutputAsset[] = [];
errors: (Message | PartialMessage)[] = [];
externalMetadata?: { implicit: string[]; explicit?: string[] };
externalMetadata?: ExternalResultMetadata;

constructor(
private rebuildContexts: BundlerContext[],
Expand All @@ -53,11 +59,16 @@ export class ExecutionResult {
/**
* Add external JavaScript import metadata to the result. This is currently used
* by the development server to optimize the prebundling process.
* @param implicit External dependencies due to the external packages option.
* @param implicitBrowser External dependencies for the browser bundles due to the external packages option.
* @param implicitServer External dependencies for the server bundles due to the external packages option.
* @param explicit External dependencies due to explicit project configuration.
*/
setExternalMetadata(implicit: string[], explicit: string[] | undefined) {
this.externalMetadata = { implicit, explicit };
setExternalMetadata(
implicitBrowser: string[],
implicitServer: string[],
explicit: string[] | undefined,
): void {
this.externalMetadata = { implicitBrowser, implicitServer, explicit: explicit ?? [] };
}

get output() {
Expand Down