feat: Introduce integrated terminal #3079

zFernand0 · 2024-08-29T13:51:52Z

Proposed changes

Introduces the MVS, TSO, and Unix command handlers as integrated terminals

Release Notes

Milestone: 3.1.0

Changelog: Introduces the MVS, TSO, and Unix command handlers as integrated terminals

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):

Further comments

Merged and published:

feat: added method to validate the ssh connection zowe-cli#2340

codecov · 2024-08-29T13:55:42Z

Codecov Report

Attention: Patch coverage is 91.68766% with 33 lines in your changes missing coverage. Please review.

Project coverage is 92.99%. Comparing base (e07e839) to head (172cfe5).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...s/zowe-explorer/src/commands/UnixCommandHandler.ts	87.50%	10 Missing ⚠️
...es/zowe-explorer/src/commands/TsoCommandHandler.ts	75.00%	8 Missing ⚠️
...es/zowe-explorer/src/commands/MvsCommandHandler.ts	81.48%	5 Missing ⚠️
.../zowe-explorer/src/commands/ZoweCommandProvider.ts	96.61%	4 Missing ⚠️
...-explorer-api/src/profiles/ZoweExplorerZosmfApi.ts	62.50%	3 Missing ⚠️
packages/zowe-explorer/src/tools/ZoweTerminal.ts	98.07%	2 Missing ⚠️
...ckages/zowe-explorer/src/configuration/Profiles.ts	85.71%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3079   +/-   ##
=======================================
  Coverage   92.99%   92.99%           
=======================================
  Files         116      117    +1     
  Lines       12008    12026   +18     
  Branches     2753     2691   -62     
=======================================
+ Hits        11167    11184   +17     
- Misses        839      840    +1     
  Partials        2        2

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

sonarcloud · 2024-09-16T20:01:53Z

Quality Gate failed

Failed conditions
22.7% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

…terminals 😋 Signed-off-by: zFernand0 <[email protected]>

Signed-off-by: zFernand0 <[email protected]>

packages/zowe-explorer/src/commands/UnixCommandHandler.ts

packages/zowe-explorer/src/webviews/src/edit-history/App.tsx

Signed-off-by: zFernand0 <[email protected]>

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

…nto feat/int-term Signed-off-by: Fernando Rijo Cedeno <[email protected]>

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

packages/zowe-explorer/__tests__/__unit__/tools/ZoweTerminal.unit.test.ts

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

packages/zowe-explorer/__tests__/__unit__/commands/ZoweCommandProvider.unit.test.ts

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

…nto feat/int-term Signed-off-by: Fernando Rijo Cedeno <[email protected]>

t1m0thyj

Thanks @zFernand0 for this awesome enhancement! A few questions:

I was a bit surprised to still see a quickpick when I try to issue MVS/TSO/USS command, as I expected to be taken straight to a terminal. I assume this behavior is intended because we want to avoid too much of a breaking change in UX. Curious if it would make sense to include an item in the quickpick to "Open MVS/TSO/USS terminal" in case someone prefers to go directly to there?
Should we "gray out" placeholder text like the first line Welcome to the integrated terminal... to make it easier to distinguish from command output?
For SSH commands, should we strip off $ from the front of the response? It may look a bit weird and cause alignment issues for output of some commands like ls -la:

$ ibmuser.p12             ibmuser-crt.pem         test2.txt
a.out                   ibmuser-crt2.pem        test23
bash                    start.sh                testHex.txt

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

- fix: remember ssh directory after running initial command - feat: added command history to every issued command withing the iTerm Signed-off-by: Fernando Rijo Cedeno <[email protected]>

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

dependencies: - disposablestack 1.1.5 + disposablestack 1.1.6 devDependencies: - @types/jest 29.5.12 + @types/jest 29.5.14 - @types/mocha 10.0.6 + @types/mocha 10.0.9 - @types/node 18.19.33 + @types/node 18.19.64 (22.9.0 is available) - @types/vscode 1.89.0 + @types/vscode 1.95.0 - @vscode/vsce 3.1.0 + @vscode/vsce 3.2.1 - esbuild-loader 4.1.0 + esbuild-loader 4.2.2 - eslint 8.57.0 + eslint 8.57.1 (9.14.0 is available) deprecated - jest-stare 2.5.1 + jest-stare 2.5.2 - mocha 10.4.0 + mocha 10.8.2 - ts-jest 29.1.2 + ts-jest 29.2.5 - tsx 4.10.4 + tsx 4.19.2 - typescript 5.4.5 + typescript 5.6.3 - webpack 5.94.0 + webpack 5.96.1 Signed-off-by: Fernando Rijo Cedeno <[email protected]>

