Add objectscript.explorer.alwaysShowServerCopy setting (intersystems-community#889)

isc-bsaviano · web-flow · commit 608476787d3c · 2022-03-11T13:25:01.000-05:00
diff --git a/docs/SettingsReference.md b/docs/SettingsReference.md
@@ -41,6 +41,7 @@ The extensions in the InterSystems ObjectScript Extension Pack provide many sett
 | `"objectscript.compileOnSave"` | Automatically compile an InterSystems file when saved in the editor. | `boolean` | `true` | |
 | `"objectscript.conn"` | Configures the active server connection. | `object` | `undefined` | See the [Configuration page](../configuration/#config-server-conn) for more details on configuring server connections. |
 | `"objectscript.debug.debugThisMethod"` | Show inline `Debug this method` CodeLens action for ClassMethods. | `boolean` | `true` | |
+| `"objectscript.explorer.alwaysShowServerCopy"` | Always show the server copy of a document in the ObjectScript Explorer. | `boolean` | `false` | |
 | `"objectscript.export.addCategory"` | Add a category folder to the beginning of the export path. | `boolean` or `object` | `false` | |
 | `"objectscript.export.atelier"` | Export source code as Atelier did it, with packages as subfolders. | `boolean` | `true` | |
 | `"objectscript.export.category"` | Category of source code to export: `CLS` = classes; `RTN` = routines; `CSP` = csp files; `OTH` = other. Default is `*` = all. | `string` or `object` | `"*"` | |
diff --git a/package.json b/package.json
@@ -1072,6 +1072,11 @@
           "description": "Automatically collapse all folding ranges when a class is opened for the first time.",
           "type": "boolean",
           "default": false
+        },
+        "objectscript.explorer.alwaysShowServerCopy": {
+          "description": "Always show the server copy of a document in the ObjectScript Explorer.",
+          "type": "boolean",
+          "default": false
         }
       }
     },
diff --git a/src/explorer/models/classNode.ts b/src/explorer/models/classNode.ts
@@ -1,6 +1,7 @@
 import * as vscode from "vscode";
 import { DocumentContentProvider } from "../../providers/DocumentContentProvider";
 import { NodeBase, NodeOptions } from "./nodeBase";
+import { config } from "../../extension";
 
 export class ClassNode extends NodeBase {
   public static readonly contextValue: string = "dataNode:classNode";
@@ -12,18 +13,27 @@ export class ClassNode extends NodeBase {
     const displayName: string = this.label;
     const itemUri = DocumentContentProvider.getUri(this.fullName, this.workspaceFolder, this.namespace);
     const isLocalFile = itemUri.scheme === "file";
+    const showServerCopy: boolean = config("explorer.alwaysShowServerCopy", this.workspaceFolder);
+    const serverCopyUri = DocumentContentProvider.getUri(
+      this.fullName,
+      this.workspaceFolder,
+      this.namespace,
+      undefined,
+      undefined,
+      true
+    );
 
     return {
       collapsibleState: vscode.TreeItemCollapsibleState.None,
       command: {
-        arguments: [itemUri],
+        arguments: [isLocalFile && !showServerCopy ? itemUri : serverCopyUri],
         command: "vscode-objectscript.explorer.open",
         title: "Open Class",
       },
-      resourceUri: isLocalFile ? itemUri : undefined,
+      resourceUri: isLocalFile && !showServerCopy ? itemUri : undefined,
       contextValue: "dataNode:classNode",
       label: `${displayName}`,
-      tooltip: isLocalFile ? undefined : this.fullName,
+      tooltip: isLocalFile && !showServerCopy ? undefined : this.fullName,
     };
   }
 }
diff --git a/src/explorer/models/cspFileNode.ts b/src/explorer/models/cspFileNode.ts
@@ -1,6 +1,7 @@
 import * as vscode from "vscode";
 import { DocumentContentProvider } from "../../providers/DocumentContentProvider";
 import { NodeBase, NodeOptions } from "./nodeBase";
