Merge pull request #2763 from github/starcke/rename-vars

Starcke/rename vars

Author: starcke

extensions/ql-vscode/package.json

@@ -943,7 +943,7 @@
         "enablement": "codeql.hasQLSource"
       },
       {
-        "command": "codeQL.openDataExtensionsEditor",
+        "command": "codeQL.openModelEditor",
         "title": "CodeQL: Open CodeQL Model Editor"
       },
       {
@@ -1415,7 +1415,7 @@
           "when": "false"
         },
         {
-          "command": "codeQL.openDataExtensionsEditor",
+          "command": "codeQL.openModelEditor",
           "when": "config.codeQL.canary && config.codeQL.dataExtensions.editor"
         },
         {
@@ -1763,15 +1763,15 @@
         {
           "id": "codeQLMethodsUsage",
           "name": "CodeQL Methods Usage",
-          "when": "config.codeQL.canary && codeql.dataExtensionsEditorOpen"
+          "when": "config.codeQL.canary && codeql.modelEditorOpen"
         }
       ],
       "explorer": [
         {
           "type": "webview",
           "id": "codeQLMethodModeling",
           "name": "CodeQL Method Modeling",
-          "when": "config.codeQL.canary && config.codeQL.modelEditor.methodModelingView && codeql.dataExtensionsEditorOpen"
+          "when": "config.codeQL.canary && config.codeQL.modelEditor.methodModelingView && codeql.modelEditorOpen"
         }
       ]
     },

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

@@ -302,9 +302,9 @@ export type PackagingCommands = {
   "codeQL.downloadPacks": () => Promise<void>;
 };
 
