Merge pull request intersystems-community#622 from isc-bsaviano/master

Improve client-side CSP workflow

Author: gjsjohnmurray

package.json

@@ -230,7 +230,7 @@
       "view/item/context": [
         {
           "command": "vscode-objectscript.explorer.export",
-          "when": "view == ObjectScriptExplorer && viewItem =~ /^dataNode:(?!(cspApplication|cspFileNode))/"
+          "when": "view == ObjectScriptExplorer && viewItem =~ /^dataNode:/"
         },
         {
           "command": "vscode-objectscript.explorer.export",
@@ -407,7 +407,8 @@
           "ObjectScript CSP"
         ],
         "extensions": [
-          "csp"
+          ".csp",
+          ".csr"
         ]
       },
       {

src/commands/compile.ts

@@ -11,10 +11,9 @@ import {
   OBJECTSCRIPT_FILE_SCHEMA,
   fileSystemProvider,
   workspaceState,
-  schemas,
 } from "../extension";
 import { DocumentContentProvider } from "../providers/DocumentContentProvider";
-import { currentFile, CurrentFile, outputChannel } from "../utils";
+import { currentFile, CurrentFile, currentWorkspaceFolder, outputChannel, workspaceFolderUri } from "../utils";
 import { RootNode } from "../explorer/models/rootNode";
 import { PackageNode } from "../explorer/models/packageNode";
 import { ClassNode } from "../explorer/models/classNode";
@@ -41,7 +40,7 @@ async function compileFlags(): Promise<string> {
  * @return mtime timestamp or -1.
  */
 export async function checkChangedOnServer(file: CurrentFile, force = false): Promise<number> {
-  if (!file || !file.uri || schemas.includes(file.uri.scheme)) {
+  if (!file || !file.uri) {
     return -1;
   }
   const api = new AtelierAPI(file.uri);
@@ -368,20 +367,30 @@ function importFiles(files, noCompile = false) {
 }
 
 export async function importFolder(uri: vscode.Uri, noCompile = false): Promise<any> {
-  const folder = uri.fsPath;
-  if (fs.lstatSync(folder).isFile()) {
-    return importFiles([folder], noCompile);
+  const uripath = uri.fsPath;
+  if (fs.lstatSync(uripath).isFile()) {
+    return importFiles([uripath], noCompile);
+  }
+  let globpattern = "*.{cls,inc,int,mac}";
+  const workspace = currentWorkspaceFolder();
+  const workspacePath = workspaceFolderUri(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
+    // We need to include eveything becuase CSP applications can
+    // include non-InterSystems files
+    globpattern = "*";
   }
   glob(
-    "*.{cls,inc,mac,int}",
+    globpattern,
     {
-      cwd: folder,
+      cwd: uripath,
       matchBase: true,
       nocase: true,
     },
     (_error, files) =>
       importFiles(
-        files.map((name) => path.join(folder, name)),
+        files.map((name) => path.join(uripath, name)),
         noCompile
       )
   );

src/commands/export.ts

@@ -13,7 +13,7 @@ const filesFilter = (file: any) => {
   return true;
 };
 
-const getCategory = (fileName: string, addCategory: any | boolean): string => {
+export const getCategory = (fileName: string, addCategory: any | boolean): string => {
   const fileExt = fileName.split(".").pop().toLowerCase();
   if (typeof addCategory === "object") {
     for (const pattern of Object.keys(addCategory)) {
@@ -45,22 +45,30 @@ export const getFileName = (
     [key: string]: string;
   }
 ): string => {
-  if (map) {
-    for (const pattern of Object.keys(map)) {
-      if (new RegExp(`^${pattern}$`).test(name)) {
-        name = name.replace(new RegExp(`^${pattern}$`), map[pattern]);
-        break;
+  if (name.includes("/")) {
+    // This is a file from a web application
+    const nameArr: string[] = name.split("/");
+    const cat = addCategory ? getCategory(name, addCategory) : null;
+    return [folder, cat, ...nameArr].filter(notNull).join(path.sep);
+  } else {
+    // This is a class, routine or include file
+    if (map) {
+      for (const pattern of Object.keys(map)) {
+        if (new RegExp(`^${pattern}$`).test(name)) {
+          name = name.replace(new RegExp(`^${pattern}$`), map[pattern]);
+          break;
+        }
       }
     }
+    const fileNameArray: string[] = name.split(".");
+    const fileExt = fileNameArray.pop().toLowerCase();
+    const cat = addCategory ? getCategory(name, addCategory) : null;
+    if (split) {
+      const fileName = [folder, cat, ...fileNameArray].filter(notNull).join(path.sep);
+      return [fileName, fileExt].join(".");
+    }
+    return [folder, cat, name].filter(notNull).join(path.sep);
   }
-  const fileNameArray: string[] = name.split(".");
-  const fileExt = fileNameArray.pop().toLowerCase();
-  const cat = addCategory ? getCategory(name, addCategory) : null;
-  if (split) {
-    const fileName = [folder, cat, ...fileNameArray].filter(notNull).join(path.sep);
-    return [fileName, fileExt].join(".");
-  }
-  return [folder, cat, name].filter(notNull).join(path.sep);
 };
 
 export const getFolderName = (folder: string, name: string, split: boolean, cat: string = null): string => {
@@ -122,26 +130,43 @@ export async function exportFile(
 
         return promise
           .then((res: any) => {
-            let joinedContent = content instanceof Buffer ? content.toString("utf-8") : (content || []).join("\n");
-            let isSkipped = "";
+            if (Buffer.isBuffer(content)) {
+              // This is a binary file
+              let isSkipped = "";
+              if (dontExportIfNoChanges && fs.existsSync(fileName)) {
+                const existingContent = fs.readFileSync(fileName);
+                if (content.equals(existingContent)) {
+                  fs.writeFileSync(fileName, content);
+                } else {
+                  isSkipped = " => skipped - no changes.";
+                }
+              } else {
+                fs.writeFileSync(fileName, content);
+              }
+              log(`Success ${isSkipped}`);
+            } else {
+              // This is a text file
+              let joinedContent = content.join("\n");
+              let isSkipped = "";
 
-            if (res.found) {
-              joinedContent = res.content.toString("utf8");
-            }
+              if (res.found) {
+                joinedContent = res.content.toString("utf8");
+              }
 
-            if (dontExportIfNoChanges && fs.existsSync(fileName)) {
-              const existingContent = fs.readFileSync(fileName, "utf8");
-              // stringify to harmonise the text encoding.
-              if (JSON.stringify(joinedContent) !== JSON.stringify(existingContent)) {
-                fs.writeFileSync(fileName, joinedContent);
+              if (dontExportIfNoChanges && fs.existsSync(fileName)) {
+                const existingContent = fs.readFileSync(fileName, "utf8");
+                // stringify to harmonise the text encoding.
+                if (JSON.stringify(joinedContent) !== JSON.stringify(existingContent)) {
+                  fs.writeFileSync(fileName, joinedContent);
+                } else {
+                  isSkipped = " => skipped - no changes.";
+                }
               } else {
-                isSkipped = " => skipped - no changes.";
+                fs.writeFileSync(fileName, joinedContent);
               }
-            } else {
-              fs.writeFileSync(fileName, joinedContent);
-            }
 
-            log(`Success ${isSkipped}`);
+              log(`Success ${isSkipped}`);
+            }
           })
           .catch((error) => {
             throw error;

src/explorer/models/rootNode.ts

@@ -155,7 +155,8 @@ export class RootNode extends NodeBase {
   }
 
   public getItems4Export(): Promise<string[]> {
-    const path = this instanceof PackageNode ? this.fullName + "/" : "";
-    return this.getList(path, "ALL", true).then((data) => data.map((el) => el.Name));
+    const path = this instanceof PackageNode || this.isCsp ? this.fullName + "/" : "";
+    const cat = this.isCsp ? "CSP" : "ALL";
+    return this.getList(path, cat, true).then((data) => data.map((el) => el.Name));
   }
 }

src/extension.ts

@@ -76,6 +76,7 @@ import {
   notNull,
   currentFile,
   InputBoxManager,
+  isImportableLocalFile,
 } from "./utils";
 import { ObjectScriptDiagnosticProvider } from "./providers/ObjectScriptDiagnosticProvider";
 import { DocumentRangeFormattingEditProvider } from "./providers/DocumentRangeFormattingEditProvider";
@@ -537,6 +538,12 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
       if (documentBeingProcessed !== file) {
         return importAndCompile(false, file, config("compileOnSave"));
       }
+    } else if (file.uri.scheme === "file") {
+      if (isImportableLocalFile(file)) {
+        // This local file is in the exported file tree, so it's a non-InterSystems file that's
+        // part of a CSP application, so import it on save
+        return importFileOrFolder(file.uri, true);
+      }
     }
   });
 

src/utils/index.ts

@@ -55,6 +55,29 @@ export interface ConnectionTarget {
   configName: string;
 }
 
+/**
+ * Determine the server name of a local non-ObjectScript file (any file that's not CLS,MAC,INT,INC).
+ * @param localPath The full path to the file on disk.
+ * @param workspace The workspace the file is in.
+ */
+function getServerDocName(localPath: string, workspace: string): string {
+  const workspacePath = workspaceFolderUri(workspace).fsPath;
+  const filePathNoWorkspaceArr = localPath.replace(workspacePath + path.sep, "").split(path.sep);
+  return filePathNoWorkspaceArr.slice(filePathNoWorkspaceArr.indexOf("csp")).join("/");
+}
+
+/**
+ * Determine if this non-InterSystems local file is importable
+ * (i.e. is part of a CSP application).
+ * @param file The file to check.
+ */
+export function isImportableLocalFile(file: vscode.TextDocument): boolean {
+  const workspace = currentWorkspaceFolder(file);
+  const workspacePath = workspaceFolderUri(workspace).fsPath;
+  const filePathNoWorkspaceArr = file.fileName.replace(workspacePath + path.sep, "").split(path.sep);
+  return filePathNoWorkspaceArr.includes("csp");
+}
+
 export function currentFile(document?: vscode.TextDocument): CurrentFile {
   document =
     document ||
@@ -72,9 +95,12 @@ export function currentFile(document?: vscode.TextDocument): CurrentFile {
       !document.fileName ||
       !document.languageId ||
       !document.languageId.startsWith("objectscript") ||
-      fileExt.match(/(csp)/i)) // Skip local CSPs for now
+      document.languageId === "objectscript-output")
   ) {
-    return null;
+    // This is a non-InterSystems local file, so check if we can import it
+    if (!isImportableLocalFile(document)) {
+      return null;
+    }
   }
   const eol = document.eol || vscode.EndOfLine.LF;
   const uri = redirectDotvscodeRoot(document.uri);
@@ -99,7 +125,15 @@ export function currentFile(document?: vscode.TextDocument): CurrentFile {
       [name, ext = "mac"] = path.basename(document.fileName).split(".");
     }
   } else {
-    name = fileName;
+    if (document.uri.scheme === "file") {
+      if (fileExt.match(/(csp|csr)/i) && !isImportableLocalFile(document)) {
+        // This is a csp or csr file that's not in a csp directory
+        return null;
+      }
+      name = getServerDocName(fileName, currentWorkspaceFolder(document));
+    } else {
+      name = fileName;
+    }
     // Need to strip leading / for custom Studio documents which should not be treated as files.
     // e.g. For a custom Studio document Test.ZPM, the variable name would be /Test.ZPM which is
     // not the document name. The document name is Test.ZPM so requests made to the Atelier APIs