_Correctly_ emulate VS Code's saveBeforeStart

Author: Dave Bartolomeo

extensions/ql-vscode/src/local-queries/local-queries.ts

@@ -358,6 +358,8 @@ export class LocalQueries extends DisposableObject {
     range?: Range,
     templates?: Record<string, string>,
   ): Promise<CoreCompletedQuery> {
+    await saveBeforeStart();
+
     let queryPath: string;
     if (queryUri !== undefined) {
       // The query URI is provided by the command, most likely because the command was run from an
@@ -388,8 +390,6 @@ export class LocalQueries extends DisposableObject {
     const additionalPacks = getOnDiskWorkspaceFolders();
     const extensionPacks = await this.getDefaultExtensionPacks(additionalPacks);
 
-    await saveBeforeStart();
-
     const coreQueryRun = this.queryRunner.createQueryRun(
       databaseItem.databaseUri.fsPath,
       {

extensions/ql-vscode/src/run-queries-shared.ts

@@ -2,14 +2,7 @@ import * as messages from "./pure/messages-shared";
 import * as legacyMessages from "./pure/legacy-messages";
 import { DatabaseInfo, QueryMetadata } from "./common/interface-types";
 import { join, parse, dirname, basename } from "path";
-import {
-  Range,
-  TextDocument,
-  TextEditor,
-  Uri,
-  window,
-  workspace,
-} from "vscode";
+import { Range, TextEditor, Uri, window, workspace } from "vscode";
 import { isCanary, VSCODE_SAVE_BEFORE_START_SETTING } from "./config";
 import {
   pathExists,
@@ -503,61 +496,29 @@ export async function saveBeforeStart(): Promise<void> {
     (VSCODE_SAVE_BEFORE_START_SETTING.getValue<string>() as SaveBeforeStartMode) ??
     "nonUntitledEditorsInActiveGroup";
 
+  // Despite the names of the modes, the VS Code implementation doesn't restrict itself to the
+  // current tab group. It saves all dirty files in all groups. We'll do the same.
   switch (mode) {
     case "nonUntitledEditorsInActiveGroup":
-      await saveAllInGroup(false);
+      await workspace.saveAll(false);
       break;
 
     case "allEditorsInActiveGroup":
-      await saveAllInGroup(true);
+      // The VS Code implementation of this mode only saves an untitled file if it is the document
+      // in the active editor. That's too much work for us, so we'll just live with the inconsistency.
+      await workspace.saveAll(true);
       break;
 
     case "none":
       break;
 
     default:
       // Unexpected value. Fall back to the default behavior.
-      await saveAllInGroup(false);
+      await workspace.saveAll(false);
       break;
   }
 }
 
-// Used in tests
-export async function saveAllInGroup(includeUntitled: boolean): Promise<void> {
-  // There's no good way to get from a `Tab` to a `TextDocument`, so we'll collect all of the dirty
-  // documents indexed by their URI, and then compare those URIs against the URIs of the tabs.
-  const dirtyDocumentUris = new Map<string, TextDocument>();
-  for (const openDocument of workspace.textDocuments) {
-    if (openDocument.isDirty) {
-      console.warn(`${openDocument.uri.toString()} is dirty.`);
-      if (!openDocument.isUntitled || includeUntitled) {
-        dirtyDocumentUris.set(openDocument.uri.toString(), openDocument);
-      }
-    }
-  }
-  if (dirtyDocumentUris.size > 0) {
-    const tabGroup = window.tabGroups.activeTabGroup;
-    for (const tab of tabGroup.tabs) {
-      const input = tab.input;
-      // The `input` property can be of an arbitrary type, depending on the underlying tab type. For
-      // text editors (and potentially others), it's an object with a `uri` property. That's all we
-      // need to know to match it up with a dirty document.
-      if (typeof input === "object") {
-        const uri = (input as any).uri;
-        if (uri instanceof Uri) {
-          const document = dirtyDocumentUris.get(uri.toString());
-          if (document !== undefined) {
-            await document.save();
-            // Remove the URI from the dirty list so we don't wind up saving the same file twice
-            // if it's open in multiple editors.
-            dirtyDocumentUris.delete(uri.toString());
-          }
-        }
-      }
-    }
-  }
-}
-
 /**
  * @param filePath This needs to be equivalent to Java's `Path.toRealPath(NO_FOLLOW_LINKS)`
  */

…ts/cli-integration/data/QuickEvalLib.qll …code/test/data/debugger/QuickEvalLib.qllextensions/ql-vscode/test/vscode-tests/cli-integration/data/QuickEvalLib.qll renamed to extensions/ql-vscode/test/data/debugger/QuickEvalLib.qll extensions/ql-vscode/test/vscode-tests/cli-integration/data/QuickEvalLib.qll renamed to extensions/ql-vscode/test/data/debugger/QuickEvalLib.qll

@@ -0,0 +1,20 @@
+---
+lockVersion: 1.0.0
+dependencies:
+  codeql/javascript-all:
+    version: 0.6.3
+  codeql/javascript-queries:
+    version: 0.6.3
+  codeql/regex:
+    version: 0.0.14
+  codeql/suite-helpers:
+    version: 0.5.3
+  codeql/tutorial:
+    version: 0.0.11
+  codeql/typos:
+    version: 0.0.18
+  codeql/util:
+    version: 0.0.11
+  codeql/yaml:
+    version: 0.0.3
+compiled: false

…s/cli-integration/data/QuickEvalQuery.ql …ode/test/data/debugger/QuickEvalQuery.qlextensions/ql-vscode/test/vscode-tests/cli-integration/data/QuickEvalQuery.ql renamed to extensions/ql-vscode/test/data/debugger/QuickEvalQuery.ql extensions/ql-vscode/test/vscode-tests/cli-integration/data/QuickEvalQuery.ql renamed to extensions/ql-vscode/test/data/debugger/QuickEvalQuery.ql

@@ -0,0 +1,4 @@
+name: integration-test-debugger-javascript
+version: 0.0.0
+dependencies:
+  codeql/javascript-queries: "*"