Merge pull request intersystems-community#685 from gjsjohnmurray/fix-683

gjsjohnmurray · web-flow · commit 322fdf929a45 · 2021-06-15T23:23:44.000+01:00
fix intersystems-community#683 better isfs handling of server-side changes
diff --git a/src/api/index.ts b/src/api/index.ts
@@ -338,6 +338,11 @@ export class AtelierAPI {
         return this.cookies;
       }
 
+      // Not Modified
+      if (response.status === 304) {
+        throw { statusCode: response.status, message: response.statusText };
+      }
+
       const buffer = await response.buffer();
       const data: Atelier.Response = JSON.parse(buffer.toString("utf-8"));
 
@@ -431,7 +436,7 @@ export class AtelierAPI {
   }
 
   // api v1+
-  public getDoc(name: string, format?: string): Promise<Atelier.Response<Atelier.Document>> {
+  public getDoc(name: string, format?: string, mtime?: number): Promise<Atelier.Response<Atelier.Document>> {
     let params = {};
     if (!format && config("multilineMethodArgs") && this._config.apiVersion >= 4) {
       format = "udl-multiline";
@@ -442,7 +447,11 @@ export class AtelierAPI {
       };
     }
     name = this.transformNameIfCsp(name);
-    return this.request(1, "GET", `${this.ns}/doc/${name}`, null, params);
+    const headers = {};
+    if (mtime && mtime > 0) {
+      headers["IF_NONE_MATCH"] = new Date(mtime).toISOString().replace(/T|Z/g, " ").trim();
+    }
+    return this.request(1, "GET", `${this.ns}/doc/${name}`, null, params, headers);
   }
 
   // api v1+
diff --git a/src/commands/compile.ts b/src/commands/compile.ts
@@ -13,7 +13,7 @@ import {
   workspaceState,
 } from "../extension";
 import { DocumentContentProvider } from "../providers/DocumentContentProvider";
-import { currentFile, CurrentFile, currentWorkspaceFolder, outputChannel, workspaceFolderUri } from "../utils";
+import { currentFile, CurrentFile, currentWorkspaceFolder, outputChannel, uriOfWorkspaceFolder } from "../utils";
 import { RootNode } from "../explorer/models/rootNode";
 import { PackageNode } from "../explorer/models/packageNode";
 import { ClassNode } from "../explorer/models/classNode";
@@ -137,10 +137,17 @@ What do you want to do?`,
       } else {
         if (error.errorText && error.errorText !== "") {
           outputChannel.appendLine("\n" + error.errorText);
-          vscode.window.showErrorMessage(
-            `Failed to save file '${file.name}' on the server. Check output channel for details.`,
-            "Dismiss"
-          );
+          vscode.window
+            .showErrorMessage(
+              `Failed to save file '${file.name}' on the server. Check 'ObjectScript' output channel for details.`,
+              "Show",
+              "Dismiss"
+            )
+            .then((action) => {
+              if (action === "Show") {
+                outputChannel.show(true);
+              }
+            });
         } else {
           vscode.window.showErrorMessage(`Failed to save file '${file.name}' on the server.`, "Dismiss");
         }
@@ -231,9 +238,15 @@ async function compile(docs: CurrentFile[], flags?: string): Promise<any> {
           .catch((error: Error) => {
             if (!config("suppressCompileErrorMessages")) {
               vscode.window
-                .showErrorMessage("Compilation failed. Check output channel for details.", "Dismiss")
-                .then((data) => {
-                  outputChannel.show(true);
+                .showErrorMessage(
+                  "Compilation failed. Check 'ObjectScript' output channel for details.",
+                  "Show",
+                  "Dismiss"
+                )
+                .then((action) => {
+                  if (action === "Show") {
+                    outputChannel.show(true);
+                  }
                 });
             }
             // Even when compile failed we should still fetch server changes
@@ -373,7 +386,7 @@ export async function importFolder(uri: vscode.Uri, noCompile = false): Promise<
   }
   let globpattern = "*.{cls,inc,int,mac}";
   const workspace = currentWorkspaceFolder();
-  const workspacePath = workspaceFolderUri(workspace).fsPath;
+  const workspacePath = uriOfWorkspaceFolder(workspace).fsPath;
   const folderPathNoWorkspaceArr = uripath.replace(workspacePath + path.sep, "").split(path.sep);
   if (folderPathNoWorkspaceArr.includes("csp")) {
     // This folder is a CSP application, so import all files
diff --git a/src/commands/export.ts b/src/commands/export.ts
@@ -3,7 +3,7 @@ import path = require("path");
 import * as vscode from "vscode";
 import { AtelierAPI } from "../api";
 import { config } from "../extension";
-import { mkdirSyncRecursive, notNull, outputChannel, workspaceFolderUri } from "../utils";
+import { mkdirSyncRecursive, notNull, outputChannel, uriOfWorkspaceFolder } from "../utils";
 import { NodeBase } from "../explorer/models/nodeBase";
 
 const filesFilter = (file: any) => {
@@ -185,7 +185,10 @@ export async function exportList(files: string[], workspaceFolder: string, names
   }
   const { atelier, folder, addCategory, map } = config("export", workspaceFolder);
 
-  const root = [workspaceFolderUri(workspaceFolder).fsPath, typeof folder === "string" && folder.length ? folder : null]
+  const root = [
+    uriOfWorkspaceFolder(workspaceFolder).fsPath,
+    typeof folder === "string" && folder.length ? folder : null,
+  ]
     .filter(notNull)
     .join(path.sep);
   const run = async (fileList) => {
diff --git a/src/commands/viewOthers.ts b/src/commands/viewOthers.ts
@@ -200,7 +200,17 @@ export async function viewOthers(forceEditable = false): Promise<void> {
     .catch((err) => {
       if (err.errorText && err.errorText !== "") {
         outputChannel.appendLine("\n" + err.errorText);
-        vscode.window.showErrorMessage(`Failed to get other documents. Check output channel for details.`, "Dismiss");
+        vscode.window
+          .showErrorMessage(
+            `Failed to get other documents. Check 'ObjectScript' output channel for details.`,
+            "Show",
+            "Dismiss"
+          )
+          .then((action) => {
+            if (action === "Show") {
+              outputChannel.show(true);
+            }
+          });
       } else {
         vscode.window.showErrorMessage(`Failed to get other documents.`, "Dismiss");
       }
diff --git a/src/providers/DocumentContentProvider.ts b/src/providers/DocumentContentProvider.ts
@@ -6,7 +6,7 @@ import { AtelierAPI } from "../api";
 
 import { getFileName, getFolderName } from "../commands/export";
 import { config, FILESYSTEM_SCHEMA, FILESYSTEM_READONLY_SCHEMA, OBJECTSCRIPT_FILE_SCHEMA } from "../extension";
-import { currentWorkspaceFolder, workspaceFolderUri } from "../utils";
+import { currentWorkspaceFolder, uriOfWorkspaceFolder } from "../utils";
 
 export class DocumentContentProvider implements vscode.TextDocumentContentProvider {
   public get onDidChange(): vscode.Event<vscode.Uri> {
@@ -16,7 +16,7 @@ export class DocumentContentProvider implements vscode.TextDocumentContentProvid
   public static getAsFile(name: string, workspaceFolder: string): string {
     const { atelier, folder, addCategory, map } = config("export", workspaceFolder);
 
-    const root = [workspaceFolderUri(workspaceFolder).fsPath, folder].join(path.sep);
+    const root = [uriOfWorkspaceFolder(workspaceFolder).fsPath, folder].join(path.sep);
     const fileName = getFileName(root, name, atelier, addCategory, map);
     if (fs.existsSync(fileName)) {
       return fs.realpathSync.native(fileName);
@@ -26,7 +26,7 @@ export class DocumentContentProvider implements vscode.TextDocumentContentProvid
   public static getAsFolder(name: string, workspaceFolder: string, category?: string): string {
     const { atelier, folder, addCategory } = config("export", workspaceFolder);
 
-    const root = [workspaceFolderUri(workspaceFolder).fsPath, folder].join(path.sep);
+    const root = [uriOfWorkspaceFolder(workspaceFolder).fsPath, folder].join(path.sep);
     const folderName = getFolderName(root, name, atelier, addCategory ? category : null);
     if (fs.existsSync(folderName)) {
       return fs.realpathSync.native(folderName);
@@ -49,7 +49,7 @@ export class DocumentContentProvider implements vscode.TextDocumentContentProvid
     // if wFolderUri was passed it takes precedence
     if (!wFolderUri) {
       workspaceFolder = workspaceFolder && workspaceFolder !== "" ? workspaceFolder : currentWorkspaceFolder();
-      wFolderUri = workspaceFolderUri(workspaceFolder);
+      wFolderUri = uriOfWorkspaceFolder(workspaceFolder);
     }
     let uri: vscode.Uri;
     if (wFolderUri.scheme === FILESYSTEM_SCHEMA || wFolderUri.scheme === FILESYSTEM_READONLY_SCHEMA) {
diff --git a/src/providers/FileSystemProvider/File.ts b/src/providers/FileSystemProvider/File.ts
@@ -10,8 +10,8 @@ export class File implements vscode.FileStat {
   public data?: Uint8Array;
   public constructor(name: string, fileName: string, ts: string, size: number, data: string | Buffer) {
     this.type = vscode.FileType.File;
-    this.ctime = new Date(ts).getTime();
-    this.mtime = new Date(ts).getTime();
+    this.ctime = Number(new Date(ts + "Z"));
+    this.mtime = this.ctime;
     this.size = size;
     this.fileName = fileName;
     this.name = name;
diff --git a/src/providers/FileSystemProvider/FileSystemProvider.ts b/src/providers/FileSystemProvider/FileSystemProvider.ts
@@ -6,7 +6,8 @@ import { Directory } from "./Directory";
 import { File } from "./File";
 import { fireOtherStudioAction, OtherStudioAction } from "../../commands/studio";
 import { StudioOpenDialog } from "../../queries";
-import { redirectDotvscodeRoot } from "../../utils/index";
+import { redirectDotvscodeRoot, workspaceFolderOfUri } from "../../utils/index";
+import { workspaceState } from "../../extension";
 
 declare function setTimeout(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timeout;
 
@@ -146,7 +147,12 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
   }
 
   public async readFile(uri: vscode.Uri): Promise<Uint8Array> {
-    return this._lookupAsFile(uri).then((file: File) => file.data);
+    return this._lookupAsFile(uri).then((file: File) => {
+      // Update cache entry
+      const uniqueId = `${workspaceFolderOfUri(uri)}:${file.fileName}`;
+      workspaceState.update(`${uniqueId}:mtime`, file.mtime);
+      return file.data;
+    });
   }
 
   private generateFileContent(fileName: string, content: Buffer): { content: string[]; enc: boolean } {
@@ -197,12 +203,16 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
         // The actual writing is done by our workspace.onDidSaveTextDocument handler.
         // But first check a case for which we should fail the write and leave the document dirty if changed.
         if (fileName.split(".").pop().toLowerCase() === "cls") {
-          return api.actionIndex([fileName]).then((result) => {
+          api.actionIndex([fileName]).then((result) => {
             if (result.result.content[0].content.depl) {
               throw new Error("Cannot overwrite a deployed class");
             }
           });
         }
+        // Set a -1 mtime cache entry so the actual write by the workspace.onDidSaveTextDocument handler always overwrites.
+        // By the time we get here VS Code's built-in conflict resolution mechanism will already have interacted with the user.
+        const uniqueId = `${workspaceFolderOfUri(uri)}:${fileName}`;
+        workspaceState.update(`${uniqueId}:mtime`, -1);
         return;
       },
       (error) => {
@@ -307,8 +317,12 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
         } else {
           throw vscode.FileSystemError.FileNotFound(uri);
         }
+      } else if (child instanceof File) {
+        // Return cached copy unless changed, in which case return updated one
+        return this._lookupAsFile(uri, child);
+      } else {
+        entry = child;
       }
-      entry = child;
     }
     return entry;
   }
@@ -325,8 +339,8 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
     throw vscode.FileSystemError.FileNotADirectory(uri);
   }
 
-  // Fetch from server and cache it
-  private async _lookupAsFile(uri: vscode.Uri): Promise<File> {
+  // Fetch from server and cache it, optionally the passed cached copy if unchanged on server
+  private async _lookupAsFile(uri: vscode.Uri, cachedFile?: File): Promise<File> {
     uri = redirectDotvscodeRoot(uri);
     if (uri.path.startsWith("/.")) {
       throw vscode.FileSystemError.NoPermissions("dot-folders not supported by server");
@@ -338,7 +352,7 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
     const name = path.basename(uri.path);
     const api = new AtelierAPI(uri);
     return api
-      .getDoc(fileName)
+      .getDoc(fileName, undefined, cachedFile?.mtime)
       .then((data) => data.result)
       .then((result) => {
         const fileSplit = fileName.split(".");
@@ -373,6 +387,9 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
         })
       )
       .catch((error) => {
+        if (error?.statusCode === 304 && cachedFile) {
+          return cachedFile;
+        }
         throw vscode.FileSystemError.FileNotFound(uri);
       });
   }
diff --git a/src/utils/index.ts b/src/utils/index.ts
@@ -61,7 +61,7 @@ export interface ConnectionTarget {
  * @param workspace The workspace the file is in.
  */
 function getServerDocName(localPath: string, workspace: string): string {
-  const workspacePath = workspaceFolderUri(workspace).fsPath;
+  const workspacePath = uriOfWorkspaceFolder(workspace).fsPath;
   const filePathNoWorkspaceArr = localPath.replace(workspacePath + path.sep, "").split(path.sep);
   return filePathNoWorkspaceArr.slice(filePathNoWorkspaceArr.indexOf("csp")).join("/");
 }
@@ -73,7 +73,7 @@ function getServerDocName(localPath: string, workspace: string): string {
  */
 export function isImportableLocalFile(file: vscode.TextDocument): boolean {
   const workspace = currentWorkspaceFolder(file);
-  const workspacePath = workspaceFolderUri(workspace).fsPath;
+  const workspacePath = uriOfWorkspaceFolder(workspace).fsPath;
   const filePathNoWorkspaceArr = file.fileName.replace(workspacePath + path.sep, "").split(path.sep);
   return filePathNoWorkspaceArr.includes("csp");
 }
@@ -259,18 +259,7 @@ export function isCSP(uri: vscode.Uri): boolean {
 export function currentWorkspaceFolder(document?: vscode.TextDocument): string {
   document = document ? document : vscode.window.activeTextEditor && vscode.window.activeTextEditor.document;
   if (document) {
-    const uri = document.uri;
-    if (uri.scheme === "file") {
-      if (vscode.workspace.getWorkspaceFolder(uri)) {
-        return vscode.workspace.getWorkspaceFolder(uri).name;
-      }
-    } else if (schemas.includes(uri.scheme)) {
-      const rootUri = uri.with({ path: "/" }).toString();
-      const foundFolder = vscode.workspace.workspaceFolders.find(
-        (workspaceFolder) => workspaceFolder.uri.toString() == rootUri
-      );
-      return foundFolder ? foundFolder.name : uri.authority;
-    }
+    return workspaceFolderOfUri(document.uri);
   }
   const firstFolder =
     vscode.workspace.workspaceFolders && vscode.workspace.workspaceFolders.length
@@ -283,7 +272,21 @@ export function currentWorkspaceFolder(document?: vscode.TextDocument): string {
   }
 }
 
-export function workspaceFolderUri(workspaceFolder: string = currentWorkspaceFolder()): vscode.Uri {
+export function workspaceFolderOfUri(uri: vscode.Uri): string {
+  if (uri.scheme === "file") {
+    if (vscode.workspace.getWorkspaceFolder(uri)) {
+      return vscode.workspace.getWorkspaceFolder(uri).name;
+    }
+  } else if (schemas.includes(uri.scheme)) {
+    const rootUri = uri.with({ path: "/" }).toString();
+    const foundFolder = vscode.workspace.workspaceFolders.find(
+      (workspaceFolder) => workspaceFolder.uri.toString() == rootUri
+    );
+    return foundFolder ? foundFolder.name : uri.authority;
+  }
+}
+
+export function uriOfWorkspaceFolder(workspaceFolder: string = currentWorkspaceFolder()): vscode.Uri {
   return (
     vscode.workspace.workspaceFolders.find((el): boolean => el.name.toLowerCase() === workspaceFolder.toLowerCase()) ||
     vscode.workspace.workspaceFolders.find((el): boolean => el.uri.authority == workspaceFolder)
@@ -309,7 +312,7 @@ export async function portFromDockerCompose(): Promise<{ port: number; docker: b
     return { docker: false, port: null };
   }
   const result = { port: null, docker: true, service };
-  const workspaceFolderPath = workspaceFolderUri().fsPath;
+  const workspaceFolderPath = uriOfWorkspaceFolder().fsPath;
   const workspaceRootPath = vscode.workspace.workspaceFolders[0].uri.fsPath;
 
   const cwd: string = await new Promise((resolve, reject) => {
