Use a single SARIF-compatible query instead of two separate queries

Author: koesie10

extensions/ql-vscode/src/data-extensions-editor/auto-model-usages-query.ts

@@ -37,7 +37,7 @@ export async function getAutoModelUsages({
 
   const cancellationTokenSource = new CancellationTokenSource();
 
-  const queryResult = await runQuery("usagesQuery", {
+  const queryResult = await runQuery({
     cliServer,
     queryRunner,
     queryStorageDir,

extensions/ql-vscode/src/data-extensions-editor/bqrs.ts

@@ -7,9 +7,9 @@ export function decodeBqrsToExternalApiUsages(
   const methodsByApiName = new Map<string, ExternalApiUsage>();
 
   chunk?.tuples.forEach((tuple) => {
-    const signature = tuple[0] as string;
-    const supported = tuple[1] as boolean;
-    const usage = tuple[2] as Call;
+    const usage = tuple[0] as Call;
+    const signature = tuple[1] as string;
+    const supported = (tuple[2] as string) === "true";
 
     const [packageWithType, methodDeclaration] = signature.split("#");
 

extensions/ql-vscode/src/data-extensions-editor/data-extensions-editor-view.ts

@@ -243,7 +243,7 @@ export class DataExtensionsEditorView extends AbstractWebview<
     const cancellationTokenSource = new CancellationTokenSource();
 
     try {
-      const queryResult = await runQuery("mainQuery", {
+      const queryResult = await runQuery({
         cliServer: this.cliServer,
         queryRunner: this.queryRunner,
         databaseItem: this.databaseItem,

extensions/ql-vscode/src/data-extensions-editor/external-api-usage-query.ts

@@ -16,7 +16,6 @@ import { QueryResultType } from "../pure/new-messages";
 import { join } from "path";
 import { redactableError } from "../pure/errors";
 import { QueryLanguage } from "../common/query-language";
-import { Query } from "./queries/query";
 
 export type RunQueryOptions = {
   cliServer: Pick<CodeQLCliServer, "resolveQlpacks">;
@@ -28,17 +27,14 @@ export type RunQueryOptions = {
   token: CancellationToken;
 };
 
-export async function runQuery(
-  queryName: keyof Omit<Query, "dependencies">,
-  {
-    cliServer,
-    queryRunner,
-    databaseItem,
-    queryStorageDir,
-    progress,
-    token,
-  }: RunQueryOptions,
-): Promise<CoreCompletedQuery | undefined> {
+export async function runQuery({
+  cliServer,
+  queryRunner,
+  databaseItem,
+  queryStorageDir,
+  progress,
+  token,
+}: RunQueryOptions): Promise<CoreCompletedQuery | undefined> {
   // The below code is temporary to allow for rapid prototyping of the queries. Once the queries are stabilized, we will
   // move these queries into the `github/codeql` repository and use them like any other contextual (e.g. AST) queries.
   // This is intentionally not pretty code, as it will be removed soon.
@@ -55,7 +51,7 @@ export async function runQuery(
 
   const queryDir = (await dir({ unsafeCleanup: true })).path;
   const queryFile = join(queryDir, "FetchExternalApis.ql");
-  await writeFile(queryFile, query[queryName], "utf8");
+  await writeFile(queryFile, query.mainQuery, "utf8");
 
   if (query.dependencies) {
     for (const [filename, contents] of Object.entries(query.dependencies)) {

extensions/ql-vscode/src/data-extensions-editor/queries/csharp.ts

@@ -2,52 +2,31 @@ import { Query } from "./query";
 
 export const fetchExternalApisQuery: Query = {
   mainQuery: `/**
-* @name Usage of APIs coming from external libraries
-* @description A list of 3rd party APIs used in the codebase.
-* @tags telemetry
-* @id cs/telemetry/fetch-external-apis
-*/
+ * @name Usage of APIs coming from external libraries
+ * @description A list of 3rd party APIs used in the codebase.
+ * @tags telemetry
+ * @kind problem
+ * @id cs/telemetry/fetch-external-apis
+ */
 
 import csharp
 import ExternalApi
 
-private Call aUsage(ExternalApi api) {
- result.getTarget().getUnboundDeclaration() = api
-}
+private Call aUsage(ExternalApi api) { result.getTarget().getUnboundDeclaration() = api }
 
 private boolean isSupported(ExternalApi api) {
- api.isSupported() and result = true
- or
- not api.isSupported() and
- result = false
+  api.isSupported() and result = true
+  or
+  not api.isSupported() and
+  result = false
 }
 
 from ExternalApi api, string apiName, boolean supported, Call usage
 where
- apiName = api.getApiName() and
- supported = isSupported(api) and
- usage = aUsage(api)
-select apiName, supported, usage
-`,
-  usagesQuery: `/**
-* @name Usage of APIs coming from external libraries
-* @description A list of 3rd party APIs used in the codebase.
-* @kind problem
-* @id cs/telemetry/fetch-external-api-usages
-*/
-
-import csharp
-import ExternalApi
-
-private Call aUsage(ExternalApi api) {
- result.getTarget().getUnboundDeclaration() = api
-}
-
-from ExternalApi api, string apiName, Call usage
-where
- apiName = api.getApiName() and
- usage = aUsage(api)
-select usage, apiName
+  apiName = api.getApiName() and
+  supported = isSupported(api) and
+  usage = aUsage(api)
+select usage, apiName, supported.toString(), "supported"
 `,
   dependencies: {
     "ExternalApi.qll": `/** Provides classes and predicates related to handling APIs from external libraries. */

extensions/ql-vscode/src/data-extensions-editor/queries/java.ts

@@ -5,6 +5,7 @@ export const fetchExternalApisQuery: Query = {
  * @name Usage of APIs coming from external libraries
  * @description A list of 3rd party APIs used in the codebase. Excludes test and generated code.
  * @tags telemetry
+ * @kind problem
  * @id java/telemetry/fetch-external-apis
  */
 
@@ -27,28 +28,7 @@ where
   apiName = api.getApiName() and
   supported = isSupported(api) and
   usage = aUsage(api)
-select apiName, supported, usage
-`,
-  usagesQuery: `/**
- * @name Usage of APIs coming from external libraries
- * @description A list of 3rd party APIs used in the codebase. Excludes test and generated code.
- * @kind problem
- * @id java/telemetry/fetch-external-api-usages
- */
-
-import java
-import ExternalApi
-
-private Call aUsage(ExternalApi api) {
-  result.getCallee().getSourceDeclaration() = api and
-  not result.getFile() instanceof GeneratedFile
-}
-
-from ExternalApi api, string apiName, Call usage
-where
-  apiName = api.getApiName() and
-  usage = aUsage(api)
-select usage, apiName
+select usage, apiName, supported.toString(), "supported"
 `,
   dependencies: {
     "ExternalApi.qll": `/** Provides classes and predicates related to handling APIs from external libraries. */

extensions/ql-vscode/src/data-extensions-editor/queries/query.ts

@@ -1,6 +1,14 @@
 export type Query = {
+  /**
+   * The main query.
+   *
+   * It should select all usages of external APIs, and return the following result pattern:
+   * - usage: the usage of the external API. This is an entity.
+   * - apiName: the name of the external API. This is a string.
+   * - supported: whether the external API is supported by the extension. This should be a string representation of a boolean to satify the result pattern for a problem query.
+   * - "supported": a string literal. This is required to make the query a valid problem query.
+   */
   mainQuery: string;
-  usagesQuery: string;
   dependencies?: {
     [filename: string]: string;
   };

extensions/ql-vscode/src/pure/bqrs-cli-types.ts

@@ -115,7 +115,7 @@ export type BqrsKind =
   | "Entity";
 
 interface BqrsColumn {
-  name: string;
+  name?: string;
   kind: BqrsKind;
 }
 export interface DecodedBqrsChunk {