Merge remote-tracking branch 'upstream/master' into pre-sync-1.4.3

Author: gjsjohnmurray

.github/workflows/main.yml

@@ -182,6 +182,7 @@ jobs:
           [ -n "${{ secrets.VSCE_TOKEN }}" ] && \
             npx vsce publish --packagePath ${{ steps.set-version.outputs.name }}.vsix -p ${{ secrets.VSCE_TOKEN }} || true
       - name: Publish to Open VSX Registry
+        timeout-minutes: 15
         run: |
           [ -n "${{ secrets.OVSX_TOKEN }}" ] && \
             npx ovsx publish ${{ steps.set-version.outputs.name }}.vsix --pat ${{ secrets.OVSX_TOKEN }} || true

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## [1.5.2022022801] 28-Feb-2022 pre-release
+Add 1.4.3 changes
+
 ## [1.5.2022022301] 23-Feb-2022 pre-release
 Add 1.4.2 changes
 
@@ -14,6 +17,11 @@ Add 1.4.1 changes
 
 ## [1.5.2022011401] 14-Jan-2022 pre-release
 Add 1.4.0 changes.
+## [1.4.3] 28-Feb-2022
+- Enhancements
+  - Add `objectscript.openClassContracted` setting (#876)
+- Fixes
+  - Fix 1.4.2 regression that broke server-side editing from ObjectScript Explorer and reloading of open documents when reopening isfs workspaces (#879)
 
 ## [1.4.2] 23-Feb-2022
 - Enhancements

README.md

@@ -62,8 +62,8 @@ To unlock these features (optional):
 
 1. Download and install a beta version from GitHub. This is necessary because Marketplace does not allow publication of extensions that use proposed APIs.
 	- Go to https://github.com/intersystems-community/vscode-objectscript/releases
-	- Locate the beta immediately above the release you installed from Marketplace. For instance, if you installed `1.4.2`, look for `1.4.3-beta.1`. This will be functionally identical to the Marketplace version apart from being able to use proposed APIs.
-	- Download the VSIX file (for example `vscode-objectscript-1.4.3-beta.1.vsix`) and install it. One way to install a VSIX is to drag it from your download folder and drop it onto the list of extensions in the Extensions view of VS Code.
+	- Locate the beta immediately above the release you installed from Marketplace. For instance, if you installed `1.4.3`, look for `1.4.4-beta.1`. This will be functionally identical to the Marketplace version apart from being able to use proposed APIs.
+	- Download the VSIX file (for example `vscode-objectscript-1.4.4-beta.1.vsix`) and install it. One way to install a VSIX is to drag it from your download folder and drop it onto the list of extensions in the Extensions view of VS Code.
 
 2. From [Command Palette](https://code.visualstudio.com/docs/getstarted/tips-and-tricks#_command-palette) choose `Preferences: Configure Runtime Arguments`.
 3. In the argv.json file that opens, add this line (required for both Stable and Insiders versions of VS Code):

docs/Gemfile.lock

@@ -221,17 +221,17 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.3.6)
-    mini_portile2 (2.6.1)
+    mini_portile2 (2.8.0)
     minima (2.5.1)
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
     minitest (5.14.4)
     multipart-post (2.1.1)
-    nokogiri (1.12.5)
-      mini_portile2 (~> 2.6.1)
+    nokogiri (1.13.3)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    nokogiri (1.12.5-x64-mingw32)
+    nokogiri (1.13.3-x64-mingw32)
       racc (~> 1.4)
     octokit (4.21.0)
       faraday (>= 0.9)

docs/SettingsReference.md

@@ -55,6 +55,7 @@ The extensions in the InterSystems ObjectScript Extension Pack provide many sett
 | `"objectscript.format.functionCase"` | Case for system functions and system variables. | `"upper"`, `"lower"` or `"word"` | `"word"` | Has no effect if the `InterSystems Language Server` extension is installed and enabled. |
 | `"objectscript.ignoreInstallServerManager"` | Do not offer to install the [intersystems-community.servermanager](https://marketplace.visualstudio.com/items?itemName=intersystems-community.servermanager) extension. | `boolean` | `false` | |
 | `"objectscript.multilineMethodArgs"` | List method arguments on multiple lines, if the server supports it. | `boolean` | `false` | Only supported on IRIS 2019.1.2, 2020.1.1+, 2021.1.0+ and subsequent versions! On all other versions, this setting will have no effect. |
+| `"objectscript.openClassContracted"` | Automatically collapse all folding ranges when a class is opened for the first time. | `boolean` | `false` | |
 | `"objectscript.overwriteServerChanges"` | Overwrite a changed server version without confirmation when importing the local file. | `boolean` | `false` | |
 | `"objectscript.serverSideEditing"` | Allow editing code directly on the server after opening it from ObjectScript Explorer. | `boolean` | `false` | |
 | `"objectscript.serverSourceControl.disableOtherActionTriggers"` | Prevent server-side source control 'other action' triggers from firing. | `boolean` | `false` | |

package.json

@@ -1066,6 +1066,11 @@
           "markdownDescription": "List method arguments on multiple lines, if the server supports it. **NOTE:** Only supported on IRIS 2019.1.2, 2020.1.1+, 2021.1.0+ and subsequent versions! On all other versions, this setting will have no effect.",
           "type": "boolean",
           "default": false
+        },
+        "objectscript.openClassContracted": {
+          "description": "Automatically collapse all folding ranges when a class is opened for the first time.",
+          "type": "boolean",
+          "default": false
         }
       }
     },

