feat: Detect JWT expiration in token values and prompt user if expired #3174

traeok · 2024-10-03T14:35:01Z

Proposed changes

Implements JWT expiration checks for profiles using a token for authentication.

Prompts the user if the JWT could be successfully decoded from the token and the expire time/date has elapsed
Skips LTPA token values (cannot be decoded w/o private key, only given to servers generating the tokens)

How to test

Log into a profile using API ML or z/OSMF using JWT token authentication.
Wait for the token to expire ⏳
Once expired, attempt to search again - notice the login prompt will appear instead of the search prompt, as the token has expired

Release Notes

Milestone: 3.1.0

Changelog:

Added expired JWT token detection for profiles in each tree view (Data Sets, USS, Jobs). When a user performs a search on a profile, they are prompted to log in if their token expired. #3175

Types of changes

Bug fix (non-breaking change which fixes an issue)
Enhancement (non-breaking change which adds or improves functionality)
Breaking change (a change that would cause existing functionality to not work as expected)
Documentation (Markdown, README updates)
Other (please specify above in "Proposed changes" section)

Checklist

General

I have read the CONTRIBUTOR GUIDANCE wiki
All PR dependencies have been merged and published (if applicable)
A GIF or screenshot is included in the PR for visual changes
The pre-publish command has been executed:
- v2 and below: yarn workspace vscode-extension-for-zowe vscode:prepublish
- v3: pnpm --filter vscode-extension-for-zowe vscode:prepublish

Code coverage

There is coverage for the code that I have added
I have added new test cases and they are passing
I have manually tested the changes

Deployment

I have added developer documentation (if applicable)
Documentation should be added to Zowe Docs
- If you're an outside contributor, please post in the #zowe-doc Slack channel to coordinate documentation.
- Otherwise, please check with the rest of the squad about any needed documentation before merging.
These changes may need ported to the appropriate branches (list here):

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>

codecov · 2024-10-03T14:48:05Z

Codecov Report

Attention: Patch coverage is 92.59259% with 2 lines in your changes missing coverage. Please review.

Project coverage is 92.80%. Comparing base (60dec5a) to head (96f3312).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...ckages/zowe-explorer/src/trees/ZoweTreeProvider.ts	90.47%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3174      +/-   ##
==========================================
- Coverage   92.81%   92.80%   -0.01%     
==========================================
  Files         113      113              
  Lines       11672    11694      +22     
  Branches     2463     2598     +135     
==========================================
+ Hits        10833    10853      +20     
- Misses        837      839       +2     
  Partials        2        2

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

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>

github-actions · 2024-10-03T17:53:21Z

📅 Suggested merge-by date: 10/17/2024

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>

traeok · 2024-10-03T18:02:31Z

Failing stage ze-build (20.x, ubuntu-latest) is due to an unrelated, transient failure in the integration tests.

adam-wolfe · 2024-10-03T21:24:31Z

Tried it out. Looks great.

sonarcloud · 2024-10-07T16:02:25Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

zFernand0

the functionality LGTM! 😋

requesting changes to prevent this PR from being merged before we publish 3.0.1 😅

zFernand0 · 2024-10-08T20:14:02Z

packages/zowe-explorer/src/trees/ZoweTreeProvider.ts

