Added support for ltpa token #219

enamkhan · 2025-01-29T13:57:38Z

This pr is a work in progress to add support for a using the ltpa token.

#217

How to Test

Review Checklist
I certify that I have:

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

Additional Comments

enamkhan · 2025-01-29T13:58:26Z

@davenice I'm just going to refactor now and remove the profile config.

codecov-commenter · 2025-01-29T13:58:26Z

Codecov Report

Attention: Patch coverage is 35.74661% with 142 lines in your changes missing coverage. Please review.

Project coverage is 40.69%. Comparing base (aec10bb) to head (b970eff).

Files with missing lines	Patch %	Lines
packages/vsce/src/trees/CICSTree.ts	22.22%	28 Missing ⚠️
packages/vsce/src/utils/profileManagement.ts	22.22%	21 Missing ⚠️
packages/vsce/src/utils/profileUtils.ts	36.84%	12 Missing ⚠️
packages/vsce/src/utils/resourceUtils.ts	64.28%	10 Missing ⚠️
...ackages/vsce/src/commands/closeLocalFileCommand.ts	0.00%	4 Missing ⚠️
packages/vsce/src/commands/showParameterCommand.ts	0.00%	4 Missing ⚠️
...ommands/disableCommands/disableLocalFileCommand.ts	0.00%	3 Missing ⚠️
.../commands/disableCommands/disableProgramCommand.ts	0.00%	3 Missing ⚠️
...mands/disableCommands/disableTransactionCommand.ts	0.00%	3 Missing ⚠️
.../commands/enableCommands/enableLocalFileCommand.ts	0.00%	3 Missing ⚠️
... and 25 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #219      +/-   ##
==========================================
+ Coverage   40.13%   40.69%   +0.55%     
==========================================
  Files         149      151       +2     
  Lines        5080     5072       -8     
  Branches      893      876      -17     
==========================================
+ Hits         2039     2064      +25     
+ Misses       3041     3008      -33

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

packages/vsce/src/trees/CICSTree.ts

packages/vsce/src/trees/CICSCombinedTrees/CICSCombinedLibraryTree.ts

packages/vsce/src/utils/profileManagement.ts

packages/vsce/__tests__/__unit__/trees/CICSSessionTree.unit.test.ts

packages/vsce/src/trees/CICSSessionTree.ts

AndrewTwydell

In a lot of the resource trees (CICSProgramTree), we're not using the new getters to get the session - might be nice if possible?

Might be nice to be able to do this.getSession() here like the combination trees.

cics-for-zowe-client/packages/vsce/src/trees/CICSProgramTree.ts

