Add a result type

Author: shati-patel

extensions/ql-vscode/src/cli.ts

@@ -8,7 +8,7 @@ import { Readable } from 'stream';
 import { StringDecoder } from 'string_decoder';
 import * as tk from 'tree-kill';
 import { promisify } from 'util';
-import { CancellationToken, Disposable, Uri, window } from 'vscode';
+import { CancellationToken, Disposable, Uri } from 'vscode';
 
 import { BQRSInfo, DecodedBqrsChunk } from './pure/bqrs-cli-types';
 import { CliConfig } from './config';
@@ -43,6 +43,16 @@ export interface QuerySetup {
   compilationCache?: string;
 }
 
+/**
+ * The expected output of `codeql resolve queries --format bylanguage`.
+ */
+export interface QueryInfoByLanguage {
+  // What should the value of these objects be? I've only ever seen it as an empty object.
+  byLanguage: Record<string, Record<string, unknown>>;
+  noDeclaredLanguage: Record<string, unknown>;
+  multipleDeclaredLanguages: Record<string, unknown>;
+}
+
 /**
  * The expected output of `codeql resolve database`.
  */
@@ -486,30 +496,14 @@ export class CodeQLCliServer implements Disposable {
    * Finds the language that a query is analyzing.
    * @param queryUri The URI of the query
    */
-  async findLanguage(workspaces: string[], queryUri?: Uri): Promise<string> {
-    let language = '';
-    if (queryUri) {
-      const subcommandArgs = [
-        '--format', 'bylanguage',
-        queryUri.fsPath,
-        '--additional-packs',
-        workspaces.join(path.delimiter)
-      ];
-      try {
-        const JSONResults = await this.runCodeQlCliCommand(['resolve', 'queries'], subcommandArgs, 'Finding query language');
-
-        // This corresponds to `codeql resolve queries <query> --format bylanguage | jq -r '.byLanguage | keys[]'`
-        language = Object.keys(JSON.parse(JSONResults).byLanguage)[0];
-      }
-      catch (e) {
-        // Add an option to manually specify the language, in case automatic language detection fails.
-        void this.logger.log('Failed to detect language. Using manual prompt instead.');
-        language = await window.showQuickPick(
-          ['cpp', 'csharp', 'go', 'java', 'javascript', 'python'], { placeHolder: 'Select language' }
-        ) || '';
-      }
-    }
-    return language;
+  async resolveQueryByLanguage(workspaces: string[], queryUri: Uri): Promise<QueryInfoByLanguage> {
+    const subcommandArgs = [
+      '--format', 'bylanguage',
+      queryUri.fsPath,
+      '--additional-packs',
+      workspaces.join(path.delimiter)
+    ];
+    return JSON.parse(await this.runCodeQlCliCommand(['resolve', 'queries'], subcommandArgs, 'Resolving query by language'));
   }
 
   /**

extensions/ql-vscode/src/extension.ts

@@ -563,10 +563,11 @@ async function activateWithInstalledDistribution(
   // (Temporary new command to test `cliServer.findLanguage`)
   ctx.subscriptions.push(
     commandRunner('codeQL.findLanguage', async (
-      uri: Uri | undefined
+      uri: Uri
     ) => {
       const diskWorkspaceFolders = helpers.getOnDiskWorkspaceFolders();
-      const language = await cliServer.findLanguage(diskWorkspaceFolders, uri || window.activeTextEditor?.document.uri);
+      const queryInfo = await cliServer.resolveQueryByLanguage(diskWorkspaceFolders, uri || window.activeTextEditor?.document.uri);
+      const language = (Object.keys(queryInfo.byLanguage))[0];
       void helpers.showAndLogInformationMessage(language);
     })
   );