Merge branch 'aeisenberg/unrevert-query-filters' into aeisenberg/fix-config-files

src/config-utils.ts

@@ -50,8 +50,38 @@ export interface UserConfig {
   // language. If this is a single language analysis, then no split by
   // language is necessary.
   packs?: Record<string, string[]> | string[];
+
+  // Set of query filters to include and exclude extra queries based on
+  // codeql query suite `include` and `exclude` properties
+  "query-filters"?: QueryFilter[];
 }
 
+export type QueryFilter = ExcludeQueryFilter | IncludeQueryFilter;
+
+interface ExcludeQueryFilter {
+  exclude: Record<string, string[] | string>;
+}
+
+interface IncludeQueryFilter {
+  include: Record<string, string[] | string>;
+}
+
+export type QuerySuitePackEntry = {
+  version?: string;
+} & (
+  | {
+      qlpack: string;
+    }
+  | {
+      from?: string;
+      query?: string;
+      queries?: string;
+      apply?: string;
+    }
+);
+
+export type QuerySuiteEntry = QuerySuitePackEntry | QueryFilter;
+
 /**
  * Lists of query files for each language.
  * Will only contain .ql files and not other kinds of files,
@@ -201,9 +231,14 @@ export const defaultAugmentationProperties: AugmentationProperties = {
   packsInput: undefined,
   queriesInput: undefined,
 };
-
 export type Packs = Partial<Record<Language, string[]>>;
 
+export interface Pack {
+  name: string;
+  version?: string;
+  path?: string;
+}
+
 /**
  * A list of queries from https://github.com/github/codeql that
  * we don't want to run. Disabling them here is a quicker alternative to
@@ -366,11 +401,7 @@ async function addBuiltinSuiteQueries(
 }
 
 function isMlPoweredJsQueriesPack(pack: string) {
-  return (
-    pack === ML_POWERED_JS_QUERIES_PACK_NAME ||
-    pack.startsWith(`${ML_POWERED_JS_QUERIES_PACK_NAME}@`) ||
-    pack.startsWith(`${ML_POWERED_JS_QUERIES_PACK_NAME}:`)
-  );
+  return parsePacksSpecification(pack).name === ML_POWERED_JS_QUERIES_PACK_NAME;
 }
 
 /**
@@ -1311,10 +1342,10 @@ export function parsePacksFromConfig(
         throw new Error(getPacksRequireLanguage(configFile, lang));
       }
     }
-    packs[lang] = [];
-    for (const packStr of packsArr) {
-      packs[lang].push(validatePacksSpecification(packStr, configFile));
-    }
+
+    packs[lang] = packsArr.map((packStr) =>
+      validatePackSpecification(packStr, configFile)
+    );
   }
   return packs;
 }
@@ -1352,7 +1383,7 @@ function parsePacksFromInput(
 
   return {
     [languages[0]]: rawPacksInput.split(",").reduce((packs, pack) => {
-      packs.push(validatePacksSpecification(pack));
+      packs.push(validatePackSpecification(pack, ""));
       return packs;
     }, [] as string[]),
   };
@@ -1376,10 +1407,10 @@ function parsePacksFromInput(
  * @param packStr the package specification to verify.
  * @param configFile Config file to use for error reporting
  */
-export function validatePacksSpecification(
+export function parsePacksSpecification(
   packStr: string,
   configFile?: string
-): string {
+): Pack {
   if (typeof packStr !== "string") {
     throw new Error(getPacksStrInvalid(packStr, configFile));
   }
@@ -1438,9 +1469,21 @@ export function validatePacksSpecification(
     throw new Error(getPacksStrInvalid(packStr, configFile));
   }
 
-  return (
-    packName + (version ? `@${version}` : "") + (packPath ? `:${packPath}` : "")
-  );
+  return {
+    name: packName,
+    version,
+    path: packPath,
+  };
+}
+
+export function prettyPrintPack(pack: Pack) {
+  return `${pack.name}${pack.version ? `@${pack.version}` : ""}${
+    pack.path ? `:${pack.path}` : ""
+  }`;
+}
+
+export function validatePackSpecification(pack: string, configFile?: string) {
+  return prettyPrintPack(parsePacksSpecification(pack, configFile));
 }
 
 // exported for testing