Merge remote-tracking branch 'upstream/master' into fix-194

Author: gjsjohnmurray

README.md

@@ -1,6 +1,6 @@
 # InterSystems Server Manager
 
-> **Note:** The best way to install and use this extension is by installing the [InterSystems ObjectScript Extension Pack](https://marketplace.visualstudio.com/items?itemName=intersystems-community.objectscript-pack) and following the [documentation here](https://intersystems-community.github.io/vscode-objectscript/).
+> **Note:** The best way to install and use this extension is by installing the [InterSystems ObjectScript Extension Pack](https://marketplace.visualstudio.com/items?itemName=intersystems-community.objectscript-pack) and following the [documentation here](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO).
 
 InterSystems Server Manager is a Visual Studio Code extension for defining connections to [InterSystems](https://www.intersystems.com/) servers. These definitions can used by other VS Code extensions when they make connections. One example is the [ObjectScript extension](https://github.com/intersystems-community/vscode-objectscript) for code editing. The [Launch WebTerminals](https://marketplace.visualstudio.com/items?itemName=georgejames.webterminal-vscode) extension is another.
 

package-lock.json

@@ -50,7 +50,7 @@
     "tough-cookie": "^4.1.3"
   },
   "devDependencies": {
-    "@intersystems-community/intersystems-servermanager": "latest",
+    "@intersystems-community/intersystems-servermanager": "^3.4.1",
     "@types/vscode": "^1.75.0",
     "@types/glob": "^7.1.1",
     "@types/mocha": "^9.0.0",
@@ -181,6 +181,38 @@
                     ],
                     "additionalProperties": false
                   },
+                  "superServer": {
+                    "type": "object",
+                    "description": "InterSystems server's superserver.",
+                    "properties": {
+                      "host": {
+                        "type": "string",
+                        "description": "Hostname or IP address of the InterSystems server. If omitted, uses the value of 'webServer.host'.",
+                        "anyOf": [
+                          {
+                            "format": "hostname"
+                          },
+                          {
+                            "format": "ipv4"
+                          },
+                          {
+                            "format": "ipv6"
+                          }
+                        ]
+                      },
+                      "port": {
+                        "type": "integer",
+                        "description": "TCP port number the superserver listens on.",
+                        "minimum": 1,
+                        "maximum": 65535,
+                        "default": 1972
+                      }
+                    },
+                    "required": [
+                      "port"
+                    ],
+                    "additionalProperties": false
+                  },
                   "username": {
                     "type": "string",
                     "description": "Username to connect as. If not set here it must be provided when connecting."

package.json

@@ -110,7 +110,7 @@ export async function addServer(
 											return name;
 										} catch (error) {
 											vscode.window.showErrorMessage(
-												"Failed to store server '${name}' definition.",
+												`Failed to store server '${name}' definition. Does your settings.json file contain a JSON syntax error?`,
 											);
 											return undefined;
 										}

src/api/addServer.ts

@@ -38,6 +38,10 @@ export async function getServerSpec(
 	server.webServer.scheme = server.webServer.scheme || "http";
 	server.webServer.port = server.webServer.port || (server.webServer.scheme === "https" ? 443 : 80);
 	server.webServer.pathPrefix = server.webServer.pathPrefix || "";
+	if (server.superServer) {
+		// Fall back to default if appropriate
+		server.superServer.host = server.superServer.host || server.webServer.host;
+	}
 
 
 	// When authentication provider is being used we should only have a password if it came from the deprecated

src/api/getServerSpec.ts

@@ -379,7 +379,7 @@ async function serverFeatures(element: ServerTreeItem, params?: any): Promise<Fe
 
 		const response = await makeRESTRequest("HEAD", serverSpec);
 		if (!response || response.status !== 200) {
-			children.push(new OfflineTreeItem({ parent: element, label: name, id: name }, element.name));
+			children.push(new OfflineTreeItem({ parent: element, label: name, id: name }, serverSpec.username || 'UnknownUser'));
 			credentialCache[name] = undefined;
 		} else {
 			children.push(new NamespacesTreeItem({ parent: element, label: name, id: name }, element.name, serverSpec.username || 'UnknownUser'));
@@ -397,14 +397,14 @@ export class OfflineTreeItem extends FeatureTreeItem {
 	public readonly name: string;
 	constructor(
 		element: ISMItem,
-		serverName: string,
+		username: string,
 	) {
 		const parentFolderId = element.parent?.id || "";
 		super({
 			id: parentFolderId + ":offline",
 			label: `Unavailable at ${new Date().toLocaleTimeString()}`,
 			parent: element.parent,
-			tooltip: `Server could not be reached`,
+			tooltip: `Server could not be accessed by '${username}'`,
 		});
 		this.name = "offline";
 		this.contextValue = "offline";
@@ -454,7 +454,7 @@ async function serverNamespaces(element: ServerTreeItem, params?: any): Promise<
 
 		const response = await makeRESTRequest("GET", serverSpec);
 		if (!response || response.status !== 200) {
-			children.push(new OfflineTreeItem({ parent: element, label: name, id: name }, element.name));
+			children.push(new OfflineTreeItem({ parent: element, label: name, id: name }, serverSpec.username || 'UnknownUser'));
 			credentialCache[params.serverName] = undefined;
 		} else {
 			response.data.result.content.namespaces.map((namespace) => {

src/ui/serverManagerView.ts

@@ -6,6 +6,10 @@ Package defining the interfaces used in the API that is published by the `inters
 
 # Changelog
 
+### v3.4.1
+
+- Add optional `superServer` object.
+
 ### v3.0.4
 
 - Export constants correctly.

types/README.md

@@ -14,8 +14,14 @@ export interface IWebServerSpec {
 	pathPrefix?: string;
 }
 
+export interface ISuperServerSpec {
+	host?: string;
+	port: number;
+}
+
 export interface IJSONServerSpec {
 	webServer: IWebServerSpec;
+	superServer?: ISuperServerSpec;
 	username?: string;
 	password?: string;
 	description?: string;

types/index.d.ts

@@ -1,6 +1,6 @@
 {
   "name": "@intersystems-community/intersystems-servermanager",
-  "version": "3.0.4",
+  "version": "3.4.1",
   "description": "InterSystems Server Manager VS Code extension API interfaces and constants",
   "types": "index.d.ts",
   "main": "index.js",