Move workspace folder functions to separate file

koesie10 · koesie10 · commit 0cfbf0cb2a93 · 2023-06-12T12:02:45.000+02:00
diff --git a/extensions/ql-vscode/src/common/vscode/workspace-folders.ts b/extensions/ql-vscode/src/common/vscode/workspace-folders.ts
@@ -0,0 +1,64 @@
+import { dirname, join } from "path";
+import { workspace, WorkspaceFolder } from "vscode";
+
+/** Returns true if the specified workspace folder is on the file system. */
+export function isWorkspaceFolderOnDisk(
+  workspaceFolder: WorkspaceFolder,
+): boolean {
+  return workspaceFolder.uri.scheme === "file";
+}
+
+/** Gets all active workspace folders that are on the filesystem. */
+export function getOnDiskWorkspaceFoldersObjects() {
+  const workspaceFolders = workspace.workspaceFolders ?? [];
+  return workspaceFolders.filter(isWorkspaceFolderOnDisk);
+}
+
+/** Gets all active workspace folders that are on the filesystem. */
+export function getOnDiskWorkspaceFolders() {
+  return getOnDiskWorkspaceFoldersObjects().map((folder) => folder.uri.fsPath);
+}
+
+/** Check if folder is already present in workspace */
+export function isFolderAlreadyInWorkspace(folderName: string) {
+  const workspaceFolders = workspace.workspaceFolders || [];
+
+  return !!workspaceFolders.find(
+    (workspaceFolder) => workspaceFolder.name === folderName,
+  );
+}
+
+/**
+ * Returns the path of the first folder in the workspace.
+ * This is used to decide where to create skeleton QL packs.
+ *
+ * If the first folder is a QL pack, then the parent folder is returned.
+ * This is because the vscode-codeql-starter repo contains a ql pack in
+ * the first folder.
+ *
+ * This is a temporary workaround until we can retire the
+ * vscode-codeql-starter repo.
+ */
+export function getFirstWorkspaceFolder() {
+  const workspaceFolders = getOnDiskWorkspaceFolders();
+
+  if (!workspaceFolders || workspaceFolders.length === 0) {
+    throw new Error("No workspace folders found");
+  }
+
+  const firstFolderFsPath = workspaceFolders[0];
+
+  // For the vscode-codeql-starter repo, the first folder will be a ql pack
+  // so we need to get the parent folder
+  if (
+    firstFolderFsPath.includes(
+      join("vscode-codeql-starter", "codeql-custom-queries"),
+    )
+  ) {
+    // return the parent folder
+    return dirname(firstFolderFsPath);
+  } else {
+    // if the first folder is not a ql pack, then we are in a normal workspace
+    return firstFolderFsPath;
+  }
+}
diff --git a/extensions/ql-vscode/src/data-extensions-editor/extension-pack-picker.ts b/extensions/ql-vscode/src/data-extensions-editor/extension-pack-picker.ts
@@ -4,11 +4,11 @@ import { dump as dumpYaml, load as loadYaml } from "js-yaml";
 import { minimatch } from "minimatch";
 import { CancellationToken, window } from "vscode";
 import { CodeQLCliServer } from "../codeql-cli/cli";
+import { showAndLogErrorMessage } from "../helpers";
 import {
   getOnDiskWorkspaceFolders,
   getOnDiskWorkspaceFoldersObjects,
-  showAndLogErrorMessage,
-} from "../helpers";
+} from "../common/vscode/workspace-folders";
 import { ProgressCallback } from "../common/vscode/progress";
 import { DatabaseItem } from "../databases/local-databases";
 import { getQlPackPath, QLPACK_FILENAMES } from "../pure/ql";
diff --git a/extensions/ql-vscode/src/data-extensions-editor/external-api-usage-query.ts b/extensions/ql-vscode/src/data-extensions-editor/external-api-usage-query.ts
@@ -2,10 +2,8 @@ import { CoreCompletedQuery, QueryRunner } from "../query-server";
 import { dir } from "tmp-promise";
 import { writeFile } from "fs-extra";
 import { dump as dumpYaml } from "js-yaml";
