Deprecate flat and type isfs query parameters (intersystems-community#1165)

Author: isc-bsaviano

docs/ServerSide.md

@@ -36,13 +36,13 @@ Next create a workspace for editing code directly on the server:
    ![Choose files.](../assets/images/ss-files.png "choose files")
   - If you chose to show web application files, pick an optional web application to show files from:
 
-   ![Choose files.](../assets/images/ss-pick-webapp.png "choose files")
+   ![Choose web app.](../assets/images/ss-pick-webapp.png "choose web app")
   - If you chose to show a project's contents, pick the project:
 
-   ![Choose files.](../assets/images/ss-pick-project.png "choose files")
+   ![Choose project.](../assets/images/ss-pick-project.png "choose project")
   - If you create your own filter, pick the filter options:
 
-   ![Choose query parameters.](../assets/images/ss-query-params.png "choose query parameters")
+   ![Choose filter options.](../assets/images/ss-query-params.png "choose filter options")
 1. If you want to reopen this workspace in the future, use the command **File > Save Workspace As...** to save it as a `.code-workspace` file.
 
 Note that the ObjectScript Explorer view is not visible in the ObjectScript view container. Because the files listed in the Explorer view are all on the server, the ObjectScript Explorer is not needed for this configuration.
@@ -147,15 +147,12 @@ Changes you make to files opened from this root folder of your VS Code workspace
 
 The query string of the `uri` property accepts several parameters that control filtering and display of the server-side entities. The examples below access the USER namespace on the server whose definition is named 'myserver'.
 
-- `isfs://myserver:user/?type=cls`, shows only classes
-- `isfs://myserver:user/?type=rtn`, shows only mac, int and inc files
 - `isfs://myserver:user/?generated=1`, shows generated files as well as not generated
-- `isfs://myserver:user/?filter=%Z*.mac,%z*.mac`, comma-delimited list of search options, ignores `type`. The default is `*.cls,*.inc,*.mac,*.int`. To see all files, use `*`.
-- `isfs://myserver:user/?flat=1`, a flat list of files. Does not split packages as folders. Cannot be combined with `csp`.
+- `isfs://myserver:user/?filter=%Z*.mac,%z*.mac`, comma-delimited list of search options. The default is `*.cls,*.inc,*.mac,*.int`. To see all files, use `*`.
 - `isfs://myserver:user/?project=prjname`, shows only files in project `prjname`. Cannot be combined with any other parameter.
 - `isfs://myserver:user/?mapped=0`, hides files that are mapped from a non-default database
 
-The options `flat`, `generated` and `mapped` can be combined with each other, and with `type` or `filter`. If `filter` is specified, `type` is ignored.
+The options `generated` and `mapped` can be combined with each other, and with `filter`.
 
 To modify the query parameters or name of an existing workspace folder, run the `Modify Server-Side Workspace Folder...` command from the command palette or the file explorer context menu.
 

docs/assets/images/ss-query-params.png

@@ -284,12 +284,6 @@ async function modifyWsFolderUri(uri: vscode.Uri): Promise<vscode.Uri | undefine
         picked: params.has("filter"),
         value: "filter",
       },
-      {
-        label: "$(list-flat) Flat Files",
-        detail: "Show a flat list of files. Do not treat packages as folders.",
-        picked: params.has("flat"),
-        value: "flat",
-      },
       {
         label: "$(server-process) Show Generated",
         detail: "Also show files tagged as generated, e.g. by compilation.",
@@ -328,6 +322,7 @@ async function modifyWsFolderUri(uri: vscode.Uri): Promise<vscode.Uri | undefine
     params.delete("generated");
     params.delete("mapped");
     params.delete("system");
+    params.delete("type");
     for (const otherParam of otherParams) {
       switch (otherParam.value) {
         case "filter": {
@@ -345,7 +340,6 @@ async function modifyWsFolderUri(uri: vscode.Uri): Promise<vscode.Uri | undefine
           }
           break;
         }
-        case "flat":
         case "generated":
         case "system":
           params.set(otherParam.value, "1");

src/commands/addServerNamespaceToWorkspace.ts

@@ -1333,6 +1333,25 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
   );
   reporter && reporter.sendTelemetryEvent("extensionActivated");
 
+  // Report the use of deprecated query parameters
+  (vscode.workspace.workspaceFolders || []).forEach(async (wf) => {
+    if (filesystemSchemas.includes(wf.uri.scheme)) {
+      const params = new URLSearchParams(wf.uri.query);
+      if (params.has("flat") || params.has("type")) {
+        const qp = params.has("flat") ? "flat" : "type";
+        await vscode.window
+          .showWarningMessage(
+            `Workspace folder '${wf.name}' is using deprecated query parameter '${qp}'. Modify it now?`,
+            "Yes",
+            "No"
+          )
+          .then(
+            (answer) => answer == "Yes" && vscode.commands.executeCommand("vscode-objectscript.modifyWsFolder", wf.uri)
+          );
+      }
+    }
+  });
+
   // The API we export
   const extensionApi = {
     serverForUri(uri: vscode.Uri): any {

src/extension.ts

@@ -96,17 +96,10 @@ export async function projectContentsFromUri(uri: vscode.Uri, overrideFlat?: boo
   return api.actionQuery(query, parameters).then((data) => data.result.content);
 }
 
-export function fileSpecFromURI(uri: vscode.Uri, overrideType?: string): string {
+export function fileSpecFromURI(uri: vscode.Uri): string {
   const params = new URLSearchParams(uri.query);
   const csp = params.has("csp") && ["", "1"].includes(params.get("csp"));
-  const type =
-    overrideType && overrideType != ""
-      ? overrideType
-      : params.has("type") && params.get("type").length
-      ? params.get("type")
-      : csp
-      ? "csp"
-      : "all";
+  const type = params.has("type") && params.get("type").length ? params.get("type") : csp ? "csp" : "all";
 
   const folder = !csp
     ? uri.path.replace(/\//g, ".")
@@ -141,7 +134,7 @@ export function fileSpecFromURI(uri: vscode.Uri, overrideType?: string): string
 
 export function studioOpenDialogFromURI(
   uri: vscode.Uri,
-  overrides: { flat?: boolean; filter?: string; type?: string } = { flat: false, filter: "", type: "" }
+  overrides: { flat?: boolean; filter?: string } = { flat: false, filter: "" }
 ): Promise<any> {
   const api = new AtelierAPI(uri);
   if (!api.active) {
@@ -150,7 +143,7 @@ export function studioOpenDialogFromURI(
   const sql = `SELECT Name, Type FROM %Library.RoutineMgr_StudioOpenDialog(?,?,?,?,?,?,?,?,?,?)`;
   const params = new URLSearchParams(uri.query);
   const csp = params.has("csp") && ["", "1"].includes(params.get("csp"));
-  const spec = fileSpecFromURI(uri, overrides.type);
+  const spec = fileSpecFromURI(uri);
   const notStudio = "0";
   const dir = "1";
   const orderBy = "1";