feat: Use keyring module from @zowe/secrets-for-zowe-sdk to replace use of node-keytar

[traeok]

Proposed changes

This PR:

• implements the use of the keyring module from the new @zowe/secrets-for-zowe-sdk
• removes old references to node-keytar in the codebase and tests
• updates old node-keytar references to the new keyring module

Note that tests will fail until the imperative PR (linked below) is merged and published.

Release Notes

Milestone: 2.10.0

Changelog: TBD

Types of changes

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

• New feature (non-breaking change which adds functionality)

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
• yarn workspace vscode-extension-for-zowe 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)

[codecov]

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.02% 🎉

Comparison is base (eb32c00) 92.79% compared to head (c7e44d8) 92.81%.
Report is 5 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2405      +/-   ##
==========================================
+ Coverage   92.79%   92.81%   +0.02%     
==========================================
  Files          92       91       -1     
  Lines        9252     9251       -1     
  Branches     1919     1919              
==========================================
+ Hits         8585     8586       +1     
+ Misses        666      664       -2     
  Partials        1        1              

Files Changed	Coverage Δ
...es/zowe-explorer-api/src/profiles/ProfilesCache.ts	99.57% <100.00%> (+0.42%)	⬆️
...ckages/zowe-explorer-api/src/security/KeytarApi.ts	100.00% <100.00%> (ø)
packages/zowe-explorer/src/utils/ProfilesUtils.ts	91.11% <100.00%> (+0.33%)	⬆️

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[zFernand0]

Changes LGTM! 😋
will test later today 🥳

[adam-wolfe]

Checked this out with VS Code Insiders and the --disable-keytar option. LGTM.

[zFernand0]

for those on a headless environment, you might want to take a look at:

• https://docs.zowe.org/v2.7.x/user-guide/cli-configure-scs-on-headless-linux-os/#unlocking-the-keyring-automatically
• https://wiki.archlinux.org/title/GNOME/Keyring#Automatically_change_keyring_password_with_user_password

---

If that does help, make sure that your launch.json file has a valid DBUS_SESSION_BUS_ADDRESS instead of the default unix:path=/run/user/0/bus.
To get an accurate value, unlock the keyring in a terminal and echo $DBUS_SESSION_BUS_ADDRESS.

    {
      "name": "Run Zowe Explorer VS Code Extension",
      "type": "extensionHost",
      "request": "launch",
      "runtimeExecutable": "${execPath}",
      "args": ["--extensionDevelopmentPath=${workspaceFolder}/packages/zowe-explorer", "--verbose"],
      "outFiles": ["${workspaceFolder}/packages/zowe-explorer/out/**/*.js"],
      "preLaunchTask": "build dev watch",
      "smartStep": true,
      "skipFiles": ["<node_internals>/**"],
      "env": {
        "DBUS_SESSION_BUS_ADDRESS": "unix:abstract=/tmp/dbus-AsdfasdF,guid=some-long-giud"
      }
    },

---

In order to avoid pushing this file to the repo, I created a quick branch that may help illustrate how we could handle this going forward.
Check the changes here:

• https://github.com/zowe/vscode-extension-for-zowe/compare/feat/keytar-rs...env-suggestion?expand=1

[zFernand0]

Assuming these changes, I was able to share credentials between the CLI and ZE in my remote SSH (headless) environment 🥳

LGTM! 😋

[traeok]

Assuming these changes, I was able to share credentials between the CLI and ZE in my remote SSH (headless) environment 🥳

LGTM! 😋

Thanks for testing & looking into the D-bus env. variable @zFernand0! Do you mind if I cherry-pick bb9f963 into this branch? I'll leave you as the commit author, of course 😋

[zFernand0]

Assuming these changes, I was able to share credentials between the CLI and ZE in my remote SSH (headless) environment 🥳
LGTM! 😋

Thanks for testing & looking into the D-bus env. variable zFernand0! Do you mind if I cherry-pick bb9f963 into this branch? I'll leave you as the commit author, of course 😋

Yeah, feel free. 😋
Thanks for considering it! 🙏🏽

[t1m0thyj]

LGTM, thanks @traeok!

The "Electron Helper (Plugin)" was unexpected 😄 Maybe it happened because I was running the extension in VS Code debugger? Regardless I don't think it matters because "Zowe" is in the message so it's clear what it is trying to access 👍

[sonarcloud]

SonarCloud Quality Gate failed.   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
7.3% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint