Update Zowe deps to fix handling of invalid ds member names

package.json

@@ -16,7 +16,7 @@
     "vscode": "^1.53.2"
   },
   "dependencies": {
-    "@zowe/cli": "7.23.6",
+    "@zowe/cli": "7.24.0",
     "vscode-nls": "4.1.2"
   },
   "devDependencies": {

packages/zowe-explorer-api/package.json

@@ -18,7 +18,7 @@
   },
   "dependencies": {
     "@types/vscode": "^1.53.2",
-    "@zowe/cli": "7.23.6",
+    "@zowe/cli": "7.24.0",
     "@zowe/secrets-for-zowe-sdk": "7.18.6",
     "handlebars": "^4.7.7",
     "semver": "^7.5.3"

packages/zowe-explorer-ftp-extension/webpack.config.js

@@ -82,6 +82,11 @@ const config = {
                     },
                 ],
             },
+            {
+                test: /\.mjs$/,
+                include: /markdown-it/,
+                type: "javascript/auto",
+            },
         ],
     },
     plugins: [new webpack.BannerPlugin(fs.readFileSync("../../scripts/LICENSE_HEADER", "utf-8"))],

packages/zowe-explorer/CHANGELOG.md

@@ -8,9 +8,9 @@ All notable changes to the "vscode-extension-for-zowe" extension will be documen
 
 ### Bug fixes
 
-## `2.15.2`
+- Fixed error that could occur when listing data set members that contain control characters in the name [#2807](https://github.com/zowe/zowe-explorer-vscode/pull/2807)
 
-### New features and enhancements
+## `2.15.2`
 
 ### Bug fixes
 
@@ -19,8 +19,6 @@ All notable changes to the "vscode-extension-for-zowe" extension will be documen
 
 ## `2.15.1`
 
-### New features and enhancements
-
 ### Bug fixes
 
 - Fixed issue where VS Code quick pick separators were used in environments that did not support the feature. [#2771](https://github.com/zowe/vscode-extension-for-zowe/pull/2771)

packages/zowe-explorer/__tests__/__unit__/ZoweNode.unit.test.ts

@@ -423,16 +423,17 @@ describe("Unit Tests (Jest)", () => {
             return {
                 success: true,
                 apiResponse: {
-                    items: [{ member: "BADMEM\ufffd" }, { member: "GOODMEM1" }],
+                    items: [{ member: "MEMBER1" }],
+                    returnedRows: 3,
                 },
             };
         });
         Object.defineProperty(List, "allMembers", { value: allMembers });
         const pdsChildren = await pds.getChildren();
-        expect(pdsChildren[0].label).toEqual("BADMEM\ufffd");
-        expect(pdsChildren[0].contextValue).toEqual(globals.DS_FILE_ERROR_CONTEXT);
-        expect(pdsChildren[1].label).toEqual("GOODMEM1");
-        expect(pdsChildren[1].contextValue).toEqual(globals.DS_MEMBER_CONTEXT);
+        expect(pdsChildren[0].label).toEqual("MEMBER1");
+        expect(pdsChildren[0].contextValue).toEqual(globals.DS_MEMBER_CONTEXT);
+        expect(pdsChildren[1].label).toEqual("2 members with errors");
+        expect(pdsChildren[1].contextValue).toEqual(globals.DS_FILE_ERROR_MEMBER_CONTEXT);
         getSessionNodeSpy.mockRestore();
     });
 

packages/zowe-explorer/__tests__/__unit__/dataset/DatasetTree.unit.test.ts

@@ -439,6 +439,7 @@ describe("Dataset Tree Unit Tests - Function getChildren", () => {
         });
         const sampleChildren: ZoweDatasetNode[] = [nodeOk, nodeImpError, nodeMigrated];
         sampleChildren[0].command = { command: "zowe.ds.ZoweNode.openPS", title: "", arguments: [sampleChildren[0]] };
+        sampleChildren[1].command = { command: "zowe.placeholderCommand", title: "" };
 
         const children = await testTree.getChildren(testTree.mSessionNodes[1]);
         expect(children.map((c) => c.label)).toEqual(sampleChildren.map((c) => c.label));

