pull out server path detection into util, use in both deploy code paths

Signed-off-by: CBforZ <chris.boehm@broadcom.com>

Author: CBforZ

packages/zowe-explorer/__tests__/__e2e__/step_definitions/jobs/JobFavorites.steps.ts

@@ -243,9 +243,7 @@ Given("a sleep job has been submitted for polling", async function () {
 
         await browser.waitUntil((): Promise<boolean> => quickPick.isClickable());
         if (await quickPick.hasOptions()) {
-            const createFilter = await quickPick.findItem(
-                "$(plus) Create a new filter. For example: HLQ.*, HLQ.aaa.bbb, HLQ.ccc.ddd(member)"
-            );
+            const createFilter = await quickPick.findItem("$(plus) Create a new filter. For example: HLQ.*, HLQ.aaa.bbb, HLQ.ccc.ddd(member)");
             await expect(createFilter).toBeClickable();
             await createFilter.click();
         }
@@ -360,9 +358,7 @@ Given("the Jobs tree has a favorited job search filter for the active job", asyn
 
     // The newly added filter is the last child under the favorited profile
     const favProfileChildren = await (await this.favProfileNode.find()).getChildren();
-    const activeFilterNode = favProfileChildren.length > 0
-        ? (favProfileChildren[favProfileChildren.length - 1] as TreeItem)
-        : undefined;
+    const activeFilterNode = favProfileChildren.length > 0 ? (favProfileChildren[favProfileChildren.length - 1] as TreeItem) : undefined;
     await expect(activeFilterNode).toBeDefined();
 
     // Click once to initialize collapsible state, then expand

packages/zowex-for-zowe-explorer/src/ServerDeployment.ts

@@ -1,8 +1,34 @@
 import type { SshSession } from "@zowe/zos-uss-for-zowe-sdk";
-import { Gui, ZoweExplorerApiType } from "@zowe/zowe-explorer-api";
+import { Gui, imperative, ZoweExplorerApiType } from "@zowe/zowe-explorer-api";
 import * as vscode from "vscode";
 import { SshErrorHandler } from "./SshErrorHandler";
 import { ZSshUtils } from "@zowe/zowex-for-zowe-sdk";
+import path from "path/posix";
+import { SshClientCache } from "./SshClientCache";
+
+/**
+ * Detect if a usable instance of our server binary exists on the user's USS environment.
+ * @param session - established SSH session used to detect the server
+ * @param profile - the SSH profile used to connect
+ * @returns true if a usable version of the SSH backend server is detected on the user's path
+ */
+export async function isServerDetectedOnPath(session: SshSession, profile: imperative.IProfileLoaded): Promise<boolean> {
+    try {
+        const pathServer = await ZSshUtils.detectServerOnPath(session);
+        imperative.Logger.getAppLogger().trace("detectServerOnPath return value: %s", JSON.stringify(pathServer));
+        if (pathServer.serverPath && pathServer.hasExecutePermission && pathServer.writeAccessToParent) {
+            imperative.Logger.getAppLogger().debug("Skipping deploy, since a usable instance of the server exists on the user's PATH");
+            // remove binary from the full path to set serverPath to the parent directory,
+            // the same as a user would configure the path manually
+            SshClientCache.inst.setOnPathServer(profile, path.resolve(pathServer.serverPath, ".."));
+            return true;
+        }
+    } catch (e) {
+        imperative.Logger.getAppLogger().error("Error detecting server on user's $PATH: %s", e);
+        await SshErrorHandler.getInstance().handleError(e as Error, ZoweExplorerApiType.All, "Detecting server on $PATH");
+    }
+    return false;
+}
 
 export function deployWithProgress(session: SshSession, serverPath: string): Thenable<boolean> {
     return Gui.withProgress(

packages/zowex-for-zowe-explorer/src/SshClientCache.ts

@@ -14,7 +14,7 @@ import { imperative, ProfilesCache } from "@zowe/zowe-explorer-api";
 import * as vscode from "vscode";
 import { type ClientOptions, type ExistingClientRequest, ZSshClient, ZSshUtils } from "@zowe/zowex-for-zowe-sdk";
 import { ConfigUtils } from "./ConfigUtils";
-import { deployWithProgress } from "./ServerDeployment";
+import { deployWithProgress, isServerDetectedOnPath } from "./ServerDeployment";
 
 class AsyncMutex extends imperative.DeferredPromise<void> implements Disposable {
     public constructor(private onDispose?: () => void) {
@@ -109,8 +109,8 @@ export class SshClientCache extends vscode.Disposable {
         if (!this.mClientSessionMap.has(clientId)) {
             using _lock = this.acquireProfileLock(clientId);
             const session = ZSshUtils.buildSession(profile.profile!);
-            const serverPath = this.mClientOnPathServerMap.get(clientId) ??
-                ConfigUtils.getServerPath(profile.profile);
+            await isServerDetectedOnPath(session, profile);
+            const serverPath = this.mClientOnPathServerMap.get(clientId) ?? ConfigUtils.getServerPath(profile.profile);
             const vsceConfig = vscode.workspace.getConfiguration("zowe");
             const keepAliveInterval = vsceConfig.get<number>("zowex.keepAliveInterval");
             const numWorkers = vsceConfig.get<number>("zowex.workerCount");

packages/zowex-for-zowe-explorer/src/Utilities.ts

@@ -16,8 +16,7 @@ import { ConfigUtils } from "./ConfigUtils";
 import { VscePromptApi } from "./VscePromptApi";
 import { SshClientCache } from "./SshClientCache";
 import { SshErrorHandler } from "./SshErrorHandler";
-import { deployWithProgress } from "./ServerDeployment";
-import path from "path/posix";
+import { deployWithProgress, isServerDetectedOnPath } from "./ServerDeployment";
 
 export function registerCommands(context: vscode.ExtensionContext, zoweExplorerApi: IApiExplorerExtender): vscode.Disposable[] {
     const profCache = zoweExplorerApi.getProfilesCache();
@@ -31,14 +30,7 @@ export function registerCommands(context: vscode.ExtensionContext, zoweExplorerA
             }
 
             const sshSession = ZSshUtils.buildSession(profile.profile);
-            const pathServer = await ZSshUtils.detectServerOnPath(sshSession);
-            imperative.Logger.getAppLogger().trace("detectServerOnPath return value: %s", JSON.stringify(pathServer));
-            if (pathServer.serverPath
-                && pathServer.hasExecutePermission
-                && pathServer.writeAccessToParent) {
-                imperative.Logger.getAppLogger().debug("Skipping deploy as an instance of the server exists on the user's PATH");
-                SshClientCache.inst.setOnPathServer(profile, path.resolve(pathServer.serverPath, '..'));
-            } else {
+            if (!(await isServerDetectedOnPath(sshSession, profile))) {
                 const defaultServerPath = ConfigUtils.getServerPath(profile.profile);
                 const deployDirectory = await vscePromptApi.promptForDeployDirectory(profile.profile.host, defaultServerPath);
                 if (!deployDirectory) {
@@ -55,7 +47,6 @@ export function registerCommands(context: vscode.ExtensionContext, zoweExplorerA
             }
 
             await ConfigUtils.showSessionInTree(profile.name!, true, zoweExplorerApi);
-
         }),
         vscode.commands.registerCommand(`zowe.zowex.restart`, async (profName?: string) => {
             imperative.Logger.getAppLogger().trace("Running restart command for profile %s", profName);