Issue #968b: Group jobs’ favorites by profile and allow extenders to activate before loading profiles

[lauren-li]

Proposed changes

Addresses the following issues for the Jobs tree:
#968 (Favorites created by other extensions should not throw errors as the other extensions are not activated yet)
#168 (Group Favorites section based on profile)

See PR #984 (the equivalent for Data Sets) for a more detailed description of how this works.

Gif of GUI changes:

Release Notes

Milestone: 1.9

Changelog: Group Jobs' favorites by profile, and load/set favorites’ profiles only when the user clicks to expand the relevant profile grouping node in the Favorites section.

Types of changes

What types of changes does your code introduce to Zowe Explorer?
Put an x in the boxes that apply

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Updates to Documentation or Tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This checklist will be used as reference for both the contributor and the reviewer

• I have read the CONTRIBUTOR GUIDANCE wiki
• PR title follows Conventional Commits Guidelines
• PR Description is included
• gif or screenshot is included if visual changes are made
• npm run vscode:prepublish has been executed
• All checks have passed (DCO, Jenkins and Code Coverage)
• I have added unit test and it is passing
• I have added integration test and it is passing
• There is coverage for the code that I have added
• I have tested it manually and there are no regressions found
• I have added necessary documentation (if appropriate)
• Any PR dependencies have been merged and published (if appropriate)

Further comments

Pre-existing issues related to Jobs favorites

• Favorited jobs have no right-click context menu.
• Favorited searches in Jobs start out with a magnifying glass icon. After clicking on the favorited search, the icon changes to a folder icon with a validation circle. The user can then add a duplicate entry of that search to favorites settings.json and UI.
• User is able to effectively favorite the same search (for the same profile) twice - once in lowercase using the default search that occurs if they just expand the profile name, and once in uppercase (if they manually enter in the owner/prefix prompt with username and *).
• The ordering of favorited searches vs jobs can sometimes appear a bit random/inconsistent, especially when adding new favorites.

[codecov]

Codecov Report

Merging #991 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #991   +/-   ##
=======================================
  Coverage   91.61%   91.61%           
=======================================
  Files          50       50           
  Lines        4829     4829           
  Branches      852      852           
=======================================
  Hits         4424     4424           
  Misses        403      403           
  Partials        2        2           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7e5c736...513593c. Read the comment docs.

[jellypuno]

@lauren-li thank you for the change. I noticed something... if I remove all the favorites, the folder is not deleted. It is not a big deal because it will be gone once VSCode is restarted. I just expected it to be removed.

[jellypuno]

Looks good to me. Functionality works.

[lauren-li]

@lauren-li thank you for the change. I noticed something... if I remove all the favorites, the folder is not deleted. It is not a big deal because it will be gone once VSCode is restarted. I just expected it to be removed.

@jellypuno Thank you for reviewing! I agree with you on this. We can address it in a 1.9.x hotfix, as it would definitely improve the UX to immediately remove the profile node in Favorites when all its children favorites are gone. Similarly, I was also thinking to add a context menu option to the profile node allowing the user to remove it and all favorites associated with it. I am currently focusing on finishing the USS portion of this update for issues #968/#168, but would like to address removing the profile nodes from Favorites sections next.

[JillieBeanSim]

@lauren-li thanks for your work on this! works great

[lauren-li]

Thanks for reviewing, @JillieBeanSim!

[lauren-li]

Description of the latest push:

• Updated this PR branch with the latest master branch.
• Per scrum discussion, added the line to sort profile nodes under Jobs' Favorites.
• Also added the line to sort profile nodes under DS Favorites per scrum discussion, as PR Issue #968a: Group data sets’ favorites by profile and allow extenders to activate before loading profiles #984 for DS Favorites was already merged.

[zFernand0]

LGTM!
Last one of the three (even though I messed up and merged USS before this one 😋 )
Looks clean!