fix(angular): ensure paths are resolved correctly in ng-packagr execu…

…tors (#13059)

packages/angular/src/executors/ng-packagr-lite/ng-packagr-lite.impl.spec.ts

@@ -1,11 +1,13 @@
 jest.mock('@nrwl/devkit');
 jest.mock('@nrwl/workspace/src/utilities/buildable-libs-utils');
 jest.mock('ng-packagr');
+jest.mock('ng-packagr/lib/utils/ng-compiler-cli');
 jest.mock('./ng-packagr-adjustments/ng-package/options.di');
 
 import type { ExecutorContext } from '@nrwl/devkit';
 import * as buildableLibsUtils from '@nrwl/workspace/src/utilities/buildable-libs-utils';
 import * as ngPackagr from 'ng-packagr';
+import { ngCompilerCli } from 'ng-packagr/lib/utils/ng-compiler-cli';
 import { BehaviorSubject } from 'rxjs';
 import type { BuildAngularLibraryExecutorOptions } from '../package/schema';
 import { NX_ENTRY_POINT_PROVIDERS } from './ng-packagr-adjustments/ng-package/entry-point/entry-point.di';
@@ -23,6 +25,7 @@ describe('NgPackagrLite executor', () => {
   let ngPackagrWatchMock: jest.Mock;
   let ngPackagrWithBuildTransformMock: jest.Mock;
   let ngPackagrWithTsConfigMock: jest.Mock;
+  let ngCliReadConfigurationMock: jest.Mock;
   let options: BuildAngularLibraryExecutorOptions;
 
   beforeEach(async () => {
@@ -46,6 +49,10 @@ describe('NgPackagrLite executor', () => {
       withBuildTransform: ngPackagrWithBuildTransformMock,
       withTsConfig: ngPackagrWithTsConfigMock,
     }));
+    ngCliReadConfigurationMock = jest.fn();
+    (ngCompilerCli as jest.Mock).mockImplementation(() => ({
+      readConfiguration: ngCliReadConfigurationMock,
+    }));
 
     context = {
       root: '/root',
@@ -131,20 +138,27 @@ describe('NgPackagrLite executor', () => {
     (
       buildableLibsUtils.checkDependentProjectsHaveBeenBuilt as jest.Mock
     ).mockReturnValue(true);
-    const generatedTsConfig = '/root/tmp/my-lib/tsconfig.app.generated.json';
+    const tsConfig = 'libs/my-lib/tsconfig.lib.json';
+    const generatedTsConfig =
+      '/root/tmp/libs/my-lib/tsconfig.lib.generated.json';
     (buildableLibsUtils.createTmpTsConfig as jest.Mock).mockImplementation(
       () => generatedTsConfig
     );
+    ngCliReadConfigurationMock.mockReturnValue({
+      options: { configFilePath: generatedTsConfig },
+    });
 
     // ACT
     const result = await ngPackagrLiteExecutor(
-      { ...options, tsConfig: '/root/my-lib/tsconfig.app.json' },
+      { ...options, tsConfig },
       context
     ).next();
 
     // ASSERT
     expect(buildableLibsUtils.createTmpTsConfig).toHaveBeenCalled();
-    expect(ngPackagrWithTsConfigMock).toHaveBeenCalledWith(generatedTsConfig);
+    expect(ngPackagrWithTsConfigMock).toHaveBeenCalledWith({
+      options: { configFilePath: `/root/${tsConfig}` },
+    });
     expect(ngPackagrBuildMock).toHaveBeenCalled();
     expect(result.value).toEqual({ success: true });
     expect(result.done).toBe(true);

packages/angular/src/executors/ng-packagr-lite/ng-packagr-lite.impl.ts

@@ -7,6 +7,7 @@ import { NgPackagr } from 'ng-packagr';
 import { resolve } from 'path';
 import { createLibraryExecutor } from '../package/package.impl';
 import type { BuildAngularLibraryExecutorOptions } from '../package/schema';
+import { parseRemappedTsConfigAndMergeDefaults } from '../utilities/typescript';
 import { NX_ENTRY_POINT_PROVIDERS } from './ng-packagr-adjustments/ng-package/entry-point/entry-point.di';
 import { nxProvideOptions } from './ng-packagr-adjustments/ng-package/options.di';
 import {
@@ -32,13 +33,18 @@ async function initializeNgPackgrLite(
   packager.withBuildTransform(NX_PACKAGE_TRANSFORM.provide);
 
   if (options.tsConfig) {
-    const tsConfigPath = createTmpTsConfig(
+    const remappedTsConfigFilePath = createTmpTsConfig(
       options.tsConfig,
       context.root,
       context.workspace.projects[context.projectName].root,
       projectDependencies
     );
-    packager.withTsConfig(tsConfigPath);
+    const tsConfig = await parseRemappedTsConfigAndMergeDefaults(
+      context.root,
+      options.tsConfig,
+      remappedTsConfigFilePath
+    );
+    packager.withTsConfig(tsConfig);
   }
 
   return packager;

packages/angular/src/executors/package/package.impl.spec.ts

@@ -1,11 +1,13 @@
 jest.mock('@nrwl/devkit');
 jest.mock('@nrwl/workspace/src/utilities/buildable-libs-utils');
 jest.mock('ng-packagr');
+jest.mock('ng-packagr/lib/utils/ng-compiler-cli');
 jest.mock('./ng-packagr-adjustments/ng-package/options.di');
 
 import type { ExecutorContext } from '@nrwl/devkit';
 import * as buildableLibsUtils from '@nrwl/workspace/src/utilities/buildable-libs-utils';
 import * as ngPackagr from 'ng-packagr';
+import { ngCompilerCli } from 'ng-packagr/lib/utils/ng-compiler-cli';
 import { BehaviorSubject } from 'rxjs';
 import { NX_ENTRY_POINT_PROVIDERS } from './ng-packagr-adjustments/ng-package/entry-point/entry-point.di';
 import { nxProvideOptions } from './ng-packagr-adjustments/ng-package/options.di';
@@ -23,6 +25,7 @@ describe('Package executor', () => {
   let ngPackagrWatchMock: jest.Mock;
   let ngPackagrWithBuildTransformMock: jest.Mock;
   let ngPackagrWithTsConfigMock: jest.Mock;
+  let ngCliReadConfigurationMock: jest.Mock;
   let options: BuildAngularLibraryExecutorOptions;
 
   beforeEach(async () => {
@@ -45,6 +48,10 @@ describe('Package executor', () => {
       withBuildTransform: ngPackagrWithBuildTransformMock,
       withTsConfig: ngPackagrWithTsConfigMock,
     }));
+    ngCliReadConfigurationMock = jest.fn();
+    (ngCompilerCli as jest.Mock).mockImplementation(() => ({
+      readConfiguration: ngCliReadConfigurationMock,
+    }));
 
     context = {
       root: '/root',
@@ -129,18 +136,25 @@ describe('Package executor', () => {
     (
       buildableLibsUtils.checkDependentProjectsHaveBeenBuilt as jest.Mock
     ).mockReturnValue(true);
-    const generatedTsConfig = '/root/tmp/my-lib/tsconfig.app.generated.json';
+    const tsConfig = 'libs/my-lib/tsconfig.lib.json';
+    const generatedTsConfig =
+      '/root/tmp/libs/my-lib/tsconfig.lib.generated.json';
     (buildableLibsUtils.createTmpTsConfig as jest.Mock).mockImplementation(
       () => generatedTsConfig
     );
+    ngCliReadConfigurationMock.mockReturnValue({
+      options: { configFilePath: generatedTsConfig },
+    });
 
     const result = await packageExecutor(
-      { ...options, tsConfig: '/root/my-lib/tsconfig.app.json' },
+      { ...options, tsConfig },
       context
     ).next();
 
     expect(buildableLibsUtils.createTmpTsConfig).toHaveBeenCalled();
-    expect(ngPackagrWithTsConfigMock).toHaveBeenCalledWith(generatedTsConfig);
+    expect(ngPackagrWithTsConfigMock).toHaveBeenCalledWith({
+      options: { configFilePath: `/root/${tsConfig}` },
+    });
     expect(ngPackagrBuildMock).toHaveBeenCalled();
     expect(result.value).toEqual({ success: true });
     expect(result.done).toBe(true);

packages/angular/src/executors/package/package.impl.ts

@@ -11,6 +11,7 @@ import type { NgPackagr } from 'ng-packagr';
 import { resolve } from 'path';
 import { from } from 'rxjs';
 import { mapTo, switchMap, tap } from 'rxjs/operators';
+import { parseRemappedTsConfigAndMergeDefaults } from '../utilities/typescript';
 import { NX_ENTRY_POINT_PROVIDERS } from './ng-packagr-adjustments/ng-package/entry-point/entry-point.di';
 import { nxProvideOptions } from './ng-packagr-adjustments/ng-package/options.di';
 import {
@@ -37,13 +38,18 @@ async function initializeNgPackagr(
   packager.withBuildTransform(NX_PACKAGE_TRANSFORM.provide);
 
   if (options.tsConfig) {
-    const tsConfigPath = createTmpTsConfig(
+    const remappedTsConfigFilePath = createTmpTsConfig(
       options.tsConfig,
       context.root,
       context.workspace.projects[context.projectName].root,
       projectDependencies
     );
-    packager.withTsConfig(tsConfigPath);
+    const tsConfig = await parseRemappedTsConfigAndMergeDefaults(
+      context.root,
+      options.tsConfig,
+      remappedTsConfigFilePath
+    );
+    packager.withTsConfig(tsConfig);
   }
 
   return packager;

packages/angular/src/executors/utilities/typescript.ts

@@ -0,0 +1,62 @@
+/**
+ * Adapted from a private function at ng-packagr
+ * https://github.com/ng-packagr/ng-packagr/blob/main/src/lib/ts/tsconfig.ts#L12:
+ *
+ * Changes made:
+ * - Added an extra function that updates the configFilePath in the returned parsed options
+ * to be the original tsconfig file.
+ */
+
+import type {
+  CompilerOptions,
+  ParsedConfiguration,
+} from '@angular/compiler-cli';
+import { ngCompilerCli } from 'ng-packagr/lib/utils/ng-compiler-cli';
+import { resolve } from 'path';
+import * as ts from 'typescript';
+
+async function readDefaultTsConfig(
+  fileName: string
+): Promise<ParsedConfiguration> {
+  // these options are mandatory
+  const extraOptions: CompilerOptions = {
+    target: ts.ScriptTarget.ES2020,
+    experimentalDecorators: true,
+
+    // sourcemaps
+    sourceMap: false,
+    inlineSources: true,
+    inlineSourceMap: true,
+
+    outDir: '',
+    declaration: true,
+
+    // ng compiler to options
+    enableResourceInlining: true,
+
+    // these are required to set the appropriate EmitFlags
+    flatModuleId: 'AUTOGENERATED',
+    flatModuleOutFile: 'AUTOGENERATED',
+  };
+
+  const { readConfiguration } = await ngCompilerCli();
+
+  return readConfiguration(fileName, extraOptions);
+}
+
+/**
+ * Proxy function that ensures the configFilePath option points to the original file path.
+ */
+export async function parseRemappedTsConfigAndMergeDefaults(
+  workspaceRoot: string,
+  originalFilePath: string,
+  remappedFilePath: string
+): Promise<ParsedConfiguration> {
+  const parsedConfiguration = await readDefaultTsConfig(remappedFilePath);
+  parsedConfiguration.options.configFilePath = resolve(
+    workspaceRoot,
+    originalFilePath
+  );
+
+  return parsedConfiguration;
+}