Merge pull request #3647 from d10c/d10c/bigint-quick-eval

d10c · web-flow · commit 9cc790ec5ea0 · 2024-10-14T16:32:16.000+02:00
diff --git a/extensions/ql-vscode/CHANGELOG.md b/extensions/ql-vscode/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## [UNRELEASED]
 
+- Support result columns of type `QlBuiltins::BigInt` in quick evaluations. [#3647](https://github.com/github/vscode-codeql/pull/3647)
+
 ## 1.16.0 - 10 October 2024
 
 - Increase the required version of VS Code to 1.90.0. [#3737](https://github.com/github/vscode-codeql/pull/3737)
diff --git a/extensions/ql-vscode/src/common/bqrs-cli-types.ts b/extensions/ql-vscode/src/common/bqrs-cli-types.ts
@@ -11,6 +11,7 @@ export namespace BqrsColumnKindCode {
   export const BOOLEAN = "b";
   export const DATE = "d";
   export const ENTITY = "e";
+  export const BIGINT = "z";
 }
 
 export type BqrsColumnKind =
@@ -19,7 +20,8 @@ export type BqrsColumnKind =
   | typeof BqrsColumnKindCode.STRING
   | typeof BqrsColumnKindCode.BOOLEAN
   | typeof BqrsColumnKindCode.DATE
-  | typeof BqrsColumnKindCode.ENTITY;
+  | typeof BqrsColumnKindCode.ENTITY
+  | typeof BqrsColumnKindCode.BIGINT;
 
 export interface BqrsSchemaColumn {
   name?: string;
@@ -79,7 +81,8 @@ export type BqrsKind =
   | "Integer"
   | "Boolean"
   | "Date"
-  | "Entity";
+  | "Entity"
+  | "BigInt";
 
 interface BqrsColumn {
   name?: string;
diff --git a/extensions/ql-vscode/src/common/bqrs-raw-results-mapper.ts b/extensions/ql-vscode/src/common/bqrs-raw-results-mapper.ts
@@ -76,6 +76,8 @@ function mapColumnKind(kind: BqrsColumnKind): ColumnKind {
       return ColumnKind.Date;
     case BqrsColumnKindCode.ENTITY:
       return ColumnKind.Entity;
+    case BqrsColumnKindCode.BIGINT:
+      return ColumnKind.BigInt;
     default:
       assertNever(kind);
   }
diff --git a/extensions/ql-vscode/src/common/raw-result-types.ts b/extensions/ql-vscode/src/common/raw-result-types.ts
@@ -5,6 +5,7 @@ export enum ColumnKind {
   Boolean = "boolean",
   Date = "date",
   Entity = "entity",
+  BigInt = "bigint",
 }
 
 export type Column = {
@@ -61,6 +62,11 @@ type CellValueNumber = {
   value: number;
 };
 
+type CellValueBigInt = {
+  type: "number";
+  value: number;
+};
+
 type CellValueString = {
   type: "string";
   value: string;
@@ -75,7 +81,8 @@ export type CellValue =
   | CellValueEntity
   | CellValueNumber
   | CellValueString
-  | CellValueBoolean;
+  | CellValueBoolean
+  | CellValueBigInt;
 
 export type Row = CellValue[];
 
diff --git a/extensions/ql-vscode/test/data/debugger/QuickEvalLib.qll b/extensions/ql-vscode/test/data/debugger/QuickEvalLib.qll
@@ -17,4 +17,8 @@ abstract class InterestingNumber extends TNumber
     final int getValue() {
         result = value
     }
+
+    QlBuiltins::BigInt getBigIntValue() {
+        result = value.toBigInt()
+    }
 }
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
@@ -144,6 +144,25 @@ describeWithCodeQL()("Debugger", () => {
     });
   });
 
+  it("should run a quick evaluation with a bigint-valued result column", async () => {
+    await withDebugController(appCommands, async (controller) => {
+      await selectForQuickEval(quickEvalLibPath, 20, 23, 20, 37);
+
+      await controller.startDebuggingSelection({
+        query: quickEvalQueryPath, // The query context. This query extends the abstract class.
+      });
+      await controller.expectLaunched();
+      const result = await controller.expectSucceeded();
+      expect(result.started.quickEvalContext).toBeDefined();
+      expect(result.started.quickEvalContext!.quickEvalText).toBe(
+        "getBigIntValue",
+      );
+      expect(result.results.queryTarget.quickEvalPosition).toBeDefined();
+      expect(await getResultCount(result.results.outputDir, cli)).toBe(8);
+      await controller.expectStopped();
+    });
+  });
+
   it("should save dirty documents before launching a debug session", async () => {
     await withDebugController(appCommands, async (controller) => {
       const editor = await selectForQuickEval(quickEvalLibPath, 4, 15, 4, 32);

Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,8 @@ function mapColumnKind(kind: BqrsColumnKind): ColumnKind {`
`76`	`76`	`return ColumnKind.Date;`
`77`	`77`	`case BqrsColumnKindCode.ENTITY:`
`78`	`78`	`return ColumnKind.Entity;`
	`79`	`+ case BqrsColumnKindCode.BIGINT:`
	`80`	`+ return ColumnKind.BigInt;`
`79`	`81`	`default:`
`80`	`82`	`assertNever(kind);`
`81`	`83`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,4 +17,8 @@ abstract class InterestingNumber extends TNumber`
`17`	`17`	`final int getValue() {`
`18`	`18`	`result = value`
`19`	`19`	`}`
	`20`	`+`
	`21`	`+ QlBuiltins::BigInt getBigIntValue() {`
	`22`	`+ result = value.toBigInt()`
	`23`	`+ }`
`20`	`24`	`}`