packages/zowe-explorer/__tests__/__unit__/extension.unit.test.ts

@@ -259,6 +259,7 @@ async function createGlobalMocks() {
             "zowe.jobs.deleteProfile",
             "zowe.issueTsoCmd",
             "zowe.issueMvsCmd",
+            "zowe.placeholderCommand",
         ],
     };
 

packages/zowe-explorer/i18n/sample/src/dataset/ZoweDatasetNode.i18n.json

@@ -2,7 +2,7 @@
   "getChildren.search": "Use the search button to display data sets",
   "getChildren.error.invalidNode": "Invalid node",
   "getChildren.responses.error": "The response from Zowe CLI was not successful",
-  "getChildren.invalidMember": "Cannot access member with control characters in the name: {0}",
+  "getChildren.invalidMember": "{0} members failed to load due to invalid name errors for {1}",
   "getChildren.noDataset": "No data sets found",
   "getDataSets.error.sessionMissing": "Profile auth error",
   "getDataSets.error.additionalDetails": "Profile is not authenticated, please log in to continue",

packages/zowe-explorer/package.json

@@ -820,6 +820,11 @@
         "command": "zowe.uss.openWithEncoding",
         "title": "%openWithEncoding%",
         "category": "Zowe Explorer"
+      },
+      {
+        "command": "zowe.placeholderCommand",
+        "title": "%zowe.placeholderCommand%",
+        "enablement": "false"
       }
     ],
     "menus": {

packages/zowe-explorer/src/dataset/ZoweDatasetNode.ts

@@ -135,7 +135,7 @@
      *
      * @returns {Promise<ZoweDatasetNode[]>}
      */
     public async getChildren(): Promise<ZoweDatasetNode[]> {
         ZoweLogger.trace("ZoweDatasetNode.getChildren called.");
         if (!this.pattern && contextually.isSessionNotFav(this)) {
             return [
@@ -201,6 +201,7 @@
                         contextOverride: globals.DS_FILE_ERROR_CONTEXT,
                         profile: this.getProfile(),
                     });
+                    temp.command = { command: "zowe.placeholderCommand", title: "" };
                     temp.errorDetails = item.error; // Save imperative error to avoid extra z/OS requests
                     elementChildren[temp.label.toString()] = temp;
                     // Creates a ZoweDatasetNode for a migrated dataset
@@ -246,29 +247,46 @@
                     elementChildren[temp.label.toString()] = temp;
                 } else {
                     // Creates a ZoweDatasetNode for a PDS member
-                    const memberInvalid = item.member?.includes("\ufffd");
                     const cachedEncoding = this.getSessionNode().encodingMap[`${item.dsname as string}(${item.member as string})`];
                     const temp = new ZoweDatasetNode({
                         label: item.member,
                         collapsibleState: vscode.TreeItemCollapsibleState.None,
                         parentNode: this,
-                        contextOverride: memberInvalid ? globals.DS_FILE_ERROR_CONTEXT : undefined,
                         encoding: cachedEncoding,
                         profile: this.getProfile(),
                     });
-                    if (!memberInvalid) {
-                        temp.command = { command: "zowe.ds.ZoweNode.openPS", title: "", arguments: [temp] };
-                    } else {
-                        temp.errorDetails = new zowe.imperative.ImperativeError({
-                            msg: localize("getChildren.invalidMember", "Cannot access member with control characters in the name: {0}", item.member),
-                        });
-                    }
+                    temp.command = { command: "zowe.ds.ZoweNode.openPS", title: "", arguments: [temp] };
 
                     // get user and last modified date for sorting, if available
                     temp.updateStats(item);
                     elementChildren[temp.label.toString()] = temp;
                 }
             }
+
+            if (
+                response.apiResponse.items &&
+                response.apiResponse.returnedRows &&
+                response.apiResponse.items.length < response.apiResponse.returnedRows
+            ) {
+                const invalidMemberCount = response.apiResponse.returnedRows - response.apiResponse.items.length;
+                const temp = new ZoweDatasetNode({
+                    label: `${invalidMemberCount} members with errors`,
+                    collapsibleState: vscode.TreeItemCollapsibleState.None,
+                    parentNode: this,
+                    contextOverride: globals.DS_FILE_ERROR_MEMBER_CONTEXT,
+                    profile: this.getProfile(),
+                });
+                temp.command = { command: "zowe.placeholderCommand", title: "" };
+                temp.errorDetails = new zowe.imperative.ImperativeError({
+                    msg: localize(
+                        "getChildren.invalidMember",
+                        "{0} members failed to load due to invalid name errors for {1}",
+                        invalidMemberCount,
+                        this.label as string
+                    ),
+                });
+                elementChildren[temp.label.toString()] = temp;
+            }
         }
 
         this.dirty = false;
@@ -313,10 +331,13 @@
      * @returns A function that sorts 2 nodes based on the given sorting method
      */
     public static sortBy(sort: NodeSort): (a: IZoweDatasetTreeNode, b: IZoweDatasetTreeNode) => number {
         return (a, b): number => {
             const aParent = a.getParent();
             if (aParent == null || !contextually.isPds(aParent)) {
                 return (a.label as string) < (b.label as string) ? -1 : 1;
+            } else if (a.contextValue === globals.DS_FILE_ERROR_MEMBER_CONTEXT || b.contextValue === globals.DS_FILE_ERROR_MEMBER_CONTEXT) {
+                // Keep invalid member node at bottom ("N members with errors")
+                return a.contextValue === globals.DS_FILE_ERROR_MEMBER_CONTEXT ? 1 : -1;
             }
 
             const sortLessThan = sort.direction == SortDirection.Ascending ? -1 : 1;
@@ -498,7 +519,7 @@
         return responses;
     }
 
     public async openDs(forceDownload: boolean, previewMember: boolean, datasetProvider: IZoweTree<IZoweDatasetTreeNode>): Promise<void> {
         ZoweLogger.trace("ZoweDatasetNode.openDs called.");
         await datasetProvider.checkCurrentProfile(this);
 

packages/zowe-explorer/src/globals.ts

@@ -35,7 +35,7 @@ export let DS_DIR: string;
 export let CONFIG_PATH; // set during activate
 export let ISTHEIA = false; // set during activate
 export let LOG: imperative.Logger;
-export const COMMAND_COUNT = 118;
+export const COMMAND_COUNT = 119;
 export const MAX_SEARCH_HISTORY = 5;
 export const MAX_FILE_HISTORY = 10;
 export const MS_PER_SEC = 1000;
@@ -60,6 +60,7 @@ export const DS_MEMBER_CONTEXT = "member";
 export const DS_MEMBER_BINARY_CONTEXT = "memberBinary";
 export const DS_MIGRATED_FILE_CONTEXT = "migr";
 export const DS_FILE_ERROR_CONTEXT = "fileError";
+export const DS_FILE_ERROR_MEMBER_CONTEXT = "fileError_member";
 export const USS_SESSION_CONTEXT = "ussSession";
 export const USS_DIR_CONTEXT = "directory";
 export const USS_FAV_DIR_CONTEXT = "directory_fav";

packages/zowe-explorer/src/shared/init.ts

@@ -204,6 +204,11 @@ export function registerCommonCommands(context: vscode.ExtensionContext, provide
                 }
             })
         );
+        context.subscriptions.push(
+            vscode.commands.registerCommand("zowe.placeholderCommand", () => {
+                // This command does nothing, its here to let us disable individual items in the tree view
+            })
+        );
     }
 }
 

packages/zowe-explorer/webpack.config.js

@@ -84,6 +84,11 @@ const config = {
                     },
                 ],
             },
+            {
+                test: /\.mjs$/,
+                include: /markdown-it/,
+                type: "javascript/auto",
+            },
         ],
     },
     plugins: [

samples/uss-profile-sample/package.json

@@ -33,7 +33,7 @@
     "watch": "tsc -watch -p ./"
   },
   "dependencies": {
-    "@zowe/cli": "7.23.6",
+    "@zowe/cli": "7.24.0",
     "@zowe/zowe-explorer-api": "file:../../packages/zowe-explorer-api",
     "ssh2-sftp-client": "^9.1.0"
   },