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.96491% with 146 lines in your changes missing coverage. Please review.

Project coverage is 40.68%. Comparing base (3ff6d32) to head (d754ac4).

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/resourceUtils.ts	60.00%	14 Missing ⚠️
packages/vsce/src/utils/profileUtils.ts	36.84%	12 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.68%   +0.55%     
==========================================
  Files         149      151       +2     
  Lines        5080     5080              
  Branches      893      877      -16     
==========================================
+ Hits         2039     2067      +28     
+ Misses       3041     3013      -28

☔ 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, {

AndrewTwydell · 2025-02-05T11:33:13Z

packages/vsce/src/utils/profileManagement.ts

@@ -282,9 +268,8 @@ export class ProfileManagement {
  /**
   * Return all the regions in a given plex
   */
-  public static async getRegionInfoInPlex(plex: CICSPlexTree): Promise<any[]> {
+  public static async getRegionInfoInPlex(plex: CICSPlexTree, session: Session): Promise<any[]> {


We can probably get the session (2nd arg) from the plex tree (1st arg) using getParent or getSession, or a combination, right? Although it's not exactly messy currently so optional.

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

AndrewTwydell · 2025-02-20T12:11:26Z

packages/vsce/CHANGELOG.md

@@ -4,9 +4,11 @@ All notable changes to the "cics-extension-for-zowe" extension will be documente

 ## Recent Changes

+- Enhancement:Use LTPA tokens to allow CMCI "sessions" [#217](https://github.com/zowe/cics-for-zowe-client/issues/217)


Suggested change

- Enhancement:Use LTPA tokens to allow CMCI "sessions" [#217](https://github.com/zowe/cics-for-zowe-client/issues/217)

- Enhancement: Use LTPA tokens to allow CMCI "sessions" [#217](https://github.com/zowe/cics-for-zowe-client/issues/217)

AndrewTwydell · 2025-02-20T12:13:02Z

packages/sdk/CHANGELOG.md

+
+## Recent Changes
+
+- Enhancement: Use LTPA tokens to allow CMCI "sessions". [#217](https://github.com/zowe/cics-for-zowe-client/issues/217)


I'm not sure adding some constants to the package warrants a changelog entry talking about LTPA tokens. I think we should change this to be something along the lines of...

Suggested change

- Enhancement: Use LTPA tokens to allow CMCI "sessions". [#217](https://github.com/zowe/cics-for-zowe-client/issues/217)

- Enhancement: Added CICS resource names to available constants. [#217](https://github.com/zowe/cics-for-zowe-client/issues/217)

AndrewTwydell · 2025-02-20T12:13:37Z

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

@@ -18,6 +18,11 @@ export const CicsCmciConstants = {
     */
  CICS_SYSTEM_MANAGEMENT: "CICSSystemManagement",

+  /**
+     * Specifies the required part of the REST interface URI to access initialization parameter


Suggested change

* Specifies the required part of the REST interface URI to access initialization parameter

* Specifies the required part of the REST interface URI to access system initialization parameters

AndrewTwydell · 2025-02-20T12:14:41Z

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

+     * Specifies the required part of the REST interface URI to access tcp/ip service definitions
+     */
+  CICS_DEFINITION_TCPIPSERVICE: "CICSTCPIPService",
+


This is not accurate. The comment and constant name suggests definitions, but the actual resource name suggests the installed resource. Which do you need here?

AndrewTwydell · 2025-02-20T12:18:15Z

packages/vsce/src/utils/resourceUtils.ts

+  let count = 0;
+  while (count <= 1) {


Maybe changing count to be a more readable boolean could be nice, although it'll achieve the same result.

I also wonder if there's a way we can achieve this without a while loop, perhaps moving the functionality inside the while to another method, and calling it from the try block AND the catch (if the 401 is received). Perhaps unecessary change at this point though - depends how strongly others feel about a while loop!

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

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

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

AndrewTwydell Feb 5, 2025

zFernand0 left a comment

zFernand0 Feb 9, 2025

AndrewTwydell Feb 10, 2025

zFernand0 Feb 9, 2025

AndrewTwydell left a comment

AndrewTwydell Feb 20, 2025

AndrewTwydell Feb 20, 2025

AndrewTwydell Feb 20, 2025

AndrewTwydell Feb 20, 2025

AndrewTwydell Feb 20, 2025

		@@ -4,9 +4,11 @@ All notable changes to the "cics-extension-for-zowe" extension will be documente

		## Recent Changes

		- Enhancement:Use LTPA tokens to allow CMCI "sessions" [#217](https://github.com/zowe/cics-for-zowe-client/issues/217)

	- Enhancement:Use LTPA tokens to allow CMCI "sessions" [#217](https://github.com/zowe/cics-for-zowe-client/issues/217)
	- Enhancement: Use LTPA tokens to allow CMCI "sessions" [#217](https://github.com/zowe/cics-for-zowe-client/issues/217)

	- Enhancement: Use LTPA tokens to allow CMCI "sessions". [#217](https://github.com/zowe/cics-for-zowe-client/issues/217)
	- Enhancement: Added CICS resource names to available constants. [#217](https://github.com/zowe/cics-for-zowe-client/issues/217)

	* Specifies the required part of the REST interface URI to access initialization parameter
	* Specifies the required part of the REST interface URI to access system initialization parameters

Added support for ltpa token #219

Are you sure you want to change the base?

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

Choose a reason for hiding this comment

zFernand0 left a comment

Choose a reason for hiding this comment

LGTM! 😋

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AndrewTwydell left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

enamkhan commented Jan 29, 2025 •

edited

Loading

codecov-commenter commented Jan 29, 2025 •

edited

Loading