+ const fullToken = tokenValueProp.argValue.toString();
+ // JWT format: [header].[payload].[signature]
+ const tokenParts = fullToken.split(".");
+ try {
+ const payloadJson = JSON.parse(Buffer.from(tokenParts[1], "base64url").toString("utf8"));
+ if ("exp" in payloadJson) {
+ const expireDate = dayjs.unix(payloadJson.exp);
+ if (expireDate.isBefore(dayjs())) {
+ await AuthUtils.promptUserForSsoLogin(profileName);
+ }
+ }
+ } catch (err) {
+ return;


Curious if this should be moved to the SDKs 😅
Or at least be made available to extenders 😅

I like the idea of moving it to the SDKs so anyone can leverage this - thanks for the suggestion! I moved this function implementation into Imperative's ProfileInfo class.
Here is the PR: zowe/zowe-cli#2298

Once that's approved & merged, we can adopt it in this PR - this would mean that extenders also get access to it directly from the facility that they already use for profiles ^^

anaxceron

Looks good, @traeok. Had one question on the changelog.

anaxceron · 2024-10-09T17:05:42Z

packages/zowe-explorer/CHANGELOG.md

@@ -6,6 +6,8 @@ All notable changes to the "vscode-extension-for-zowe" extension will be documen

 ### New features and enhancements

+- Added expired JWT token detection for profiles in each tree view (Data Sets, USS, Jobs). When a user performs a search on a profile, they are prompted to log in if their token expired. [#3175](https://github.com/zowe/zowe-explorer-vscode/issues/3175)


Should we spell out JWT?

traeok added 4 commits October 3, 2024 09:33

feat: Detect JWT token expiration during validation

ef59420

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>

refactor: Optimize logic in checkJwtTokenForProfile

cc44048

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>

wip: resolve failing test cases

ebbe0d6

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>

tests: ZoweTreeProvider.checkJwtTokenForProfile test cases

7ceb341

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>

pull-request-size bot added the size/L label Oct 3, 2024

github-actions bot assigned traeok Oct 3, 2024

traeok added 3 commits October 3, 2024 10:35

refactor: Remove old ESLint max-len comment

337c971

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>

fix(tests): failing test cases due to function change

94c740c

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>

chore: run prepublish

1ed7689

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>

traeok linked an issue Oct 3, 2024 that may be closed by this pull request

Add detection for JWT token expiration #3175

Open

chore: update ZE changelog

0993ac0

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>

traeok force-pushed the feat/detect-jwt-expiration branch from adfcd73 to 1c91184 Compare October 3, 2024 17:36

refactor: rename promptUserForTokenLogin -> promptUserForSsoLogin

fbbb98c

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>

traeok force-pushed the feat/detect-jwt-expiration branch from 1c91184 to fbbb98c Compare October 3, 2024 17:36

refactor: shorten logic in ZoweTreeProvider.checkJwtTokenForProfile

42a26a6

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>

traeok marked this pull request as ready for review October 3, 2024 17:53

Merge branch 'main' into feat/detect-jwt-expiration

0b9ec60

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>

traeok requested review from t1m0thyj, zFernand0, JillieBeanSim, awharn, rudyflores, anaxceron, adam-wolfe, SanthoshiBoyina1 and likhithanimma1 October 3, 2024 19:08

t1m0thyj added this to the v3.1.0 milestone Oct 3, 2024

Merge branch 'main' into feat/detect-jwt-expiration

91c10a5

Merge branch 'main' into feat/detect-jwt-expiration

96f3312

zFernand0 requested changes Oct 8, 2024

View reviewed changes

zFernand0 self-requested a review October 8, 2024 20:14

traeok mentioned this pull request Oct 8, 2024

feat(ProfileInfo): JWT token expiration detection zowe/zowe-cli#2298

Open

4 tasks

anaxceron approved these changes Oct 9, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Detect JWT expiration in token values and prompt user if expired #3174

feat: Detect JWT expiration in token values and prompt user if expired #3174

traeok commented Oct 3, 2024 •

edited

Loading

codecov bot commented Oct 3, 2024 •

edited

Loading

github-actions bot commented Oct 3, 2024

traeok commented Oct 3, 2024

adam-wolfe commented Oct 3, 2024

sonarcloud bot commented Oct 7, 2024

zFernand0 left a comment

zFernand0 Oct 8, 2024

traeok Oct 8, 2024 •

edited

Loading

anaxceron left a comment

anaxceron Oct 9, 2024

		@@ -6,6 +6,8 @@ All notable changes to the "vscode-extension-for-zowe" extension will be documen

		### New features and enhancements

		- Added expired JWT token detection for profiles in each tree view (Data Sets, USS, Jobs). When a user performs a search on a profile, they are prompted to log in if their token expired. [#3175](https://github.com/zowe/zowe-explorer-vscode/issues/3175)

feat: Detect JWT expiration in token values and prompt user if expired #3174

Are you sure you want to change the base?

feat: Detect JWT expiration in token values and prompt user if expired #3174

Conversation

traeok commented Oct 3, 2024 • edited Loading

Proposed changes

How to test

Release Notes

Types of changes

Checklist

codecov bot commented Oct 3, 2024 • edited Loading

Codecov Report

github-actions bot commented Oct 3, 2024

traeok commented Oct 3, 2024

adam-wolfe commented Oct 3, 2024

sonarcloud bot commented Oct 7, 2024

Quality Gate passed

zFernand0 left a comment

Choose a reason for hiding this comment

zFernand0 Oct 8, 2024

Choose a reason for hiding this comment

traeok Oct 8, 2024 • edited Loading

Choose a reason for hiding this comment

anaxceron left a comment

Choose a reason for hiding this comment

anaxceron Oct 9, 2024

Choose a reason for hiding this comment

traeok commented Oct 3, 2024 •

edited

Loading

codecov bot commented Oct 3, 2024 •

edited

Loading

traeok Oct 8, 2024 •

edited

Loading