+import { config } from "../../extension";
 
 export class CSPFileNode extends NodeBase {
   public static readonly contextValue: string = "dataNode:cspFileNode";
@@ -12,18 +13,27 @@ export class CSPFileNode extends NodeBase {
     const displayName: string = this.label;
     const itemUri = DocumentContentProvider.getUri(this.fullName, this.workspaceFolder, this.namespace);
     const isLocalFile = itemUri.scheme === "file";
+    const showServerCopy: boolean = config("explorer.alwaysShowServerCopy", this.workspaceFolder);
+    const serverCopyUri = DocumentContentProvider.getUri(
+      this.fullName,
+      this.workspaceFolder,
+      this.namespace,
+      undefined,
+      undefined,
+      true
+    );
 
     return {
       collapsibleState: vscode.TreeItemCollapsibleState.None,
       command: {
-        arguments: [itemUri],
+        arguments: [isLocalFile && !showServerCopy ? itemUri : serverCopyUri],
         command: "vscode-objectscript.explorer.open",
         title: "Open File",
       },
-      resourceUri: isLocalFile ? itemUri : undefined,
+      resourceUri: isLocalFile && !showServerCopy ? itemUri : undefined,
       contextValue: CSPFileNode.contextValue,
       label: `${displayName}`,
-      tooltip: isLocalFile ? undefined : this.fullName,
+      tooltip: isLocalFile && !showServerCopy ? undefined : this.fullName,
     };
   }
 }
diff --git a/src/explorer/models/packageNode.ts b/src/explorer/models/packageNode.ts
@@ -2,6 +2,7 @@ import * as vscode from "vscode";
 import { RootNode } from "./rootNode";
 import { NodeOptions } from "./nodeBase";
 import { DocumentContentProvider } from "../../providers/DocumentContentProvider";
