fix(core): require.resolve(m/package.json) is not guarunteed to work …

…for modern module format
nrwl · May 27, 2022 · 4bcfeac · 4bcfeac
1 parent fea7e39
commit 4bcfeac
Show file tree

Hide file tree

Showing 18 changed files with 112 additions and 51 deletions.
diff --git a/e2e/cli/src/cli.test.ts b/e2e/cli/src/cli.test.ts
@@ -166,6 +166,7 @@ describe('migrate', () => {
       `./node_modules/migrate-parent-package/package.json`,
       JSON.stringify({
         version: '1.0.0',
+        name: 'migrate-parent-package',
         'nx-migrations': './migrations.json',
       })
     );
@@ -212,6 +213,7 @@ describe('migrate', () => {
       `./node_modules/migrate-child-package/package.json`,
       JSON.stringify({
         version: '1.0.0',
+        name: 'migrate-child-package',
       })
     );
 

diff --git a/packages/angular/src/executors/file-server/file-server.impl.ts b/packages/angular/src/executors/file-server/file-server.impl.ts
@@ -11,6 +11,7 @@ import { Schema } from './schema';
 import { watch } from 'chokidar';
 import { platform } from 'os';
 import { resolve } from 'path';
+import { readModulePackageJson } from 'nx/src/utils/package-json';
 
 // platform specific command name
 const pmCmd = platform() === 'win32' ? `npx.cmd` : 'npx';
@@ -153,7 +154,7 @@ export default async function* fileServerExecutor(
   const outputPath = getBuildTargetOutputPath(options, context);
   const args = getHttpServerArgs(options);
 
-  const pathToHttpServerPkgJson = require.resolve('http-server/package.json');
+  const pathToHttpServerPkgJson = readModulePackageJson('http-server').path;
   const pathToHttpServerBin = readJsonFile(pathToHttpServerPkgJson).bin[
     'http-server'
   ];

diff --git a/packages/angular/src/generators/ng-add/utilities/workspace.ts b/packages/angular/src/generators/ng-add/utilities/workspace.ts
@@ -16,6 +16,7 @@ import { resolveUserExistingPrettierConfig } from '@nrwl/workspace/src/utilities
 import { getRootTsConfigPathInTree } from '@nrwl/workspace/src/utilities/typescript';
 import { prettierVersion } from '@nrwl/workspace/src/utils/versions';
 import { readFileSync } from 'fs';
+import { readModulePackageJson } from 'nx/src/utils/package-json';
 import { dirname, join } from 'path';
 import { angularDevkitVersion, nxVersion } from '../../../utils/versions';
 import { GeneratorOptions } from '../schema';
@@ -82,7 +83,7 @@ export function createNxJson(
 }
 
 export function decorateAngularCli(tree: Tree): void {
-  const nrwlWorkspacePath = require.resolve('@nrwl/workspace/package.json');
+  const nrwlWorkspacePath = readModulePackageJson('@nrwl/workspace').path;
   const decorateCli = readFileSync(
     join(
       dirname(nrwlWorkspacePath),

diff --git a/packages/angular/src/utils/mfe/mfe-webpack.ts b/packages/angular/src/utils/mfe/mfe-webpack.ts
@@ -9,6 +9,7 @@ import {
   readTsConfig,
 } from '@nrwl/workspace/src/utilities/typescript';
 import { existsSync, lstatSync, readdirSync } from 'fs';
+import { readModulePackageJson } from 'nx/src/utils/package-json';
 import { dirname, join, normalize, relative } from 'path';
 import { ParsedCommandLine } from 'typescript';
 import { NormalModuleReplacementPlugin } from 'webpack';
@@ -143,9 +144,7 @@ function collectPackageSecondaryEntryPoints(
 ): void {
   let pathToPackage: string;
   try {
-    const packageJsonPath = require.resolve(`${pkgName}/package.json`, {
-      paths: [workspaceRoot],
-    });
+    const packageJsonPath = readModulePackageJson(pkgName).path;
     pathToPackage = dirname(packageJsonPath);
   } catch {
     // the package.json might not resolve if the package has the "exports"

diff --git a/packages/make-angular-cli-faster/src/utilities/migration.ts b/packages/make-angular-cli-faster/src/utilities/migration.ts
@@ -6,6 +6,7 @@ import {
 } from '@nrwl/devkit';
 import { execSync } from 'child_process';
 import { prompt } from 'enquirer';
+import { readModulePackageJson } from 'nx/src/utils/package-json';
 import { lt, lte, major, satisfies } from 'semver';
 import { resolvePackageVersion } from './package-manager';
 import { MigrationDefinition } from './types';
@@ -173,10 +174,7 @@ async function promptForVersion(version: string): Promise<boolean> {
 }
 
 function getInstalledAngularVersion(): string {
-  const packageJsonPath = require.resolve('@angular/core/package.json', {
-    paths: [workspaceRoot],
-  });
-  return readJsonFile(packageJsonPath).version;
+  return readModulePackageJson('@angular/core').packageJson.version;
 }
 
 async function normalizeVersion(version: string): Promise<string> {

diff --git a/packages/nx/src/adapter/ngcli-adapter.ts b/packages/nx/src/adapter/ngcli-adapter.ts
@@ -39,6 +39,7 @@ import {
   WorkspaceJsonConfiguration,
 } from '../config/workspace-json-project-json';
 import { readNxJson } from '../generators/utils/project-configuration';
+import { readModulePackageJson } from '../utils/package-json';
 
 export async function scheduleTarget(
   root: string,
@@ -891,9 +892,7 @@ function resolveMigrationsCollection(name: string): string {
   } else {
     let packageJsonPath;
     try {
-      packageJsonPath = require.resolve(join(name, 'package.json'), {
-        paths: [process.cwd()],
-      });
+      packageJsonPath = readModulePackageJson(name, [process.cwd()]).path;
     } catch (e) {
       // workaround for a bug in node 12
       packageJsonPath = require.resolve(

diff --git a/packages/nx/src/command-line/migrate.ts b/packages/nx/src/command-line/migrate.ts
@@ -20,6 +20,7 @@ import {
   NxMigrationsConfiguration,
   PackageGroup,
   PackageJson,
+  readModulePackageJson,
 } from '../utils/package-json';
 import {
   createTempNpmDirectory,
@@ -466,10 +467,8 @@ function versions(root: string, from: Record<string, string>) {
       }
 
       if (!cache[packageName]) {
-        const packageJsonPath = require.resolve(`${packageName}/package.json`, {
-          paths: [root],
-        });
-        cache[packageName] = readJsonFile(packageJsonPath).version;
+        const { packageJson } = readModulePackageJson(packageName, [root]);
+        cache[packageName] = packageJson.version;
       }
 
       return cache[packageName];
@@ -713,11 +712,11 @@ function readPackageMigrationConfig(
   packageName: string,
   dir: string
 ): PackageMigrationConfig {
-  const packageJsonPath = require.resolve(`${packageName}/package.json`, {
-    paths: [dir],
-  });
+  const { path: packageJsonPath, packageJson: json } = readModulePackageJson(
+    packageName,
+    [dir]
+  );
 
-  const json = readJsonFile<PackageJson>(packageJsonPath);
   const migrationConfigOrFile = json['nx-migrations'] || json['ng-update'];
 
   if (!migrationConfigOrFile) {

diff --git a/packages/nx/src/command-line/report.ts b/packages/nx/src/command-line/report.ts
@@ -7,6 +7,7 @@ import {
   getPackageManagerVersion,
 } from '../utils/package-manager';
 import { readJsonFile } from '../utils/fileutils';
+import { PackageJson, readModulePackageJson } from '../utils/package-json';
 
 export const packagesWeCareAbout = [
   'nx',
@@ -77,19 +78,16 @@ export function reportHandler() {
   });
 }
 
-export function readPackageJson(p: string) {
+export function readPackageJson(p: string): PackageJson | null {
   try {
-    const packageJsonPath = require.resolve(`${p}/package.json`, {
-      paths: [workspaceRoot],
-    });
-    return readJsonFile(packageJsonPath);
+    return readModulePackageJson(p).packageJson;
   } catch {
-    return {};
+    return null;
   }
 }
 
 export function readPackageVersion(p: string): string {
-  return readPackageJson(p).version || 'Not Found';
+  return readPackageJson(p)?.version || 'Not Found';
 }
 
 export function findInstalledCommunityPlugins(): {
@@ -116,7 +114,8 @@ export function findInstalledCommunityPlugins(): {
         return arr;
       }
       try {
-        const depPackageJson = readPackageJson(nextDep);
+        const depPackageJson: Partial<PackageJson> =
+          readPackageJson(nextDep) || {};
         if (
           [
             'ng-update',

diff --git a/packages/nx/src/utils/nx-plugin.ts b/packages/nx/src/utils/nx-plugin.ts
@@ -6,7 +6,7 @@ import { Workspaces } from '../config/workspaces';
 
 import { workspaceRoot } from '../utils/app-root';
 import { readJsonFile } from '../utils/fileutils';
-import { PackageJson } from './package-json';
+import { PackageJson, readModulePackageJson } from './package-json';
 import { registerTsProject } from './register';
 import {
   ProjectConfiguration,
@@ -117,11 +117,12 @@ export function readPluginPackageJson(
   path: string;
   json: PackageJson;
 } {
-  let packageJsonPath: string;
   try {
-    packageJsonPath = require.resolve(`${pluginName}/package.json`, {
-      paths,
-    });
+    const result = readModulePackageJson(pluginName, paths);
+    return {
+      json: result.packageJson,
+      path: result.path,
+    };
   } catch (e) {
     if (e.code === 'MODULE_NOT_FOUND') {
       const localPluginPath = resolveLocalNxPlugin(pluginName);
@@ -138,7 +139,6 @@ export function readPluginPackageJson(
     }
     throw e;
   }
-  return { json: readJsonFile(packageJsonPath), path: packageJsonPath };
 }
 
 /**

diff --git a/packages/nx/src/utils/package-json.spec.ts b/packages/nx/src/utils/package-json.spec.ts
@@ -1,6 +1,11 @@
+import { join } from 'path';
+import { workspaceRoot } from './app-root';
+import { readJsonFile } from './fileutils';
 import {
   buildTargetFromScript,
+  PackageJson,
   PackageJsonTargetConfiguration,
+  readModulePackageJson,
 } from './package-json';
 
 describe('buildTargetFromScript', () => {
@@ -38,3 +43,18 @@ describe('buildTargetFromScript', () => {
     expect(target.executor).toEqual('nx:run-script');
   });
 });
+
+const rootPackageJson: PackageJson = readJsonFile(
+  join(workspaceRoot, 'package.json')
+);
+
+const dependencies = [
+  ...Object.keys(rootPackageJson.dependencies),
+  ...Object.keys(rootPackageJson.devDependencies),
+];
+
+describe('readModulePackageJson', () => {
+  it.each(dependencies)(`should be able to find %s`, (s) => {
+    expect(() => readModulePackageJson(s)).not.toThrow();
+  });
+});
diff --git a/packages/nx/src/utils/package-json.ts b/packages/nx/src/utils/package-json.ts
@@ -1,4 +1,8 @@
+import { existsSync } from 'fs';
+import { dirname, join } from 'path';
 import { TargetConfiguration } from '../config/workspace-json-project-json';
+import { workspaceRoot } from './app-root';
+import { readJsonFile } from './fileutils';
 
 export type PackageJsonTargetConfiguration = Omit<
   TargetConfiguration,
@@ -69,3 +73,42 @@ export function buildTargetFromScript(
     },
   };
 }
+
+export function readModulePackageJson(
+  moduleSpecifier: string,
+  requirePaths = [workspaceRoot]
+): {
+  packageJson: PackageJson;
+  path: string;
+} {
+  let packageJsonPath: string;
+  try {
+    packageJsonPath = require.resolve(`${moduleSpecifier}/package.json`, {
+      paths: requirePaths,
+    });
+  } catch (e) {
+    const entryPoint = require.resolve(moduleSpecifier, {
+      paths: requirePaths,
+    });
+    let moduleRootPath = dirname(entryPoint);
+    packageJsonPath = join(moduleRootPath, 'package.json');
+
+    while (!existsSync(packageJsonPath)) {
+      moduleRootPath = dirname(moduleRootPath);
+      packageJsonPath = join(moduleRootPath, 'package.json');
+    }
+  }
+
+  const packageJson = readJsonFile(packageJsonPath);
+
+  if (packageJson.name !== moduleSpecifier) {
+    throw new Error(
+      `Found module ${packageJson.name} while trying to locate ${moduleSpecifier}/package.json`
+    );
+  }
+
+  return {
+    packageJson,
+    path: packageJsonPath,
+  };
+}
diff --git a/packages/nx/src/utils/package-manager.ts b/packages/nx/src/utils/package-manager.ts
@@ -5,7 +5,7 @@ import { dirname, join } from 'path';
 import { dirSync } from 'tmp';
 import { promisify } from 'util';
 import { readJsonFile, writeJsonFile } from './fileutils';
-import { PackageJson } from './package-json';
+import { PackageJson, readModulePackageJson } from './package-json';
 import { gte, lt } from 'semver';
 
 const execAsync = promisify(exec);
@@ -198,11 +198,9 @@ export async function resolvePackageVersionUsingInstallation(
     const pmc = getPackageManagerCommand();
     await execAsync(`${pmc.add} ${packageName}@${version}`, { cwd: dir });
 
-    const packageJsonPath = require.resolve(`${packageName}/package.json`, {
-      paths: [dir],
-    });
+    const { packageJson } = readModulePackageJson(packageName, [dir]);
 
-    return readJsonFile<PackageJson>(packageJsonPath).version;
+    return packageJson.version;
   } finally {
     await cleanup();
   }

diff --git a/packages/nx/src/utils/plugins/installed-plugins.ts b/packages/nx/src/utils/plugins/installed-plugins.ts
@@ -4,6 +4,7 @@ import type { CommunityPlugin, CorePlugin, PluginCapabilities } from './models';
 import { getPluginCapabilities } from './plugin-capabilities';
 import { hasElements } from './shared';
 import { readJsonFile } from '../fileutils';
+import { readModulePackageJson } from '../package-json';
 
 export function getInstalledPluginsFromPackageJson(
   workspaceRoot: string,
@@ -25,7 +26,7 @@ export function getInstalledPluginsFromPackageJson(
         try {
           // Check for `package.json` existence instead of requiring the module itself
           // because malformed entries like `main`, may throw false exceptions.
-          require.resolve(`${name}/package.json`, { paths: [workspaceRoot] });
+          readModulePackageJson(name, [workspaceRoot]);
           return true;
         } catch {
           return false;

diff --git a/packages/nx/src/utils/plugins/plugin-capabilities.ts b/packages/nx/src/utils/plugins/plugin-capabilities.ts
@@ -6,6 +6,7 @@ import type { PluginCapabilities } from './models';
 import { hasElements } from './shared';
 import { readJsonFile } from '../fileutils';
 import { getPackageManagerCommand } from '../package-manager';
+import { readModulePackageJson } from '../package-json';
 
 function tryGetCollection<T extends object>(
   packageJsonPath: string,
@@ -29,10 +30,8 @@ export function getPluginCapabilities(
   pluginName: string
 ): PluginCapabilities | null {
   try {
-    const packageJsonPath = require.resolve(`${pluginName}/package.json`, {
-      paths: [workspaceRoot],
-    });
-    const packageJson = readJsonFile(packageJsonPath);
+    const { packageJson, path: packageJsonPath } =
+      readModulePackageJson(pluginName);
     return {
       name: pluginName,
       generators:

diff --git a/packages/web/src/executors/file-server/file-server.impl.ts b/packages/web/src/executors/file-server/file-server.impl.ts
@@ -12,6 +12,7 @@ import { Schema } from './schema';
 import { watch } from 'chokidar';
 import { platform } from 'os';
 import { resolve } from 'path';
+import { readModulePackageJson } from 'nx/src/utils/package-json';
 
 // platform specific command name
 const pmCmd = platform() === 'win32' ? `npx.cmd` : 'npx';
@@ -153,7 +154,7 @@ export default async function* fileServerExecutor(
   const outputPath = getBuildTargetOutputPath(options, context);
   const args = getHttpServerArgs(options);
 
-  const pathToHttpServerPkgJson = require.resolve('http-server/package.json');
+  const pathToHttpServerPkgJson = readModulePackageJson('http-server').path;
   const pathToHttpServerBin = readJsonFile(pathToHttpServerPkgJson).bin[
     'http-server'
   ];

diff --git a/packages/workspace/src/utilities/plugins/installed-plugins.ts b/packages/workspace/src/utilities/plugins/installed-plugins.ts
@@ -4,6 +4,7 @@ import { output } from '../output';
 import type { CommunityPlugin, CorePlugin, PluginCapabilities } from './models';
 import { getPluginCapabilities } from './plugin-capabilities';
 import { hasElements } from './shared';
+import { readModulePackageJson } from 'nx/src/utils/package-json';
 
 export function getInstalledPluginsFromPackageJson(
   workspaceRoot: string,
@@ -25,7 +26,7 @@ export function getInstalledPluginsFromPackageJson(
         try {
           // Check for `package.json` existence instead of requiring the module itself
           // because malformed entries like `main`, may throw false exceptions.
-          require.resolve(`${name}/package.json`, { paths: [workspaceRoot] });
+          readModulePackageJson(name);
           return true;
         } catch {
           return false;