Introduce type for QlPackFile

Author: koesie10

extensions/ql-vscode/src/local-queries/query-resolver.ts

@@ -13,6 +13,7 @@ import { redactableError } from "../common/errors";
 import { showAndLogExceptionWithTelemetry } from "../common/logging";
 import { extLogger } from "../common/logging/vscode";
 import { telemetryListener } from "../common/vscode/telemetry";
+import { SuiteInstruction } from "../packaging/suite-instruction";
 
 export async function qlpackOfDatabase(
   cli: Pick<CodeQLCliServer, "resolveQlpacks">,
@@ -50,12 +51,12 @@ async function resolveQueriesFromPacks(
       postfix: ".qls",
     })
   ).path;
-  const suiteYaml = [];
+  const suiteYaml: SuiteInstruction[] = [];
   for (const qlpack of qlpacks) {
     suiteYaml.push({
       from: qlpack,
       queries: ".",
-      include: constraints,
+      include: constraints as Record<string, string[]>,
     });
   }
   await writeFile(

extensions/ql-vscode/src/model-editor/extension-pack-metadata.schema.json

@@ -5,33 +5,86 @@
     "ExtensionPackMetadata": {
       "type": "object",
       "properties": {
+        "extensionTargets": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        "dataExtensions": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
         "name": {
           "type": "string"
         },
         "version": {
           "type": "string"
         },
-        "dataExtensions": {
-          "anyOf": [
-            {
+        "dependencies": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        "dbscheme": {
+          "type": "string"
+        },
+        "library": {
+          "type": "boolean"
+        },
+        "defaultSuite": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/SuiteInstruction"
+          }
+        },
+        "defaultSuiteFile": {
+          "type": "string"
+        }
+      },
+      "required": ["dataExtensions", "extensionTargets", "name", "version"]
+    },
+    "SuiteInstruction": {
+      "type": "object",
+      "properties": {
+        "qlpack": {
+          "type": "string"
+        },
+        "query": {
+          "type": "string"
+        },
+        "queries": {
+          "type": "string"
+        },
+        "include": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "array",
+            "items": {
               "type": "string"
-            },
-            {
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
             }
-          ]
+          }
         },
-        "extensionTargets": {
+        "exclude": {
           "type": "object",
           "additionalProperties": {
-            "type": "string"
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
           }
+        },
+        "description": {
+          "type": "string"
+        },
+        "from": {
+          "type": "string"
         }
       },
-      "required": ["name", "version", "dataExtensions", "extensionTargets"]
+      "description": "A single entry in a .qls file."
     }
   }
 }

extensions/ql-vscode/src/model-editor/extension-pack-metadata.ts

@@ -1,6 +1,7 @@
-export type ExtensionPackMetadata = {
-  name: string;
-  version: string;
-  dataExtensions: string | string[];
+import { QlPackFile } from "../packaging/qlpack-file";
+
+export type ExtensionPackMetadata = QlPackFile & {
+  // Make both extensionTargets and dataExtensions required
   extensionTargets: Record<string, string>;
+  dataExtensions: string[];
 };

extensions/ql-vscode/src/packaging/qlpack-file.ts

@@ -0,0 +1,16 @@
+import { SuiteInstruction } from "./suite-instruction";
+
+/**
+ * The qlpack pack file, either in qlpack.yml or in codeql-pack.yml.
+ */
+export interface QlPackFile {
+  name: string;
+  version: string;
+  dependencies?: Record<string, string>;
+  extensionTargets?: Record<string, string>;
+  dbscheme?: string;
+  library?: boolean;
+  defaultSuite?: SuiteInstruction[];
+  defaultSuiteFile?: string;
+  dataExtensions?: string[];
+}

extensions/ql-vscode/src/packaging/suite-instruction.ts

@@ -0,0 +1,12 @@
+/**
+ * A single entry in a .qls file.
+ */
+export interface SuiteInstruction {
+  qlpack?: string;
+  query?: string;
+  queries?: string;
+  include?: Record<string, string[]>;
+  exclude?: Record<string, string[]>;
+  description?: string;
+  from?: string;
+}

extensions/ql-vscode/src/variant-analysis/run-remote-query.ts

@@ -37,15 +37,7 @@ import {
 import { QueryLanguage } from "../common/query-language";
 import { tryGetQueryMetadata } from "../codeql-cli/query-metadata";
 import { askForLanguage, findLanguage } from "../codeql-cli/query-language";
-
-interface QlPack {
-  name: string;
-  version: string;
-  library?: boolean;
-  dependencies: { [key: string]: string };
-  defaultSuite?: Array<Record<string, unknown>>;
-  defaultSuiteFile?: string;
-}
+import { QlPackFile } from "../packaging/qlpack-file";
 
 /**
  * Well-known names for the query pack used by the server.
@@ -395,7 +387,7 @@ async function fixPackFile(
       )} file in '${queryPackDir}'`,
     );
   }
-  const qlpack = load(await readFile(packPath, "utf8")) as QlPack;
+  const qlpack = load(await readFile(packPath, "utf8")) as QlPackFile;
 
   updateDefaultSuite(qlpack, packRelativePath);
   removeWorkspaceRefs(qlpack);
@@ -416,7 +408,11 @@ async function injectExtensionPacks(
       )} file in '${queryPackDir}'`,
     );
   }
-  const syntheticQueryPack = load(await readFile(qlpackFile, "utf8")) as QlPack;
+  const syntheticQueryPack = load(
+    await readFile(qlpackFile, "utf8"),
+  ) as QlPackFile;
+
+  const dependencies = syntheticQueryPack.dependencies ?? {};
 
   const extensionPacks = await cliServer.resolveQlpacks(workspaceFolders, true);
   Object.entries(extensionPacks).forEach(([name, paths]) => {
@@ -433,13 +429,16 @@ async function injectExtensionPacks(
     // Add this extension pack as a dependency. It doesn't matter which
     // version we specify, since we are guaranteed that the extension pack
     // is resolved from source at the given path.
-    syntheticQueryPack.dependencies[name] = "*";
+    dependencies[name] = "*";
   });
+
+  syntheticQueryPack.dependencies = dependencies;
+
   await writeFile(qlpackFile, dump(syntheticQueryPack));
   await cliServer.clearCache();
 }
 
-function updateDefaultSuite(qlpack: QlPack, packRelativePath: string) {
+function updateDefaultSuite(qlpack: QlPackFile, packRelativePath: string) {
   delete qlpack.defaultSuiteFile;
   qlpack.defaultSuite = generateDefaultSuite(packRelativePath);
 }
@@ -541,10 +540,12 @@ async function getControllerRepoFromApi(
   }
 }
 
-export function removeWorkspaceRefs(qlpack: {
-  dependencies: Record<string, string>;
-}) {
-  for (const [key, value] of Object.entries(qlpack.dependencies || {})) {
+export function removeWorkspaceRefs(qlpack: QlPackFile) {
+  if (!qlpack.dependencies) {
+    return;
+  }
+
+  for (const [key, value] of Object.entries(qlpack.dependencies)) {
     if (value === "${workspace}") {
       qlpack.dependencies[key] = "*";
     }