Fix for extenders favorites not loading after registration (#3482)

* add fix for ds tree Signed-off-by: Billie Simmons <[email protected]> * add functionality for unix and jobs tree Signed-off-by: Billie Simmons <[email protected]> * revert changes made to test file Signed-off-by: Billie Simmons <[email protected]> * fix test Signed-off-by: Billie Simmons <[email protected]> * add CHANGELOG Signed-off-by: Billie Simmons <[email protected]> * ze api changelog Signed-off-by: Billie Simmons <[email protected]> * run prepublish Signed-off-by: Billie Simmons <[email protected]> * make some changes due to windows breakage Signed-off-by: Billie Simmons <[email protected]> --------- Signed-off-by: Billie Simmons <[email protected]>
zowe · Mar 3, 2025 · d7b66e0 · d7b66e0
1 parent a05967b
commit d7b66e0
Show file tree

Hide file tree

Showing 11 changed files with 39 additions and 36 deletions.
diff --git a/packages/zowe-explorer-api/CHANGELOG.md b/packages/zowe-explorer-api/CHANGELOG.md
@@ -8,6 +8,7 @@ All notable changes to the "zowe-explorer-api" extension will be documented in t
 
 - Added new `copyDataSetCrossLpar` API to provide ability to copy/paste data sets across LPARs. [#3012](https://github.com/zowe/zowe-explorer-vscode/issues/3012)
 - Added new `directConnectLogin` and `directConnectLogout` to the ZoweVsCodeExtension class. [#3346](https://github.com/zowe/zowe-explorer-vscode/issues/3346)
+- Added new optional `refreshFavorites` to IZoweTree interface. [#3470](https://github.com/zowe/zowe-explorer-vscode/issues/3470)
 
 ### Bug fixes
 

diff --git a/packages/zowe-explorer-api/src/tree/IZoweTree.ts b/packages/zowe-explorer-api/src/tree/IZoweTree.ts
@@ -118,6 +118,12 @@ export interface IZoweTree<T> extends vscode.TreeDataProvider<T>, Partial<vscode
      */
     addFavorite(favorite: IZoweTreeNode): void | Promise<void>;
 
+    /**
+     * refresh favorites
+     * @param favorite Adds a favorite node
+     */
+    refreshFavorites?(): void | Promise<void>;
+
     /**
      * Removes a favorite node
      * @param favorite Adds a favorite node

diff --git a/packages/zowe-explorer/CHANGELOG.md b/packages/zowe-explorer/CHANGELOG.md
@@ -23,6 +23,7 @@ All notable changes to the "vscode-extension-for-zowe" extension will be documen
 - Fixed an issue seen with outdated profile information in the z/OS tree view data during upload and download of data set and USS files
   [#3457](https://github.com/zowe/zowe-explorer-vscode/issues/3457)
 - Fixed issue where deleting too many nodes at once would cause the confirmation prompt to be oversized. [#3254](https://github.com/zowe/zowe-explorer-vscode/issues/3254)
+- Fixed an issue seen where extender favorites not showing in the tree views. [#3470](https://github.com/zowe/zowe-explorer-vscode/issues/3470)
 - Fixed an issue where selecting items in table views would reset the column sort order. [#3473](https://github.com/zowe/zowe-explorer-vscode/issues/3473)
 - Fixed an issue where data set migration status was incorrectly handled when the `migr` attribute was not present in the API response. [#3471](https://github.com/zowe/zowe-explorer-vscode/issues/3471)
 

diff --git a/packages/zowe-explorer/__tests__/__unit__/extending/ZoweExplorerExtender.unit.test.ts b/packages/zowe-explorer/__tests__/__unit__/extending/ZoweExplorerExtender.unit.test.ts
@@ -96,6 +96,7 @@ describe("ZoweExplorerExtender unit tests", () => {
         const datasetTree = createDatasetTree(datasetSessionNode, blockMocks.altTypeProfile);
         ZoweExplorerExtender.createInstance(datasetTree, undefined, undefined);
         jest.spyOn(blockMocks.instTest.datasetProvider, "addSession");
+        jest.spyOn(blockMocks.instTest.datasetProvider, "refreshFavorites").mockImplementation();
         await blockMocks.instTest.reloadProfiles();
         expect(blockMocks.instTest.datasetProvider.addSession).toHaveBeenCalled();
     });
@@ -129,6 +130,7 @@ describe("ZoweExplorerExtender unit tests", () => {
         ZoweExplorerExtender.createInstance(datasetTree, ussTree, jobsTree);
         jest.spyOn(SharedTreeProviders, "providers", "get").mockReturnValue({ ds: datasetTree, uss: ussTree, job: jobsTree });
         jest.spyOn(blockMocks.instTest.datasetProvider, "addSession").mockImplementation(DatasetTree.prototype.addSession);
+        jest.spyOn(blockMocks.instTest.datasetProvider, "refreshFavorites").mockImplementation();
         jest.spyOn(blockMocks.instTest.ussFileProvider, "addSession").mockImplementation(USSTree.prototype.addSession);
         jest.spyOn(blockMocks.instTest.jobsProvider, "addSession").mockImplementation(JobTree.prototype.addSession);
         const loadProfileSpy = jest.spyOn(ZoweTreeProvider.prototype as any, "loadProfileByPersistedProfile");

diff --git a/packages/zowe-explorer/__tests__/__unit__/trees/ZoweTreeProvider.unit.test.ts b/packages/zowe-explorer/__tests__/__unit__/trees/ZoweTreeProvider.unit.test.ts
@@ -585,7 +585,7 @@ describe("Tree Provider Unit Tests - function loadProfileByPersistedProfile", ()
         globalMocks.testDSTree = DatasetInit.createDatasetTree(imperative.Logger.getAppLogger());
         globalMocks.testDSTree.mSessionNodes = [{ label: "sestest", getProfileName: (): string => "profile1" }];
         globalMocks.testDSTree.getSessions = (): string[] => ["profile1"];
-        globalMocks.testDSTree.addSingleSession = jest.fn();
+        globalMocks.testDSTree.addSingleSession = jest.fn().mockImplementationOnce(() => Promise.resolve());
 
         const resetValidationSettingsSpy = jest.spyOn(SharedActions, "resetValidationSettings");
         resetValidationSettingsSpy.mockImplementation();
@@ -596,7 +596,7 @@ describe("Tree Provider Unit Tests - function loadProfileByPersistedProfile", ()
         const zoweLoggerWarnSpy = jest.spyOn(ZoweLogger, "warn");
 
         await expect(ZoweTreeProvider.prototype["loadProfileByPersistedProfile"](globalMocks.testDSTree, "zosmf", true)).resolves.not.toThrow();
-        expect(globalMocks.testDSTree.addSingleSession).toHaveBeenCalledTimes(2);
+        expect(globalMocks.testDSTree.addSingleSession).toHaveBeenCalledTimes(1); // only once due to error thrown with getDefaultProfile
         expect(resetValidationSettingsSpy).toHaveBeenCalled();
         expect(zoweLoggerWarnSpy).toHaveBeenCalledTimes(1);
         resetValidationSettingsSpy.mockClear();

diff --git a/packages/zowe-explorer/l10n/bundle.l10n.json b/packages/zowe-explorer/l10n/bundle.l10n.json
@@ -312,12 +312,6 @@
   "Uploading file to USS tree": "Uploading file to USS tree",
   "Upload action was cancelled.": "Upload action was cancelled.",
   "Uploading USS file": "Uploading USS file",
-  "Are you sure you want to delete the following item?\nThis will permanently remove the following file or folder from your system.\n\n{0}/File names": {
-    "message": "Are you sure you want to delete the following item?\nThis will permanently remove the following file or folder from your system.\n\n{0}",
-    "comment": [
-      "File names"
-    ]
-  },
   "Delete action was canceled.": "Delete action was canceled.",
   "Copying file structure...": "Copying file structure...",
   "The paste operation is not supported for this node.": "The paste operation is not supported for this node.",
@@ -509,15 +503,8 @@
       "Job name"
     ]
   },
-  "Are you sure you want to delete the following {0} items?\nThis will permanently remove the following jobs from your system.\n\n{1}/Jobs lengthJob names": {
-    "message": "Are you sure you want to delete the following {0} items?\nThis will permanently remove the following jobs from your system.\n\n{1}",
-    "comment": [
-      "Jobs length",
-      "Job names"
-    ]
-  },
-  "The following jobs were deleted: {0}/Deleted jobs": {
-    "message": "The following jobs were deleted: {0}",
+  "The following jobs were deleted: {0}{1}/Deleted jobs": {
+    "message": "The following jobs were deleted: {0}{1}",
     "comment": [
       "Deleted jobs"
     ]
@@ -757,19 +744,13 @@
       "Data Sets to delete"
     ]
   },
-  "Are you sure you want to delete the following {0} item(s)?\nThis will permanently remove these data sets and/or members from your system.\n\n{1}/Data Sets to delete lengthData Sets to delete": {
-    "message": "Are you sure you want to delete the following {0} item(s)?\nThis will permanently remove these data sets and/or members from your system.\n\n{1}",
-    "comment": [
-      "Data Sets to delete length",
-      "Data Sets to delete"
-    ]
-  },
   "Deleting items": "Deleting items",
-  "The following {0} item(s) were deleted: {1}/Data Sets deleted lengthData Sets deleted": {
-    "message": "The following {0} item(s) were deleted: {1}",
+  "The following {0} item(s) were deleted:\n{1}{2}/Data Sets deleted lengthData Sets deletedAdditional datasets count": {
+    "message": "The following {0} item(s) were deleted:\n{1}{2}",
     "comment": [
       "Data Sets deleted length",
-      "Data Sets deleted"
+      "Data Sets deleted",
+      "Additional datasets count"
     ]
   },
   "Name of member": "Name of member",

diff --git a/packages/zowe-explorer/l10n/poeditor.json b/packages/zowe-explorer/l10n/poeditor.json
@@ -12,7 +12,7 @@
     "Zowe Resources": ""
   },
   "zowe.zosconsole": {
-    "Zowe Explorer z/OS Console": ""
+    "z/OS Console": ""
   },
   "zowe.resources.name": {
     "Zowe Resources": ""
@@ -593,7 +593,6 @@
   "Uploading file to USS tree": "",
   "Upload action was cancelled.": "",
   "Uploading USS file": "",
-  "Are you sure you want to delete the following item?\nThis will permanently remove the following file or folder from your system.\n\n{0}": "",
   "Delete action was canceled.": "",
   "Copying file structure...": "",
   "The paste operation is not supported for this node.": "",
@@ -687,8 +686,7 @@
   "Failed to delete job {0}": "",
   "Are you sure you want to delete the following item?\nThis will permanently remove the following job from your system.\n\n{0}": "",
   "Job {0} was deleted.": "",
-  "Are you sure you want to delete the following {0} items?\nThis will permanently remove the following jobs from your system.\n\n{1}": "",
-  "The following jobs were deleted: {0}": "",
+  "The following jobs were deleted: {0}{1}": "",
   "Download single spool operation not implemented by extender. Please contact the extension developer(s).": "",
   "No spool files found for {0}": "",
   "Modify Command": "",
@@ -779,9 +777,8 @@
   "Uploading to data set": "",
   "No data sets selected for deletion, cancelling...": "",
   "Deleting data set(s): {0}": "",
-  "Are you sure you want to delete the following {0} item(s)?\nThis will permanently remove these data sets and/or members from your system.\n\n{1}": "",
   "Deleting items": "",
-  "The following {0} item(s) were deleted: {1}": "",
+  "The following {0} item(s) were deleted:\n{1}{2}": "",
   "Name of member": "",
   "Creating new data set member {0}": "",
   "Unable to create member.": "",

diff --git a/packages/zowe-explorer/src/extending/ZoweExplorerExtender.ts b/packages/zowe-explorer/src/extending/ZoweExplorerExtender.ts
@@ -264,7 +264,10 @@ export class ZoweExplorerExtender implements IApiExplorerExtender, IZoweExplorer
         });
         // profileType is used to load a default extender profile if no other profiles are populating the trees
         await this.datasetProvider?.addSession({ profileType });
+        await this.datasetProvider?.refreshFavorites();
         await this.ussFileProvider?.addSession({ profileType });
+        await this.ussFileProvider?.refreshFavorites();
         await this.jobsProvider?.addSession({ profileType });
+        await this.jobsProvider?.refreshFavorites();
     }
 }
diff --git a/packages/zowe-explorer/src/trees/dataset/DatasetTree.ts b/packages/zowe-explorer/src/trees/dataset/DatasetTree.ts
@@ -402,6 +402,10 @@ export class DatasetTree extends ZoweTreeProvider<IZoweDatasetTreeNode> implemen
         ZoweLogger.trace("DatasetTree.initializeFavorites called.");
         this.log = log;
         ZoweLogger.debug(vscode.l10n.t("Initializing profiles with data set favorites."));
+        await this.refreshFavorites();
+    }
+
+    public async refreshFavorites(): Promise<void> {
         const lines: string[] = this.mHistory.readFavorites();
         if (lines.length === 0) {
             ZoweLogger.debug(vscode.l10n.t("No data set favorites found."));
@@ -437,8 +441,8 @@ export class DatasetTree extends ZoweTreeProvider<IZoweDatasetTreeNode> implemen
         ZoweLogger.trace("DatasetTree.initializeFavChildNodeForProfile called.");
         const profile = parentNode.getProfile();
         let node: ZoweDatasetNode;
-        if (contextValue === Constants.DS_PDS_CONTEXT || contextValue === Constants.DS_DS_CONTEXT) {
-            if (contextValue === Constants.DS_PDS_CONTEXT) {
+        if (contextValue.includes(Constants.DS_PDS_CONTEXT) || contextValue.includes(Constants.DS_DS_CONTEXT)) {
+            if (contextValue.includes(Constants.DS_PDS_CONTEXT)) {
                 node = new ZoweDatasetNode({
                     label,
                     collapsibleState: vscode.TreeItemCollapsibleState.Collapsed,
@@ -465,7 +469,7 @@ export class DatasetTree extends ZoweTreeProvider<IZoweDatasetTreeNode> implemen
             if (icon) {
                 node.iconPath = icon.path;
             }
-        } else if (contextValue === Constants.DS_SESSION_CONTEXT) {
+        } else if (contextValue.includes(Constants.DS_SESSION_CONTEXT)) {
             node = new ZoweDatasetNode({
                 label,
                 collapsibleState: vscode.TreeItemCollapsibleState.Collapsed,

diff --git a/packages/zowe-explorer/src/trees/job/JobTree.ts b/packages/zowe-explorer/src/trees/job/JobTree.ts
@@ -337,6 +337,10 @@ export class JobTree extends ZoweTreeProvider<IZoweJobTreeNode> implements Types
         ZoweLogger.trace("JobTree.initializeJobsTree called.");
         this.log = log;
         ZoweLogger.debug(vscode.l10n.t("Initializing profiles with jobs favorites."));
+        await this.refreshFavorites();
+    }
+
+    public async refreshFavorites(): Promise<void> {
         const lines: string[] = this.mHistory.readFavorites();
         if (lines.length === 0) {
             ZoweLogger.debug(vscode.l10n.t("No jobs favorites found."));

diff --git a/packages/zowe-explorer/src/trees/uss/USSTree.ts b/packages/zowe-explorer/src/trees/uss/USSTree.ts
@@ -825,6 +825,10 @@ export class USSTree extends ZoweTreeProvider<IZoweUSSTreeNode> implements Types
         ZoweLogger.trace("USSTree.initializeFavorites called.");
         this.log = log;
         ZoweLogger.debug(vscode.l10n.t("Initializing profiles with USS favorites."));
+        await this.refreshFavorites();
+    }
+
+    public async refreshFavorites(): Promise<void> {
         const lines: string[] = this.mHistory.readFavorites();
         if (lines.length === 0) {
             ZoweLogger.debug(vscode.l10n.t("No USS favorites found."));