Merge pull request #551 from gjsjohnmurray/enh-450

implement isfs://server:namespace/ alternative syntax (#450)

Author: gjsjohnmurray

src/api/index.ts

@@ -100,10 +100,16 @@ export class AtelierAPI {
       if (wsOrFile instanceof vscode.Uri) {
         if (schemas.includes(wsOrFile.scheme)) {
           workspaceFolderName = wsOrFile.authority;
-          const { query } = url.parse(decodeURIComponent(wsOrFile.toString()), true);
-          if (query) {
-            if (query.ns && query.ns !== "") {
-              namespace = query.ns.toString();
+          const parts = workspaceFolderName.split(":");
+          if (parts.length === 2 && config("intersystems.servers").has(parts[0].toLowerCase())) {
+            workspaceFolderName = parts[0];
+            namespace = parts[1];
+          } else {
+            const { query } = url.parse(wsOrFile.toString(true), true);
+            if (query) {
+              if (query.ns && query.ns !== "") {
+                namespace = query.ns.toString();
+              }
             }
           }
         }

src/debug/debugSession.ts

@@ -37,18 +37,19 @@ interface AttachRequestArguments extends DebugProtocol.AttachRequestArguments {
   stopOnEntry?: boolean;
 }
 
-/** converts a local path from VS Code to a server-side XDebug file URI with respect to source root settings */
-export async function convertClientPathToDebugger(localPath: string, namespace: string): Promise<string> {
-  const { protocol, pathname, query } = url.parse(decodeURIComponent(localPath), true, true);
-  let fileName = localPath;
-  if (protocol && schemas.includes(protocol.slice(0, -1))) {
+/** converts a uri from VS Code to a server-side XDebug file URI with respect to source root settings */
+async function convertClientPathToDebugger(uri: vscode.Uri, namespace: string): Promise<string> {
+  const { scheme, path } = uri;
+  const { query } = url.parse(uri.toString(true), true);
+  let fileName: string;
+  if (scheme && schemas.includes(scheme)) {
     if (query.ns && query.ns !== "") {
       namespace = query.ns.toString();
     }
-    fileName = pathname.slice(1).replace(/\//, ".");
+    fileName = path.slice(1).replace(/\//, ".");
   } else {
     fileName = await vscode.workspace
-      .openTextDocument(localPath)
+      .openTextDocument(uri)
       .then(currentFile)
       .then((curFile) => {
         return curFile.name;
@@ -241,10 +242,9 @@ export class ObjectScriptDebugSession extends LoggingDebugSession {
       await this._debugTargetSet.wait(1000);
 
       const filePath = args.source.path;
-      const { protocol } = url.parse(decodeURIComponent(filePath), true, true);
-      const uri =
-        protocol && schemas.includes(protocol.slice(0, -1)) ? vscode.Uri.parse(filePath) : vscode.Uri.file(filePath);
-      const fileUri = await convertClientPathToDebugger(args.source.path, this._namespace);
+      const scheme = filePath.split(":")[0];
+      const uri = schemas.includes(scheme) ? vscode.Uri.parse(filePath) : vscode.Uri.file(filePath);
+      const fileUri = await convertClientPathToDebugger(uri, this._namespace);
       const [, fileName] = fileUri.match(/\|([^|]+)$/);
 
       const currentList = await this._connection.sendBreakpointListCommand();

src/providers/DocumentContentProvider.ts

@@ -108,7 +108,7 @@ export class DocumentContentProvider implements vscode.TextDocumentContentProvid
 
   public provideTextDocumentContent(uri: vscode.Uri, token: vscode.CancellationToken): vscode.ProviderResult<string> {
     const api = new AtelierAPI(uri);
-    const query = url.parse(decodeURIComponent(uri.toString()), true).query;
+    const query = url.parse(uri.toString(true), true).query;
     const fileName = query && query.csp ? uri.path.substring(1) : uri.path.split("/").slice(1).join(".");
     if (query) {
       if (query.ns && query.ns !== "") {

src/providers/FileSystemPovider/FileSystemProvider.ts

@@ -47,7 +47,7 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
       return;
     }
     const sql = `CALL %Library.RoutineMgr_StudioOpenDialog(?,?,?,?,?,?,?)`;
-    const { query } = url.parse(decodeURIComponent(uri.toString()), true);
+    const { query } = url.parse(uri.toString(true), true);
     const type = query.type && query.type != "" ? query.type.toString() : "all";
     const csp = query.csp === "" || query.csp === "1";
     let filter = "";
@@ -181,7 +181,7 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
     if (uri.path.startsWith("/.")) {
       throw vscode.FileSystemError.NoPermissions("dot-folders not supported by server");
     }
-    const { query } = url.parse(decodeURIComponent(uri.toString()), true);
+    const { query } = url.parse(uri.toString(true), true);
     const csp = query.csp === "" || query.csp === "1";
     const fileName = csp ? uri.path : uri.path.slice(1).replace(/\//g, ".");
     if (fileName.startsWith(".")) {
@@ -244,7 +244,7 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
   }
 
   public delete(uri: vscode.Uri, options: { recursive: boolean }): void | Thenable<void> {
-    const { query } = url.parse(decodeURIComponent(uri.toString()), true);
+    const { query } = url.parse(uri.toString(true), true);
     const csp = query.csp === "" || query.csp === "1";
     const fileName = csp ? uri.path : uri.path.slice(1).replace(/\//g, ".");
     if (fileName.startsWith(".")) {
@@ -330,7 +330,7 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
       throw vscode.FileSystemError.NoPermissions("dot-folders not supported by server");
     }
 
-    const { query } = url.parse(decodeURIComponent(uri.toString()), true);
+    const { query } = url.parse(uri.toString(true), true);
     const csp = query.csp === "" || query.csp === "1";
     const fileName = csp ? uri.path : uri.path.slice(1).replace(/\//g, ".");
     const name = path.basename(uri.path);

src/utils/index.ts

@@ -81,7 +81,7 @@ export function currentFile(document?: vscode.TextDocument): CurrentFile {
   const content = document.getText();
   let name = "";
   let ext = "";
-  const { query } = url.parse(decodeURIComponent(uri.toString()), true);
+  const { query } = url.parse(uri.toString(true), true);
   const csp = query.csp === "" || query.csp === "1";
   if (csp) {
     name = uri.path;
@@ -167,7 +167,8 @@ export function connectionTarget(uri?: vscode.Uri): ConnectionTarget {
       }
     } else if (schemas.includes(uri.scheme)) {
       result.apiTarget = uri;
-      result.configName = uri.authority;
+      const parts = uri.authority.split(":");
+      result.configName = parts.length === 2 ? parts[0] : uri.authority;
     }
   }
 
@@ -178,7 +179,8 @@ export function connectionTarget(uri?: vscode.Uri): ConnectionTarget {
         ? vscode.workspace.workspaceFolders[0]
         : undefined;
     if (firstFolder && schemas.includes(firstFolder.uri.scheme)) {
-      result.configName = firstFolder.uri.authority;
+      const parts = firstFolder.uri.authority.split(":");
+      result.configName = parts.length === 2 ? parts[0] : firstFolder.uri.authority;
       result.apiTarget = firstFolder.uri;
     } else {
       result.configName = workspaceState.get<string>("workspaceFolder") || firstFolder ? firstFolder.name : "";
@@ -350,7 +352,9 @@ export async function terminalWithDocker(): Promise<vscode.Terminal> {
  * Alter isfs-type uri.path of /.vscode/* files or subdirectories.
  * Rewrite `/.vscode/path/to/file` as `/_vscode/XYZ/path/to/file`
  *  where XYZ comes from the `ns` queryparam of uri.
- * Also alter query to specify `ns=%SYS&csp=1`
+ *  Also alter query to specify `ns=%SYS&csp=1`
+ * Also handles the alternative syntax isfs://server:namespace/
+ *  in which there is no ns queryparam
  *
  * @returns uri, altered if necessary.
  * @throws if `ns` queryparam is missing but required.
@@ -361,13 +365,24 @@ export function redirectDotvscodeRoot(uri: vscode.Uri): vscode.Uri {
   }
   const dotMatch = uri.path.match(/^\/(\.[^/]*)\/(.*)$/);
   if (dotMatch && dotMatch[1] === ".vscode") {
+    let namespace: string;
     const nsMatch = `&${uri.query}&`.match(/&ns=([^&]+)&/);
-    if (!nsMatch) {
-      throw new Error("No 'ns' query parameter on uri");
+    if (nsMatch) {
+      namespace = nsMatch[1];
+      const newQueryString = (("&" + uri.query).replace(`ns=${namespace}`, "ns=%SYS") + "&csp=1").slice(1);
+      return uri.with({ path: `/_vscode/${namespace}/${dotMatch[2]}`, query: newQueryString });
+    } else {
+      const parts = uri.authority.split(":");
+      if (parts.length === 2) {
+        namespace = parts[1];
+        return uri.with({
+          authority: `${parts[0]}:%SYS`,
+          path: `/_vscode/${namespace}/${dotMatch[2]}`,
+          query: uri.query + "&csp=1",
+        });
+      }
     }
-    const namespace = nsMatch[1];
-    const newQueryString = (("&" + uri.query).replace(`ns=${namespace}`, "ns=%SYS") + "&csp=1").slice(1);
-    return uri.with({ path: `/_vscode/${namespace}/${dotMatch[2]}`, query: newQueryString });
+    throw new Error("No namespace determined from uri");
   } else {
     return uri;
   }