…nto feat/int-term Signed-off-by: Fernando Rijo Cedeno <[email protected]>

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

zFernand0 · 2024-11-06T21:49:12Z

Thanks @zFernand0 for this awesome enhancement! A few questions:

I was a bit surprised to still see a quickpick when I try to issue MVS/TSO/USS command, as I expected to be taken straight to a terminal. I assume this behavior is intended because we want to avoid too much of a breaking change in UX. Curious if it would make sense to include an item in the quickpick to "Open MVS/TSO/USS terminal" in case someone prefers to go directly to there?

Still need to take care of this item

Should we "gray out" placeholder text like the first line Welcome to the integrated terminal... to make it easier to distinguish from command output?

Done in e181481

For SSH commands, should we strip off $ from the front of the response? It may look a bit weird and cause alignment issues for output of some commands like ls -la:
$ ibmuser.p12             ibmuser-crt.pem         test2.txt
a.out                   ibmuser-crt2.pem        test23
bash                    start.sh                testHex.txt

Done in 7f18310

zFernand0 · 2024-11-06T21:53:42Z

This is looking so awesome @zFernand0! thanks for working on this huge addition/transformation of issuing commands.

I do see one thing with extenders and issue unix commands, I was prompted for an ssh profile when it's not needed with the extender's profile (not seen on marketplace). May have missed the check for ssh profile needed that was in place with ZE APIs. The prompt for TSO account worked correctly and didn't prompt if not needed by extender type but did when needed, ie. with zosmf profiles.

Still need to test this, but I believe it should not prompt for extenders that do not require SSH profiles.

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

github-actions · 2024-11-10T11:04:44Z

Reminder: This pull request has a merge-by date coming up within the next 24 hours. Please review this PR as soon as possible.

@t1m0thyj @JillieBeanSim @awharn @rudyflores @traeok @adam-wolfe @SanthoshiBoyina1 @likhithanimma1

traeok

Thanks Fernando for all your work on this, this looks awesome! I had a couple requests about moving the history settings for these terminals as well as a question about the TypeScript error in #3298

traeok · 2024-11-11T15:03:36Z

package.json

-    "typescript": "^5.3.3",
-    "webpack": "^5.94.0",
+    "ts-jest": "^29.2.5",
+    "tsx": "^4.19.2",
+    "typescript": "^5.6.3",


Comparing the outputs from CI in this PR and another recent PR, I think the update from [email protected] -> [email protected] is causing the issue described in #3298. I'm wondering if we should hold off on the TypeScript update until the cause is identified/resolved 🤔

packages/zowe-explorer-api/CHANGELOG.md

traeok · 2024-11-11T15:06:22Z

packages/zowe-explorer-api/src/extend/MainframeInteraction.ts

+        /**
+         * Issues a TSO Command without the need for account information
+         *
+         * @param {string} command
+         * @param {zostso.IStartTsoParms} parms
+         * @returns {Promise<zostso.IIssueResponse>}
+         * @memberof ICommand
+         */
+        issueTsoCmdWithParms?(command: string, parms?: zostso.IStartTsoParms): Promise<zostso.IIssueResponse>;
+


Question for my own edification: Was this added to prevent overwriting the behavior that's in place for existing issueTsoCommandWithParms implementations? I noticed that the function signatures are the same for both in this interface.

traeok · 2024-11-11T15:07:35Z

packages/zowe-explorer-api/src/profiles/UserSettings.ts

+    MvsCommands = "zowe.commands.mvs.history",
+    TsoCommands = "zowe.commands.tso.history",
+    UssCommands = "zowe.commands.uss.history",


I can add these as readable/writable keys for local storage access in #3299 once they're available in main 😋

packages/zowe-explorer-ftp-extension/CHANGELOG.md

packages/zowe-explorer/CHANGELOG.md

traeok · 2024-11-11T15:11:48Z

packages/zowe-explorer/package.json

