refactor(@angular-devkit/build-angular): remove implicit localize polyfill

jkrems · jkrems · commit 8f038de751dd · 2024-09-26T13:30:24.000-07:00
In the v19 application builder, the localize polyfill should not be added implicitly. See: d6a3403
diff --git a/packages/angular_devkit/build_angular/src/builders/karma/application_builder.ts b/packages/angular_devkit/build_angular/src/builders/karma/application_builder.ts
@@ -12,7 +12,6 @@ import {
   ResultKind,
   buildApplicationInternal,
   emitFilesToDisk,
-  purgeStaleBuildCache,
 } from '@angular/build/private';
 import { BuilderContext, BuilderOutput } from '@angular-devkit/architect';
 import { randomUUID } from 'crypto';
@@ -22,7 +21,6 @@ import * as path from 'path';
 import { Observable, catchError, defaultIfEmpty, from, of, switchMap } from 'rxjs';
 import { Configuration } from 'webpack';
 import { ExecutionTransformer } from '../../transforms';
-import { readTsconfig } from '../../utils/read-tsconfig';
 import { OutputHashing } from '../browser-esbuild/schema';
 import { findTests } from './find-tests';
 import { Schema as KarmaBuilderOptions } from './schema';
@@ -110,18 +108,6 @@ async function collectEntrypoints(
     entryPoints.add('zone.js/testing');
   }
 
-  const tsConfigPath = path.resolve(context.workspaceRoot, options.tsConfig);
-  const tsConfig = await readTsconfig(tsConfigPath);
-
-  const localizePackageInitEntryPoint = '@angular/localize/init';
-  const hasLocalizeType = tsConfig.options.types?.some(
-    (t) => t === '@angular/localize' || t === localizePackageInitEntryPoint,
-  );
-
-  if (hasLocalizeType) {
-    polyfills.push(localizePackageInitEntryPoint);
-  }
-
   return [entryPoints, polyfills];
 }
 
diff --git a/packages/angular_devkit/build_angular/src/builders/karma/tests/behavior/code-coverage_spec.ts b/packages/angular_devkit/build_angular/src/builders/karma/tests/behavior/code-coverage_spec.ts
@@ -29,8 +29,8 @@ describeKarmaBuilder(execute, KARMA_BUILDER_INFO, (harness, setupTarget, isAppli
       });
     }
 
