Reorganize utilities and add tests (#1003)

plemarquand · web-flow · commit 689bdead11e5 · 2024-08-09T10:37:18.000-04:00
Reorganize utilities into filesystem utilities and general utilities.
Add more tests.
diff --git a/src/BackgroundCompilation.ts b/src/BackgroundCompilation.ts
@@ -14,7 +14,7 @@
 
 import * as vscode from "vscode";
 import * as path from "path";
-import { isPathInsidePath } from "./utilities/utilities";
+import { isPathInsidePath } from "./utilities/filesystem";
 import { getBuildAllTask } from "./tasks/SwiftTaskProvider";
 import configuration from "./configuration";
 import { FolderContext } from "./FolderContext";
diff --git a/src/FolderContext.ts b/src/FolderContext.ts
@@ -21,7 +21,7 @@ import { TestExplorer } from "./TestExplorer/TestExplorer";
 import { WorkspaceContext, FolderEvent } from "./WorkspaceContext";
 import { BackgroundCompilation } from "./BackgroundCompilation";
 import { TaskQueue } from "./tasks/TaskQueue";
-import { isPathInsidePath } from "./utilities/utilities";
+import { isPathInsidePath } from "./utilities/filesystem";
 
 export class FolderContext implements vscode.Disposable {
     private packageWatcher: PackageWatcher;
diff --git a/src/LinuxMain.ts b/src/LinuxMain.ts
@@ -13,7 +13,7 @@
 //===----------------------------------------------------------------------===//
 
 import * as vscode from "vscode";
-import { pathExists } from "./utilities/utilities";
+import { pathExists } from "./utilities/filesystem";
 
 /**
  * Cache the existence of `Tests/LinuxMain.swift`.
diff --git a/src/SwiftPackage.ts b/src/SwiftPackage.ts
@@ -15,12 +15,8 @@
 import * as vscode from "vscode";
 import * as fs from "fs/promises";
 import * as path from "path";
-import {
-    execSwift,
-    getErrorDescription,
-    hashString,
-    isPathInsidePath,
-} from "./utilities/utilities";
+import { execSwift, getErrorDescription, hashString } from "./utilities/utilities";
+import { isPathInsidePath } from "./utilities/filesystem";
 import { SwiftToolchain } from "./toolchain/toolchain";
 import { BuildFlags } from "./toolchain/BuildFlags";
 
diff --git a/src/TestExplorer/TestExplorer.ts b/src/TestExplorer/TestExplorer.ts
@@ -14,7 +14,8 @@
 
 import * as vscode from "vscode";
 import { FolderContext } from "../FolderContext";
-import { getErrorDescription, isPathInsidePath } from "../utilities/utilities";
+import { getErrorDescription } from "../utilities/utilities";
+import { isPathInsidePath } from "../utilities/filesystem";
 import { FolderEvent, WorkspaceContext } from "../WorkspaceContext";
 import { TestRunProxy, TestRunner } from "./TestRunner";
 import { LSPTestDiscovery } from "./LSPTestDiscovery";
diff --git a/src/WorkspaceContext.ts b/src/WorkspaceContext.ts
@@ -17,12 +17,8 @@ import * as path from "path";
 import { FolderContext } from "./FolderContext";
 import { StatusItem } from "./ui/StatusItem";
 import { SwiftOutputChannel } from "./ui/SwiftOutputChannel";
-import {
-    pathExists,
-    isPathInsidePath,
-    swiftLibraryPathKey,
-    getErrorDescription,
-} from "./utilities/utilities";
+import { swiftLibraryPathKey, getErrorDescription } from "./utilities/utilities";
+import { pathExists, isPathInsidePath } from "./utilities/filesystem";
 import { getLLDBLibPath } from "./debugger/lldb";
 import { LanguageClientManager } from "./sourcekit-lsp/LanguageClientManager";
 import { TemporaryFolder } from "./utilities/tempFolder";
diff --git a/src/debugger/debugAdapter.ts b/src/debugger/debugAdapter.ts
@@ -13,12 +13,11 @@
 //===----------------------------------------------------------------------===//
 
 import * as vscode from "vscode";
-import * as fs from "fs";
-import { WorkspaceContext } from "../WorkspaceContext";
 import configuration from "../configuration";
 import contextKeys from "../contextKeys";
-import { SwiftToolchain } from "../toolchain/toolchain";
+import { fileExists } from "../utilities/filesystem";
 import { Version } from "../utilities/version";
+import { WorkspaceContext } from "../WorkspaceContext";
 
 /**
  * Class managing which debug adapter we are using. Will only setup lldb-vscode/lldb-dap if it is available.
@@ -27,36 +26,34 @@ export class DebugAdapter {
     private static debugAdapaterExists = false;
 
     /** Debug adapter name */
-    static get adapterName(): string {
+    public static get adapterName(): string {
         return configuration.debugger.useDebugAdapterFromToolchain && this.debugAdapaterExists
             ? "swift-lldb"
             : "lldb";
     }
 
     /** Return debug adapter for toolchain */
-    static getDebugAdapter(toolchain: SwiftToolchain): string {
-        if (toolchain.swiftVersion.isLessThan(new Version(6, 0, 0))) {
-            return "lldb-vscode";
-        } else {
-            return "lldb-dap";
-        }
+    public static getDebugAdapter(swiftVersion: Version): string {
+        return swiftVersion.isLessThan(new Version(6, 0, 0)) ? "lldb-vscode" : "lldb-dap";
     }
+
     /**
      * Verify that the toolchain debug adapter exists
      * @param workspace WorkspaceContext
      * @param quiet Should dialog be displayed
      * @returns Is debugger available
      */
-    static async verifyDebugAdapterExists(
+    public static async verifyDebugAdapterExists(
         workspace: WorkspaceContext,
         quiet = false
     ): Promise<boolean> {
         const useCustom = configuration.debugger.debugAdapterPath.length > 0;
-        const debugAdapter = DebugAdapter.getDebugAdapter(workspace.toolchain);
+        const debugAdapter = DebugAdapter.getDebugAdapter(workspace.toolchain.swiftVersion);
         const lldbDebugAdapterPath = useCustom
             ? configuration.debugger.debugAdapterPath
             : workspace.toolchain.getToolchainExecutable(debugAdapter);
-        if (!(await this.doesFileExist(lldbDebugAdapterPath))) {
+
+        if (!(await fileExists(lldbDebugAdapterPath))) {
             if (!quiet) {
                 vscode.window.showErrorMessage(
                     useCustom
@@ -69,16 +66,9 @@ export class DebugAdapter {
             contextKeys.lldbVSCodeAvailable = false;
             return false;
         }
+
         this.debugAdapaterExists = true;
         contextKeys.lldbVSCodeAvailable = true;
         return true;
     }
-
-    private static async doesFileExist(path: string): Promise<boolean> {
-        try {
-            return (await fs.promises.stat(path)).isFile();
-        } catch (e) {
-            return false;
-        }
-    }
 }
diff --git a/src/debugger/debugAdapterFactory.ts b/src/debugger/debugAdapterFactory.ts
@@ -24,7 +24,9 @@ export function registerLLDBDebugAdapter(workspaceContext: WorkspaceContext): vs
             executable: vscode.DebugAdapterExecutable | undefined
         ): vscode.ProviderResult<vscode.DebugAdapterDescriptor> {
             // use the executable specified in the settings or use version in toolchain
-            const debugAdapter = DebugAdapter.getDebugAdapter(workspaceContext.toolchain);
+            const debugAdapter = DebugAdapter.getDebugAdapter(
+                workspaceContext.toolchain.swiftVersion
+            );
             if (!executable) {
                 const lldbDebugAdapterPath =
                     configuration.debugger.debugAdapterPath.length > 0
diff --git a/src/sourcekit-lsp/LanguageClientManager.ts b/src/sourcekit-lsp/LanguageClientManager.ts
@@ -16,7 +16,8 @@ import * as vscode from "vscode";
 import * as path from "path";
 import * as langclient from "vscode-languageclient/node";
 import configuration from "../configuration";
-import { isPathInsidePath, swiftRuntimeEnv } from "../utilities/utilities";
+import { swiftRuntimeEnv } from "../utilities/utilities";
+import { isPathInsidePath } from "../utilities/filesystem";
 import { Version } from "../utilities/version";
 import { FolderEvent, WorkspaceContext } from "../WorkspaceContext";
 import { activateLegacyInlayHints } from "./inlayHints";
diff --git a/src/toolchain/toolchain.ts b/src/toolchain/toolchain.ts
@@ -19,7 +19,8 @@ import * as plist from "plist";
 import * as vscode from "vscode";
 import configuration from "../configuration";
 import { SwiftOutputChannel } from "../ui/SwiftOutputChannel";
-import { execFile, execSwift, expandFilePathTilda, pathExists } from "../utilities/utilities";
+import { execFile, execSwift } from "../utilities/utilities";
+import { expandFilePathTilda, pathExists } from "../utilities/filesystem";
 import { Version } from "../utilities/version";
 import { BuildFlags } from "./BuildFlags";
 import { Sanitizer } from "./Sanitizer";
diff --git a/src/utilities/filesystem.ts b/src/utilities/filesystem.ts
@@ -0,0 +1,66 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the VS Code Swift open source project
+//
+// Copyright (c) 2024 the VS Code Swift project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of VS Code Swift project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import * as fs from "fs/promises";
+import * as path from "path";
+
+/**
+ * Checks if a file, directory or symlink exists at the supplied path.
+ * @param pathComponents The path to check for existence
+ * @returns Whether or not an entity exists at the path
+ */
+export async function pathExists(...pathComponents: string[]): Promise<boolean> {
+    try {
+        await fs.access(path.join(...pathComponents));
+        return true;
+    } catch {
+        return false;
+    }
+}
+
+/**
+ * Checks if a file exists at the supplied path.
+ * @param pathComponents The file path to check for existence
+ * @returns Whether or not the file exists at the path
+ */
+export async function fileExists(...pathComponents: string[]): Promise<boolean> {
+    try {
+        return (await fs.stat(path.join(...pathComponents))).isFile();
+    } catch (e) {
+        return false;
+    }
+}
+
+/**
+ * Return whether a file/folder is inside a folder.
+ * @param subpath child file/folder
+ * @param parent parent folder
+ * @returns if child file/folder is inside the parent folder
+ */
+export function isPathInsidePath(subpath: string, parent: string): boolean {
+    // return true if path doesn't start with '..'
+    return !path.relative(parent, subpath).startsWith("..");
+}
+
+/**
+ * Expand ~ in file path to full $HOME folder
+ * @param filepath File path
+ * @returns full path
+ */
+export function expandFilePathTilda(filepath: string): string {
+    if (process.platform !== "win32" && filepath[0] === "~" && process.env.HOME) {
+        return path.join(process.env.HOME, filepath.slice(1));
+    }
+    return filepath;
+}
diff --git a/src/utilities/utilities.ts b/src/utilities/utilities.ts
@@ -14,7 +14,6 @@
 
 import * as vscode from "vscode";
 import * as cp from "child_process";
-import * as fs from "fs/promises";
 import * as path from "path";
 import * as Stream from "stream";
 import configuration from "../configuration";
@@ -228,32 +227,6 @@ export function getRepositoryName(url: string): string {
     return lastPathComponent;
 }
 
-/**
- * Whether the given path exists.
- *
- * Does not check whether the user has permission to read the path.
- */
-export async function pathExists(...pathComponents: string[]): Promise<boolean> {
-    try {
-        await fs.access(path.join(...pathComponents));
-        return true;
-    } catch {
-        return false;
-    }
-}
-
-/**
- * Return whether a file is inside a folder
- * @param subfolder child file/folder
- * @param folder parent folder
- * @returns if child file is inside parent folder
- */
-export function isPathInsidePath(subfolder: string, folder: string): boolean {
-    const relativePath = path.relative(folder, subfolder);
-    // return true if path doesnt start with '..'
-    return relativePath[0] !== "." || relativePath[1] !== ".";
-}
-
 /**
  * Return random string
  * @param length Length of string to return (max 16)
@@ -312,18 +285,6 @@ export function hashString(str: string, seed = 0) {
     return 4294967296 * (2097151 & h2) + (h1 >>> 0);
 }
 
-/**
- * Expand ~ in file path to full $HOME folder
- * @param filepath File path
- * @returns full path
- */
-export function expandFilePathTilda(filepath: string): string {
-    if (process.platform !== "win32" && filepath[0] === "~" && process.env.HOME) {
-        return path.join(process.env.HOME, filepath.slice(1));
-    }
-    return filepath;
-}
-
 /**
  * Transforms a file, line and optional column in to a vscode.Location.
  * The line numbers are expected to start at 1, not 0.
diff --git a/test/suite/utilities.test.ts b/test/suite/utilities.test.ts
diff --git a/test/suite/utilities/filesystem.test.ts b/test/suite/utilities/filesystem.test.ts
diff --git a/test/suite/utilities/utilities.test.ts b/test/suite/utilities/utilities.test.ts
