Merge remote-tracking branch 'origin/main' into koesie10/sort-usages-panel

Author: koesie10

extensions/ql-vscode/CHANGELOG.md

@@ -8,6 +8,8 @@
 - Fix a bug where the query server was restarted twice after configuration changes. [#2884](https://github.com/github/vscode-codeql/pull/2884).
 - Add support for the `telemetry.telemetryLevel` setting. For more information, see the [telemetry documentation](https://codeql.github.com/docs/codeql-for-visual-studio-code/about-telemetry-in-codeql-for-visual-studio-code). [#2824](https://github.com/github/vscode-codeql/pull/2824).
 - Fix syntax highlighting directly after import statements with instantiation arguments. [#2792](https://github.com/github/vscode-codeql/pull/2792)
+- The `debug.saveBeforeStart` setting is now respected when running variant analyses. [#2950](https://github.com/github/vscode-codeql/pull/2950)
+- The 'open database' button of the model editor was renamed to 'open source'. Also, it's now only available if the source archive is available as a workspace folder. [#2945](https://github.com/github/vscode-codeql/pull/2945)
 
 ## 1.9.1 - 29 September 2023
 

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

@@ -507,7 +507,7 @@ interface SetMethodsMessage {
 
 interface SetModeledMethodsMessage {
   t: "setModeledMethods";
-  methods: Record<string, ModeledMethod>;
+  methods: Record<string, ModeledMethod[]>;
 }
 
 interface SetModifiedMethodsMessage {
@@ -577,6 +577,12 @@ interface SetModeledMethodMessage {
   method: ModeledMethod;
 }
 
+interface SetMultipleModeledMethodsMessage {
+  t: "setMultipleModeledMethods";
+  methodSignature: string;
+  modeledMethods: ModeledMethod[];
+}
+
 interface SetInModelingModeMessage {
   t: "setInModelingMode";
   inModelingMode: boolean;
@@ -643,14 +649,14 @@ interface SetMethodModifiedMessage {
 interface SetSelectedMethodMessage {
   t: "setSelectedMethod";
   method: Method;
-  modeledMethod?: ModeledMethod;
+  modeledMethods: ModeledMethod[];
   isModified: boolean;
 }
 
 export type ToMethodModelingMessage =
   | SetMethodModelingPanelViewStateMessage
   | SetMethodMessage
-  | SetModeledMethodMessage
+  | SetMultipleModeledMethodsMessage
   | SetMethodModifiedMessage
   | SetSelectedMethodMessage
   | SetInModelingModeMessage;

extensions/ql-vscode/src/databases/local-databases/database-item-impl.ts

@@ -167,6 +167,15 @@ export class DatabaseItemImpl implements DatabaseItem {
     return encodeArchiveBasePath(sourceArchive.fsPath);
   }
 
+  /**
+   * Returns true if the database's source archive is in the workspace.
+   */
+  public hasSourceArchiveInExplorer(): boolean {
+    return (vscode.workspace.workspaceFolders || []).some((folder) =>
+      this.belongsToSourceArchiveExplorerUri(folder.uri),
+    );
+  }
+
   public verifyZippedSources(): string | undefined {
     const sourceArchive = this.sourceArchive;
     if (sourceArchive === undefined) {

extensions/ql-vscode/src/databases/local-databases/database-item.ts

@@ -56,6 +56,11 @@ export interface DatabaseItem {
    */
   getSourceArchiveExplorerUri(): vscode.Uri;
 
+  /**
+   * Returns true if the database's source archive is in the workspace.
+   */
+  hasSourceArchiveInExplorer(): boolean;
+
   /**
    * Holds if `uri` belongs to this database's source archive.
    */

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

@@ -14,10 +14,7 @@ import { assertNever } from "../../common/helpers-pure";
 import { ModelEditorViewTracker } from "../model-editor-view-tracker";
 import { ModelConfigListener } from "../../config";
 import { DatabaseItem } from "../../databases/local-databases";
-import {
-  convertFromLegacyModeledMethod,
-  convertToLegacyModeledMethod,
-} from "../shared/modeled-methods-legacy";
+import { convertFromLegacyModeledMethod } from "../shared/modeled-methods-legacy";
 
 export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
   ToMethodModelingMessage,
@@ -77,9 +74,7 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
         await this.postMessage({
           t: "setSelectedMethod",
           method: selectedMethod.method,
-          modeledMethod: convertToLegacyModeledMethod(
-            selectedMethod.modeledMethods,
-          ),
+          modeledMethods: selectedMethod.modeledMethods,
           isModified: selectedMethod.isModified,
         });
       }
@@ -149,29 +144,23 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
       return;
     }
 
-    const views = this.editorViewTracker.getViews(
+    const view = this.editorViewTracker.getView(
       this.databaseItem.databaseUri.toString(),
     );
-    if (views.length === 0) {
-      return;
-    }
-
-    await Promise.all(views.map((view) => view.revealMethod(method)));
+    await view?.revealMethod(method);
   }
 
   private registerToModelingStoreEvents(): void {
     this.push(
       this.modelingStore.onModeledMethodsChanged(async (e) => {
-        if (this.webviewView && e.isActiveDb) {
-          const modeledMethods = e.modeledMethods[this.method?.signature ?? ""];
+        if (this.webviewView && e.isActiveDb && this.method) {
+          const modeledMethods = e.modeledMethods[this.method.signature];
           if (modeledMethods) {
-            const modeledMethod = convertToLegacyModeledMethod(modeledMethods);
-            if (modeledMethod) {
-              await this.postMessage({
-                t: "setModeledMethod",
-                method: modeledMethod,
-              });
-            }
+            await this.postMessage({
+              t: "setMultipleModeledMethods",
+              methodSignature: this.method.signature,
+              modeledMethods,
+            });
           }
         }
       }),
@@ -198,7 +187,7 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
           await this.postMessage({
             t: "setSelectedMethod",
             method: e.method,
-            modeledMethod: convertToLegacyModeledMethod(e.modeledMethods),
+            modeledMethods: e.modeledMethods,
             isModified: e.isModified,
           });
         }

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

@@ -68,12 +68,12 @@ export function getArgumentsList(methodParameters: string): string[] {
 
 export function canMethodBeModeled(
   method: Method,
-  modeledMethod: ModeledMethod | undefined,
+  modeledMethods: ModeledMethod[],
   methodIsUnsaved: boolean,
 ): boolean {
   return (
     !method.supported ||
-    (modeledMethod && modeledMethod?.type !== "none") ||
+    modeledMethods.some((modeledMethod) => modeledMethod.type !== "none") ||
     methodIsUnsaved
   );
 }

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

@@ -127,6 +127,15 @@ export class ModelEditorModule extends DisposableObject {
         return;
       }
 
+      const existingView = this.editorViewTracker.getView(
+        db.databaseUri.toString(),
+      );
+      if (existingView) {
+        await existingView.focusView();
+
+        return;
+      }
+
       return withProgress(
         async (progress) => {
           const maxStep = 4;
@@ -191,6 +200,17 @@ export class ModelEditorModule extends DisposableObject {
             maxStep,
           });
 
+          // Check again just before opening the editor to ensure no model editor has been opened between
+          // our first check and now.
+          const existingView = this.editorViewTracker.getView(
+            db.databaseUri.toString(),
+          );
+          if (existingView) {
+            await existingView.focusView();
+
+            return;
+          }
+
           const view = new ModelEditorView(
             this.app,
             this.modelingStore,

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

@@ -9,33 +9,25 @@ interface ModelEditorViewInterface {
 export class ModelEditorViewTracker<
   T extends ModelEditorViewInterface = ModelEditorViewInterface,
 > {
-  private readonly views = new Map<string, T[]>();
+  private readonly views = new Map<string, T>();
 
   constructor() {}
 
   public registerView(view: T): void {
     const databaseUri = view.databaseUri;
 
-    if (!this.views.has(databaseUri)) {
-      this.views.set(databaseUri, []);
+    if (this.views.has(databaseUri)) {
+      throw new Error(`View for database ${databaseUri} already registered`);
     }
 
-    this.views.get(databaseUri)?.push(view);
+    this.views.set(databaseUri, view);
   }
 
   public unregisterView(view: T): void {
-    const views = this.views.get(view.databaseUri);
-    if (!views) {
-      return;
-    }
-
-    const index = views.indexOf(view);
-    if (index !== -1) {
-      views.splice(index, 1);
-    }
+    this.views.delete(view.databaseUri);
   }
 
-  public getViews(databaseUri: string): T[] {
-    return this.views.get(databaseUri) ?? [];
+  public getView(databaseUri: string): T | undefined {
+    return this.views.get(databaseUri);
   }
 }

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

@@ -43,10 +43,7 @@ import { AutoModeler } from "./auto-modeler";
 import { telemetryListener } from "../common/vscode/telemetry";
 import { ModelingStore } from "./modeling-store";
 import { ModelEditorViewTracker } from "./model-editor-view-tracker";
-import {
-  convertFromLegacyModeledMethod,
-  convertToLegacyModeledMethods,
-} from "./shared/modeled-methods-legacy";
+import { convertFromLegacyModeledMethod } from "./shared/modeled-methods-legacy";
 
 export class ModelEditorView extends AbstractWebview<
   ToModelEditorMessage,
@@ -353,6 +350,10 @@ export class ModelEditorView extends AbstractWebview<
     return this.databaseItem.databaseUri.toString();
   }
 
+  public async focusView(): Promise<void> {
+    this.panel?.reveal();
+  }
+
   public async revealMethod(method: Method): Promise<void> {
     this.panel?.reveal();
 
@@ -366,6 +367,9 @@ export class ModelEditorView extends AbstractWebview<
     const showLlmButton =
       this.databaseItem.language === "java" && this.modelConfig.llmGeneration;
 
+    const sourceArchiveAvailable =
+      this.databaseItem.hasSourceArchiveInExplorer();
+
     await this.postMessage({
       t: "setModelEditorViewState",
       viewState: {
@@ -374,6 +378,7 @@ export class ModelEditorView extends AbstractWebview<
         showLlmButton,
         showMultipleModels: this.modelConfig.showMultipleModels,
         mode: this.modelingStore.getMode(this.databaseItem),
+        sourceArchiveAvailable,
       },
     });
   }
@@ -526,6 +531,15 @@ export class ModelEditorView extends AbstractWebview<
         return;
       }
 
+      let existingView = this.viewTracker.getView(
+        addedDatabase.databaseUri.toString(),
+      );
+      if (existingView) {
+        await existingView.focusView();
+
+        return;
+      }
+
       const modelFile = await pickExtensionPack(
         this.cliServer,
         addedDatabase,
@@ -538,6 +552,17 @@ export class ModelEditorView extends AbstractWebview<
         return;
       }
 
+      // Check again just before opening the editor to ensure no model editor has been opened between
+      // our first check and now.
+      existingView = this.viewTracker.getView(
+        addedDatabase.databaseUri.toString(),
+      );
+      if (existingView) {
+        await existingView.focusView();
+
+        return;
+      }
+
       const view = new ModelEditorView(
         this.app,
         this.modelingStore,
@@ -646,7 +671,7 @@ export class ModelEditorView extends AbstractWebview<
         if (event.dbUri === this.databaseItem.databaseUri.toString()) {
           await this.postMessage({
             t: "setModeledMethods",
-            methods: convertToLegacyModeledMethods(event.modeledMethods),
+            methods: event.modeledMethods,
           });
         }
       }),

extensions/ql-vscode/src/model-editor/shared/modeled-methods-legacy.ts

@@ -1,32 +1,5 @@
 import { ModeledMethod } from "../modeled-method";
 
-/**
- * Converts a record of a single ModeledMethod indexed by signature to a record of ModeledMethod[] indexed by signature
- * for legacy usage. This function should always be used instead of the trivial conversion to track usages of this
- * conversion.
- *
- * This method should only be called inside a `postMessage` call. If it's used anywhere else, consider whether the
- * boundary is correct: the boundary should as close as possible to the extension host -> webview boundary.
- *
- * @param modeledMethods The record of a single ModeledMethod indexed by signature
- */
-export function convertToLegacyModeledMethods(
-  modeledMethods: Record<string, ModeledMethod[]>,
-): Record<string, ModeledMethod> {
-  // Always take the first modeled method in the array
-  return Object.fromEntries(
-    Object.entries(modeledMethods)
-      .map(([signature, modeledMethods]) => {
-        const modeledMethod = convertToLegacyModeledMethod(modeledMethods);
-        if (!modeledMethod) {
-          return null;
-        }
-        return [signature, modeledMethod];
-      })
-      .filter((entry): entry is [string, ModeledMethod] => entry !== null),
-  );
-}
-
 /**
  * Converts a single ModeledMethod to a ModeledMethod[] for legacy usage. This function should always be used instead
  * of the trivial conversion to track usages of this conversion.

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

@@ -7,6 +7,7 @@ export interface ModelEditorViewState {
   showLlmButton: boolean;
   showMultipleModels: boolean;
   mode: Mode;
+  sourceArchiveAvailable: boolean;
 }
 
 export interface MethodModelingPanelViewState {