src/extension.ts

@@ -467,6 +467,9 @@ function languageServer(install = true): vscode.Extension<any> {
   return extension;
 }
 
+// The URIs of all classes that have been opened. Used when objectscript.openClassContracted is true.
+let openedClasses: string[];
+
 export async function activate(context: vscode.ExtensionContext): Promise<any> {
   if (!packageJson.version.includes("SNAPSHOT")) {
     try {
@@ -756,6 +759,8 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
     }
   }
 
+  openedClasses = workspaceState.get("openedClasses") ?? [];
+
   context.subscriptions.push(
     reporter,
     panel,
@@ -986,6 +991,25 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
           })
       )
     ),
+    vscode.window.onDidChangeActiveTextEditor((editor: vscode.TextEditor) => {
+      const uri: string = editor.document.uri.toString();
+      if (
+        config("openClassContracted") &&
+        editor &&
+        editor.document.languageId === "objectscript-class" &&
+        !openedClasses.includes(uri)
+      ) {
+        vscode.commands.executeCommand("editor.foldAll");
+        openedClasses.push(uri);
+      }
+    }),
+    vscode.workspace.onDidCloseTextDocument((doc: vscode.TextDocument) => {
+      const uri: string = doc.uri.toString();
+      const idx: number = openedClasses.indexOf(uri);
+      if (idx > -1) {
+        openedClasses.splice(idx, 1);
+      }
+    }),
 
     /* Anything we use from the VS Code proposed API */
     ...proposed
@@ -1059,6 +1083,9 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
 }
 
 export function deactivate(): void {
+  if (workspaceState) {
+    workspaceState.update("openedClasses", openedClasses);
+  }
   // This will ensure all pending events get flushed
   reporter && reporter.dispose();
   if (terminals) {

src/providers/FileSystemProvider/FileSystemProvider.ts

@@ -183,7 +183,7 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
   public async readFile(uri: vscode.Uri): Promise<Uint8Array> {
     // Use _lookup() instead of _lookupAsFile() so we send
     // our cached mtime with the GET /doc request if we have it
-    return this._lookup(uri).then((file: File) => {
+    return this._lookup(uri, true).then((file: File) => {
       // Update cache entry
       const uniqueId = `${workspaceFolderOfUri(uri)}:${file.fileName}`;
       workspaceState.update(`${uniqueId}:mtime`, file.mtime);
@@ -336,7 +336,7 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
   }
 
   // Fetch entry (a file or directory) from cache, else from server
-  private async _lookup(uri: vscode.Uri): Promise<Entry> {
+  private async _lookup(uri: vscode.Uri, fillInPath?: boolean): Promise<Entry> {
     const api = new AtelierAPI(uri);
     if (uri.path === "/") {
       await api
@@ -363,9 +363,18 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
       if (entry instanceof Directory) {
         child = entry.entries.get(part);
         // If the last element of path is dotted and is one we haven't already cached as a directory
-        // then it is assumed to be a file.
+        // then it is assumed to be a file. Treat all other cases as a directory we haven't yet explored.
         if (!child && (!part.includes(".") || i + 1 < parts.length)) {
-          throw vscode.FileSystemError.FileNotFound(uri);
+          if (!fillInPath) {
+            throw vscode.FileSystemError.FileNotFound(uri);
+          }
+          // Caller granted us permission to create structures for intermediate directories not yet seen.
+          // This arises when ObjectScript Explorer uses isfs to enable server-side editing, and when reloading a workspace
+          // in which isfs documents were previously open.
+          // See https://github.com/intersystems-community/vscode-objectscript/issues/879
+          const fullName = entry.name === "" ? part : entry.fullName + "/" + part;
+          child = new Directory(part, fullName);
+          entry.entries.set(part, child);
         }
       }
       if (!child) {
@@ -389,7 +398,7 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
     if (uri.path.startsWith("/node_modules")) {
       throw vscode.FileSystemError.FileNotADirectory(uri);
     }
-    const entry = await this._lookup(uri);
+    const entry = await this._lookup(uri, true);
     if (entry instanceof Directory) {
       return entry;
     }