Server-side source control improvements

package.json

@@ -201,15 +201,15 @@
         },
         {
           "command": "vscode-objectscript.serverCommands.sourceControl",
-          "when": "vscode-objectscript.connectActive && resourceScheme == isfs || vscode-objectscript.connectActive && !editorIsOpen"
+          "when": "vscode-objectscript.connectActive && resourceScheme == isfs || (vscode-objectscript.connectActive && !editorIsOpen)"
         },
         {
           "command": "vscode-objectscript.serverCommands.contextSourceControl",
           "when": "false"
         },
         {
           "command": "vscode-objectscript.serverCommands.other",
-          "when": "vscode-objectscript.connectActive && resourceScheme =~ /^isfs(-readonly)?$/ || vscode-objectscript.connectActive && !editorIsOpen"
+          "when": "vscode-objectscript.connectActive && resourceScheme =~ /^isfs(-readonly)?$/ || (vscode-objectscript.connectActive && !editorIsOpen)"
         },
         {
           "command": "vscode-objectscript.serverCommands.contextOther",
@@ -575,12 +575,12 @@
         },
         {
           "command": "vscode-objectscript.serverCommands.contextSourceControl",
-          "when": "resourceScheme == isfs && vscode-objectscript.connectActive",
+          "when": "resourceScheme == isfs && vscode-objectscript.connectActive && resourcePath && !(resourcePath =~ /^\\/?$/) && !(explorerResourceIsFolder && resource =~ /\\?csp(%3D1|$)/)",
           "group": "objectscript_servercommand@1"
         },
         {
           "command": "vscode-objectscript.serverCommands.contextOther",
-          "when": "resourceScheme =~ /^isfs(-readonly)?$/ && vscode-objectscript.connectActive",
+          "when": "resourceScheme =~ /^isfs(-readonly)?$/ && vscode-objectscript.connectActive && resourcePath && !(resourcePath =~ /^\\/?$/) && !(explorerResourceIsFolder && resource =~ /\\?csp(%3D1|$)/)",
           "group": "objectscript_servercommand@2"
         },
         {

src/api/atelier.d.ts

@@ -24,6 +24,15 @@ interface ServerInfoFeature {
   enabled: string;
 }
 
+export interface UserAction {
+  action: number;
+  target: string;
+  message: string;
+  reload: boolean;
+  doc: any;
+  errorText: string;
+}
+
 export interface Document {
   name: string;
   db: string;
@@ -34,7 +43,7 @@ export interface Document {
   enc: boolean;
   flags: number;
   content: string[] | Buffer;
-  ext: string;
+  ext?: UserAction | UserAction[];
 }
 
 export interface ServerInfo {

src/commands/delete.ts

@@ -8,6 +8,7 @@ import { explorerProvider } from "../extension";
 import { outputChannel } from "../utils";
 import { OtherStudioAction, fireOtherStudioAction } from "./studio";
 import { DocumentContentProvider } from "../providers/DocumentContentProvider";
+import { UserAction } from "../api/atelier";
 
 function deleteList(items: string[], workspaceFolder: string, namespace: string): Promise<any> {
   if (!items || !items.length) {
@@ -20,7 +21,7 @@ function deleteList(items: string[], workspaceFolder: string, namespace: string)
     files.forEach((file) => {
       if (file.result.ext) {
         const uri = DocumentContentProvider.getUri(file.result.name);
-        fireOtherStudioAction(OtherStudioAction.DeletedDocument, uri, file.result.ext);
+        fireOtherStudioAction(OtherStudioAction.DeletedDocument, uri, <UserAction>file.result.ext);
       }
     });
     outputChannel.appendLine(`Deleted items: ${files.filter((el) => el.result).length}`);

src/commands/project.ts

@@ -12,6 +12,7 @@ import { isCSPFile } from "../providers/FileSystemProvider/FileSystemProvider";
 import { notNull, outputChannel } from "../utils";
 import { pickServerAndNamespace } from "./addServerNamespaceToWorkspace";
 import { exportList } from "./export";
+import { OtherStudioAction, StudioActions } from "./studio";
 
 export interface ProjectItem {
   Name: string;
@@ -137,6 +138,21 @@ export async function createProject(node: NodeBase | undefined, api?: AtelierAPI
         return;
       }
 
+      // Technically a project is a "document", so tell the server that we created it
+      try {
+        const studioActions = new StudioActions();
+        await studioActions.fireProjectUserAction(api, name, OtherStudioAction.CreatedNewDocument);
+        await studioActions.fireProjectUserAction(api, name, OtherStudioAction.FirstTimeDocumentSave);
+      } catch (error) {
+        let message = `Source control actions failed for project '${name}'.`;
+        if (error && error.errorText && error.errorText !== "") {
+          outputChannel.appendLine("\n" + error.errorText);
+          outputChannel.show(true);
+          message += " Check 'ObjectScript' output channel for details.";
+        }
+        vscode.window.showErrorMessage(message, "Dismiss");
+      }
+
       // Refresh the explorer
       projectsExplorerProvider.refresh();
 
@@ -179,6 +195,19 @@ export async function deleteProject(node: ProjectNode | undefined): Promise<any>
     return vscode.window.showErrorMessage(message, "Dismiss");
   }
 
+  // Technically a project is a "document", so tell the server that we deleted it
+  try {
+    await new StudioActions().fireProjectUserAction(api, project, OtherStudioAction.DeletedDocument);
+  } catch (error) {
+    let message = `'DeletedDocument' source control action failed for project '${project}'.`;
+    if (error && error.errorText && error.errorText !== "") {
+      outputChannel.appendLine("\n" + error.errorText);
+      outputChannel.show(true);
+      message += " Check 'ObjectScript' output channel for details.";
+    }
+    vscode.window.showErrorMessage(message, "Dismiss");
+  }
+
   // Refresh the explorer
   projectsExplorerProvider.refresh();
 
@@ -706,6 +735,12 @@ export async function modifyProject(
       return;
     }
   }
+
+  // Technically a project is a "document", so tell the server that we're opening it
+  await new StudioActions().fireProjectUserAction(api, project, OtherStudioAction.OpenedDocument).catch(() => {
+    // Swallow error because showing it is more disruptive than using a potentially outdated project definition
+  });
+
   let items: ProjectItem[] = await api
     .actionQuery("SELECT Name, Type FROM %Studio.Project_ProjectItemsList(?,?) WHERE Type != 'GBL'", [project, "1"])
     .then((data) => data.result.content);
@@ -862,6 +897,23 @@ export async function modifyProject(
   }
 
   try {
+    if (add.length || remove.length) {
+      // Technically a project is a "document", so tell the server that we're editing it
+      const studioActions = new StudioActions();
+      await studioActions.fireProjectUserAction(api, project, OtherStudioAction.AttemptedEdit);
+      if (studioActions.projectEditAnswer != "1") {
+        // Don't perform the edit
+        if (studioActions.projectEditAnswer == "-1") {
+          // Source control action failed
+          vscode.window.showErrorMessage(
+            `'AttemptedEdit' source control action failed for project '${project}'. Check the 'ObjectScript' Output channel for details.`,
+            "Dismiss"
+          );
+        }
+        return;
+      }
+    }
+
     if (remove.length) {
       // Delete the obsolete items
       await api.actionQuery(
@@ -900,7 +952,7 @@ export async function modifyProject(
 
     // Refresh the files explorer if there's an isfs folder for this project
     if (node == undefined && isfsFolderForProject(project, node ?? api.configName) != -1) {
-      await vscode.commands.executeCommand("workbench.files.action.refreshFilesExplorer");
+      vscode.commands.executeCommand("workbench.files.action.refreshFilesExplorer");
     }
   }
 }
@@ -1070,6 +1122,21 @@ export async function addIsfsFileToProject(
 
   try {
     if (add.length) {
+      // Technically a project is a "document", so tell the server that we're editing it
+      const studioActions = new StudioActions();
+      await studioActions.fireProjectUserAction(api, project, OtherStudioAction.AttemptedEdit);
+      if (studioActions.projectEditAnswer != "1") {
+        // Don't perform the edit
+        if (studioActions.projectEditAnswer == "-1") {
+          // Source control action failed
+          vscode.window.showErrorMessage(
+            `'AttemptedEdit' source control action failed for project '${project}'. Check the 'ObjectScript' Output channel for details.`,
+            "Dismiss"
+          );
+        }
+        return;
+      }
+
       // Add any new items
       await api.actionQuery(
         `INSERT INTO %Studio.ProjectItem (Project,Name,Type) SELECT * FROM (${add

src/commands/studio.ts

@@ -6,10 +6,10 @@ import { DocumentContentProvider } from "../providers/DocumentContentProvider";
 import { ClassNode } from "../explorer/models/classNode";
 import { PackageNode } from "../explorer/models/packageNode";
 import { RoutineNode } from "../explorer/models/routineNode";
-import { NodeBase } from "../explorer/models/nodeBase";
 import { importAndCompile } from "./compile";
 import { ProjectNode } from "../explorer/models/projectNode";
 import { openCustomEditors } from "../providers/RuleEditorProvider";
+import { UserAction } from "../api/atelier";
 
 export let documentBeingProcessed: vscode.TextDocument = null;
 
@@ -72,18 +72,17 @@ export class StudioActions {
   private uri: vscode.Uri;
   private api: AtelierAPI;
   private name: string;
+  public projectEditAnswer?: string;
 
   public constructor(uriOrNode?: vscode.Uri | PackageNode | ClassNode | RoutineNode) {
     if (uriOrNode instanceof vscode.Uri) {
-      const uri: vscode.Uri = uriOrNode;
-      this.uri = uri;
-      this.name = getServerName(uri);
-      this.api = new AtelierAPI(uri);
+      this.uri = uriOrNode;
+      this.name = getServerName(uriOrNode);
+      this.api = new AtelierAPI(uriOrNode);
     } else if (uriOrNode) {
-      const node: NodeBase = uriOrNode;
-      this.api = new AtelierAPI(node.workspaceFolder);
-      this.api.setNamespace(node.namespace);
-      this.name = node instanceof PackageNode ? node.fullName + ".PKG" : node.fullName;
+      this.api = new AtelierAPI(uriOrNode.workspaceFolderUri || uriOrNode.workspaceFolder);
+      this.api.setNamespace(uriOrNode.namespace);
+      this.name = uriOrNode instanceof PackageNode ? uriOrNode.fullName + ".PKG" : uriOrNode.fullName;
     } else {
       this.api = new AtelierAPI();
     }
@@ -105,9 +104,24 @@ export class StudioActions {
     );
   }
 
-  // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-  public processUserAction(userAction): Thenable<any> {
-    const serverAction = parseInt(userAction.action || 0, 10);
+  /** Fire UserAction `id` on server `api` for project `name`. */
+  public async fireProjectUserAction(api: AtelierAPI, name: string, id: OtherStudioAction): Promise<void> {
+    this.api = api;
+    this.name = `${name}.PRJ`;
+    return this.userAction(
+      {
+        id: id.toString(),
+        label: getOtherStudioActionLabel(id),
+      },
+      false,
+      "",
+      "",
+      1
+    );
+  }
+
+  public processUserAction(userAction: UserAction): Thenable<any> {
+    const serverAction = userAction.action;
     const { target, errorText } = userAction;
     if (errorText !== "") {
       outputChannel.appendLine(errorText);
@@ -281,14 +295,18 @@ export class StudioActions {
       ? [type.toString(), action.id, this.name, answer, msg]
       : [type.toString(), action.id, this.name, selectedText];
 
+    if (config().studioActionDebugOutput) {
+      outputChannel.appendLine(`${query.slice(0, query.indexOf("("))}(${JSON.stringify(parameters).slice(1, -1)})`);
+    }
+
     return vscode.window.withProgress(
       {
         cancellable: false,
-        location: vscode.ProgressLocation.Notification,
-        title: `Executing ${afterUserAction ? "AfterUserAction" : "UserAction"}: ${action.label}`,
+        location: vscode.ProgressLocation.Window,
+        title: `Executing ${afterUserAction ? "After" : ""}UserAction: ${action.label}`,
       },
-      () => {
-        return new Promise((resolve, reject) => {
+      () =>
+        new Promise((resolve, reject) => {
           this.api
             .actionQuery(query, parameters)
             .then(async (data) => {
@@ -299,37 +317,46 @@ export class StudioActions {
                 outputConsole(data.console);
               }
               if (!data.result.content.length) {
-                // nothing to-do, just ignore it
+                // Nothing to do. Most likely no source control class is enabled.
+                this.projectEditAnswer = "1";
                 return;
               }
-              const actionToProcess = data.result.content.pop();
+              const actionToProcess: UserAction = data.result.content.pop();
 
               if (actionToProcess.reload) {
                 // Avoid the reload triggering the edit listener here
                 suppressEditListenerMap.set(this.uri.toString(), true);
                 await vscode.commands.executeCommand("workbench.action.files.revert", this.uri);
               }
 
-              // CSP pages should not have a progress bar
-              if (actionToProcess.action === 2) {
-                resolve();
-              }
-
               const attemptedEditLabel = getOtherStudioActionLabel(OtherStudioAction.AttemptedEdit);
               if (afterUserAction && actionToProcess.errorText !== "") {
                 if (action.label === attemptedEditLabel) {
-                  suppressEditListenerMap.set(this.uri.toString(), true);
-                  await vscode.commands.executeCommand("workbench.action.files.revert", this.uri);
+                  if (this.name.toUpperCase().endsWith(".PRJ")) {
+                    // Store the "answer" so the caller knows there was an error
+                    this.projectEditAnswer = "-1";
+                  } else if (this.uri) {
+                    // Only revert if we have a URI
+                    suppressEditListenerMap.set(this.uri.toString(), true);
+                    await vscode.commands.executeCommand("workbench.action.files.revert", this.uri);
+                  }
                 }
                 outputChannel.appendLine(actionToProcess.errorText);
-                outputChannel.show();
+                outputChannel.show(true);
               }
               if (actionToProcess && !afterUserAction) {
                 const answer = await this.processUserAction(actionToProcess);
                 // call AfterUserAction only if there is a valid answer
-                if (action.label === attemptedEditLabel && answer !== "1") {
-                  suppressEditListenerMap.set(this.uri.toString(), true);
-                  await vscode.commands.executeCommand("workbench.action.files.revert", this.uri);
+                if (action.label === attemptedEditLabel) {
+                  if (answer != "1" && this.uri) {
+                    // Only revert if we have a URI
+                    suppressEditListenerMap.set(this.uri.toString(), true);
+                    await vscode.commands.executeCommand("workbench.action.files.revert", this.uri);
+                  }
+                  if (this.name.toUpperCase().endsWith(".PRJ")) {
+                    // Store the answer. No answer means "allow the edit".
+                    this.projectEditAnswer = answer ?? "1";
+                  }
                 }
                 if (answer) {
                   answer.msg || answer.msg === ""
@@ -350,11 +377,10 @@ export class StudioActions {
               if (err.errorText && err.errorText !== "") {
                 outputChannel.appendLine("\n" + err.errorText);
               }
-              outputChannel.show();
+              outputChannel.show(true);
               reject();
             });
-        });
-      }
+        })
     );
   }
 
@@ -411,8 +437,7 @@ export class StudioActions {
       .then((action) => this.userAction(action));
   }
 
-  // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-  public fireOtherStudioAction(action: OtherStudioAction, userAction?): void {
+  public fireOtherStudioAction(action: OtherStudioAction, userAction?: UserAction): void {
     const actionObject = {
       id: action.toString(),
       label: getOtherStudioActionLabel(action),
@@ -474,7 +499,8 @@ export class StudioActions {
     return this.api
       .actionQuery("SELECT %Atelier_v1_Utils.Extension_ExtensionEnabled() AS Enabled", [])
       .then((data) => data.result.content)
-      .then((content) => (content && content.length ? content[0].Enabled : false));
+      .then((content) => (content && content.length ? content[0]?.Enabled ?? false : false))
+      .catch(() => false); // Treat any errors as "no source control"
   }
 
   public getServerInfo(): { server: string; namespace: string } {
@@ -541,15 +567,17 @@ export async function _contextMenu(sourceControl: boolean, node: PackageNode | C
   }
 }
 
-// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-export async function fireOtherStudioAction(action: OtherStudioAction, uri?: vscode.Uri, userAction?): Promise<void> {
+export async function fireOtherStudioAction(
+  action: OtherStudioAction,
+  uri?: vscode.Uri,
+  userAction?: UserAction
+): Promise<void> {
   if (vscode.workspace.getConfiguration("objectscript.serverSourceControl", uri)?.get("disableOtherActionTriggers")) {
     return;
   }
   const studioActions = new StudioActions(uri);
   return (
     studioActions &&
-    (await studioActions.isSourceControlEnabled()) &&
     !openCustomEditors.includes(uri?.toString()) && // The custom editor will handle all server-side source control interactions
     studioActions.fireOtherStudioAction(action, userAction)
   );