Use openapi-validator from node_modules, bypassing autorest's package manager

Author: danieljurek

eng/tools/lint-diff/package.json

@@ -15,6 +15,7 @@
   "dependencies": {
     "@azure-tools/openapi-tools-common": "^1.2.2",
     "@azure/openapi-markdown": "^0.9.4",
+    "@microsoft.azure/openapi-validator": "2.2.3",
     "autorest": "3.6.1",
     "commonmark": "^0.31.2"
   },

eng/tools/lint-diff/src/lint-diff.ts

@@ -3,7 +3,7 @@ import { exec } from "node:child_process";
 import { parseArgs, ParseArgsConfig } from "node:util";
 import { getOpenapiType, getAllTags, getInputFiles } from "./markdown-parser.js";
 import { sep, dirname, join } from "path";
-import { pathExists } from "./util.js";
+import { pathExists, getPathToDependency } from "./util.js";
 
 // 64 MiB max ouptut buffers for exec
 const MAX_EXEC_BUFFER = 64 * 1024 * 1024;
@@ -32,13 +32,6 @@ export async function main() {
         type: "string",
         short: "o",
       },
-      // TODO: Bring this in through package.json. Do not use autorest's
-      // package manager.
-      "lint-version": {
-        type: "string",
-        short: "l",
-        default: "2.2.3",
-      },
     },
     strict: true,
   };
@@ -49,7 +42,6 @@ export async function main() {
       after: afterArg,
       "changed-files-path": changedFilesPath,
       "out-file": outFile,
-      "lint-version": lintVersion,
     },
   } = parseArgs(config);
 
@@ -68,11 +60,6 @@ export async function main() {
     console.log("--changed-files-path missing");
   }
 
-  if (!(lintVersion as string).match(/^\d+\.\d+\.\d+$/)) {
-    validArgs = false;
-    console.log("Invalid lint version:", lintVersion);
-  }
-
   if (!validArgs) {
     usage();
     process.exit(1);
@@ -92,7 +79,6 @@ export async function main() {
     afterArg as string,
     changedFilesPath as string,
     outFile as string,
-    lintVersion as string,
   );
 }
 
@@ -107,7 +93,6 @@ async function runLintDiff(
   afterPath: string,
   changedFilesPath: string,
   outFile: string,
-  lintVersion: string,
 ) {
   // TODO: Should filter happen here or upstream? (probably upstream)
   // TODO: NEED TO PARSE TAG CHANGES STILL
@@ -138,7 +123,7 @@ async function runLintDiff(
   //   return;
   // }
 
-  let validator = `@microsoft.azure/openapi-validator@${lintVersion}`;
+  const dependenciesDir = await getPathToDependency("@microsoft.azure/openapi-validator");
   const changedFileAndTagsMap = new Map<string, string[]>();
   for (const readmeAndTags of affectedTags) {
     const dedupedTags = await deduplicateTags(
@@ -178,7 +163,7 @@ async function runLintDiff(
         `--message-format=json ` +
         `--openapi-type=${openApiType} ` +
         `--openapi-subtype=${openApiSubType} ` +
-        `--use=${validator} ` +
+        `--use=${dependenciesDir} ` +
         `${tagArg} ` +
         `${changedFilePath}`;
 

eng/tools/lint-diff/src/util.ts

@@ -1,4 +1,6 @@
-import { access } from "fs/promises";
+import { access, constants } from "node:fs/promises";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
 
 /**
  * Enumerate files in a directory that match the given string ending
@@ -23,3 +25,29 @@ export async function pathExists(path: string): Promise<boolean> {
     return false;
   }
 }
+
+// Copied from azure-sdk-tools repo
+// TODO: This should probably be moved to another more general location
+export async function getPathToDependency(dependency: string): Promise<string> {
+  // Example: /home/user/foo/node_modules/@autorest/bar/dist/index.js
+  const entrypoint = fileURLToPath(import.meta.resolve(dependency));
+
+  // Walk up directory tree to first folder containing "package.json"
+  let currentDir = dirname(entrypoint);
+  while (true) {
+    const packageJsonFile = join(currentDir, "package.json");
+    try {
+      // Throws if file cannot be read
+      await access(packageJsonFile, constants.R_OK);
+      return currentDir;
+    } catch {
+      const parentDir = dirname(currentDir);
+      if (parentDir !== currentDir) {
+        currentDir = parentDir;
+      } else {
+        // Reached fs root but no package.json found
+        throw new Error(`Unable to find package.json in folder tree above '${entrypoint}'`);
+      }
+    }
+  }
+}