feat(ProfileInfo): JWT token expiration detection

[traeok]

What It Does

Fernando mentioned that extenders would benefit from having access to the JWT token expiration feature from Zowe Explorer, so I figured it made the most sense to put it the logic for it in ProfileInfo. That way, anyone using Imperative to access/manage profiles can leverage this functionality.

How to Test

Once merged, this can be tested in action after this PR is updated: zowe/zowe-explorer-vscode#3174

Here's a manual test to show the behavior of the function itself:

• Checkout this branch and run npm run build && npm pack from the packages/imperative folder
• Copy the zowe-imperative-8.1.0.tgz file from this folder and place it into a new folder outside of the repo
• cd to the empty folder and run zowe config init --no-prompt && npm init -y && npm install zowe-imperative-8.1.0.tgz @zowe/secrets-for-zowe-sdk (you don't need secrets SDK, but its easier than getting around cred manager setup in ProfileInfo)
• Copy this config and replace the contents of zowe.config.json:

{
    "$schema": "./zowe.schema.json",
    "profiles": {
        "zosmf": {
            "type": "zosmf",
            "properties": {
                "port": 1337
            }
        },
        "project_base": {
            "type": "base",
            "properties": {
                "host": "localhost",
                // this token expired in 2001
                // if you want to test an unexpired token, this one expires in 2128: 123.eyJleHAiOjUwMDAwMDAwMDB9.456
                "tokenValue": "123.eyJleHAiOjEwMDAwMDAwMDB9.456"
            }
        }
    },
    "defaults": {
        "zosmf": "zosmf",
        "base": "project_base"
    }
}

• Save the following code snippet as script.mjs within this test folder and run it using node script.mjs

const { ProfileInfo } = await import("@zowe/imperative");
const profInfo = new ProfileInfo("zowe");
await profInfo.readProfilesFromDisk({ projectDir: process.cwd() });
console.log("token expired:", profInfo.hasTokenExpiredForProfile("zosmf"));

The script should output token expired: true.

Review Checklist
I certify that I have:

• tested my changes
• added/updated automated tests
• updated the changelog
• followed the contribution guidelines

Additional Comments

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.08%. Comparing base (a4b4d45) to head (7e1b0ab).
Report is 15 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2298      +/-   ##
==========================================
+ Coverage   91.07%   91.08%   +0.01%     
==========================================
  Files         628      628              
  Lines       17874    17896      +22     
  Branches     3842     3848       +6     
==========================================
+ Hits        16278    16300      +22     
  Misses       1595     1595              
  Partials        1        1              

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

[traeok]

I don't have permissions on Zowe CLI to update the new issue reported by SonarCloud, but it is a false positive as argValue will almost always be type string. Even in some abnormal case where it isn't a string, all exceptions will be handled in the try/catch block.

[t1m0thyj]

Thanks for adding this to the ProfileInfo API! As the ProfileInfo API is used only by extenders like ZE, I'm curious if we'd want to move this part of the method to make it usable by CLI itself?

Perhaps we could have a static isTokenExpired method on the ConfigUtils or RestStandaloneUtils classes, that only checks if the token is expired and doesn't handle loading it from config.

[traeok]

Good call - I added a function to ConfigUtils called hasTokenExpired and updated the ProfileInfo function to use it.
Also added an entry for the new function in the changelog 👍

[t1m0thyj]

LGTM, thanks @traeok!

[zFernand0]

LGTM! 😋

looking at the code reminded me of this issue:

• Enable APIML token renewal before expiration  #1966 (comment)

[sonarqubecloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
93.5% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[anaxceron]

Requesting some edits to the changelog

[anaxceron]

Fantastic changelog @traeok!

[github-actions]

Release succeeded for the master branch. 🎉

The following packages have been published:

• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]

_{Powered by Octorelease 🚀}