+import { config } from "../../extension";
 
 export class PackageNode extends RootNode {
   public constructor(label: string, fullName: string, category: string, options: NodeOptions) {
@@ -12,10 +13,11 @@ export class PackageNode extends RootNode {
     const displayName: string = this.label;
     const localFolderPath = DocumentContentProvider.getAsFolder(this.fullName, this.workspaceFolder, "cls");
     const localUri = localFolderPath ? vscode.Uri.file(localFolderPath) : undefined;
+    const showServerCopy: boolean = config("explorer.alwaysShowServerCopy", this.workspaceFolder);
 
     return {
       collapsibleState: vscode.TreeItemCollapsibleState.Collapsed,
-      resourceUri: !this.extraNode ? localUri : undefined,
+      resourceUri: !this.extraNode && !showServerCopy ? localUri : undefined,
       contextValue: this.contextValue,
       label: `${displayName}`,
       tooltip: this.fullName,
diff --git a/src/explorer/models/routineNode.ts b/src/explorer/models/routineNode.ts
@@ -1,6 +1,7 @@
 import * as vscode from "vscode";
 import { DocumentContentProvider } from "../../providers/DocumentContentProvider";
 import { NodeBase, NodeOptions } from "./nodeBase";
+import { config } from "../../extension";
 
 export class RoutineNode extends NodeBase {
   public static readonly contextValue: string = "dataNode:routineNode";
@@ -12,18 +13,27 @@ export class RoutineNode extends NodeBase {
     const displayName: string = this.label;
     const itemUri = DocumentContentProvider.getUri(this.fullName, this.workspaceFolder, this.namespace);
     const isLocalFile = itemUri.scheme === "file";
+    const showServerCopy: boolean = config("explorer.alwaysShowServerCopy", this.workspaceFolder);
+    const serverCopyUri = DocumentContentProvider.getUri(
+      this.fullName,
+      this.workspaceFolder,
+      this.namespace,
+      undefined,
+      undefined,
+      true
+    );
 
     return {
       collapsibleState: vscode.TreeItemCollapsibleState.None,
       command: {
-        arguments: [itemUri],
+        arguments: [isLocalFile && !showServerCopy ? itemUri : serverCopyUri],
         command: "vscode-objectscript.explorer.open",
         title: "Open Routine",
       },
-      resourceUri: isLocalFile ? itemUri : undefined,
+      resourceUri: isLocalFile && !showServerCopy ? itemUri : undefined,
       contextValue: "dataNode:routineNode",
       label: `${displayName}`,
-      tooltip: isLocalFile ? undefined : this.fullName,
+      tooltip: isLocalFile && !showServerCopy ? undefined : this.fullName,
     };
   }
 }
diff --git a/src/providers/DocumentContentProvider.ts b/src/providers/DocumentContentProvider.ts
@@ -38,7 +38,8 @@ export class DocumentContentProvider implements vscode.TextDocumentContentProvid
     workspaceFolder?: string,
     namespace?: string,
     vfs?: boolean,
-    wFolderUri?: vscode.Uri
+    wFolderUri?: vscode.Uri,
+    forceServerCopy = false
   ): vscode.Uri {
     if (vfs === undefined) {
       vfs = config("serverSideEditing");
@@ -72,46 +73,50 @@ export class DocumentContentProvider implements vscode.TextDocumentContentProvid
       }
     } else {
       const conn = config("conn", workspaceFolder);
-      const localFile = this.getAsFile(name, workspaceFolder);
-      if (localFile && (!namespace || namespace === conn.ns)) {
-        // Exists as a local file and we aren't viewing a different namespace on the same server,
-        // so return a file:// uri that will open the local file.
-        return vscode.Uri.file(localFile);
-      } else {
-        // The local file doesn't exist in this folder, so check any other
-        // local folders in this workspace if it's a multi-root workspace
-        const wFolders = vscode.workspace.workspaceFolders;
-        if (wFolders && wFolders.length > 1) {
-          // This is a multi-root workspace
-          for (const wFolder of wFolders) {
-            if (wFolder.uri.scheme === "file" && wFolder.name !== workspaceFolder) {
-              // This isn't the folder that we checked originally
-              const wFolderConn = config("conn", wFolder.name);
-              const compareConns = (): boolean => {
-                if (wFolderConn.ns === conn.ns) {
-                  if (wFolderConn.server && conn.server) {
-                    if (wFolderConn.server === conn.server) {
-                      return true;
-                    }
-                  } else if (!wFolderConn.server && !conn.server) {
-                    if (wFolderConn.host === conn.host && wFolderConn.port === conn.port) {
-                      return true;
+      if (!forceServerCopy) {
+        // Look for the document in the local file system
+        const localFile = this.getAsFile(name, workspaceFolder);
+        if (localFile && (!namespace || namespace === conn.ns)) {
+          // Exists as a local file and we aren't viewing a different namespace on the same server,
+          // so return a file:// uri that will open the local file.
+          return vscode.Uri.file(localFile);
+        } else {
+          // The local file doesn't exist in this folder, so check any other
+          // local folders in this workspace if it's a multi-root workspace
+          const wFolders = vscode.workspace.workspaceFolders;
+          if (wFolders && wFolders.length > 1) {
+            // This is a multi-root workspace
+            for (const wFolder of wFolders) {
+              if (wFolder.uri.scheme === "file" && wFolder.name !== workspaceFolder) {
+                // This isn't the folder that we checked originally
+                const wFolderConn = config("conn", wFolder.name);
+                const compareConns = (): boolean => {
+                  if (wFolderConn.ns === conn.ns) {
+                    if (wFolderConn.server && conn.server) {
+                      if (wFolderConn.server === conn.server) {
+                        return true;
+                      }
+                    } else if (!wFolderConn.server && !conn.server) {
+                      if (wFolderConn.host === conn.host && wFolderConn.port === conn.port) {
+                        return true;
+                      }
                     }
                   }
-                }
-                return false;
-              };
-              if (compareConns() && (!namespace || namespace === wFolderConn.ns)) {
-                // This folder is connected to the same server:ns combination as the original folder
-                const wFolderFile = this.getAsFile(name, wFolder.name);
-                if (wFolderFile) {
-                  return vscode.Uri.file(wFolderFile);
+                  return false;
+                };
+                if (compareConns() && (!namespace || namespace === wFolderConn.ns)) {
+                  // This folder is connected to the same server:ns combination as the original folder
+                  const wFolderFile = this.getAsFile(name, wFolder.name);
+                  if (wFolderFile) {
+                    return vscode.Uri.file(wFolderFile);
+                  }
                 }
               }
             }
           }
         }
       }
+
       const { active } = conn;
       if (!active) {
         return null;

Original file line number	Diff line number	Diff line change
`@@ -1072,6 +1072,11 @@`
`1072`	`1072`	`"description": "Automatically collapse all folding ranges when a class is opened for the first time.",`
`1073`	`1073`	`"type": "boolean",`
`1074`	`1074`	`"default": false`
	`1075`	`+ },`
	`1076`	`+ "objectscript.explorer.alwaysShowServerCopy": {`
	`1077`	`+ "description": "Always show the server copy of a document in the ObjectScript Explorer.",`
	`1078`	`+ "type": "boolean",`
	`1079`	`+ "default": false`
`1075`	`1080`	`}`
`1076`	`1081`	`}`
`1077`	`1082`	`},`