view-autofixes/overrideQueryHelp: recompile autofix if query help has changed.

Author: d10c

extensions/ql-vscode/src/codeql-cli/cli.ts

@@ -1158,23 +1158,22 @@ export class CodeQLCliServer implements Disposable {
   /**
    * Uses a .qhelp file to generate Query Help documentation in a specified format.
    * @param pathToQhelp The path to the .qhelp file
-   * @param format The format in which the query help should be generated {@link https://codeql.github.com/docs/codeql-cli/manual/generate-query-help/#cmdoption-codeql-generate-query-help-format}
-   * @param outputDirectory The output directory for the generated file
+   * @param outputFileOrDirectory The output directory for the generated file
    */
   async generateQueryHelp(
     pathToQhelp: string,
-    outputDirectory?: string,
+    outputFileOrDirectory?: string,
   ): Promise<string> {
     const subcommandArgs = ["--format=markdown"];
-    if (outputDirectory) {
-      subcommandArgs.push("--output", outputDirectory);
+    if (outputFileOrDirectory) {
+      subcommandArgs.push("--output", outputFileOrDirectory);
     }
     subcommandArgs.push(pathToQhelp);
 
     return await this.runCodeQlCliCommand(
       ["generate", "query-help"],
       subcommandArgs,
-      `Generating qhelp in markdown format at ${outputDirectory}`,
+      `Generating qhelp in markdown format at ${outputFileOrDirectory}`,
     );
   }
 

extensions/ql-vscode/src/variant-analysis/view-autofixes.ts

@@ -245,9 +245,9 @@ async function overrideQueryHelp(
   // Use `replaceAll` since some query IDs have multiple slashes.
   const queryIdWithDash = queryId.replaceAll("/", "-");
 
-  // Get the path to the output directory for overriding the query help.
-  // Note: the path to this directory may change in the future.
-  const queryHelpOverrideDirectory = join(
+  // Get the path to the output file for overriding the query help.
+  // Note: the path to this file may change in the future.
+  const queryHelpOverrideFile = join(
     localAutofixPath,
     "pkg",
     "autofix",
@@ -256,10 +256,26 @@ async function overrideQueryHelp(
     `${queryIdWithDash}.md`,
   );
 
-  await cliServer.generateQueryHelp(
-    queryHelpFilePath,
-    queryHelpOverrideDirectory,
-  );
+  // If the file already exists, slurp it so that we can check if it has changed.
+  let existingContents: string | null = null;
+  if (await pathExists(queryHelpOverrideFile)) {
+    existingContents = await readFile(queryHelpOverrideFile, "utf8");
+  }
+
+  // Generate the query help and output it to the override directory.
+  await cliServer.generateQueryHelp(queryHelpFilePath, queryHelpOverrideFile);
+
+  // If the contents of `queryHelpOverrideFile` have changed, recompile autofix
+  // to include the new query help.
+  if (existingContents !== null) {
+    const newContents = await readFile(queryHelpOverrideFile, "utf8");
+    if (existingContents !== newContents) {
+      void extLogger.log(
+        `Query help for query ID ${queryId} has changed. Recompiling autofix...`,
+      );
+      await recompileAutofix(localAutofixPath);
+    }
+  }
 }
 
 /**
@@ -907,6 +923,22 @@ async function opRead(secretReference: string): Promise<string> {
   }
 }
 
+/** Recompile the Autofix binary. */
+async function recompileAutofix(localAutofixPath: string): Promise<void> {
+  const { code, stderr } = await execCommand(
+    "make",
+    ["build"],
+    { cwd: localAutofixPath },
+    false,
+  );
+
+  if (code !== 0) {
+    throw new Error(
+      `Failed to recompile autofix after query help change. Exit code: ${code}. Stderr: ${stderr}`,
+    );
+  }
+}
+
 /**
  * Creates a new file path by appending the given suffix.
  * @param filePath The original file path.