Merge pull request #994 from gjsjohnmurray/pre-sync-post-1.8.3

Sync prerelease branch with everything added to master since 1.8.2 released

Author: gjsjohnmurray

.github/workflows/codeql-analysis.yml

@@ -39,7 +39,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -50,7 +50,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -64,4 +64,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

.github/workflows/main.yml

@@ -16,6 +16,11 @@ on:
   release:
     types:
       - released
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.base_ref || github.run_id }}
+  cancel-in-progress: false
+
 jobs:
   build:
     timeout-minutes: 10
@@ -182,7 +187,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
+        timeout-minutes: 5
         run: |
           [ -n "${{ secrets.OVSX_TOKEN }}" ] && \
             npx ovsx publish ${{ steps.set-version.outputs.name }}.vsix --pat ${{ secrets.OVSX_TOKEN }} || true

.vscodeignore

@@ -1,11 +1,16 @@
+# Run 'vsce ls' to verify that the following lines exclude everything not needed in the VSIX.
+
 **
-!dist/
+!dist/*.js
+!dist/*.txt
 !snippets/
 !images/
 !syntaxes/
 !webview/
 !CHANGELOG.md
 !LICENSE
 !README.md
-!*.json
+!package.json
+!package.nls.json
+!language-configuration.json
 !*.jsonc

docs/Configuration.md

@@ -137,19 +137,21 @@ First, configure one or more servers. You can use the plus sign (`+`) at the top
 
 Provide the following values when prompted:
 
-- **Name of new server definition** - an arbitrary name to identify this server.
-- **Description (optional)** - a brief description of the server.
-- **Hostname or IP address of web server** - the host for this server.
-- **Port of web server** - the WebServer port number for this server.
-- **Username** - the username to use in logging in to this server.
-- **Confirm connection type** - the protocol used for connections, possible values are **http** and **https**.
+- **Name of new server definition** - An arbitrary name to identify this server.
+- **Description (optional)** - A brief description of the server.
+- **Hostname or IP address of web server** - The host of the InterSystems server, or a standalone web server that publishes the web services of your target InterSystems server via the InterSystems Web Gateway.
+- **Port of web server** - The WebServer port number for this server's private web server, or the port number of the standalone web server.
+- **Username** - The username to use when logging in to this server.
+- **Confirm connection type** - The protocol used for connections. Possible values are **http** and **https**.
 
-Once you have entered these values, the server definition is stored in your user-level `settings.json` file, and the server appears at the top of the **Recent** folder in the InterSystems Tools view.
+Once you have entered these values the server definition is stored in your user-level `settings.json` file, and the server appears at the top of the **Recent** folder in the InterSystems Tools view.
 
 If you want to store a password for this server definition, select **Store Password in Keychain** from the context menu for the server in the InterSystems Tools view.  If you do not store a password, users are prompted for a password each time they connect to the server. To remove a password from the keychain, Select **Clear Password from Keychain** from the server context menu. For more information, see [Server Context Menu](../extensionui#server-context-menu).
 
 You can create a configuration for a server that is not currently running.
 
+If you are connecting via a standalone web server which bublishes services for more than one InterSystems server you will need to edit the server configuration in your `settings.json` file to add a `pathPrefix` property. See the next section.
+
 ## Editing a Server Configuration
 
 If you need to modify a server configuration select **File > Preferences > Settings** (**Code > Preferences > Settings** on Mac) from the menu. Select the **User** settings level. Find **Extensions** in the list in the left pane of the editor window, click to open, then select **InterSystems Server Manager** from the list to find the **InterSystems Server Manager** area of the edit pane, as illustrated in the following screen shot:
@@ -180,23 +182,24 @@ The server configuration in *settings.json* looks similar to the following, with
 ```
 The components of the server definition are as follows:
 
-- **iris-1** - An arbitrary name to identify this server
-- **webServer** - The collection of properties that define the web server
-- **scheme** - The protocol used for connections
-- **host** - the host for this server
-- **port** - the WebServer port number for this server
-- **username** - the username to use in logging in to this server
-- **password** - password for the specified username. Entering the password in this file is acceptable only in limited situations with very low need for security. 
+- **iris-1** - An arbitrary name to identify this server.
+- **webServer** - The collection of properties that define the web server through which you will connect. This can either be the InterSystems server's private web server or a standalone web server configured as an InterSystems Web Gateway.
+  - **scheme** - The protocol used for connections (http or https).
+  - **host** - The host of the web server.
+  - **port** - The port number for this web server.
+  - **pathPrefix** - Only required when connecting through a standalone web server that publishes the target server's web services under a subfolder.
+- **username** - The username to use in logging in to this server.
+- **password** - Password for the specified username. Entering the password as plaintext in this file is acceptable only in limited situations with very low need for security. 
 
-If you do not store the password securely in the system Keychain or add it to the server definition, anyone using the server needs to supply the password. The InterSystems Server Manager provides the following commands for managing stored passwords in the Command Palette:
+If you do not store the password securely in your workstation keychain or add it to the server definition, anyone using the server needs to supply the password. The InterSystems Server Manager provides the following commands for managing stored passwords in the Command Palette:
 
-- **InterSystems Server Manager: Clear Password from Keychain** - remove the password for a selected server
-- **InterSystems Server Manager: Store Password in Keychain** - select a server or create a new one and enter a password
+- **InterSystems Server Manager: Clear Password from Keychain** - Remove the password for a selected server.
+- **InterSystems Server Manager: Store Password in Keychain** - Select a server or create a new one, then enter a password.
 
 {: #config-server-conn}
 ## Configuring a Server Connection
 
-Open the folder where you want client-side files to be located. Select the **ObjectScript Explorer** button on the Activity Bar. Select the **Choose Server and Namespace** button. This action opens a dialog that lets you select a server, or create a new one. Once you have selected a server and namespace, connection configuration is complete. VS Code adds the server and namespace to the status bar, as shown in the following screen shot.
+Open the folder where you want client-side files to be located. Select the **ObjectScript Explorer** button on the Activity Bar. Select the **Choose Server and Namespace** button. This action opens a dialog that lets you select a server or create a new one. Once you have selected a server and namespace, connection configuration is complete. VS Code adds the server and namespace to the status bar, as shown in the following screen shot.
 
 ![Connection information in the status bar.](../assets/images/action-for-server-start.png "connection information in the status bar")
 
@@ -218,9 +221,9 @@ The connection configuration looks like this:
 
 The components of this configuration are:
 
-- **ns** - namespace to use on the server
-- **server** - server name as specified in the server configuration
-- **active** - specifies whether the connection is active.
+- **ns** - Namespace to use on the server
+- **server** - Server name as specified in the server configuration
+- **active** - Specifies whether the connection is active.
 
 {: #server-actions-menu}
 ## Add Custom Entries to the Server Actions Menu

docs/Gemfile.lock

@@ -14,7 +14,7 @@ GEM
       execjs
     coffee-script-source (1.11.1)
     colorator (1.1.0)
-    commonmarker (0.23.4)
+    commonmarker (0.23.6)
     concurrent-ruby (1.1.10)
     dnsruby (1.61.9)
       simpleidn (~> 0.1)

docs/RunDebug.md

@@ -113,3 +113,13 @@ When starting **objectscript launch** debug session, make sure that the file con
 This extension uses WebSockets to communicate with the InterSystems server during debugging. If you are experiencing issues when trying to start a debugging session, check that the InterSystems server's web server allows WebSocket connections.
 
 Debugging commands and items on the **Run** menu function much as they do for other languages supported by VS Code. For information on VS Code debugging, see the documentation resources listed at the start of this section. 
+
+## Troubleshooting Debugger Issues
+
+If you are experiencing issues using the debugger, please follow these steps before opening an issue on GitHub:
+
+1. Open a terminal on your server and `zn` to the namespace containing the class or routine you are debugging.
+2. Run the command `Kill ^IRIS.Temp.Atelier("debug")`, then `Set ^IRIS.Temp.Atelier("debug") = 1` to turn on the Atelier API debug logging feature. If you are on Caché or Ensemble, the global is `^CacheTemp.ISC.Atelier("debug")`.
+3. In VS Code, start a debugging session using the configuration that produces the error.
+4. Once the error appears, copy the contents of the `^IRIS.Temp.Atelier("debug")` global and add it to your GitHub issue.
+5. After you capture the log, run the command `Kill ^IRIS.Temp.Atelier("debug")`, then `Set ^IRIS.Temp.Atelier("debug") = 0` to turn logging back off again.

docs/SettingsReference.md

@@ -57,7 +57,7 @@ The extensions in the InterSystems ObjectScript Extension Pack provide many sett
 | `"objectscript.export.dontExportIfNoChanges"` | Do not rewrite the local file if the content is identical to what came from the server. | `boolean` | `false` | |
 | `"objectscript.export.exactFilter"` | SQL filter to limit what to export. | `string` | `""` | The filter is applied to document names using the [LIKE predicate](https://irisdocs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=RSQL_like) (i.e. `Name LIKE 'exactFilter'`). If provided, `objectscript.export.filter` is ignored. |
 | `"objectscript.export.filter"` | SQL filter to limit what to export. | `string` | `""` | The filter is applied to document names using the [LIKE predicate](https://irisdocs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=RSQL_like) (i.e. `Name LIKE '%filter%'`). |
-| `"objectscript.export.folder"` | Folder for exported source code within workspace. | `string` | `"src"` | |
+| `"objectscript.export.folder"` | Folder for exported source code within workspace. | `string` | `"src"` | This setting is relative to the workspace folder root. |
 | `"objectscript.export.generated"` | Export generated source code files, such as INTs generated from classes. | `boolean` | `false` | |
 | `"objectscript.export.map"` | Map file names before export, with regexp pattern as a key and replacement as a value. | `object` | `{}` | For example, `{  \"%(.*)\": \"_$1\" }` to make % classes or routines use underscore prefix instead. |
 | `"objectscript.export.mapped"` | Export source code files mapped from a non-default database. | `boolean` | `true` | |
@@ -66,6 +66,7 @@ The extensions in the InterSystems ObjectScript Extension Pack provide many sett
 | `"objectscript.format.commandCase"` | Case for commands. | `"upper"`, `"lower"` or `"word"` | `"word"` | Has no effect if the `InterSystems Language Server` extension is installed and enabled. |
 | `"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.importOnSave"` | Automatically save a client-side InterSystems file on the server when saved in the editor. | `boolean` | `true` | |
 | `"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 class member 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` | |

images/installation.gif

@@ -1104,7 +1104,7 @@
           },
           "properties": {
             "folder": {
-              "description": "Folder for exported source code within workspace.",
+              "description": "Folder for exported source code within workspace. This setting is relative to the workspace folder root.",
               "type": "string"
             },
             "addCategory": {
@@ -1247,7 +1247,12 @@
         "objectscript.debug.debugThisMethod": {
           "type": "boolean",
           "default": true,
-          "markdownDescription": "Show inline `Debug this method` CodeLens action for ClassMethods."
+          "markdownDescription": "Show inline `Debug Method` CodeLens action for ClassMethods and Routine Labels."
+        },
+        "objectscript.debug.copyToClipboard": {
+          "type": "boolean",
+          "default": true,
+          "markdownDescription": "Show inline `Copy Invocation` CodeLens action for ClassMethods and Routine Labels."
         },
         "objectscript.studioActionDebugOutput": {
           "type": "boolean",
@@ -1293,6 +1298,11 @@
             "type": "string",
             "pattern": "^[^.]+$"
           }
+        },
+        "objectscript.importOnSave": {
+          "description": "Automatically save a client-side InterSystems file on the server when saved in the editor.",
+          "type": "boolean",
+          "default": true
         }
       }
     },

package.json

@@ -1,4 +1,3 @@
-import fs = require("fs");
 import glob = require("glob");
 import path = require("path");
 import vscode = require("vscode");
@@ -55,14 +54,14 @@ export async function checkChangedOnServer(file: CurrentFile, force = false): Pr
     (await api
       .getDoc(file.name)
       .then((data) => data.result)
-      .then(({ ts, content }) => {
+      .then(async ({ ts, content }) => {
         const fileContent = file.content.split(/\r?\n/);
         const serverTime = Number(new Date(ts + "Z"));
         const sameContent = force
           ? false
           : content.every((line, index) => line.trim() == (fileContent[index] || "").trim());
         const mtime =
-          force || sameContent ? serverTime : Math.max(Number(fs.statSync(file.fileName).mtime), serverTime);
+          force || sameContent ? serverTime : Math.max((await vscode.workspace.fs.stat(file.uri)).mtime, serverTime);
         return mtime;
       })
       .catch(() => -1));
@@ -197,12 +196,12 @@ export async function loadChanges(files: CurrentFile[]): Promise<any> {
     files.map((file) =>
       api
         .getDoc(file.name)
-        .then((data) => {
+        .then(async (data) => {
           const content = (data.result.content || []).join(file.eol === vscode.EndOfLine.LF ? "\n" : "\r\n");
           const mtime = Number(new Date(data.result.ts + "Z"));
           workspaceState.update(`${file.uniqueId}:mtime`, mtime > 0 ? mtime : undefined);
           if (file.uri.scheme === "file") {
-            fs.writeFileSync(file.fileName, content);
+            await vscode.workspace.fs.writeFile(file.uri, new TextEncoder().encode(content));
           } else if (file.uri.scheme === FILESYSTEM_SCHEMA || file.uri.scheme === FILESYSTEM_READONLY_SCHEMA) {
             fileSystemProvider.fireFileChanged(file.uri);
           }
@@ -398,12 +397,13 @@ export async function namespaceCompile(askFlags = false): Promise<any> {
   );
 }
 
-function importFiles(files, noCompile = false) {
+function importFiles(files: string[], noCompile = false) {
   return Promise.all<CurrentFile>(
     files.map(
-      throttleRequests((file) =>
-        fs.promises
-          .readFile(file, { encoding: "utf8" })
+      throttleRequests((file: string) =>
+        vscode.workspace.fs
+          .readFile(vscode.Uri.file(file))
+          .then((contentBytes) => new TextDecoder().decode(contentBytes))
           .then((content) => currentFileFromContent(file, content))
           .then((curFile) =>
             importFile(curFile).then((data) => {
@@ -418,7 +418,7 @@ function importFiles(files, noCompile = false) {
 
 export async function importFolder(uri: vscode.Uri, noCompile = false): Promise<any> {
   const uripath = uri.fsPath;
-  if (fs.lstatSync(uripath).isFile()) {
+  if ((await vscode.workspace.fs.stat(uri)).type != vscode.FileType.Directory) {
     return importFiles([uripath], noCompile);
   }
   let globpattern = "*.{cls,inc,int,mac}";