Line 48 in df6656b

    
           const programResponse = await getResource(this.parentRegion.parentSession.session, {

packages/vsce/src/utils/profileManagement.ts

packages/vsce/src/trees/CICSCombinedTrees/CICSCombinedWebServiceTree.ts

zFernand0

LGTM! 😋

Haven't had a chance to test this, but the changes make sense to me! 😋

zFernand0 · 2025-02-09T22:39:10Z

packages/vsce/src/trees/CICSCombinedTrees/CICSCombinedTCPIPServiceTree.ts

It feels like we have to make the same/similar changes across all/most CICSCombinedTrees.
Wondering if there is some consolidation that can be done (in a future PR) to create a BaseCombinedTree class that the others extend 😋

This refactor is actually in progress in this PR. Because all the resource and combined resource trees are practically identical, we can use common tree classes for them all :D

zFernand0 · 2025-02-09T22:43:37Z

packages/vsce/src/trees/CICSSessionTree.ts

    this.session = new imperative.Session({
-      type: "basic",
+      type: SessConstants.AUTH_TYPE_TOKEN,
+      storeCookie: true,


I know I mentioned that perhaps we could move some of the LTPA token support to the CLI.
However, it makes sense the way this is being done here since (as you mentioned on the last standup) this is all handled by Imperative.

Curious if the CICs plug-in could make use the the LTPA token when the CLI is in Daemon mode. 😋
No need to worry about testing this, since people haven't asked for this feature yet 😋

packages/vsce/__tests__/__unit__/trees/CICSSessionTree.unit.test.ts

packages/vsce/src/trees/CICSLibraryTree.ts

packages/vsce/src/trees/treeItems/CICSLibraryTreeItem.ts

packages/vsce/src/utils/resourceUtils.ts

packages/vsce/tsup.config.json

packages/vsce/src/utils/resourceUtils.ts

packages/vsce/src/commands/openLocalFileCommand.ts

packages/vsce/src/utils/resourceUtils.ts

Signed-off-by: enam-khan <[email protected]>

AndrewTwydell

Few changes, will also test functionality locally

packages/vsce/CHANGELOG.md

packages/sdk/CHANGELOG.md

packages/sdk/src/constants/CicsCmci.constants.ts

packages/vsce/src/utils/resourceUtils.ts

Co-authored-by: Andrew <[email protected]> Signed-off-by: EKhan <[email protected]>

Signed-off-by: enam-khan <[email protected]>

packages/vsce/__tests__/__unit__/trees/CICSSessionTree.unit.test.ts

Signed-off-by: enam-khan <[email protected]>

AndrewTwydell

Couple things to tweak - and I need a longer, more thorough, look at CICSTree. There's another while loop in there which I'm keen to avoid but not absolutely necessary. Will test locally and we can go over it tomorrow.

packages/vsce/src/commands/disableCommands/disableTransactionCommand.ts

packages/vsce/src/commands/openLocalFileCommand.ts

…ommand.ts Co-authored-by: Andrew <[email protected]> Signed-off-by: EKhan <[email protected]>

Co-authored-by: Andrew <[email protected]> Signed-off-by: EKhan <[email protected]>

Signed-off-by: enam-khan <[email protected]>

Signed-off-by: Andrew Twydell <[email protected]>

Signed-off-by: enam-khan <[email protected]>

AndrewTwydell

Wahoo! LGTM - tested thoroughly locally and seems all good. Nice to be able to use tokens and not rely on basic auth for every request! 👍🏼

davenice

This looks good to me! I know you and Andrew have tested it pretty hard.

Let's pause and check whether @zFernand0 wants to give another review.

(BTW interesting point from @zFernand0 about the CLI in daemon mode. I've not tried that out. It's certainly a potential use case for making use of tokens in the future.)

zFernand0

LGTM! 😋

This is really cool! 🎉
One step closer to APIML integration 😋

zFernand0 · 2025-02-26T20:21:35Z

packages/vsce/src/utils/resourceUtils.ts

I really like the way this was refactored. Very clever! 🧠

github-actions · 2025-02-26T20:49:18Z

Release succeeded for the main branch. 🎉

The following packages have been published:

npm: @zowe/[email protected]
npm: @zowe/[email protected]
vsce: [email protected]
vsce: [email protected] (OVSX)

_{Powered by Octorelease 🚀}

* Added support for the ltpa token Signed-off-by: enam-khan <[email protected]> * Removed unused import and variable in test Signed-off-by: enam-khan <[email protected]> * Some cleanup Signed-off-by: enam-khan <[email protected]> * Updated changelogs Signed-off-by: enam-khan <[email protected]> * Update packages/vsce/CHANGELOG.md Co-authored-by: Andrew <[email protected]> Signed-off-by: EKhan <[email protected]> * Update packages/sdk/CHANGELOG.md Co-authored-by: Andrew <[email protected]> Signed-off-by: EKhan <[email protected]> * Update packages/sdk/src/constants/CicsCmci.constants.ts Co-authored-by: Andrew <[email protected]> Signed-off-by: EKhan <[email protected]> * Update packages/vsce/src/commands/disableCommands/disableTransactionCommand.ts Co-authored-by: Andrew <[email protected]> Signed-off-by: EKhan <[email protected]> * Update packages/vsce/src/commands/openLocalFileCommand.ts Co-authored-by: Andrew <[email protected]> Signed-off-by: EKhan <[email protected]> * set tree to unauthorized on error Signed-off-by: Andrew Twydell <[email protected]> --------- Signed-off-by: enam-khan <[email protected]> Signed-off-by: EKhan <[email protected]> Signed-off-by: Andrew Twydell <[email protected]> Co-authored-by: Andrew <[email protected]> Co-authored-by: Andrew Twydell <[email protected]>

enamkhan requested review from AndrewTwydell and davenice January 29, 2025 13:57

github-actions bot assigned enamkhan Jan 29, 2025

github-advanced-security bot found potential problems Jan 29, 2025

View reviewed changes

packages/vsce/src/trees/CICSTree.ts Fixed Show fixed Hide fixed

github-advanced-security bot found potential problems Jan 30, 2025

View reviewed changes

packages/vsce/src/trees/CICSCombinedTrees/CICSCombinedLibraryTree.ts Fixed Show fixed Hide fixed

packages/vsce/src/utils/profileManagement.ts Fixed Show fixed Hide fixed

enamkhan force-pushed the khane-use-ltpa-token branch from f88f1d5 to fd79504 Compare February 3, 2025 15:24

github-advanced-security bot found potential problems Feb 4, 2025

View reviewed changes

packages/vsce/__tests__/__unit__/trees/CICSSessionTree.unit.test.ts Fixed Show fixed Hide fixed

packages/vsce/src/trees/CICSSessionTree.ts Fixed Show fixed Hide fixed

enamkhan force-pushed the khane-use-ltpa-token branch from 7c4bd64 to 1cd8078 Compare February 4, 2025 13:22

AndrewTwydell reviewed Feb 5, 2025

View reviewed changes

packages/vsce/src/utils/profileManagement.ts Outdated Show resolved Hide resolved

packages/vsce/src/trees/CICSCombinedTrees/CICSCombinedWebServiceTree.ts Outdated Show resolved Hide resolved

JTonda requested a review from zFernand0 February 6, 2025 16:05

zFernand0 reviewed Feb 9, 2025

View reviewed changes

enamkhan force-pushed the khane-use-ltpa-token branch from 50424cb to e132aca Compare February 11, 2025 11:30

github-advanced-security bot found potential problems Feb 11, 2025

View reviewed changes

packages/vsce/__tests__/__unit__/trees/CICSSessionTree.unit.test.ts Fixed Show fixed Hide fixed

enamkhan force-pushed the khane-use-ltpa-token branch 2 times, most recently from 22fb9a1 to a602446 Compare February 14, 2025 13:57

github-advanced-security bot found potential problems Feb 14, 2025

View reviewed changes

packages/vsce/src/trees/CICSLibraryTree.ts Fixed Show fixed Hide fixed

packages/vsce/src/trees/treeItems/CICSLibraryTreeItem.ts Fixed Show fixed Hide fixed

AndrewTwydell reviewed Feb 14, 2025

View reviewed changes

packages/vsce/src/utils/resourceUtils.ts Outdated Show resolved Hide resolved

AndrewTwydell reviewed Feb 14, 2025

View reviewed changes

packages/vsce/src/utils/resourceUtils.ts Outdated Show resolved Hide resolved

AndrewTwydell reviewed Feb 14, 2025

View reviewed changes

packages/vsce/tsup.config.json Outdated Show resolved Hide resolved

github-advanced-security bot found potential problems Feb 14, 2025

View reviewed changes

packages/vsce/src/utils/resourceUtils.ts Fixed Show fixed Hide fixed

github-advanced-security bot found potential problems Feb 14, 2025

View reviewed changes

packages/vsce/src/commands/openLocalFileCommand.ts Fixed Show fixed Hide fixed

packages/vsce/src/utils/resourceUtils.ts Fixed Show fixed Hide fixed

Added support for the ltpa token

e4447ab

Signed-off-by: enam-khan <[email protected]>

enamkhan force-pushed the khane-use-ltpa-token branch from a5251ac to e4447ab Compare February 14, 2025 15:58

enamkhan added 2 commits February 14, 2025 16:01

Fixed some lint errors

20764ab

Signed-off-by: enam-khan <[email protected]>

Removed unused import and variable in test

6ac628f

Signed-off-by: enam-khan <[email protected]>

enamkhan marked this pull request as ready for review February 14, 2025 16:16

enamkhan added 2 commits February 14, 2025 17:11

Some cleanup

3d7a9a3

Signed-off-by: enam-khan <[email protected]>

Updated changelogs

d754ac4

Signed-off-by: enam-khan <[email protected]>

AndrewTwydell requested changes Feb 20, 2025

View reviewed changes

enamkhan and others added 5 commits February 24, 2025 08:50

Update packages/vsce/CHANGELOG.md

a0a128f

Co-authored-by: Andrew <[email protected]> Signed-off-by: EKhan <[email protected]>

Update packages/sdk/CHANGELOG.md

c24caee

Co-authored-by: Andrew <[email protected]> Signed-off-by: EKhan <[email protected]>

Update packages/sdk/src/constants/CicsCmci.constants.ts

cb24efc

Co-authored-by: Andrew <[email protected]> Signed-off-by: EKhan <[email protected]>

Small refactor to resourceUtils

1e6f2f6

Signed-off-by: enam-khan <[email protected]>

Renamed some constants

65fc6ae

Signed-off-by: enam-khan <[email protected]>

enamkhan requested a review from AndrewTwydell February 24, 2025 15:40

AndrewTwydell reviewed Feb 24, 2025

View reviewed changes

packages/vsce/__tests__/__unit__/trees/CICSSessionTree.unit.test.ts Outdated Show resolved Hide resolved

Fixes small rename error

48e9945

Signed-off-by: enam-khan <[email protected]>

AndrewTwydell requested changes Feb 24, 2025

View reviewed changes

packages/vsce/src/commands/disableCommands/disableTransactionCommand.ts Outdated Show resolved Hide resolved

packages/vsce/src/commands/openLocalFileCommand.ts Outdated Show resolved Hide resolved

enamkhan and others added 4 commits February 24, 2025 16:38

Update packages/vsce/src/commands/disableCommands/disableTransactionC…

c33e5bf

…ommand.ts Co-authored-by: Andrew <[email protected]> Signed-off-by: EKhan <[email protected]>

Update packages/vsce/src/commands/openLocalFileCommand.ts

aa9402c

Co-authored-by: Andrew <[email protected]> Signed-off-by: EKhan <[email protected]>

Some small updates

3917785

Signed-off-by: enam-khan <[email protected]>

set tree to unauthorized on error

e94059d

Signed-off-by: Andrew Twydell <[email protected]>

enamkhan requested a review from AndrewTwydell February 25, 2025 13:33

Call getPlexInfo again when profile has been updated

2e5d9bd

Signed-off-by: enam-khan <[email protected]>

AndrewTwydell approved these changes Feb 25, 2025

View reviewed changes

zFernand0 self-requested a review February 25, 2025 16:08

Merge branch 'main' into khane-use-ltpa-token

b970eff

davenice approved these changes Feb 26, 2025

View reviewed changes

zFernand0 approved these changes Feb 26, 2025

View reviewed changes

packages/vsce/src/utils/resourceUtils.ts

Copy link

Member

zFernand0 Feb 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really like the way this was refactored. Very clever! 🧠

AndrewTwydell merged commit 44d8f8b into main Feb 26, 2025
19 checks passed

AndrewTwydell deleted the khane-use-ltpa-token branch February 26, 2025 20:39

AndrewTwydell added the release-minor Indicates a minor feature has been added label Feb 26, 2025

github-actions bot added the released label Feb 26, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added support for ltpa token #219

Added support for ltpa token #219

enamkhan commented Jan 29, 2025 •

edited

Loading

enamkhan commented Jan 29, 2025

codecov-commenter commented Jan 29, 2025 •

edited

Loading

AndrewTwydell left a comment

zFernand0 left a comment

zFernand0 Feb 9, 2025

AndrewTwydell Feb 10, 2025

zFernand0 Feb 9, 2025

AndrewTwydell left a comment

AndrewTwydell left a comment

AndrewTwydell left a comment

davenice left a comment

zFernand0 left a comment

zFernand0 Feb 26, 2025

github-actions bot commented Feb 26, 2025

Added support for ltpa token #219

Added support for ltpa token #219

Conversation

enamkhan commented Jan 29, 2025 • edited Loading

enamkhan commented Jan 29, 2025

codecov-commenter commented Jan 29, 2025 • edited Loading

Codecov Report

AndrewTwydell left a comment

Choose a reason for hiding this comment

zFernand0 left a comment

Choose a reason for hiding this comment

LGTM! 😋

zFernand0 Feb 9, 2025

Choose a reason for hiding this comment

AndrewTwydell Feb 10, 2025

Choose a reason for hiding this comment

zFernand0 Feb 9, 2025

Choose a reason for hiding this comment

AndrewTwydell left a comment

Choose a reason for hiding this comment

AndrewTwydell left a comment

Choose a reason for hiding this comment

AndrewTwydell left a comment

Choose a reason for hiding this comment

davenice left a comment

Choose a reason for hiding this comment

zFernand0 left a comment

Choose a reason for hiding this comment

LGTM! 😋

zFernand0 Feb 26, 2025

Choose a reason for hiding this comment

github-actions bot commented Feb 26, 2025

enamkhan commented Jan 29, 2025 •

edited

Loading

codecov-commenter commented Jan 29, 2025 •

edited

Loading