Remote queries: Get query name from metadata (if possible)

Author: shati-patel

extensions/ql-vscode/src/remote-queries/run-remote-query.ts

@@ -8,11 +8,12 @@ import { Credentials } from '../authentication';
 import * as cli from '../cli';
 import { logger } from '../logging';
 import { getRemoteControllerRepo, getRemoteRepositoryLists, setRemoteControllerRepo } from '../config';
-import { tmpDir } from '../run-queries';
+import { getQueryMetadata, tmpDir } from '../run-queries';
 import { ProgressCallback, UserCancellationException } from '../commandRunner';
 import { OctokitResponse } from '@octokit/types/dist-types';
 import { RemoteQuery } from './remote-query';
 import { RemoteQuerySubmissionResult } from './remote-query-submission-result';
+import { QueryMetadata } from '../pure/interface-types';
 
 interface Config {
   repositories: string[];
@@ -323,6 +324,7 @@ export async function runRemoteQuery(
 
     const workflowRunId = await runRemoteQueriesApiRequest(credentials, ref, language, repositories, owner, repo, base64Pack, dryRun);
     const queryStartTime = new Date();
+    const queryMetadata = await getQueryMetadata(cliServer, queryFile);
 
     if (dryRun) {
       return { queryDirPath: remoteQueryDir.path };
@@ -331,7 +333,7 @@ export async function runRemoteQuery(
         return;
       }
 
-      const remoteQuery = await buildRemoteQueryEntity(repositories, queryFile, owner, repo, queryStartTime, workflowRunId);
+      const remoteQuery = await buildRemoteQueryEntity(repositories, queryFile, queryMetadata, owner, repo, queryStartTime, workflowRunId);
 
       // don't return the path because it has been deleted
       return { query: remoteQuery };
@@ -454,13 +456,14 @@ async function ensureNameAndSuite(queryPackDir: string, packRelativePath: string
 async function buildRemoteQueryEntity(
   repositories: string[],
   queryFilePath: string,
+  queryMetadata: QueryMetadata | undefined,
   controllerRepoOwner: string,
   controllerRepoName: string,
   queryStartTime: Date,
   workflowRunId: number
 ): Promise<RemoteQuery> {
-  // For now, just use the file name as the query name. 
-  const queryName = path.basename(queryFilePath);
+  // The query name is either the name as specified in the query metadata, or the file name. 
+  const queryName = queryMetadata?.name ?? path.basename(queryFilePath);
 
   const queryRepos = repositories.map(r => {
     const [owner, repo] = r.split('/');

extensions/ql-vscode/src/run-queries.ts

@@ -334,17 +334,17 @@ async function convertToQlPath(filePath: string): Promise<string> {
 
 /** Gets the selected position within the given editor. */
 async function getSelectedPosition(editor: TextEditor, range?: Range): Promise<messages.Position> {
-    const selectedRange = range || editor.selection;
-    const pos = selectedRange.start;
-    const posEnd = selectedRange.end;
-    // Convert from 0-based to 1-based line and column numbers.
-    return {
-      fileName: await convertToQlPath(editor.document.fileName),
-      line: pos.line + 1,
-      column: pos.character + 1,
-      endLine: posEnd.line + 1,
-      endColumn: posEnd.character + 1
-    };
+  const selectedRange = range || editor.selection;
+  const pos = selectedRange.start;
+  const posEnd = selectedRange.end;
+  // Convert from 0-based to 1-based line and column numbers.
+  return {
+    fileName: await convertToQlPath(editor.document.fileName),
+    line: pos.line + 1,
+    column: pos.character + 1,
+    endLine: posEnd.line + 1,
+    endColumn: posEnd.character + 1
+  };
 }
 
 /**
@@ -612,13 +612,7 @@ export async function compileAndRunQueryAgainstDatabase(
   };
 
   // Read the query metadata if possible, to use in the UI.
-  let metadata: QueryMetadata | undefined;
-  try {
-    metadata = await cliServer.resolveMetadata(qlProgram.queryPath);
-  } catch (e) {
-    // Ignore errors and provide no metadata.
-    void logger.log(`Couldn't resolve metadata for ${qlProgram.queryPath}: ${e}`);
-  }
+  const metadata = await getQueryMetadata(cliServer, qlProgram.queryPath);
 
   let availableMlModels: cli.MlModelInfo[] = [];
   // The `capabilities.untrustedWorkspaces.restrictedConfigurations` entry in package.json doesn't
@@ -718,6 +712,22 @@ const compilationFailedErrorTail = ' compilation failed. Please make sure there
   ' and the query and database use the same target language. For more details on the error, go to View > Output,' +
   ' and choose CodeQL Query Server from the dropdown.';
 
+/**
+ * Gets metadata for a query, if it exists.
+ * @param cliServer The CLI server.
+ * @param queryPath The path to the query.
+ * @returns A promise that resolves to the query metadata, if available.
+ */
+export async function getQueryMetadata(cliServer: cli.CodeQLCliServer, queryPath: string): Promise<QueryMetadata | undefined> {
+  try {
+    return await cliServer.resolveMetadata(queryPath);
+  } catch (e) {
+    // Ignore errors and provide no metadata.
+    void logger.log(`Couldn't resolve metadata for ${queryPath}: ${e}`);
+    return;
+  }
+}
+
 function createSyntheticResult(
   query: QueryInfo,
   db: DatabaseItem,