Show server name in Status Bar (#1017)

Author: isc-bsaviano

docs/Configuration.md

@@ -150,7 +150,7 @@ If you want to store a password for this server definition, select **Store Passw
 
 You can create a configuration for a server that is not currently running.
 
-If you are connecting via a standalone web server which bublishes services for more than one InterSystems server you will need to edit the server configuration in your `settings.json` file to add a `pathPrefix` property. See the next section.
+If you are connecting via a standalone web server which publishes services for more than one InterSystems server you will need to edit the server configuration in your `settings.json` file to add a `pathPrefix` property. See the next section.
 
 ## Editing a Server Configuration
 

docs/ExtensionUI.md

@@ -133,3 +133,21 @@ Technically the **InterSystems Tools** and **ObjectScript** entities described a
 When a VS Code container has only a single view in it the view header merges with the container header, with the two names separated by a colon.
 
 Views can be dragged between containers, so for example you could move Explorer off its ObjectScript container and onto the InterSystems Tools container. Or move Servers onto the ObjectScript container. Or move either of them onto VS Code's main Explorer container.
+
+## Server Connection Status Bar Item
+
+The connection status of the current server can be seen in the [VS Code status bar](https://code.visualstudio.com/api/ux-guidelines/status-bar). If the server connection is active, the connected server and namespace will be shown in the status bar. If the server connection info is defined in the [`intersystems.servers` setting object](../settings/#intersystems-servermanager), the name of the server and namepsace will be shown:
+
+![Status bar name](../assets/images/server-status-bar.png "status bar name")
+
+Otherwise, the host, port and namespace will be shown:
+
+![Status bar host port](../assets/images/action-for-server-start.png "status bar host port")
+
+Hover over the status bar item to see more detailed connection information, like a full connection URL and the username of the connection. Click on the status bar item to open the Server Actions menu. Custom entries [can be added](../configuration/#server-actions-menu) to this menu.
+
+If the server connection is inactive, the connection info or the word `ObjectScript` will be shown, accompanied by an error or warning icon:
+
+![Status bar error](../assets/images/server-status-bar-error.png "status bar error")
+
+Hover over the status bar item to see more detailed error information. Click on the status bar item to open a menu that will help you activate your connection.

docs/assets/images/server-status-bar-error.png

@@ -228,9 +228,15 @@ export class AtelierAPI {
   }
 
   public get connInfo(): string {
-    const { host, port, docker, dockerService } = this.config;
+    const { serverName, host, port, docker, dockerService } = this.config;
     const ns = this.ns.toUpperCase();
-    return (docker ? "docker" + (dockerService ? `:${dockerService}:${port}` : "") : `${host}:${port}`) + `[${ns}]`;
+    return (
+      (docker
+        ? "docker" + (dockerService ? `:${dockerService}:${port}` : "")
+        : serverName
+        ? serverName
+        : `${host}:${port}`) + `[${ns}]`
+    );
   }
 
   public async request(

docs/assets/images/server-status-bar.png

@@ -3,7 +3,7 @@ export const extensionId = "intersystems-community.vscode-objectscript";
 import vscode = require("vscode");
 import * as semver from "semver";
 
-import { AtelierJob } from "./api/atelier";
+import { AtelierJob, Content, Response, ServerInfo } from "./api/atelier";
 export const OBJECTSCRIPT_FILE_SCHEMA = "objectscript";
 export const OBJECTSCRIPTXML_FILE_SCHEMA = "objectscriptxml";
 export const FILESYSTEM_SCHEMA = "isfs";
@@ -253,7 +253,7 @@ export async function checkConnection(
     _onDidChangeConnection.fire();
   }
   let api = new AtelierAPI(apiTarget, false);
-  const { active, host = "", port = 0, pathPrefix, username, ns = "" } = api.config;
+  const { active, host = "", port = 0, username, ns = "" } = api.config;
   vscode.commands.executeCommand("setContext", "vscode-objectscript.connectActive", active);
   if (!panel.text) {
     panel.text = `${PANEL_LABEL}`;
@@ -265,11 +265,12 @@ export async function checkConnection(
   }
   let connInfo = api.connInfo;
   if (!active) {
-    if (!host.length || !port || !ns.length) {
-      connInfo = `incompletely specified server ${connInfo}`;
-    }
     panel.text = `${PANEL_LABEL} $(warning)`;
-    panel.tooltip = `Connection to ${connInfo} is disabled`;
+    panel.tooltip = new vscode.MarkdownString(
+      `Connection to${
+        !host.length || !port || !ns.length ? " incompletely specified server" : ""
+      } \`${connInfo}\` is disabled`
+    );
     return;
   }
 
@@ -324,9 +325,17 @@ export async function checkConnection(
   checkingConnection = true;
 
   // What we do when api.serverInfo call succeeds
-  const gotServerInfo = async (info) => {
+  const gotServerInfo = async (info: Response<Content<ServerInfo>>) => {
     panel.text = api.connInfo;
-    panel.tooltip = `Connected${pathPrefix ? " to " + pathPrefix : ""} as ${username}`;
+    if (api.config.serverName) {
+      panel.tooltip = new vscode.MarkdownString(
+        `Connected to \`${api.config.host}:${api.config.port}${api.config.pathPrefix}\` as \`${username}\``
+      );
+    } else {
+      panel.tooltip = new vscode.MarkdownString(
+        `Connected${api.config.pathPrefix ? ` to \`${api.config.pathPrefix}\`` : ""} as \`${username}\``
+      );
+    }
     const hasHS = info.result.content.features.find((el) => el.name === "HEALTHSHARE" && el.enabled) !== undefined;
     reporter &&
       reporter.sendTelemetryEvent("connected", {