Merge pull request #2074 from github/elena/refactor-query-language

Consolidate the way we define query languages

Author: elenatanasoiu

extensions/ql-vscode/src/cli.ts

@@ -26,9 +26,9 @@ import { QueryMetadata, SortDirection } from "./pure/interface-types";
 import { Logger, ProgressReporter } from "./common";
 import { CompilationMessage } from "./pure/legacy-messages";
 import { sarifParser } from "./sarif-parser";
-import { dbSchemeToLanguage, walkDirectory } from "./helpers";
+import { walkDirectory } from "./helpers";
 import { App } from "./common/app";
-import { QueryLanguage } from "./qlpack-generator";
+import { QueryLanguage } from "./common/query-language";
 
 /**
  * The version of the SARIF format that we are using.
@@ -1179,9 +1179,11 @@ export class CodeQLCliServer implements Disposable {
    */
   public async getSupportedLanguages(): Promise<string[]> {
     if (!this._supportedLanguages) {
-      // Get the intersection of resolveLanguages with the list of hardcoded languages in dbSchemeToLanguage.
+      // Get the intersection of resolveLanguages with the list of languages in QueryLanguage.
       const resolvedLanguages = Object.keys(await this.resolveLanguages());
-      const hardcodedLanguages = Object.values(dbSchemeToLanguage);
+      const hardcodedLanguages = Object.values(QueryLanguage).map((s) =>
+        s.toString(),
+      );
 
       this._supportedLanguages = resolvedLanguages.filter((lang) =>
         hardcodedLanguages.includes(lang),

extensions/ql-vscode/src/common/query-language.ts

@@ -0,0 +1,37 @@
+export enum QueryLanguage {
+  CSharp = "csharp",
+  Cpp = "cpp",
+  Go = "go",
+  Java = "java",
+  Javascript = "javascript",
+  Python = "python",
+  Ruby = "ruby",
+  Swift = "swift",
+}
+
+export const PACKS_BY_QUERY_LANGUAGE = {
+  [QueryLanguage.Cpp]: ["codeql/cpp-queries"],
+  [QueryLanguage.CSharp]: [
+    "codeql/csharp-queries",
+    "codeql/csharp-solorigate-queries",
+  ],
+  [QueryLanguage.Go]: ["codeql/go-queries"],
+  [QueryLanguage.Java]: ["codeql/java-queries"],
+  [QueryLanguage.Javascript]: [
+    "codeql/javascript-queries",
+    "codeql/javascript-experimental-atm-queries",
+  ],
+  [QueryLanguage.Python]: ["codeql/python-queries"],
+  [QueryLanguage.Ruby]: ["codeql/ruby-queries"],
+};
+
+export const dbSchemeToLanguage = {
+  "semmlecode.javascript.dbscheme": "javascript",
+  "semmlecode.cpp.dbscheme": "cpp",
+  "semmlecode.dbscheme": "java",
+  "semmlecode.python.dbscheme": "python",
+  "semmlecode.csharp.dbscheme": "csharp",
+  "go.dbscheme": "go",
+  "ruby.dbscheme": "ruby",
+  "swift.dbscheme": "swift",
+};

extensions/ql-vscode/src/helpers.ts

@@ -24,6 +24,7 @@ import { QueryMetadata } from "./pure/interface-types";
 import { telemetryListener } from "./telemetry";
 import { RedactableError } from "./pure/errors";
 import { getQlPackPath } from "./pure/ql";
+import { dbSchemeToLanguage } from "./common/query-language";
 
 // Shared temporary folder for the extension.
 export const tmpDir = dirSync({
@@ -568,16 +569,6 @@ export class CachedOperation<U> {
  *
  * @see cli.CodeQLCliServer.resolveDatabase
  */
-export const dbSchemeToLanguage = {
-  "semmlecode.javascript.dbscheme": "javascript",
-  "semmlecode.cpp.dbscheme": "cpp",
-  "semmlecode.dbscheme": "java",
-  "semmlecode.python.dbscheme": "python",
-  "semmlecode.csharp.dbscheme": "csharp",
-  "go.dbscheme": "go",
-  "ruby.dbscheme": "ruby",
-  "swift.dbscheme": "swift",
-};
 
 export const languageToDbScheme = Object.entries(dbSchemeToLanguage).reduce(
   (acc, [k, v]) => {

extensions/ql-vscode/src/local-databases.ts

@@ -26,7 +26,8 @@ import { QueryRunner } from "./queryRunner";
 import { pathsEqual } from "./pure/files";
 import { redactableError } from "./pure/errors";
 import { isCodespacesTemplate } from "./config";
-import { QlPackGenerator, QueryLanguage } from "./qlpack-generator";
+import { QlPackGenerator } from "./qlpack-generator";
+import { QueryLanguage } from "./common/query-language";
 
 /**
  * databases.ts

extensions/ql-vscode/src/packaging.ts

@@ -9,18 +9,7 @@ import { ProgressCallback, UserCancellationException } from "./commandRunner";
 import { extLogger } from "./common";
 import { asError, getErrorStack } from "./pure/helpers-pure";
 import { redactableError } from "./pure/errors";
-
-const QUERY_PACKS = [
-  "codeql/cpp-queries",
-  "codeql/csharp-queries",
-  "codeql/go-queries",
-  "codeql/java-queries",
-  "codeql/javascript-queries",
-  "codeql/python-queries",
-  "codeql/ruby-queries",
-  "codeql/csharp-solorigate-queries",
-  "codeql/javascript-experimental-atm-queries",
-];
+import { PACKS_BY_QUERY_LANGUAGE } from "./common/query-language";
 
 /**
  * Prompts user to choose packs to download, and downloads them.
@@ -45,7 +34,7 @@ export async function handleDownloadPacks(
     { ignoreFocusOut: true },
   );
   if (quickpick === queryPackOption) {
-    packsToDownload = QUERY_PACKS;
+    packsToDownload = Object.values(PACKS_BY_QUERY_LANGUAGE).flat();
   } else if (quickpick === customPackOption) {
     const customPack = await window.showInputBox({
       prompt:

extensions/ql-vscode/src/qlpack-generator.ts

@@ -3,16 +3,7 @@ import { dump } from "js-yaml";
 import { join } from "path";
 import { Uri, workspace } from "vscode";
 import { CodeQLCliServer } from "./cli";
-
-export type QueryLanguage =
-  | "csharp"
-  | "cpp"
-  | "go"
-  | "java"
-  | "javascript"
-  | "python"
-  | "ruby"
-  | "swift";
+import { QueryLanguage } from "./common/query-language";
 
 export class QlPackGenerator {
   private readonly qlpackName: string;

extensions/ql-vscode/src/variant-analysis/gh-api/variant-analysis.ts

@@ -1,28 +1,19 @@
+import { QueryLanguage } from "../../common/query-language";
 import { Repository, RepositoryWithMetadata } from "./repository";
 
 export interface VariantAnalysisSubmissionRequest {
   action_repo_ref: string;
-  language: VariantAnalysisQueryLanguage;
+  language: QueryLanguage;
   query_pack: string;
   repositories?: string[];
   repository_lists?: string[];
   repository_owners?: string[];
 }
 
-export type VariantAnalysisQueryLanguage =
-  | "csharp"
-  | "cpp"
-  | "go"
-  | "java"
-  | "javascript"
-  | "python"
-  | "ruby"
-  | "swift";
-
 export interface VariantAnalysis {
   id: number;
   controller_repo: Repository;
-  query_language: VariantAnalysisQueryLanguage;
+  query_language: QueryLanguage;
   query_pack_url: string;
   created_at: string;
   updated_at: string;

extensions/ql-vscode/src/variant-analysis/shared/variant-analysis.ts

@@ -1,13 +1,14 @@
 import { Repository, RepositoryWithMetadata } from "./repository";
 import { AnalysisAlert, AnalysisRawResults } from "./analysis-result";
+import { QueryLanguage } from "../../common/query-language";
 
 export interface VariantAnalysis {
   id: number;
   controllerRepo: Repository;
   query: {
     name: string;
     filePath: string;
-    language: VariantAnalysisQueryLanguage;
+    language: QueryLanguage;
     text: string;
   };
   databases: {
@@ -26,23 +27,10 @@ export interface VariantAnalysis {
   skippedRepos?: VariantAnalysisSkippedRepositories;
 }
 
-export enum VariantAnalysisQueryLanguage {
-  CSharp = "csharp",
-  Cpp = "cpp",
-  Go = "go",
-  Java = "java",
-  Javascript = "javascript",
-  Python = "python",
-  Ruby = "ruby",
-  Swift = "swift",
-}
-
 export function parseVariantAnalysisQueryLanguage(
   language: string,
-): VariantAnalysisQueryLanguage | undefined {
-  return Object.values(VariantAnalysisQueryLanguage).find(
-    (x) => x === language,
-  );
+): QueryLanguage | undefined {
+  return Object.values(QueryLanguage).find((x) => x === language);
 }
 
 export enum VariantAnalysisStatus {
@@ -148,7 +136,7 @@ export interface VariantAnalysisSubmission {
   query: {
     name: string;
     filePath: string;
-    language: VariantAnalysisQueryLanguage;
+    language: QueryLanguage;
     text: string;
 
     // Base64 encoded query pack.

extensions/ql-vscode/test/factories/variant-analysis/gh-api/variant-analysis-api-response.ts

@@ -5,7 +5,7 @@ import {
   VariantAnalysisSkippedRepositories,
   VariantAnalysisStatus,
 } from "../../../../src/variant-analysis/gh-api/variant-analysis";
-import { VariantAnalysisQueryLanguage } from "../../../../src/variant-analysis/shared/variant-analysis";
+import { QueryLanguage } from "../../../../src/common/query-language";
 import { createMockScannedRepos } from "./scanned-repositories";
 import { createMockSkippedRepos } from "./skipped-repositories";
 import { createMockRepository } from "./repository";
@@ -23,7 +23,7 @@ export function createMockApiResponse(
       full_name: "github/pickles",
       private: false,
     },
-    query_language: VariantAnalysisQueryLanguage.Javascript,
+    query_language: QueryLanguage.Javascript,
     query_pack_url: "https://example.com/foo",
     created_at: faker.date.recent().toISOString(),
     updated_at: faker.date.recent().toISOString(),

extensions/ql-vscode/test/factories/variant-analysis/shared/variant-analysis-submission.ts

@@ -1,8 +1,6 @@
 import { faker } from "@faker-js/faker";
-import {
-  VariantAnalysisQueryLanguage,
-  VariantAnalysisSubmission,
-} from "../../../../src/variant-analysis/shared/variant-analysis";
+import { VariantAnalysisSubmission } from "../../../../src/variant-analysis/shared/variant-analysis";
+import { QueryLanguage } from "../../../../src/common/query-language";
 
 export function createMockSubmission(): VariantAnalysisSubmission {
   return {
@@ -12,7 +10,7 @@ export function createMockSubmission(): VariantAnalysisSubmission {
     query: {
       name: "query-name",
       filePath: "query-file-path",
-      language: VariantAnalysisQueryLanguage.Javascript,
+      language: QueryLanguage.Javascript,
       text: "query-text",
       pack: "base64-encoded-string",
     },