fix(ng-dev): check pnpm lock for latest ng-dev version when running release tool

Currently we only check `yarn.lock`, but in e.g. CLI we already removed
the yarn lock file.

Author: devversion

ng-dev/utils/constants.ts

@@ -11,6 +11,3 @@ export const ngDevNpmPackageName = '@angular/ng-dev';
 
 /** Workspace-relative path for the "package.json" file. */
 export const workspaceRelativePackageJsonPath = 'package.json';
-
-/** Workspace-relative path for the "yarn.lock" file. */
-export const workspaceRelativeYarnLockFilePath = 'yarn.lock';

ng-dev/utils/version-check.ts

@@ -10,36 +10,50 @@ import * as path from 'path';
 import * as fs from 'fs';
 import lockfile from '@yarnpkg/lockfile';
 import {parse as parseYaml} from 'yaml';
-import {
-  ngDevNpmPackageName,
-  workspaceRelativePackageJsonPath,
-  workspaceRelativeYarnLockFilePath,
-} from './constants.js';
+import {ngDevNpmPackageName, workspaceRelativePackageJsonPath} from './constants.js';
 import {Log} from './logging.js';
 
 /**
  * Verifies that the `ng-dev` tool is up-to-date in the workspace. The check will compare
  * the local version of the tool against the requested version in the workspace lock file.
  *
  * This check is helpful ensuring that the caretaker does not accidentally run with an older
- * local version of `ng-dev` due to not running `yarn` after checking out new revisions.
+ * local version of `ng-dev` due to not running `yarn`/`pnpm` after checking out new revisions.
  *
  * @returns a boolean indicating success or failure.
  */
 export async function verifyNgDevToolIsUpToDate(workspacePath: string): Promise<boolean> {
   // The placeholder will be replaced by the `pkg_npm` substitutions.
   const localVersion = `0.0.0-{SCM_HEAD_SHA}`;
   const workspacePackageJsonFile = path.join(workspacePath, workspaceRelativePackageJsonPath);
-  const workspaceDirLockFile = path.join(workspacePath, workspaceRelativeYarnLockFilePath);
+  const pnpmLockFile = path.join(workspacePath, 'pnpm-lock.yaml');
+  const yarnLockFile = path.join(workspacePath, 'yarn.lock');
 
+  // TODO: Clean up this logic when fully dropping Yarn
+  const isPnpmMigrated = fs.existsSync(pnpmLockFile) && !fs.existsSync(yarnLockFile);
+  const expectedVersion = isPnpmMigrated
+    ? getExpectedVersionFromPnpmLock(workspacePackageJsonFile, pnpmLockFile)
+    : getExpectedVersionFromYarnLock(workspacePackageJsonFile, yarnLockFile);
+
+  if (localVersion !== expectedVersion) {
+    Log.error('  ✘   Your locally installed version of the `ng-dev` tool is outdated and not');
+    Log.error('      matching with the version in the `package.json` file.');
+    Log.error('      Re-install the dependencies to ensure you are using the correct version.');
+    return false;
+  }
+
+  return true;
+}
+
+function getExpectedVersionFromYarnLock(workspacePackageJsonFile: string, lockFilePath: string) {
   try {
     const packageJson = JSON.parse(fs.readFileSync(workspacePackageJsonFile, 'utf8')) as any;
     // If we are operating in the actual dev-infra repo, always return `true`.
     if (packageJson.name === ngDevNpmPackageName) {
       return true;
     }
 
-    const lockFileContent = fs.readFileSync(workspaceDirLockFile, 'utf8');
+    const lockFileContent = fs.readFileSync(lockFilePath, 'utf8');
 
     let lockFileObject: Record<string, {version: string}>;
     try {
@@ -57,17 +71,27 @@ export async function verifyNgDevToolIsUpToDate(workspacePath: string): Promise<
       packageJson?.dependencies?.[ngDevNpmPackageName] ??
       packageJson?.devDependencies?.[ngDevNpmPackageName] ??
       packageJson?.optionalDependencies?.[ngDevNpmPackageName];
-    const expectedVersion = lockFileObject[`${ngDevNpmPackageName}@${devInfraPkgVersion}`].version;
+    return lockFileObject[`${ngDevNpmPackageName}@${devInfraPkgVersion}`].version;
+  } catch (e) {
+    Log.debug('Could not find expected ng-dev version from `yarn.lock` file:', e);
+    return null;
+  }
+}
 
-    if (localVersion !== expectedVersion) {
-      Log.error('  ✘   Your locally installed version of the `ng-dev` tool is outdated and not');
-      Log.error('      matching with the version in the `package.json` file.');
-      Log.error('      Re-install the dependencies to ensure you are using the correct version.');
-      return false;
+function getExpectedVersionFromPnpmLock(workspacePackageJsonFile: string, lockFilePath: string) {
+  try {
+    const packageJson = JSON.parse(fs.readFileSync(workspacePackageJsonFile, 'utf8')) as any;
+    // If we are operating in the actual dev-infra repo, always return `true`.
+    if (packageJson.name === ngDevNpmPackageName) {
+      return true;
     }
-    return true;
+
+    const lockFileContent = fs.readFileSync(lockFilePath, 'utf8');
+    const lockFile = parseYaml(lockFileContent);
+    const ngDevVersionSpecifier = lockFile['importers']['.']['@angular/ng-dev'];
+    return lockFile['packages'][`@angular/ng-dev@${ngDevVersionSpecifier}`].version;
   } catch (e) {
-    Log.error(e);
-    return false;
+    Log.debug('Could not find expected ng-dev version from `pnpm-lock.yaml` file:', e);
+    return null;
   }
 }