-    beforeEach(() => {
-      setupTarget(harness);
+    beforeEach(async () => {
+      await setupTarget(harness);
     });
 
     it('should generate coverage report when file was previously processed by Babel', async () => {
diff --git a/packages/angular_devkit/build_angular/src/builders/karma/tests/behavior/errors_spec.ts b/packages/angular_devkit/build_angular/src/builders/karma/tests/behavior/errors_spec.ts
@@ -11,8 +11,8 @@ import { BASE_OPTIONS, KARMA_BUILDER_INFO, describeKarmaBuilder } from '../setup
 
 describeKarmaBuilder(execute, KARMA_BUILDER_INFO, (harness, setupTarget) => {
   describe('Behavior: "Errors"', () => {
-    beforeEach(() => {
-      setupTarget(harness);
+    beforeEach(async () => {
+      await setupTarget(harness);
     });
 
     it('should fail when there is a TypeScript error', async () => {
diff --git a/packages/angular_devkit/build_angular/src/builders/karma/tests/behavior/module-cjs_spec.ts b/packages/angular_devkit/build_angular/src/builders/karma/tests/behavior/module-cjs_spec.ts
@@ -11,8 +11,8 @@ import { BASE_OPTIONS, KARMA_BUILDER_INFO, describeKarmaBuilder } from '../setup
 
 describeKarmaBuilder(execute, KARMA_BUILDER_INFO, (harness, setupTarget) => {
   describe('Behavior: "module commonjs"', () => {
-    beforeEach(() => {
-      setupTarget(harness);
+    beforeEach(async () => {
+      await setupTarget(harness);
     });
 
     it('should work when module is commonjs', async () => {
diff --git a/packages/angular_devkit/build_angular/src/builders/karma/tests/behavior/rebuilds_spec.ts b/packages/angular_devkit/build_angular/src/builders/karma/tests/behavior/rebuilds_spec.ts
@@ -18,8 +18,8 @@ describeKarmaBuilder(execute, KARMA_BUILDER_INFO, (harness, setupTarget, isAppli
       });
     }
 
-    beforeEach(() => {
-      setupTarget(harness);
+    beforeEach(async () => {
+      await setupTarget(harness);
     });
 
     it('recovers from compilation failures in watch mode', async () => {
diff --git a/packages/angular_devkit/build_angular/src/builders/karma/tests/options/assets_spec.ts b/packages/angular_devkit/build_angular/src/builders/karma/tests/options/assets_spec.ts
@@ -11,8 +11,8 @@ import { BASE_OPTIONS, KARMA_BUILDER_INFO, describeKarmaBuilder } from '../setup
 
 describeKarmaBuilder(execute, KARMA_BUILDER_INFO, (harness, setupTarget) => {
   describe('Option: "assets"', () => {
-    beforeEach(() => {
-      setupTarget(harness);
+    beforeEach(async () => {
+      await setupTarget(harness);
     });
 
     it('includes assets', async () => {
diff --git a/packages/angular_devkit/build_angular/src/builders/karma/tests/options/builder-mode_spec.ts b/packages/angular_devkit/build_angular/src/builders/karma/tests/options/builder-mode_spec.ts
@@ -14,13 +14,15 @@ const ESBUILD_LOG_TEXT = 'Application bundle generation complete.';
 
 describeKarmaBuilder(execute, KARMA_BUILDER_INFO, (harness, setupTarget, isApplicationTarget) => {
   describe('option: "builderMode"', () => {
-    beforeEach(() => {
-      setupTarget(harness);
+    beforeEach(async () => {
+      await setupTarget(harness);
     });
 
     it('"application" always uses esbuild', async () => {
       harness.useTarget('test', {
         ...BASE_OPTIONS,
+        // Must explicitly provide localize polyfill:
+        polyfills: ['zone.js', '@angular/localize/init', 'zone.js/testing'],
         builderMode: BuilderMode.Application,
       });
 
diff --git a/packages/angular_devkit/build_angular/src/builders/karma/tests/options/code-coverage-exclude_spec.ts b/packages/angular_devkit/build_angular/src/builders/karma/tests/options/code-coverage-exclude_spec.ts
@@ -26,8 +26,8 @@ describeKarmaBuilder(execute, KARMA_BUILDER_INFO, (harness, setupTarget, isAppli
       });
     }
 
-    beforeEach(() => {
-      setupTarget(harness);
+    beforeEach(async () => {
+      await setupTarget(harness);
     });
 
     it('should exclude file from coverage when set', async () => {
diff --git a/packages/angular_devkit/build_angular/src/builders/karma/tests/options/code-coverage_spec.ts b/packages/angular_devkit/build_angular/src/builders/karma/tests/options/code-coverage_spec.ts
@@ -27,8 +27,8 @@ describeKarmaBuilder(execute, KARMA_BUILDER_INFO, (harness, setupTarget, isAppli
       });
     }
 
-    beforeEach(() => {
-      setupTarget(harness);
+    beforeEach(async () => {
+      await setupTarget(harness);
     });
 
     it('should generate coverage report when option is set to true', async () => {
diff --git a/packages/angular_devkit/build_angular/src/builders/karma/tests/options/exclude_spec.ts b/packages/angular_devkit/build_angular/src/builders/karma/tests/options/exclude_spec.ts
@@ -11,8 +11,8 @@ import { BASE_OPTIONS, KARMA_BUILDER_INFO, describeKarmaBuilder } from '../setup
 
 describeKarmaBuilder(execute, KARMA_BUILDER_INFO, (harness, setupTarget) => {
   describe('Option: "exclude"', () => {
-    beforeEach(() => {
-      setupTarget(harness);
+    beforeEach(async () => {
+      await setupTarget(harness);
     });
 
     beforeEach(async () => {
diff --git a/packages/angular_devkit/build_angular/src/builders/karma/tests/options/include_spec.ts b/packages/angular_devkit/build_angular/src/builders/karma/tests/options/include_spec.ts
@@ -11,8 +11,8 @@ import { BASE_OPTIONS, KARMA_BUILDER_INFO, describeKarmaBuilder } from '../setup
 
 describeKarmaBuilder(execute, KARMA_BUILDER_INFO, (harness, setupTarget) => {
   describe('Option: "include"', () => {
-    beforeEach(() => {
-      setupTarget(harness);
+    beforeEach(async () => {
+      await setupTarget(harness);
     });
 
     it(`should fail when includes doesn't match any files`, async () => {
diff --git a/packages/angular_devkit/build_angular/src/builders/karma/tests/options/styles_spec.ts b/packages/angular_devkit/build_angular/src/builders/karma/tests/options/styles_spec.ts
@@ -11,8 +11,8 @@ import { BASE_OPTIONS, KARMA_BUILDER_INFO, describeKarmaBuilder } from '../setup
 
 describeKarmaBuilder(execute, KARMA_BUILDER_INFO, (harness, setupTarget) => {
   describe('Option: "styles"', () => {
-    beforeEach(() => {
-      setupTarget(harness);
+    beforeEach(async () => {
+      await setupTarget(harness);
     });
 
     it(`processes 'styles.css' styles`, async () => {
diff --git a/packages/angular_devkit/build_angular/src/builders/karma/tests/options/web-worker-tsconfig_spec.ts b/packages/angular_devkit/build_angular/src/builders/karma/tests/options/web-worker-tsconfig_spec.ts
@@ -11,8 +11,8 @@ import { BASE_OPTIONS, KARMA_BUILDER_INFO, describeKarmaBuilder } from '../setup
 
 describeKarmaBuilder(execute, KARMA_BUILDER_INFO, (harness, setupTarget, isApplicationBuilder) => {
   describe('Option: "webWorkerTsConfig"', () => {
-    beforeEach(() => {
-      setupTarget(harness);
+    beforeEach(async () => {
+      await setupTarget(harness);
     });
 
     beforeEach(async () => {
diff --git a/packages/angular_devkit/build_angular/src/builders/karma/tests/setup.ts b/packages/angular_devkit/build_angular/src/builders/karma/tests/setup.ts
@@ -35,7 +35,7 @@ export const KARMA_BUILDER_INFO = Object.freeze({
  * Also disables progress reporting to minimize logging output.
  */
 export const BASE_OPTIONS = Object.freeze<Schema>({
-  polyfills: ['zone.js', 'zone.js/testing'],
+  polyfills: ['./src/polyfills', 'zone.js/testing'],
   tsConfig: 'src/tsconfig.spec.json',
   karmaConfig: 'karma.conf.js',
   browsers: 'ChromeHeadlessCI',
@@ -62,10 +62,10 @@ function getCachedSchema(options: { schemaPath: string }): json.schema.JsonSchem
  * @param harness The builder harness to use when setting up the browser builder target
  * @param extraOptions The additional options that should be used when executing the target.
  */
-export function setupBrowserTarget<T>(
+export async function setupBrowserTarget<T>(
   harness: BuilderHarness<T>,
   extraOptions?: Partial<BrowserSchema>,
-): void {
+): Promise<void> {
   const browserSchema = getCachedSchema(BROWSER_BUILDER_INFO);
 
   harness.withBuilderTarget(
@@ -117,10 +117,10 @@ export const APPLICATION_BUILDER_INFO = Object.freeze({
  * @param harness The builder harness to use when setting up the application builder target
  * @param extraOptions The additional options that should be used when executing the target.
  */
-export function setupApplicationTarget<T>(
+export async function setupApplicationTarget<T>(
   harness: BuilderHarness<T>,
   extraOptions?: Partial<ApplicationSchema>,
-): void {
+): Promise<void> {
   const applicationSchema = getCachedSchema(APPLICATION_BUILDER_INFO);
 
   harness.withBuilderTarget(
@@ -135,6 +135,9 @@ export function setupApplicationTarget<T>(
       optionSchema: applicationSchema,
     },
   );
+
+  // For application-builder based targets, the localize polyfill needs to be explicit.
+  await harness.appendToFile('src/polyfills.ts', `import '@angular/localize/init';`);
 }
 
 /** Runs the test against both an application- and a browser-builder context. */

Original file line number	Diff line number	Diff line change
`@@ -29,8 +29,8 @@ describeKarmaBuilder(execute, KARMA_BUILDER_INFO, (harness, setupTarget, isAppli`
`29`	`29`	`});`
`30`	`30`	`}`
`31`	`31`
`32`		`- beforeEach(() => {`
`33`		`- setupTarget(harness);`
	`32`	`+ beforeEach(async () => {`
	`33`	`+ await setupTarget(harness);`
`34`	`34`	`});`
`35`	`35`
`36`	`36`	`it('should generate coverage report when file was previously processed by Babel', async () => {`
Original file line number	Diff line number	Diff line change
`@@ -18,8 +18,8 @@ describeKarmaBuilder(execute, KARMA_BUILDER_INFO, (harness, setupTarget, isAppli`
`18`	`18`	`});`
`19`	`19`	`}`
`20`	`20`
`21`		`- beforeEach(() => {`
`22`		`- setupTarget(harness);`
	`21`	`+ beforeEach(async () => {`
	`22`	`+ await setupTarget(harness);`
`23`	`23`	`});`
`24`	`24`
`25`	`25`	`it('recovers from compilation failures in watch mode', async () => {`
Original file line number	Diff line number	Diff line change
`@@ -26,8 +26,8 @@ describeKarmaBuilder(execute, KARMA_BUILDER_INFO, (harness, setupTarget, isAppli`
`26`	`26`	`});`
`27`	`27`	`}`
`28`	`28`
`29`		`- beforeEach(() => {`
`30`		`- setupTarget(harness);`
	`29`	`+ beforeEach(async () => {`
	`30`	`+ await setupTarget(harness);`
`31`	`31`	`});`
`32`	`32`
`33`	`33`	`it('should exclude file from coverage when set', async () => {`
Original file line number	Diff line number	Diff line change
`@@ -27,8 +27,8 @@ describeKarmaBuilder(execute, KARMA_BUILDER_INFO, (harness, setupTarget, isAppli`
`27`	`27`	`});`
`28`	`28`	`}`
`29`	`29`
`30`		`- beforeEach(() => {`
`31`		`- setupTarget(harness);`
	`30`	`+ beforeEach(async () => {`
	`31`	`+ await setupTarget(harness);`
`32`	`32`	`});`
`33`	`33`
`34`	`34`	`it('should generate coverage report when option is set to true', async () => {`