+        "zowe.commands.mvs.history": {
+          "default": {
+            "persistence": true,
+            "history": []
+          },
+          "description": "%zowe.commands.mvs.history%",
+          "scope": "application"
+        },
+        "zowe.commands.tso.history": {


We currently keep history for Data Sets, USS and Jobs in local storage. Should these be moved into local storage to keep all the "history settings" in one place? If these are moved, I believe the logic would need updated to grab these from local storage.

traeok · 2024-11-11T15:16:13Z

packages/zowe-explorer/src/commands/ZoweCommandProvider.ts

+                ZoweLogger.info(this.operationCancelled);
+                return;


Is this log message needed? If so, can we make it more specific to point out exactly what operation was cancelled? From the perspective of a user reading the output channel, all that would be printed is [INFO] Operation cancelled.

traeok · 2024-11-11T15:17:44Z

packages/zowe-explorer/src/commands/ZoweCommandProvider.ts

+            const noProfAvailable = vscode.l10n.t("No profiles available");
+            ZoweLogger.info(noProfAvailable);


Similar request to the operation cancelled log message - if we want to log a message here, additional context could help surface an issue if no profiles are available.

packages/zowe-explorer/src/tools/ZoweTerminal.ts

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

adam-wolfe · 2024-11-18T01:38:34Z

Two things I've run into with issuing TSO commands:

If I issue commands (hit enter) before the previous command's output is displayed, I get back an error like: Unable to perform this operation due to the following problem. Expect Error: IZUG1126E: z/OSMF cannot correlate the request for key "ADAM-249-aadcaakf" with an active z/OS application session. - Would it make sense/be possible to disable the terminal while waiting for a response?
The delete key causes strange behavior, e.g.:

> LISTCATe
IKJ56621I INVALID COMMAND NAME SYNTAX 
READY
// I try to delete the 'e' using delete key, which does not delete the 'e', then try backspace
> LISTCAT
IKJ56621I INVALID COMMAND NAME SYNTAX 
READY
// Then I retype LISTCAT and everything works normally
> LISTCAT
IN CATALOG:...

pull-request-size bot added the size/XXL label Aug 29, 2024

zFernand0 self-assigned this Aug 29, 2024

adam-wolfe added this to the v3.1.0 milestone Sep 3, 2024

zFernand0 mentioned this pull request Sep 5, 2024

Port zosconsole to next #3058

Merged

15 tasks

zFernand0 added 8 commits October 9, 2024 09:41

chore: remove code duplication in preparation to handling integrated …

0f14050

…terminals 😋 Signed-off-by: zFernand0 <[email protected]>

chore: done consolidating, fixing unit test before continuing 😋

73f5814

Signed-off-by: zFernand0 <[email protected]>

tests: fix unit tests and address any missing checks 😋

ee95d66

Signed-off-by: zFernand0 <[email protected]>

tests: fix the rest of the unit tests 😋

48abeef

Signed-off-by: zFernand0 <[email protected]>

l10n: update strings 😋

43d6863

Signed-off-by: zFernand0 <[email protected]>

chore: Add zoweTerminal 😋

beba0c4

Signed-off-by: zFernand0 <[email protected]>

chore: finalize ZoweTerminal implementation 😋

d3b5975

Signed-off-by: zFernand0 <[email protected]>

chore: add actual z/os behavior 😋

4f7dd21

Signed-off-by: zFernand0 <[email protected]>

zFernand0 force-pushed the feat/int-term branch from 525170c to 4f7dd21 Compare October 9, 2024 13:54

zFernand0 added 4 commits October 9, 2024 09:56

chore: add missing license header

451c49b

Signed-off-by: zFernand0 <[email protected]>

tests: fix unit tests assuming we are not using integrated terminals

978ff99

Signed-off-by: zFernand0 <[email protected]>

feat: initial addition of zowe commands to edit History webview

8b2d310

Signed-off-by: zFernand0 <[email protected]>

fix: done with core terminal issues

ee12695

Signed-off-by: zFernand0 <[email protected]>

github-advanced-security bot found potential problems Oct 9, 2024

View reviewed changes

packages/zowe-explorer/src/commands/UnixCommandHandler.ts Fixed Show fixed Hide fixed

packages/zowe-explorer/src/webviews/src/edit-history/App.tsx Fixed Show fixed Hide fixed

zFernand0 added 5 commits October 10, 2024 10:06

tests: fix unit tests for now 😋

859807c

Signed-off-by: zFernand0 <[email protected]>

fix remainig unit tests

6d49d02

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

Merge branch 'main' of https://github.com/zowe/zowe-explorer-vscode i…

65c8e24

…nto feat/int-term Signed-off-by: Fernando Rijo Cedeno <[email protected]>

fix: remove circular references

04927a3

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

test: add small unit test 😋

96a8d25

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

github-advanced-security bot found potential problems Oct 21, 2024

View reviewed changes

packages/zowe-explorer/__tests__/__unit__/tools/ZoweTerminal.unit.test.ts Fixed Show fixed Hide fixed

packages/zowe-explorer/__tests__/__unit__/tools/ZoweTerminal.unit.test.ts Fixed Show fixed Hide fixed

test: add more unit testws to bump patch coverage

257254b

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

github-advanced-security bot found potential problems Oct 22, 2024

View reviewed changes

zFernand0 added 2 commits October 22, 2024 11:52

chore: more unit tests

819e742

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

Merge branch 'main' into feat/int-term

3898c54

zFernand0 added 3 commits October 31, 2024 14:33

fix: profile selection cached between commands via the palette

75d1386

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

fix: iTerm setting not working from the workspace scope 😋

882db9a

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

Merge branch 'main' of https://github.com/zowe/zowe-explorer-vscode i…

1ba492a

…nto feat/int-term Signed-off-by: Fernando Rijo Cedeno <[email protected]>

t1m0thyj reviewed Oct 31, 2024

View reviewed changes

This comment was marked as outdated.

Sign in to view

zFernand0 added 5 commits October 31, 2024 15:19

fix: make profile validation consistent amonogst all cmdTypes

7833f74

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

review: add validation of SSH porfiles:

88e064b

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

chore: multiple fixes (see below)

33294c9

- fix: remember ssh directory after running initial command - feat: added command history to every issued command withing the iTerm Signed-off-by: Fernando Rijo Cedeno <[email protected]>

feat: separated commands history 😋

986fbaf

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

fix: Greyout entry text in iTerms

e181481

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

zFernand0 mentioned this pull request Nov 1, 2024

feat: added method to validate the ssh connection zowe/zowe-cli#2340

Merged

4 tasks

zFernand0 added 9 commits November 2, 2024 17:42

review: fix unit test after adding validation

e618b14

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

chore: update changelog

75a6d03

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

review: updated sdk and removed ssh2 lazy-loading

7f18310

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

chore: update unit tests for new APIs

85696d1

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

Merge branch 'main' of https://github.com/zowe/zowe-explorer-vscode i…

3311857

…nto feat/int-term Signed-off-by: Fernando Rijo Cedeno <[email protected]>

Merge branch 'main' of https://github.com/zowe/zowe-explorer-vscode i…

133276e

…nto feat/int-term Signed-off-by: Fernando Rijo Cedeno <[email protected]>

chore: fix lint issues and update changelogs

ccc9f48

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

review: fis unit tests

a18f7f6

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

chore: cleanup ssh profile validation logic

230e933

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

JTonda requested review from JillieBeanSim, t1m0thyj and traeok November 7, 2024 16:07

traeok requested changes Nov 11, 2024

View reviewed changes

review: update changelog

172cfe5

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Introduce integrated terminal #3079

feat: Introduce integrated terminal #3079

zFernand0 commented Aug 29, 2024 •

edited

Loading

codecov bot commented Aug 29, 2024 •

edited

Loading

sonarcloud bot commented Sep 16, 2024 •

edited

Loading

t1m0thyj left a comment •

edited

Loading

This comment was marked as outdated.

zFernand0 commented Nov 6, 2024

zFernand0 commented Nov 6, 2024

github-actions bot commented Nov 10, 2024

traeok left a comment

traeok Nov 11, 2024

traeok Nov 11, 2024 •

edited

Loading

traeok Nov 11, 2024

traeok Nov 11, 2024 •

edited

Loading

traeok Nov 11, 2024

traeok Nov 11, 2024

adam-wolfe commented Nov 18, 2024 •

edited

Loading

		const noProfAvailable = vscode.l10n.t("No profiles available");
		ZoweLogger.info(noProfAvailable);

feat: Introduce integrated terminal #3079

Are you sure you want to change the base?

feat: Introduce integrated terminal #3079

Conversation

zFernand0 commented Aug 29, 2024 • edited Loading

Proposed changes

Release Notes

Types of changes

Checklist

Further comments

codecov bot commented Aug 29, 2024 • edited Loading

Codecov Report

sonarcloud bot commented Sep 16, 2024 • edited Loading

Quality Gate failed

t1m0thyj left a comment • edited Loading

Choose a reason for hiding this comment

This comment was marked as outdated.

zFernand0 commented Nov 6, 2024

zFernand0 commented Nov 6, 2024

github-actions bot commented Nov 10, 2024

traeok left a comment

Choose a reason for hiding this comment

traeok Nov 11, 2024

Choose a reason for hiding this comment

traeok Nov 11, 2024 • edited Loading

Choose a reason for hiding this comment

traeok Nov 11, 2024

Choose a reason for hiding this comment

traeok Nov 11, 2024 • edited Loading

Choose a reason for hiding this comment

traeok Nov 11, 2024

Choose a reason for hiding this comment

traeok Nov 11, 2024

Choose a reason for hiding this comment

adam-wolfe commented Nov 18, 2024 • edited Loading

zFernand0 commented Aug 29, 2024 •

edited

Loading

codecov bot commented Aug 29, 2024 •

edited

Loading

sonarcloud bot commented Sep 16, 2024 •

edited

Loading

t1m0thyj left a comment •

edited

Loading

traeok Nov 11, 2024 •

edited

Loading

traeok Nov 11, 2024 •

edited

Loading

adam-wolfe commented Nov 18, 2024 •

edited

Loading