Merge pull request #2922 from github/dbartol/passthru

Dave Bartolomeo · web-flow · commit 623890adc98b · 2023-10-09T15:04:13.000-04:00
Add `additionalArgs` option to `launch.json`
diff --git a/extensions/ql-vscode/package.json b/extensions/ql-vscode/package.json
@@ -110,6 +110,10 @@
                   "string"
                 ],
                 "description": "Names of extension packs to include in the evaluation. These are resolved from the locations specified in `additionalPacks`."
+              },
+              "additionalRunQueryArgs": {
+                "type": "object",
+                "description": "**Internal use only**. Additional arguments to pass to the `runQuery` command of the query server, without validation."
               }
             }
           }
diff --git a/extensions/ql-vscode/src/debugger/debug-configuration.ts b/extensions/ql-vscode/src/debugger/debug-configuration.ts
@@ -22,6 +22,7 @@ export interface QLDebugArgs {
   extensionPacks?: string[] | string;
   quickEval?: boolean;
   noDebug?: boolean;
+  additionalRunQueryArgs?: Record<string, any>;
 }
 
 /**
@@ -120,6 +121,7 @@ export class QLDebugConfigurationProvider
         extensionPacks,
         quickEvalContext,
         noDebug: qlConfiguration.noDebug ?? false,
+        additionalRunQueryArgs: qlConfiguration.additionalRunQueryArgs ?? {},
       };
 
       return resultConfiguration;
diff --git a/extensions/ql-vscode/src/debugger/debug-protocol.ts b/extensions/ql-vscode/src/debugger/debug-protocol.ts
@@ -70,6 +70,8 @@ export interface LaunchConfig {
   quickEvalContext: QuickEvalContext | undefined;
   /** Run the query without debugging it. */
   noDebug: boolean;
