fixup! fix(@angular/build): conditionally declare tslib in built library package

Author: alan-agius4

packages/angular/build/src/builders/library/builder.ts

@@ -8,7 +8,6 @@
 
 import type { BuilderContext, BuilderOutput } from '@angular-devkit/architect';
 import type { logging } from '@angular-devkit/core';
-import fs from 'node:fs/promises';
 import {
   resetSassWorkerPoolCaches,
   shutdownSassWorkerPool,
@@ -27,8 +26,9 @@ import type { BuildWatcher } from '../../utils/watcher';
 import { normalizeLibraryOptions } from './options';
 import { updateWatchedEntryPoints } from './pipeline/entry-points';
 import type { createComponentStylesheetBundlerForLibrary } from './pipeline/stylesheet-bundler';
+import { loadPackageJson } from './pipeline/utils';
 import type { Schema as LibraryBuilderOptions } from './schema';
-import type { NormalizedLibraryOptions, PackageJsonData, SingleBuildState } from './types';
+import type { NormalizedLibraryOptions, SingleBuildState } from './types';
 
 /**
  * Executes the library builder to compile, bundle, and package an Angular library into the Angular Package Format (APF).
@@ -330,15 +330,6 @@ async function* runWatchLoop(
   }
 }
 
-/**
- * Loads and parses a JSON file from disk.
- */
-async function loadPackageJson(packageJsonPath: string): Promise<PackageJsonData> {
-  const content = await fs.readFile(packageJsonPath, 'utf-8');
-
-  return JSON.parse(content) as PackageJsonData;
-}
-
 /**
  * Logs the build completion time and status.
  */

packages/angular/build/src/builders/library/options.ts

@@ -7,7 +7,6 @@
  */
 
 import type { BuilderContext } from '@angular-devkit/architect';
-import fs from 'node:fs/promises';
 import path from 'node:path';
 import type { StylesheetPluginsass } from '../../tools/esbuild/stylesheets/stylesheet-plugin-factory';
 import { normalizeAssetPatterns } from '../../utils';
@@ -22,6 +21,7 @@ import {
 } from '../../utils/postcss-configuration';
 import { getProjectRootPaths } from '../../utils/project-metadata';
 import { normalizeEntryPoints } from './pipeline/entry-points';
+import { loadPackageJson } from './pipeline/utils';
 import type { Schema as LibraryBuilderOptions } from './schema';
 import type { NormalizedLibraryOptions, PackageJsonData } from './types';
 
@@ -69,8 +69,7 @@ export async function normalizeLibraryOptions(
 
   let packageJson: PackageJsonData;
   try {
-    const packageJsonContent = await fs.readFile(packageJsonPath, 'utf8');
-    packageJson = JSON.parse(packageJsonContent) as PackageJsonData;
+    packageJson = await loadPackageJson(packageJsonPath);
   } catch (error) {
     assertIsError(error);
     throw new Error(`Failed to read 'package.json' at '${packageJsonPath}': ${error.message}`, {

packages/angular/build/src/builders/library/pipeline/build-action.ts

@@ -175,7 +175,7 @@ export async function buildAction(actionContext: BuildActionContext): Promise<vo
   }
 
   if (shouldGenerateManifests || buildState.hasEmittedTslib !== hasTslibImport) {
-    filesToEmit.push(...generatePackageManifests(options, isWatchMode, hasTslibImport));
+    filesToEmit.push(...(await generatePackageManifests(options, isWatchMode, hasTslibImport)));
   }
 
   filesToEmit.push(

packages/angular/build/src/builders/library/pipeline/package-manifests.ts

@@ -14,6 +14,7 @@ import {
   type MemoryOutputFile,
   TYPES_OUTPUT_DIR,
   createMemoryOutputFile,
+  loadPackageJson,
 } from './utils';
 
 /**
@@ -24,11 +25,11 @@ import {
  * @param hasTslibImport Whether any output chunk imports 'tslib'.
  * @returns An array of memory output files containing generated package manifests and .npmignore.
  */
-export function generatePackageManifests(
+export async function generatePackageManifests(
   options: NormalizedLibraryOptions,
   isWatchMode: boolean,
   hasTslibImport = false,
-): MemoryOutputFile[] {
+): Promise<MemoryOutputFile[]> {
   const { packageJson: rawPackageJson, keepLifecycleScripts, compilationMode } = options;
 
   const {
@@ -77,7 +78,7 @@ export function generatePackageManifests(
   };
 
   if (hasTslibImport && !rawPackageJson.dependencies?.['tslib']) {
-    const tslibVersion = getAngularTslibRange(options.workspaceRoot);
+    const tslibVersion = await getAngularTslibRange(options.workspaceRoot);
     if (tslibVersion) {
       distPackageJson.dependencies = {
         ...rawPackageJson.dependencies,
@@ -190,25 +191,25 @@ let cachedTslibRange: string | undefined;
  * @param workspaceRoot path to the workspace root
  * @returns tslib range
  */
-function getAngularTslibRange(workspaceRoot: string): string {
+async function getAngularTslibRange(workspaceRoot: string): Promise<string> {
   if (cachedTslibRange) {
     return cachedTslibRange;
   }
 
-  const workspaceRequire = createRequire(path.join(workspaceRoot, '/'));
+  const workspaceRequire = createRequire(path.join(workspaceRoot, 'package.json'));
 
   // Try resolving via @angular/compiler dependencies
   try {
-    const angularCompilerPkg = workspaceRequire('@angular/compiler/package.json') as {
-      dependencies?: Record<string, string>;
-    };
+    const angularCompilerPkg = await loadPackageJson(
+      workspaceRequire.resolve('@angular/compiler/package.json'),
+    );
     cachedTslibRange = angularCompilerPkg.dependencies?.['tslib'];
   } catch {}
 
   // Fallback: Try resolving tslib directly
   if (!cachedTslibRange) {
     try {
-      const tslibPkg = workspaceRequire('tslib/package.json') as { version?: string };
+      const tslibPkg = await loadPackageJson(workspaceRequire.resolve('tslib/package.json'));
       if (tslibPkg.version) {
         cachedTslibRange = `^${tslibPkg.version}`;
       }

packages/angular/build/src/builders/library/pipeline/package-manifests_spec.ts

@@ -93,7 +93,7 @@ describe('generatePackageManifests', () => {
     };
   }
 
-  it('should generate a valid APF package.json for an unscoped package', () => {
+  it('should generate a valid APF package.json for an unscoped package', async () => {
     const options = createOptions({
       packageJson: {
         name: 'my-lib',
@@ -108,7 +108,7 @@ describe('generatePackageManifests', () => {
       },
     });
 
-    const files = generatePackageManifests(options, false);
+    const files = await generatePackageManifests(options, false);
     const result = getRootPackageJson(files);
 
     expect(result).toEqual({
@@ -131,15 +131,15 @@ describe('generatePackageManifests', () => {
     });
   });
 
-  it('should sanitize scoped package names in fesm and types paths', () => {
+  it('should sanitize scoped package names in fesm and types paths', async () => {
     const options = createOptions({
       packageJson: {
         name: '@my-scope/my-lib',
         version: '2.1.0',
       },
     });
 
-    const files = generatePackageManifests(options, false);
+    const files = await generatePackageManifests(options, false);
     const result = getRootPackageJson(files);
 
     expect(result).toEqual(
@@ -158,7 +158,7 @@ describe('generatePackageManifests', () => {
     );
   });
 
-  it('should retain scripts when keepLifecycleScripts is true', () => {
+  it('should retain scripts when keepLifecycleScripts is true', async () => {
     const options = createOptions({
       keepLifecycleScripts: true,
       packageJson: {
@@ -170,12 +170,12 @@ describe('generatePackageManifests', () => {
       },
     });
 
-    const files = generatePackageManifests(options, false);
+    const files = await generatePackageManifests(options, false);
     const result = getRootPackageJson(files);
     expect(result.scripts).toEqual({ postinstall: 'echo done' });
   });
 
-  it('should configure secondary entry points and create secondary manifests', () => {
+  it('should configure secondary entry points and create secondary manifests', async () => {
     const options = createOptions(
       {
         packageJson: {
@@ -186,7 +186,7 @@ describe('generatePackageManifests', () => {
       true,
     );
 
-    const files = generatePackageManifests(options, false);
+    const files = await generatePackageManifests(options, false);
     const result = getRootPackageJson(files);
 
     expect(result.exports).toEqual(
@@ -210,20 +210,20 @@ describe('generatePackageManifests', () => {
     expect(npmignoreFile?.contents).toContain('/testing/package.json');
   });
 
-  it('should inject watch version when isWatchMode is true', () => {
+  it('should inject watch version when isWatchMode is true', async () => {
     const options = createOptions({
       packageJson: {
         name: 'my-lib',
         version: '1.0.0',
       },
     });
 
-    const files = generatePackageManifests(options, true);
+    const files = await generatePackageManifests(options, true);
     const result = getRootPackageJson(files);
     expect(result.version).toMatch(/^0\.0\.0-watch\+\d+$/);
   });
 
-  it('should throw an error if primary entry point is missing', () => {
+  it('should throw an error if primary entry point is missing', async () => {
     const options = createOptions({
       packageJson: {
         name: 'my-lib',
@@ -232,12 +232,12 @@ describe('generatePackageManifests', () => {
       entryPoints: new Map(),
     });
 
-    expect(() => generatePackageManifests(options, false)).toThrowError(
+    await expectAsync(generatePackageManifests(options, false)).toBeRejectedWithError(
       /Primary entry point '\.' was not found in entryPoints\./,
     );
   });
 
-  it('should inject prepublishOnly guard script when compilationMode is full', () => {
+  it('should inject prepublishOnly guard script when compilationMode is full', async () => {
     const options = createOptions({
       compilationMode: 'full',
       packageJson: {
@@ -246,14 +246,14 @@ describe('generatePackageManifests', () => {
       },
     });
 
-    const files = generatePackageManifests(options, false);
+    const files = await generatePackageManifests(options, false);
     const result = getRootPackageJson(files);
     expect(result.scripts?.['prepublishOnly']).toContain(
       'Trying to publish a package that has been compiled in full compilation mode',
     );
   });
 
-  it('should preserve custom user exports in package.json and merge subpath conditions', () => {
+  it('should preserve custom user exports in package.json and merge subpath conditions', async () => {
     const options = createOptions({
       packageJson: {
         name: 'my-lib',
@@ -268,7 +268,7 @@ describe('generatePackageManifests', () => {
       },
     });
 
-    const files = generatePackageManifests(options, false);
+    const files = await generatePackageManifests(options, false);
     const result = getRootPackageJson(files);
 
     expect(result.exports).toEqual({
@@ -283,8 +283,8 @@ describe('generatePackageManifests', () => {
     });
   });
 
-  it('should default sideEffects to false if not specified, and preserve when set', () => {
-    const files1 = generatePackageManifests(
+  it('should default sideEffects to false if not specified, and preserve when set', async () => {
+    const files1 = await generatePackageManifests(
       createOptions({
         packageJson: {
           name: 'my-lib',
@@ -295,7 +295,7 @@ describe('generatePackageManifests', () => {
     );
     expect(getRootPackageJson(files1).sideEffects).toBeFalse();
 
-    const files2 = generatePackageManifests(
+    const files2 = await generatePackageManifests(
       createOptions({
         packageJson: {
           name: 'my-lib',
@@ -308,7 +308,7 @@ describe('generatePackageManifests', () => {
     expect(getRootPackageJson(files2).sideEffects).toEqual(['*.css']);
   });
 
-  it('should conditionally inject tslib into dependencies only when hasTslibImport is true', () => {
+  it('should conditionally inject tslib into dependencies only when hasTslibImport is true', async () => {
     const options = createOptions({
       workspaceRoot: process.cwd(),
       packageJson: {
@@ -317,17 +317,17 @@ describe('generatePackageManifests', () => {
       },
     });
 
-    const filesWithoutTslib = generatePackageManifests(options, false, false);
+    const filesWithoutTslib = await generatePackageManifests(options, false, false);
     expect(getRootPackageJson(filesWithoutTslib).dependencies).toBeUndefined();
 
-    const filesWithTslib = generatePackageManifests(options, false, true);
+    const filesWithTslib = await generatePackageManifests(options, false, true);
     expect(getRootPackageJson(filesWithTslib).dependencies).toEqual({
       tslib: jasmine.any(String),
     });
   });
 
-  it('should preserve existing user tslib declaration when hasTslibImport is true', () => {
-    const filesInDeps = generatePackageManifests(
+  it('should preserve existing user tslib declaration when hasTslibImport is true', async () => {
+    const filesInDeps = await generatePackageManifests(
       createOptions({
         workspaceRoot: process.cwd(),
         packageJson: {

packages/angular/build/src/builders/library/pipeline/utils.ts

@@ -6,6 +6,9 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
+import fs from 'node:fs/promises';
+import type { PackageJsonData } from '../types';
+
 const IS_DTS_FILE_REGEXP = /\.d\.[cm]?ts$/i;
 const IS_DTS_MAP_FILE_REGEXP = /\.d\.[cm]?ts\.map$/i;
 
@@ -105,3 +108,15 @@ export function isDeclarationFile(path: string): boolean {
 export function isDeclarationSourceMapFile(path: string): boolean {
   return IS_DTS_MAP_FILE_REGEXP.test(path);
 }
+
+/**
+ * Loads and parses a package.json file from disk.
+ *
+ * @param packageJsonPath The path to the package.json file.
+ * @returns The parsed package.json data.
+ */
+export async function loadPackageJson(packageJsonPath: string): Promise<PackageJsonData> {
+  const content = await fs.readFile(packageJsonPath, 'utf-8');
+
+  return JSON.parse(content) as PackageJsonData;
+}