Rename ExternalApiUsage to Method (#2776)

Author: charisk

extensions/ql-vscode/src/common/commands.ts

@@ -12,7 +12,7 @@ import type {
 } from "../variant-analysis/shared/variant-analysis";
 import type { QLDebugConfiguration } from "../debugger/debug-configuration";
 import type { QueryTreeViewItem } from "../queries-panel/query-tree-view-item";
-import type { Usage } from "../model-editor/external-api-usage";
+import type { Usage } from "../model-editor/method";
 
 // A command function matching the signature that VS Code calls when
 // a command is invoked from a context menu on a TreeView with

extensions/ql-vscode/src/common/interface-types.ts

@@ -17,7 +17,7 @@ import {
 } from "../variant-analysis/shared/variant-analysis-filter-sort";
 import { ErrorLike } from "../common/errors";
 import { DataFlowPaths } from "../variant-analysis/shared/data-flow-paths";
-import { ExternalApiUsage, Usage } from "../model-editor/external-api-usage";
+import { Method, Usage } from "../model-editor/method";
 import { ModeledMethod } from "../model-editor/modeled-method";
 import { ModelEditorViewState } from "../model-editor/shared/view-state";
 import { Mode } from "../model-editor/shared/mode";
@@ -495,9 +495,9 @@ interface SetExtensionPackStateMessage {
   viewState: ModelEditorViewState;
 }
 
-interface SetExternalApiUsagesMessage {
-  t: "setExternalApiUsages";
-  externalApiUsages: ExternalApiUsage[];
+interface SetMethodsMessage {
+  t: "setMethods";
+  methods: Method[];
 }
 
 interface LoadModeledMethodsMessage {
@@ -523,7 +523,7 @@ interface SwitchModeMessage {
 
 interface JumpToUsageMessage {
   t: "jumpToUsage";
-  method: ExternalApiUsage;
+  method: Method;
   usage: Usage;
 }
 
@@ -535,29 +535,29 @@ interface OpenExtensionPackMessage {
   t: "openExtensionPack";
 }
 
-interface RefreshExternalApiUsages {
-  t: "refreshExternalApiUsages";
+interface RefreshMethods {
+  t: "refreshMethods";
 }
 
 interface SaveModeledMethods {
   t: "saveModeledMethods";
-  externalApiUsages: ExternalApiUsage[];
+  methods: Method[];
   modeledMethods: Record<string, ModeledMethod>;
 }
 
-interface GenerateExternalApiMessage {
-  t: "generateExternalApi";
+interface GenerateMethodMessage {
+  t: "generateMethod";
 }
 
-interface GenerateExternalApiFromLlmMessage {
-  t: "generateExternalApiFromLlm";
+interface GenerateMethodsFromLlmMessage {
+  t: "generateMethodsFromLlm";
   packageName: string;
-  externalApiUsages: ExternalApiUsage[];
+  methods: Method[];
   modeledMethods: Record<string, ModeledMethod>;
 }
 
-interface StopGeneratingExternalApiFromLlmMessage {
-  t: "stopGeneratingExternalApiFromLlm";
+interface StopGeneratingMethodsFromLlmMessage {
+  t: "stopGeneratingMethodsFromLlm";
   packageName: string;
 }
 
@@ -572,22 +572,22 @@ interface HideModeledApisMessage {
 
 export type ToModelEditorMessage =
   | SetExtensionPackStateMessage
-  | SetExternalApiUsagesMessage
+  | SetMethodsMessage
   | LoadModeledMethodsMessage
   | AddModeledMethodsMessage
   | SetInProgressMethodsMessage;
 
 export type FromModelEditorMessage =
   | ViewLoadedMsg
   | SwitchModeMessage
-  | RefreshExternalApiUsages
+  | RefreshMethods
   | OpenDatabaseMessage
   | OpenExtensionPackMessage
   | JumpToUsageMessage
   | SaveModeledMethods
-  | GenerateExternalApiMessage
-  | GenerateExternalApiFromLlmMessage
-  | StopGeneratingExternalApiFromLlmMessage
+  | GenerateMethodMessage
+  | GenerateMethodsFromLlmMessage
+  | StopGeneratingMethodsFromLlmMessage
   | ModelDependencyMessage
   | HideModeledApisMessage;
 
@@ -597,7 +597,7 @@ export type FromMethodModelingMessage =
 
 interface SetMethodMessage {
   t: "setMethod";
-  method: ExternalApiUsage;
+  method: Method;
 }
 
 export type ToMethodModelingMessage = SetMethodMessage;

extensions/ql-vscode/src/model-editor/auto-model-codeml-queries.ts

@@ -11,7 +11,7 @@ import { assertNever } from "../common/helpers-pure";
 import { dir } from "tmp-promise";
 import { writeFile, outputFile } from "fs-extra";
 import { dump as dumpYaml } from "js-yaml";
-import { MethodSignature } from "./external-api-usage";
+import { MethodSignature } from "./method";
 import { runQuery } from "../local-queries/run-query";
 import { QueryMetadata } from "../common/interface-types";
 import { CancellationTokenSource } from "vscode";

extensions/ql-vscode/src/model-editor/auto-model.ts

@@ -4,7 +4,7 @@ import { AutoModelQueriesResult } from "./auto-model-codeml-queries";
 import { assertNever } from "../common/helpers-pure";
 import * as Sarif from "sarif";
 import { gzipEncode } from "../common/zlib";
-import { ExternalApiUsage, MethodSignature } from "./external-api-usage";
+import { Method, MethodSignature } from "./method";
 import { ModeledMethod } from "./modeled-method";
 import { groupMethods, sortGroupNames, sortMethods } from "./shared/sorting";
 
@@ -13,28 +13,26 @@ import { groupMethods, sortGroupNames, sortMethods } from "./shared/sorting";
  * candidates to the candidate limit and filtering out anything that is already modeled and respecting
  * the order in the UI.
  * @param mode Whether it is application or framework mode.
- * @param externalApiUsages all external API usages.
+ * @param methods all methods.
  * @param modeledMethods the currently modeled methods.
  * @returns list of modeled methods that are candidates for modeling.
  */
 export function getCandidates(
   mode: Mode,
-  externalApiUsages: ExternalApiUsage[],
+  methods: Method[],
   modeledMethods: Record<string, ModeledMethod>,
 ): MethodSignature[] {
   // Sort the same way as the UI so we send the first ones listed in the UI first
-  const grouped = groupMethods(externalApiUsages, mode);
+  const grouped = groupMethods(methods, mode);
   const sortedGroupNames = sortGroupNames(grouped);
-  const sortedExternalApiUsages = sortedGroupNames.flatMap((name) =>
+  const sortedMethods = sortedGroupNames.flatMap((name) =>
     sortMethods(grouped[name]),
   );
 
   const candidates: MethodSignature[] = [];
 
-  for (const externalApiUsage of sortedExternalApiUsages) {
-    const modeledMethod: ModeledMethod = modeledMethods[
-      externalApiUsage.signature
-    ] ?? {
+  for (const method of sortedMethods) {
+    const modeledMethod: ModeledMethod = modeledMethods[method.signature] ?? {
       type: "none",
     };
 
@@ -44,12 +42,12 @@ export function getCandidates(
     }
 
     // A method that is supported is modeled outside of the model file, so it is not a candidate.
-    if (externalApiUsage.supported) {
+    if (method.supported) {
       continue;
     }
 
     // The rest are candidates
-    candidates.push(externalApiUsage);
+    candidates.push(method);
   }
   return candidates;
 }

extensions/ql-vscode/src/model-editor/auto-modeler.ts

@@ -1,4 +1,4 @@
-import { ExternalApiUsage, MethodSignature } from "./external-api-usage";
+import { Method, MethodSignature } from "./method";
 import { ModeledMethod } from "./modeled-method";
 import { extLogger } from "../common/logging/vscode";
 import { load as loadYaml } from "js-yaml";
@@ -52,13 +52,13 @@ export class AutoModeler {
    * Models the given package's external API usages, except
    * the ones that are already modeled.
    * @param packageName The name of the package to model.
-   * @param externalApiUsages The external API usages.
+   * @param methods The methods.
    * @param modeledMethods The currently modeled methods.
    * @param mode The mode we are modeling in.
    */
   public async startModeling(
     packageName: string,
-    externalApiUsages: ExternalApiUsage[],
+    methods: Method[],
     modeledMethods: Record<string, ModeledMethod>,
     mode: Mode,
   ): Promise<void> {
@@ -72,7 +72,7 @@ export class AutoModeler {
     try {
       await this.modelPackage(
         packageName,
-        externalApiUsages,
+        methods,
         modeledMethods,
         mode,
         cancellationTokenSource,
@@ -105,19 +105,15 @@ export class AutoModeler {
 
   private async modelPackage(
     packageName: string,
-    externalApiUsages: ExternalApiUsage[],
+    methods: Method[],
     modeledMethods: Record<string, ModeledMethod>,
     mode: Mode,
     cancellationTokenSource: CancellationTokenSource,
   ): Promise<void> {
     void extLogger.log(`Modeling package ${packageName}`);
     await withProgress(async (progress) => {
       // Fetch the candidates to send to the model
-      const allCandidateMethods = getCandidates(
-        mode,
-        externalApiUsages,
-        modeledMethods,
-      );
+      const allCandidateMethods = getCandidates(mode, methods, modeledMethods);
 
       // If there are no candidates, there is nothing to model and we just return
       if (allCandidateMethods.length === 0) {

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

@@ -1,16 +1,12 @@
 import { DecodedBqrsChunk } from "../common/bqrs-cli-types";
-import {
-  Call,
-  CallClassification,
-  ExternalApiUsage,
-} from "./external-api-usage";
+import { Call, CallClassification, Method } from "./method";
 import { ModeledMethodType } from "./modeled-method";
 import { parseLibraryFilename } from "./library";
 
 export function decodeBqrsToExternalApiUsages(
   chunk: DecodedBqrsChunk,
-): ExternalApiUsage[] {
-  const methodsByApiName = new Map<string, ExternalApiUsage>();
+): Method[] {
+  const methodsByApiName = new Map<string, Method>();
 
   chunk?.tuples.forEach((tuple) => {
     const usage = tuple[0] as Call;

extensions/ql-vscode/src/model-editor/external-api-usage-queries.ts

@@ -13,7 +13,7 @@ import { Mode } from "./shared/mode";
 import { writeFile } from "fs-extra";
 import { QueryLanguage } from "../common/query-language";
 import { fetchExternalApiQueries } from "./queries";
-import { ExternalApiUsage } from "./external-api-usage";
+import { Method } from "./method";
 import { runQuery } from "../local-queries/run-query";
 import { decodeBqrsToExternalApiUsages } from "./bqrs";
 
@@ -69,7 +69,7 @@ export async function runExternalApiQueries(
     progress,
     token,
   }: RunQueryOptions,
-): Promise<ExternalApiUsage[] | undefined> {
+): Promise<Method[] | 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.

extensions/ql-vscode/src/model-editor/method-modeling/method-modeling-panel.ts

@@ -1,7 +1,7 @@
 import { ExtensionContext, window } from "vscode";
 import { DisposableObject } from "../../common/disposable-object";
 import { MethodModelingViewProvider } from "./method-modeling-view-provider";
-import { ExternalApiUsage } from "../external-api-usage";
+import { Method } from "../method";
 
 export class MethodModelingPanel extends DisposableObject {
   private readonly provider: MethodModelingViewProvider;
@@ -18,7 +18,7 @@ export class MethodModelingPanel extends DisposableObject {
     );
   }
 
-  public async setMethod(method: ExternalApiUsage): Promise<void> {
+  public async setMethod(method: Method): Promise<void> {
     await this.provider.setMethod(method);
   }
 }

extensions/ql-vscode/src/model-editor/method-modeling/method-modeling-view-provider.ts

@@ -6,7 +6,7 @@ import { telemetryListener } from "../../common/vscode/telemetry";
 import { showAndLogExceptionWithTelemetry } from "../../common/logging/notifications";
 import { extLogger } from "../../common/logging/vscode/loggers";
 import { redactableError } from "../../common/errors";
-import { ExternalApiUsage } from "../external-api-usage";
+import { Method } from "../method";
 
 export class MethodModelingViewProvider implements WebviewViewProvider {
   public static readonly viewType = "codeQLMethodModeling";
@@ -46,7 +46,7 @@ export class MethodModelingViewProvider implements WebviewViewProvider {
     this.webviewView = webviewView;
   }
 
-  public async setMethod(method: ExternalApiUsage): Promise<void> {
+  public async setMethod(method: Method): Promise<void> {
     if (this.webviewView) {
       await this.webviewView.webview.postMessage({
         t: "setMethod",

…e/src/model-editor/external-api-usage.ts …ons/ql-vscode/src/model-editor/method.tsextensions/ql-vscode/src/model-editor/external-api-usage.ts renamed to extensions/ql-vscode/src/model-editor/method.ts extensions/ql-vscode/src/model-editor/external-api-usage.ts renamed to extensions/ql-vscode/src/model-editor/method.ts

@@ -39,7 +39,7 @@ export interface MethodSignature {
   methodParameters: string;
 }
 
-export interface ExternalApiUsage extends MethodSignature {
+export interface Method extends MethodSignature {
   /**
    * Contains the name of the library containing the method declaration, e.g. `sql2o-1.6.0.jar` or `System.Runtime.dll`
    */