+  /** Undocumented: Additional arguments to be passed to the `runQuery` API on the query server. */
+  additionalRunQueryArgs: Record<string, any>;
 }
 
 export interface LaunchRequest extends Request, DebugProtocol.LaunchRequest {
diff --git a/extensions/ql-vscode/src/debugger/debug-session.ts b/extensions/ql-vscode/src/debugger/debug-session.ts
@@ -161,6 +161,7 @@ class RunningQuery extends DisposableObject {
       true,
       config.additionalPacks,
       config.extensionPacks,
+      config.additionalRunQueryArgs,
       queryStorageDir,
       undefined,
       undefined,
diff --git a/extensions/ql-vscode/src/language-support/contextual/query-resolver.ts b/extensions/ql-vscode/src/language-support/contextual/query-resolver.ts
@@ -44,6 +44,7 @@ export async function runContextualQuery(
     false,
     getOnDiskWorkspaceFolders(),
     undefined,
+    {},
     queryStorageDir,
     undefined,
     templates,
diff --git a/extensions/ql-vscode/src/local-queries/local-queries.ts b/extensions/ql-vscode/src/local-queries/local-queries.ts
@@ -456,6 +456,7 @@ export class LocalQueries extends DisposableObject {
       true,
       additionalPacks,
       extensionPacks,
+      {},
       this.queryStorageDir,
       undefined,
       templates,
diff --git a/extensions/ql-vscode/src/local-queries/run-query.ts b/extensions/ql-vscode/src/local-queries/run-query.ts
@@ -41,6 +41,7 @@ export async function runQuery({
     false,
     additionalPacks,
     extensionPacks,
+    {},
     queryStorageDir,
     undefined,
     undefined,
diff --git a/extensions/ql-vscode/src/query-server/legacy/legacy-query-runner.ts b/extensions/ql-vscode/src/query-server/legacy/legacy-query-runner.ts
@@ -65,6 +65,7 @@ export class LegacyQueryRunner extends QueryRunner {
     query: CoreQueryTarget,
     additionalPacks: string[],
     extensionPacks: string[] | undefined,
+    _additionalRunQueryArgs: Record<string, any>, // Ignored in legacy query server
     generateEvalLog: boolean,
     outputDir: QueryOutputDir,
     progress: ProgressCallback,
diff --git a/extensions/ql-vscode/src/query-server/new-query-runner.ts b/extensions/ql-vscode/src/query-server/new-query-runner.ts
@@ -75,6 +75,7 @@ export class NewQueryRunner extends QueryRunner {
     query: CoreQueryTarget,
     additionalPacks: string[],
     extensionPacks: string[] | undefined,
+    additionalRunQueryArgs: Record<string, any>,
     generateEvalLog: boolean,
     outputDir: QueryOutputDir,
     progress: ProgressCallback,
@@ -89,6 +90,7 @@ export class NewQueryRunner extends QueryRunner {
       generateEvalLog,
       additionalPacks,
       extensionPacks,
+      additionalRunQueryArgs,
       outputDir,
       progress,
       token,
diff --git a/extensions/ql-vscode/src/query-server/query-runner.ts b/extensions/ql-vscode/src/query-server/query-runner.ts
@@ -75,6 +75,7 @@ export abstract class QueryRunner {
     query: CoreQueryTarget,
     additionalPacks: string[],
     extensionPacks: string[] | undefined,
+    additionalRunQueryArgs: Record<string, any>,
     generateEvalLog: boolean,
     outputDir: QueryOutputDir,
     progress: ProgressCallback,
@@ -107,6 +108,7 @@ export abstract class QueryRunner {
     generateEvalLog: boolean,
     additionalPacks: string[],
     extensionPacks: string[] | undefined,
+    additionalRunQueryArgs: Record<string, any>,
     queryStorageDir: string,
     id = `${basename(query.queryPath)}-${nanoid()}`,
     templates: Record<string, string> | undefined,
@@ -133,6 +135,7 @@ export abstract class QueryRunner {
             query,
             additionalPacks,
             extensionPacks,
+            additionalRunQueryArgs,
             generateEvalLog,
             outputDir,
             progress,
diff --git a/extensions/ql-vscode/src/query-server/run-queries.ts b/extensions/ql-vscode/src/query-server/run-queries.ts
@@ -27,6 +27,7 @@ export async function compileAndRunQueryAgainstDatabaseCore(
   generateEvalLog: boolean,
   additionalPacks: string[],
   extensionPacks: string[] | undefined,
+  additionalRunQueryArgs: Record<string, any>,
   outputDir: QueryOutputDir,
   progress: ProgressCallback,
   token: CancellationToken,
@@ -55,6 +56,8 @@ export async function compileAndRunQueryAgainstDatabaseCore(
     logPath: evalLogPath,
     target,
     extensionPacks,
+    // Add any additional arguments without interpretation.
+    ...additionalRunQueryArgs,
   };
 
   // Update the active query logger every time there is a new request to compile.
diff --git a/extensions/ql-vscode/test/vscode-tests/cli-integration/debugger/debugger.test.ts b/extensions/ql-vscode/test/vscode-tests/cli-integration/debugger/debugger.test.ts
@@ -177,4 +177,31 @@ describeWithCodeQL()("Debugger", () => {
       expect(editor.document.isDirty).toBe(false);
     });
   });
+
+  it("should pass additionalArgs through to query server", async () => {
+    if (!(await cli.cliConstraints.supportsNewQueryServerForTests())) {
+      // Only works with the new query server.
+      return;
+    }
+    await withDebugController(appCommands, async (controller) => {
+      await controller.startDebugging(
+        {
+          query: quickEvalQueryPath,
+          additionalRunQueryArgs: {
+            // Overrides the value passed to the query server
+            queryPath: simpleQueryPath,
+          },
+        },
+        true,
+      );
+      await controller.expectLaunched();
+      const result = await controller.expectSucceeded();
+      await controller.expectExited();
+      await controller.expectTerminated();
+      await controller.expectSessionClosed();
+
+      // Expect the number of results to be the same as if we had run the simple query, not the quick eval query.
+      expect(await getResultCount(result.results.outputDir, cli)).toBe(2);
+    });
+  });
 });
diff --git a/extensions/ql-vscode/test/vscode-tests/no-workspace/model-editor/auto-model-codeml-queries.test.ts b/extensions/ql-vscode/test/vscode-tests/no-workspace/model-editor/auto-model-codeml-queries.test.ts
@@ -159,6 +159,7 @@ describe("runAutoModelQueries", () => {
       false,
       expect.arrayContaining([expect.stringContaining("tmp")]),
       ["/a/b/c/my-extension-pack"],
+      {},
       "/tmp/queries",
       undefined,
       undefined,
diff --git a/extensions/ql-vscode/test/vscode-tests/no-workspace/model-editor/external-api-usage-query.test.ts b/extensions/ql-vscode/test/vscode-tests/no-workspace/model-editor/external-api-usage-query.test.ts
@@ -165,6 +165,7 @@ describe("external api usage query", () => {
         false,
         [],
         ["my/extensions"],
+        {},
         "/tmp/queries",
         undefined,
         undefined,

Original file line number	Diff line number	Diff line change
`@@ -110,6 +110,10 @@`
`110`	`110`	`"string"`
`111`	`111`	`],`
`112`	`112`	"description": "Names of extension packs to include in the evaluation. These are resolved from the locations specified in `additionalPacks`."
	`113`	`+ },`
	`114`	`+ "additionalRunQueryArgs": {`
	`115`	`+ "type": "object",`
	`116`	+ "description": "Internal use only. Additional arguments to pass to the `runQuery` command of the query server, without validation."
`113`	`117`	`}`
`114`	`118`	`}`
`115`	`119`	`}`
Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,8 @@ export interface LaunchConfig {`
`70`	`70`	`quickEvalContext: QuickEvalContext \| undefined;`
`71`	`71`	`/** Run the query without debugging it. */`
`72`	`72`	`noDebug: boolean;`
	`73`	+ /** Undocumented: Additional arguments to be passed to the `runQuery` API on the query server. */
	`74`	`+ additionalRunQueryArgs: Record<string, any>;`
`73`	`75`	`}`
`74`	`76`
`75`	`77`	`export interface LaunchRequest extends Request, DebugProtocol.LaunchRequest {`