-import {
-  getOnDiskWorkspaceFolders,
-  showAndLogExceptionWithTelemetry,
-} from "../helpers";
+import { showAndLogExceptionWithTelemetry } from "../helpers";
+import { getOnDiskWorkspaceFolders } from "../common/vscode/workspace-folders";
 import { TeeLogger } from "../common";
 import { isQueryLanguage } from "../common/query-language";
 import { CancellationToken } from "vscode";
diff --git a/extensions/ql-vscode/src/data-extensions-editor/generate-flow-model.ts b/extensions/ql-vscode/src/data-extensions-editor/generate-flow-model.ts
@@ -6,10 +6,8 @@ import { CodeQLCliServer } from "../codeql-cli/cli";
 import { TeeLogger } from "../common";
 import { extensiblePredicateDefinitions } from "./predicates";
 import { ProgressCallback } from "../common/vscode/progress";
-import {
-  getOnDiskWorkspaceFolders,
-  showAndLogExceptionWithTelemetry,
-} from "../helpers";
+import { showAndLogExceptionWithTelemetry } from "../helpers";
+import { getOnDiskWorkspaceFolders } from "../common/vscode/workspace-folders";
 import {
   ModeledMethodType,
   ModeledMethodWithSignature,
diff --git a/extensions/ql-vscode/src/databases/local-databases/database-manager.ts b/extensions/ql-vscode/src/databases/local-databases/database-manager.ts
@@ -14,11 +14,13 @@ import { join } from "path";
 import { FullDatabaseOptions } from "./database-options";
 import { DatabaseItemImpl } from "./database-item-impl";
 import {
-  getFirstWorkspaceFolder,
-  isFolderAlreadyInWorkspace,
   showAndLogExceptionWithTelemetry,
   showNeverAskAgainDialog,
 } from "../../helpers";
+import {
+  getFirstWorkspaceFolder,
+  isFolderAlreadyInWorkspace,
+} from "../../common/vscode/workspace-folders";
 import { isQueryLanguage } from "../../common/query-language";
 import { existsSync } from "fs";
 import { QlPackGenerator } from "../../qlpack-generator";
diff --git a/extensions/ql-vscode/src/databases/qlpack.ts b/extensions/ql-vscode/src/databases/qlpack.ts
@@ -6,7 +6,7 @@ import { readFile } from "fs-extra";
 import { getQlPackPath } from "../pure/ql";
 import { CodeQLCliServer, QlpacksInfo } from "../codeql-cli/cli";
 import { extLogger } from "../common";
-import { getOnDiskWorkspaceFolders } from "../helpers";
+import { getOnDiskWorkspaceFolders } from "../common/vscode/workspace-folders";
 
 export interface QlPacksForLanguage {
   /** The name of the pack containing the dbscheme. */
diff --git a/extensions/ql-vscode/src/debugger/debug-configuration.ts b/extensions/ql-vscode/src/debugger/debug-configuration.ts
@@ -4,7 +4,8 @@ import {
   DebugConfigurationProvider,
   WorkspaceFolder,
 } from "vscode";
-import { getOnDiskWorkspaceFolders, showAndLogErrorMessage } from "../helpers";
+import { showAndLogErrorMessage } from "../helpers";
+import { getOnDiskWorkspaceFolders } from "../common/vscode/workspace-folders";
 import { LocalQueries } from "../local-queries";
 import { getQuickEvalContext, validateQueryPath } from "../run-queries-shared";
 import * as CodeQLProtocol from "./debug-protocol";
diff --git a/extensions/ql-vscode/src/helpers.ts b/extensions/ql-vscode/src/helpers.ts
@@ -1,7 +1,7 @@
 import { ensureDirSync, pathExists, ensureDir, writeFile } from "fs-extra";
-import { join, dirname } from "path";
+import { join } from "path";
 import { dirSync } from "tmp-promise";
-import { Uri, window as Window, workspace, env, WorkspaceFolder } from "vscode";
+import { Uri, window as Window, workspace, env } from "vscode";
 import { CodeQLCliServer } from "./codeql-cli/cli";
 import { UserCancellationException } from "./common/vscode/progress";
 import { extLogger, OutputChannelLogger } from "./common";
@@ -11,6 +11,7 @@ import { RedactableError } from "./pure/errors";
 import { isQueryLanguage, QueryLanguage } from "./common/query-language";
 import { isCodespacesTemplate } from "./config";
 import { AppCommandManager } from "./common/commands";
+import { getOnDiskWorkspaceFolders } from "./common/vscode/workspace-folders";
 
 // Shared temporary folder for the extension.
 export const tmpDir = dirSync({
@@ -232,13 +233,6 @@ export async function showInformationMessageWithAction(
   return chosenItem === actionItem;
 }
 
-/** Returns true if the specified workspace folder is on the file system. */
-export function isWorkspaceFolderOnDisk(
-  workspaceFolder: WorkspaceFolder,
-): boolean {
-  return workspaceFolder.uri.scheme === "file";
-}
-
 /**
  * Opens a modal dialog for the user to make a choice between yes/no/never be asked again.
  *
@@ -279,26 +273,6 @@ export async function showNeverAskAgainDialog(
   return chosenItem?.title;
 }
 
-/** Gets all active workspace folders that are on the filesystem. */
-export function getOnDiskWorkspaceFoldersObjects() {
-  const workspaceFolders = workspace.workspaceFolders ?? [];
-  return workspaceFolders.filter(isWorkspaceFolderOnDisk);
-}
-
-/** Gets all active workspace folders that are on the filesystem. */
-export function getOnDiskWorkspaceFolders() {
-  return getOnDiskWorkspaceFoldersObjects().map((folder) => folder.uri.fsPath);
-}
-
-/** Check if folder is already present in workspace */
-export function isFolderAlreadyInWorkspace(folderName: string) {
-  const workspaceFolders = workspace.workspaceFolders || [];
-
-  return !!workspaceFolders.find(
-    (workspaceFolder) => workspaceFolder.name === folderName,
-  );
-}
-
 /** Check if the current workspace is the CodeTour and open the workspace folder.
  * Without this, we can't run the code tour correctly.
  **/
@@ -448,39 +422,3 @@ export async function createTimestampFile(storagePath: string) {
   await ensureDir(storagePath);
   await writeFile(timestampPath, Date.now().toString(), "utf8");
 }
-
-/**
- * Returns the path of the first folder in the workspace.
- * This is used to decide where to create skeleton QL packs.
- *
- * If the first folder is a QL pack, then the parent folder is returned.
- * This is because the vscode-codeql-starter repo contains a ql pack in
- * the first folder.
- *
- * This is a temporary workaround until we can retire the
- * vscode-codeql-starter repo.
- */
-
-export function getFirstWorkspaceFolder() {
-  const workspaceFolders = getOnDiskWorkspaceFolders();
-
-  if (!workspaceFolders || workspaceFolders.length === 0) {
-    throw new Error("No workspace folders found");
-  }
-
-  const firstFolderFsPath = workspaceFolders[0];
-
-  // For the vscode-codeql-starter repo, the first folder will be a ql pack
-  // so we need to get the parent folder
-  if (
-    firstFolderFsPath.includes(
-      join("vscode-codeql-starter", "codeql-custom-queries"),
-    )
-  ) {
-    // return the parent folder
-    return dirname(firstFolderFsPath);
-  } else {
-    // if the first folder is not a ql pack, then we are in a normal workspace
-    return firstFolderFsPath;
-  }
-}
diff --git a/extensions/ql-vscode/src/language-support/contextual/query-resolver.ts b/extensions/ql-vscode/src/language-support/contextual/query-resolver.ts
@@ -3,10 +3,8 @@ import { dump } from "js-yaml";
 import { file } from "tmp-promise";
 import { basename, dirname, resolve } from "path";
 
-import {
-  getOnDiskWorkspaceFolders,
-  showAndLogExceptionWithTelemetry,
-} from "../../helpers";
+import { showAndLogExceptionWithTelemetry } from "../../helpers";
+import { getOnDiskWorkspaceFolders } from "../../common/vscode/workspace-folders";
 import {
   getPrimaryDbscheme,
   getQlPackForDbscheme,
diff --git a/extensions/ql-vscode/src/local-queries/local-queries.ts b/extensions/ql-vscode/src/local-queries/local-queries.ts
@@ -19,11 +19,11 @@ import { basename } from "path";
 import {
   createTimestampFile,
   findLanguage,
-  getOnDiskWorkspaceFolders,
   showAndLogErrorMessage,
   showAndLogWarningMessage,
   showBinaryChoiceDialog,
 } from "../helpers";
+import { getOnDiskWorkspaceFolders } from "../common/vscode/workspace-folders";
 import { displayQuickQuery } from "./quick-query";
 import { CoreCompletedQuery, QueryRunner } from "../query-server";
 import { QueryHistoryManager } from "../query-history/query-history-manager";
diff --git a/extensions/ql-vscode/src/packaging/packaging.ts b/extensions/ql-vscode/src/packaging/packaging.ts
@@ -1,9 +1,9 @@
 import { CodeQLCliServer } from "../codeql-cli/cli";
 import {
-  getOnDiskWorkspaceFolders,
   showAndLogExceptionWithTelemetry,
   showAndLogInformationMessage,
 } from "../helpers";
+import { getOnDiskWorkspaceFolders } from "../common/vscode/workspace-folders";
 import { QuickPickItem, window } from "vscode";
 import {
   ProgressCallback,
diff --git a/extensions/ql-vscode/src/queries-panel/query-discovery.ts b/extensions/ql-vscode/src/queries-panel/query-discovery.ts
@@ -5,7 +5,7 @@ import { Event, RelativePattern, Uri, WorkspaceFolder } from "vscode";
 import { MultiFileSystemWatcher } from "../common/vscode/multi-file-system-watcher";
 import { App } from "../common/app";
 import { FileTreeDirectory, FileTreeLeaf } from "../common/file-tree-nodes";
-import { getOnDiskWorkspaceFoldersObjects } from "../helpers";
+import { getOnDiskWorkspaceFoldersObjects } from "../common/vscode/workspace-folders";
 import { AppEventEmitter } from "../common/events";
 import { QueryDiscoverer } from "./query-tree-data-provider";
 import { extLogger } from "../common";
diff --git a/extensions/ql-vscode/src/query-server/legacy/upgrades.ts b/extensions/ql-vscode/src/query-server/legacy/upgrades.ts
@@ -1,9 +1,6 @@
 import * as vscode from "vscode";
-import {
-  getOnDiskWorkspaceFolders,
-  showAndLogExceptionWithTelemetry,
-  tmpDir,
-} from "../../helpers";
+import { showAndLogExceptionWithTelemetry, tmpDir } from "../../helpers";
+import { getOnDiskWorkspaceFolders } from "../../common/vscode/workspace-folders";
 import {
   ProgressCallback,
   UserCancellationException,
diff --git a/extensions/ql-vscode/src/query-server/new-query-runner.ts b/extensions/ql-vscode/src/query-server/new-query-runner.ts
@@ -16,7 +16,7 @@ import { CoreQueryResults, CoreQueryTarget, QueryRunner } from "./query-runner";
 import { QueryServerClient } from "./query-server-client";
 import { compileAndRunQueryAgainstDatabaseCore } from "./run-queries";
 import * as vscode from "vscode";
-import { getOnDiskWorkspaceFolders } from "../helpers";
+import { getOnDiskWorkspaceFolders } from "../common/vscode/workspace-folders";
 import { CodeQLCliServer } from "../codeql-cli/cli";
 import { Logger } from "../common";
 import { QueryOutputDir } from "../run-queries-shared";
diff --git a/extensions/ql-vscode/src/query-testing/test-manager.ts b/extensions/ql-vscode/src/query-testing/test-manager.ts
@@ -23,7 +23,7 @@ import { BaseLogger, LogOptions } from "../common";
 import { TestRunner } from "./test-runner";
 import { TestManagerBase } from "./test-manager-base";
 import { App } from "../common/app";
-import { isWorkspaceFolderOnDisk } from "../helpers";
+import { isWorkspaceFolderOnDisk } from "../common/vscode/workspace-folders";
 import {
   FileTreeDirectory,
   FileTreeLeaf,
diff --git a/extensions/ql-vscode/src/query-testing/test-runner.ts b/extensions/ql-vscode/src/query-testing/test-runner.ts
@@ -2,10 +2,10 @@ import { CancellationToken, Uri } from "vscode";
 import { CodeQLCliServer, TestCompleted } from "../codeql-cli/cli";
 import { DatabaseItem, DatabaseManager } from "../databases/local-databases";
 import {
-  getOnDiskWorkspaceFolders,
   showAndLogExceptionWithTelemetry,
   showAndLogWarningMessage,
 } from "../helpers";
+import { getOnDiskWorkspaceFolders } from "../common/vscode/workspace-folders";
 import { asError, getErrorMessage } from "../pure/helpers-pure";
 import { redactableError } from "../pure/errors";
 import { access } from "fs-extra";
diff --git a/extensions/ql-vscode/src/skeleton-query-wizard.ts b/extensions/ql-vscode/src/skeleton-query-wizard.ts
@@ -4,11 +4,11 @@ import { CodeQLCliServer } from "./codeql-cli/cli";
 import { OutputChannelLogger } from "./common";
 import { Credentials } from "./common/authentication";
 import { QueryLanguage } from "./common/query-language";
+import { askForLanguage } from "./helpers";
 import {
-  askForLanguage,
   getFirstWorkspaceFolder,
   isFolderAlreadyInWorkspace,
-} from "./helpers";
+} from "./common/vscode/workspace-folders";
 import { getErrorMessage } from "./pure/helpers-pure";
 import { QlPackGenerator } from "./qlpack-generator";
 import { DatabaseItem, DatabaseManager } from "./databases/local-databases";
diff --git a/extensions/ql-vscode/src/variant-analysis/run-remote-query.ts b/extensions/ql-vscode/src/variant-analysis/run-remote-query.ts
@@ -6,10 +6,10 @@ import { dir, tmpName } from "tmp-promise";
 import {
   askForLanguage,
   findLanguage,
-  getOnDiskWorkspaceFolders,
   tryGetQueryMetadata,
   tmpDir,
 } from "../helpers";
+import { getOnDiskWorkspaceFolders } from "../common/vscode/workspace-folders";
 import { Credentials } from "../common/authentication";
 import * as cli from "../codeql-cli/cli";
 import { extLogger } from "../common";
diff --git a/extensions/ql-vscode/test/vscode-tests/cli-integration/debugger/debug-controller.ts b/extensions/ql-vscode/test/vscode-tests/cli-integration/debugger/debug-controller.ts
@@ -20,7 +20,7 @@ import { join } from "path";
 import { writeFile } from "fs-extra";
 import { expect } from "@jest/globals";
 import { AppCommandManager } from "../../../../src/common/commands";
-import { getOnDiskWorkspaceFolders } from "../../../../src/helpers";
+import { getOnDiskWorkspaceFolders } from "../../../../src/common/vscode/workspace-folders";
 
 type Resolver<T> = (value: T) => void;
 
diff --git a/extensions/ql-vscode/test/vscode-tests/cli-integration/run-cli.test.ts b/extensions/ql-vscode/test/vscode-tests/cli-integration/run-cli.test.ts
@@ -7,7 +7,7 @@ import {
   QueryInfoByLanguage,
 } from "../../../src/codeql-cli/cli";
 import { itWithCodeQL } from "../cli";
-import { getOnDiskWorkspaceFolders } from "../../../src/helpers";
+import { getOnDiskWorkspaceFolders } from "../../../src/common/vscode/workspace-folders";
 import { KeyType, resolveQueries } from "../../../src/language-support";
 import { faker } from "@faker-js/faker";
 import { getActivatedExtension } from "../global.helper";
diff --git a/extensions/ql-vscode/test/vscode-tests/cli-integration/skeleton-query-wizard.test.ts b/extensions/ql-vscode/test/vscode-tests/cli-integration/skeleton-query-wizard.test.ts
diff --git a/extensions/ql-vscode/test/vscode-tests/no-workspace/common/vscode/workspace-folders.test.ts b/extensions/ql-vscode/test/vscode-tests/no-workspace/common/vscode/workspace-folders.test.ts
diff --git a/extensions/ql-vscode/test/vscode-tests/no-workspace/helpers.test.ts b/extensions/ql-vscode/test/vscode-tests/no-workspace/helpers.test.ts
diff --git a/extensions/ql-vscode/test/vscode-tests/no-workspace/language-support/contextual/query-resolver.test.ts b/extensions/ql-vscode/test/vscode-tests/no-workspace/language-support/contextual/query-resolver.test.ts