-export type DataExtensionsEditorCommands = {
-  "codeQL.openDataExtensionsEditor": () => Promise<void>;
-  "codeQLDataExtensionsEditor.jumpToUsageLocation": (
+export type ModelEditorCommands = {
+  "codeQL.openModelEditor": () => Promise<void>;
+  "codeQLModelEditor.jumpToUsageLocation": (
     usage: Usage,
     databaseItem: DatabaseItem,
   ) => Promise<void>;
@@ -347,7 +347,7 @@ export type AllExtensionCommands = BaseCommands &
   AstCfgCommands &
   AstViewerCommands &
   PackagingCommands &
-  DataExtensionsEditorCommands &
+  ModelEditorCommands &
   EvalLogViewerCommands &
   SummaryLanguageSupportCommands &
   Partial<TestUICommands> &

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

@@ -19,7 +19,7 @@ import { ErrorLike } from "../common/errors";
 import { DataFlowPaths } from "../variant-analysis/shared/data-flow-paths";
 import { ExternalApiUsage, Usage } from "../model-editor/external-api-usage";
 import { ModeledMethod } from "../model-editor/modeled-method";
-import { DataExtensionEditorViewState } from "../model-editor/shared/view-state";
+import { ModelEditorViewState } from "../model-editor/shared/view-state";
 import { Mode } from "../model-editor/shared/mode";
 
 /**
@@ -491,8 +491,8 @@ export type ToDataFlowPathsMessage = SetDataFlowPathsMessage;
 export type FromDataFlowPathsMessage = CommonFromViewMessages;
 
 interface SetExtensionPackStateMessage {
-  t: "setDataExtensionEditorViewState";
-  viewState: DataExtensionEditorViewState;
+  t: "setModelEditorViewState";
+  viewState: ModelEditorViewState;
 }
 
 interface SetExternalApiUsagesMessage {
@@ -569,14 +569,14 @@ interface HideModeledApisMessage {
   hideModeledApis: boolean;
 }
 
-export type ToDataExtensionsEditorMessage =
+export type ToModelEditorMessage =
   | SetExtensionPackStateMessage
   | SetExternalApiUsagesMessage
   | LoadModeledMethodsMessage
   | AddModeledMethodsMessage
   | SetInProgressMethodsMessage;
 
-export type FromDataExtensionsEditorMessage =
+export type FromModelEditorMessage =
   | ViewLoadedMsg
   | SwitchModeMessage
   | RefreshExternalApiUsages

extensions/ql-vscode/src/extension.ts

@@ -128,7 +128,7 @@ import { getAstCfgCommands } from "./language-support/ast-viewer/ast-cfg-command
 import { App } from "./common/app";
 import { registerCommandWithErrorHandling } from "./common/vscode/commands";
 import { DebuggerUI } from "./debugger/debugger-ui";
-import { DataExtensionsEditorModule } from "./model-editor/model-editor-module";
+import { ModelEditorModule } from "./model-editor/model-editor-module";
 import { TestManager } from "./query-testing/test-manager";
 import { TestRunner } from "./query-testing/test-runner";
 import { TestManagerBase } from "./query-testing/test-manager-base";
@@ -934,15 +934,14 @@ async function activateWithInstalledDistribution(
   const debuggerUI = new DebuggerUI(app, localQueries, dbm);
   ctx.subscriptions.push(debuggerUI);
 
-  const dataExtensionsEditorModule =
-    await DataExtensionsEditorModule.initialize(
-      ctx,
-      app,
-      dbm,
-      cliServer,
-      qs,
-      tmpDir.name,
-    );
+  const modelEditorModule = await ModelEditorModule.initialize(
+    ctx,
+    app,
+    dbm,
+    cliServer,
+    qs,
+    tmpDir.name,
+  );
 
   void extLogger.log("Initializing QLTest interface.");
 
@@ -1015,7 +1014,7 @@ async function activateWithInstalledDistribution(
     ...getPackagingCommands({
       cliServer,
     }),
-    ...dataExtensionsEditorModule.getCommands(),
+    ...modelEditorModule.getCommands(),
     ...evalLogViewer.getCommands(),
     ...summaryLanguageSupport.getCommands(),
     ...testUiCommands,

extensions/ql-vscode/src/model-editor/methods-usage/methods-usage-data-provider.ts

@@ -79,7 +79,7 @@ export class MethodsUsageDataProvider
         collapsibleState: TreeItemCollapsibleState.None,
         command: {
           title: "Show usage",
-          command: "codeQLDataExtensionsEditor.jumpToUsageLocation",
+          command: "codeQLModelEditor.jumpToUsageLocation",
           arguments: [item, this.databaseItem],
         },
         iconPath: new ThemeIcon("error", new ThemeColor("errorForeground")),

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

@@ -1,6 +1,6 @@
 import { ExtensionContext } from "vscode";
-import { DataExtensionsEditorView } from "./model-editor-view";
-import { DataExtensionsEditorCommands } from "../common/commands";
+import { ModelEditorView } from "./model-editor-view";
+import { ModelEditorCommands } from "../common/commands";
 import { CliVersionConstraint, CodeQLCliServer } from "../codeql-cli/cli";
 import { QueryRunner } from "../query-server";
 import { DatabaseItem, DatabaseManager } from "../databases/local-databases";
@@ -23,12 +23,11 @@ import { MethodModelingPanel } from "./method-modeling/method-modeling-panel";
 
 const SUPPORTED_LANGUAGES: string[] = ["java", "csharp"];
 
-export class DataExtensionsEditorModule extends DisposableObject {
+export class ModelEditorModule extends DisposableObject {
   private readonly queryStorageDir: string;
   private readonly methodsUsagePanel: MethodsUsagePanel;
 
-  private mostRecentlyActiveView: DataExtensionsEditorView | undefined =
-    undefined;
+  private mostRecentlyActiveView: ModelEditorView | undefined = undefined;
 
   private constructor(
     private readonly ctx: ExtensionContext,
@@ -39,25 +38,22 @@ export class DataExtensionsEditorModule extends DisposableObject {
     baseQueryStorageDir: string,
   ) {
     super();
-    this.queryStorageDir = join(
-      baseQueryStorageDir,
-      "data-extensions-editor-results",
-    );
+    this.queryStorageDir = join(baseQueryStorageDir, "model-editor-results");
     this.methodsUsagePanel = this.push(new MethodsUsagePanel(cliServer));
     this.push(new MethodModelingPanel(ctx));
   }
 
-  private handleViewBecameActive(view: DataExtensionsEditorView): void {
+  private handleViewBecameActive(view: ModelEditorView): void {
     this.mostRecentlyActiveView = view;
   }
 
-  private handleViewWasDisposed(view: DataExtensionsEditorView): void {
+  private handleViewWasDisposed(view: ModelEditorView): void {
     if (this.mostRecentlyActiveView === view) {
       this.mostRecentlyActiveView = undefined;
     }
   }
 
-  private isMostRecentlyActiveView(view: DataExtensionsEditorView): boolean {
+  private isMostRecentlyActiveView(view: ModelEditorView): boolean {
     return this.mostRecentlyActiveView === view;
   }
 
@@ -68,8 +64,8 @@ export class DataExtensionsEditorModule extends DisposableObject {
     cliServer: CodeQLCliServer,
     queryRunner: QueryRunner,
     queryStorageDir: string,
-  ): Promise<DataExtensionsEditorModule> {
-    const dataExtensionsEditorModule = new DataExtensionsEditorModule(
+  ): Promise<ModelEditorModule> {
+    const modelEditorModule = new ModelEditorModule(
       ctx,
       app,
       databaseManager,
@@ -78,13 +74,13 @@ export class DataExtensionsEditorModule extends DisposableObject {
       queryStorageDir,
     );
 
-    await dataExtensionsEditorModule.initialize();
-    return dataExtensionsEditorModule;
+    await modelEditorModule.initialize();
+    return modelEditorModule;
   }
 
-  public getCommands(): DataExtensionsEditorCommands {
+  public getCommands(): ModelEditorCommands {
     return {
-      "codeQL.openDataExtensionsEditor": async () => {
+      "codeQL.openModelEditor": async () => {
         const db = this.databaseManager.currentDatabaseItem;
         if (!db) {
           void showAndLogErrorMessage(this.app.logger, "No database selected");
@@ -141,7 +137,7 @@ export class DataExtensionsEditorModule extends DisposableObject {
               return;
             }
 
-            const view = new DataExtensionsEditorView(
+            const view = new ModelEditorView(
               this.ctx,
               this.app,
               this.databaseManager,
@@ -165,7 +161,7 @@ export class DataExtensionsEditorModule extends DisposableObject {
           },
         );
       },
-      "codeQLDataExtensionsEditor.jumpToUsageLocation": async (
+      "codeQLModelEditor.jumpToUsageLocation": async (
         usage: Usage,
         databaseItem: DatabaseItem,
       ) => {

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

@@ -10,8 +10,8 @@ import {
   WebviewPanelConfig,
 } from "../common/vscode/abstract-webview";
 import {
-  FromDataExtensionsEditorMessage,
-  ToDataExtensionsEditorMessage,
+  FromModelEditorMessage,
+  ToModelEditorMessage,
 } from "../common/interface-types";
 import { ProgressCallback, withProgress } from "../common/vscode/progress";
 import { QueryRunner } from "../query-server";
@@ -40,9 +40,9 @@ import { getLanguageDisplayName } from "../common/query-language";
 import { AutoModeler } from "./auto-modeler";
 import { INITIAL_HIDE_MODELED_APIS_VALUE } from "./shared/hide-modeled-apis";
 
-export class DataExtensionsEditorView extends AbstractWebview<
-  ToDataExtensionsEditorMessage,
-  FromDataExtensionsEditorMessage
+export class ModelEditorView extends AbstractWebview<
+  ToModelEditorMessage,
+  FromModelEditorMessage
 > {
   private readonly autoModeler: AutoModeler;
 
@@ -66,14 +66,10 @@ export class DataExtensionsEditorView extends AbstractWebview<
       hideModeledApis: boolean,
     ) => Promise<void>,
     private readonly revealItemInUsagePanel: (usage: Usage) => Promise<void>,
-    private readonly handleViewBecameActive: (
-      view: DataExtensionsEditorView,
-    ) => void,
-    private readonly handleViewWasDisposed: (
-      view: DataExtensionsEditorView,
-    ) => void,
+    private readonly handleViewBecameActive: (view: ModelEditorView) => void,
+    private readonly handleViewWasDisposed: (view: ModelEditorView) => void,
     private readonly isMostRecentlyActiveView: (
-      view: DataExtensionsEditorView,
+      view: ModelEditorView,
     ) => boolean,
   ) {
     super(ctx);
@@ -120,27 +116,27 @@ export class DataExtensionsEditorView extends AbstractWebview<
       // so we want to check if there are any others still open.
       void this.app.commands.execute(
         "setContext",
-        "codeql.dataExtensionsEditorOpen",
-        this.isADataExtensionsEditorOpen(),
+        "codeql.modelEditorOpen",
+        this.isAModelEditorOpen(),
       );
     });
 
     await this.waitForPanelLoaded();
 
     void this.app.commands.execute(
       "setContext",
-      "codeql.dataExtensionsEditorOpen",
+      "codeql.modelEditorOpen",
       true,
     );
   }
 
-  private isADataExtensionsEditorOpen(): boolean {
+  private isAModelEditorOpen(): boolean {
     return window.tabGroups.all.some((tabGroup) =>
       tabGroup.tabs.some((tab) => {
         const viewType: string | undefined = (tab.input as any)?.viewType;
         // The viewType has a prefix, such as "mainThreadWebview-", but if the
         // suffix matches that should be enough to identify the view.
-        return viewType && viewType.endsWith("data-extensions-editor");
+        return viewType && viewType.endsWith("model-editor");
       }),
     );
   }
@@ -169,9 +165,7 @@ export class DataExtensionsEditorView extends AbstractWebview<
     // Nothing to do here
   }
 
-  protected async onMessage(
-    msg: FromDataExtensionsEditorMessage,
-  ): Promise<void> {
+  protected async onMessage(msg: FromModelEditorMessage): Promise<void> {
     switch (msg.t) {
       case "viewLoaded":
         await this.onWebViewLoaded();
@@ -264,7 +258,7 @@ export class DataExtensionsEditorView extends AbstractWebview<
       this.databaseItem.language === "java" && showLlmGeneration();
 
     await this.postMessage({
-      t: "setDataExtensionEditorViewState",
+      t: "setModelEditorViewState",
       viewState: {
         extensionPack: this.extensionPack,
         showLlmButton,
@@ -433,7 +427,7 @@ export class DataExtensionsEditorView extends AbstractWebview<
         return;
       }
 
-      const view = new DataExtensionsEditorView(
+      const view = new ModelEditorView(
         this.ctx,
         this.app,
         this.databaseManager,

extensions/ql-vscode/src/model-editor/shared/view-state.ts

@@ -1,7 +1,7 @@
 import { ExtensionPack } from "./extension-pack";
 import { Mode } from "./mode";
 
-export interface DataExtensionEditorViewState {
+export interface ModelEditorViewState {
   extensionPack: ExtensionPack;
   showLlmButton: boolean;
   mode: Mode;

extensions/ql-vscode/src/stories/model-editor/ModelEditor.stories.tsx

@@ -3,20 +3,20 @@ import * as React from "react";
 import { Meta, StoryFn } from "@storybook/react";
 
 import { Mode } from "../../model-editor/shared/mode";
-import { DataExtensionsEditor as DataExtensionsEditorComponent } from "../../view/model-editor/ModelEditor";
+import { ModelEditor as ModelEditorComponent } from "../../view/model-editor/ModelEditor";
 import { CallClassification } from "../../model-editor/external-api-usage";
 
 export default {
   title: "CodeQL Model Editor/CodeQL Model Editor",
-  component: DataExtensionsEditorComponent,
-} as Meta<typeof DataExtensionsEditorComponent>;
+  component: ModelEditorComponent,
+} as Meta<typeof ModelEditorComponent>;
 
-const Template: StoryFn<typeof DataExtensionsEditorComponent> = (args) => (
-  <DataExtensionsEditorComponent {...args} />
+const Template: StoryFn<typeof ModelEditorComponent> = (args) => (
+  <ModelEditorComponent {...args} />
 );
 
-export const DataExtensionsEditor = Template.bind({});
-DataExtensionsEditor.args = {
+export const ModelEditor = Template.bind({});
+ModelEditor.args = {
   initialViewState: {
     extensionPack: {
       path: "/home/user/vscode-codeql-starter/codeql-custom-queries-java/sql2o",