feat(unix-cmd): User Experience improvements #2662

likhithanimma1 · 2024-01-12T20:22:36Z

Proposed changes

Fixes #2643
Enhanced Unix user experience, addressing feedback and improving usability.

Release Notes

Milestone:

Changelog:

Types of changes

What types of changes does your code introduce to Zowe Explorer?
Put an x in the boxes that apply

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Updates to Documentation or Tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This checklist will be used as reference for both the contributor and the reviewer

Further comments

Signed-off-by: Likhitha Nimma <[email protected]>

codecov · 2024-01-12T20:24:26Z

Codecov Report

Attention: 9 lines in your changes are missing coverage. Please review.

Comparison is base (26b8ded) 93.36% compared to head (522aaf9) 93.37%.

Files	Patch %	Lines
...es/zowe-explorer/src/command/UnixCommandHandler.ts	91.56%	7 Missing ⚠️
packages/zowe-explorer/src/Profiles.ts	66.66%	1 Missing ⚠️
packages/zowe-explorer/src/utils/ProfilesUtils.ts	50.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             next    #2662   +/-   ##
=======================================
  Coverage   93.36%   93.37%           
=======================================
  Files         109      109           
  Lines       10193    10192    -1     
  Branches     2150     2146    -4     
=======================================
  Hits         9517     9517           
+ Misses        675      674    -1     
  Partials        1        1

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

traeok

Thanks @likhithanimma1! Left a couple comments regarding variable naming and input box logic.

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

traeok · 2024-01-16T18:53:48Z

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

+                    if (obj.argValue) {
+                        sshProfile.profile[p] = obj.argValue;
+                    } else {
+                        const options: vscode.InputBoxOptions = {
+                            prompt: `Enter the ${p} of the ssh profile`,
+                            value: "",
+                            ignoreFocusOut: true,
+                            password: true,
+                        };
+                        const response = await Gui.showInputBox(options);
+                        if (!response) {
+                            Gui.showMessage(localize("issueUnixCommand.enter.command", `No command entered.`));
+                            return;
                        }
+                        sshProfile.profile[p] = response;


I'm not sure how common this would be, but if I do not have a specific property specified and the profile property expects a type other than string, this may cause undefined behavior. To avoid this possibility, the validateInput option in InputBoxOptions can be used to ensure the property is set with a proper value.

Since this is unlikely to surface in this scenario, this isn't a requested change, but I wanted to mention this for future reference.

JillieBeanSim

Thanks @likhithanimma1 for working on these polish items. I left a couple comments mainly on localization. I was also wondering a couple things:

this doesn't seem to support using the base profile stored credentials with ssh profile even when they share host and ru values.
when prompted for ssh credentials are we planning to write them to file/store securely? When I tested I was prompted but after checked config and no updates under ssh profile.

JillieBeanSim · 2024-01-16T18:53:13Z

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

-            return;
+        if (cwd == "") {
+            cwd = await vscode.window.showInputBox({
+                prompt: "Enter the path of the directory in order to execute the command",


this text should be localized

JillieBeanSim · 2024-01-16T18:55:43Z

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

+                        sshProfile.profile[p] = obj.argValue;
+                    } else {
+                        const options: vscode.InputBoxOptions = {
+                            prompt: `Enter the ${p} of the ssh profile`,


This should also be localized

likhithanimma1 · 2024-01-17T10:26:17Z

Thanks @likhithanimma1 for working on these polish items. I left a couple comments mainly on localization. I was also wondering a couple things:

this doesn't seem to support using the base profile stored credentials with ssh profile even when they share host and ru values.

when prompted for ssh credentials are we planning to write them to file/store securely? When I tested I was prompted but after checked config and no updates under ssh profile.

Hey @JillieBeanSim !

This way of implementation will not support the stored credentials of the base profile with the ssh profile but if wanted can be modified to pick the username and password from the base profile for the default ssh profile. And if the base not containing them(user and pw) can be prompted for it.
We are not planning to write them to any file or store them billie!

JillieBeanSim · 2024-01-17T13:57:15Z

@likhithanimma1 we will need this to behave similarly as if using the team configuration file with cli commands for ssh.

Signed-off-by: Likhitha Nimma <[email protected]>

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

Signed-off-by: Billie Simmons <[email protected]>

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

updates for unix cmd ux

t1m0thyj

This looks pretty good, thanks @likhithanimma1!

Will re-review after merge conflicts have been resolved. A few questions:

What is the expected behavior when the ssh profile does not have user or password? I'm seeing that nothing happens when I click "Issue Unix Command". But when my ssh profile has credentials, then it works as expected.
For the prompt shown in the terminal output, it is currently formatted like this:
> ibmuser @ lpar1.ssh : ~ ls
Personally I think the spaces in between symbols look kind of weird. Would it make sense to use a format similar to most Linux terminals?
[email protected]:~$ ls OR [[email protected] ~]$ ls

t1m0thyj · 2024-02-16T15:53:20Z

packages/zowe-explorer/i18n/sample/src/command/UnixCommandHandler.i18n.json

Can this empty file be removed?

If the ssh profile doesn't have the user or password it will prompt you to enter the credentials and the corresponding profile in the config file will be updated with credentials

traeok

Changes LGTM, had a question about the use of the profType variable in promptCredentials 👍 will approve once conflicts are resolved

traeok · 2024-02-16T15:18:31Z

packages/zowe-explorer/src/Profiles.ts

+        let profType = "";
+        if (typeof profile !== "string") {
+            profType = profile.type;
+        }
        const userInputBoxOptions: vscode.InputBoxOptions = {
            placeHolder: vscode.l10n.t(`User Name`),
-            prompt: vscode.l10n.t(`Enter the user name for the connection. Leave blank to not store.`),
+            prompt: vscode.l10n.t(`Enter the user name for the {0} connection.`, profType),
        };
        const passwordInputBoxOptions: vscode.InputBoxOptions = {
            placeHolder: vscode.l10n.t(`Password`),
-            prompt: vscode.l10n.t(`Enter the password for the connection. Leave blank to not store.`),
+            prompt: vscode.l10n.t(`Enter the password for the {0} connection.`, profType),


If profile is of type string, profType will be an empty string and the prompt will say "Enter the password for the connection" (with two spaces between "the" and "connection"). Is this intended behavior?

No, that would not be the intended behaviour. Just missed that case. Addressed the scenario and changed the prompt.

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

sonarcloud · 2024-02-20T15:06:04Z

Quality Gate failed

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

See analysis details on SonarCloud

traeok

Tested and LGTM - thanks @likhithanimma1!

I like that the quick pick keeps track of your recent commands, this is really convenient if you have to run the same command frequently 😋

I filed #2728 as a possible future enhancement to allow adding/removing from this quick pick.

Unix-User-Enhancements

90fa043

Signed-off-by: Likhitha Nimma <[email protected]>

likhithanimma1 requested review from t1m0thyj, zFernand0, JillieBeanSim, rudyflores, SanthoshiBoyina, traeok and adam-wolfe January 12, 2024 20:25

t1m0thyj assigned likhithanimma1 Jan 16, 2024

traeok reviewed Jan 16, 2024

View reviewed changes

JillieBeanSim requested changes Jan 16, 2024

View reviewed changes

likhithanimma1 and others added 2 commits January 23, 2024 12:14

Merge branch 'next' into Unix-User-Experience

4e2551f

Supporting-base-profile-enhancements

822de33

Signed-off-by: Likhitha Nimma <[email protected]>

likhithanimma1 requested review from traeok and JillieBeanSim January 23, 2024 08:07

likhithanimma1 and others added 12 commits January 29, 2024 22:55

User-Input-Box-Modified

d7141f1

Signed-off-by: Likhitha Nimma <[email protected]>

Resolved COnflicts

b34b26a

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

Merge remote-tracking branch 'origin/next' into Unix-User-Experience

4490fec

Signed-off-by: Billie Simmons <[email protected]>

updates for unix cmd ux

ccc56f8

Signed-off-by: Billie Simmons <[email protected]>

update strings

bd502c6

Signed-off-by: Billie Simmons <[email protected]>

start refactoring tests to have global mock

ed3b96b

Signed-off-by: Billie Simmons <[email protected]>

multiple ssh profile fix

7d35d8a

Signed-off-by: Billie Simmons <[email protected]>

fix double quickpick and ooo

3384ec6

Signed-off-by: Billie Simmons <[email protected]>

Fixed all broken tests

563cbdd

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

Removed-UnusedVar

07870dd

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

Revert-Commmit

f662b41

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

SonarCloudIssue-Fixed

9f2ffab

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

likhithanimma1 added 4 commits February 13, 2024 21:23

Security-Hotspot Fixed

97eb48b

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

Increased test code coverage

b0ca67c

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

Test-Coverage

253ebd5

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

Merge pull request #2700 from zowe/some-cmd-updates

e12de87

updates for unix cmd ux

t1m0thyj reviewed Feb 16, 2024

View reviewed changes

traeok reviewed Feb 16, 2024

View reviewed changes

likhithanimma1 added 2 commits February 17, 2024 12:19

Resolved conflicts

f5e130f

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

Address-Comments

6ea9f3b

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

likhithanimma1 added the no-changelog Add to PR's that don't require a CHANGELOG update label Feb 20, 2024

likhithanimma1 requested review from traeok and t1m0thyj February 20, 2024 06:49

likhithanimma1 and others added 2 commits February 20, 2024 19:29

Merge remote-tracking branch 'zowenext/next' into Unix-User-Experience

3dbd294

Merge branch 'next' into Unix-User-Experience

522aaf9

traeok approved these changes Feb 20, 2024

View reviewed changes

JillieBeanSim approved these changes Feb 20, 2024

View reviewed changes

JillieBeanSim merged commit 1e34354 into next Feb 20, 2024
13 of 15 checks passed

JillieBeanSim deleted the Unix-User-Experience branch February 20, 2024 15:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(unix-cmd): User Experience improvements #2662

feat(unix-cmd): User Experience improvements #2662

likhithanimma1 commented Jan 12, 2024

codecov bot commented Jan 12, 2024 •

edited

Loading

traeok left a comment

traeok Jan 16, 2024 •

edited

Loading

JillieBeanSim left a comment

JillieBeanSim Jan 16, 2024

JillieBeanSim Jan 16, 2024

likhithanimma1 commented Jan 17, 2024

JillieBeanSim commented Jan 17, 2024

t1m0thyj left a comment •

edited

Loading

t1m0thyj Feb 16, 2024

likhithanimma1 Feb 20, 2024

traeok left a comment

traeok Feb 16, 2024

likhithanimma1 Feb 20, 2024

sonarcloud bot commented Feb 20, 2024

traeok left a comment •

edited

Loading

feat(unix-cmd): User Experience improvements #2662

feat(unix-cmd): User Experience improvements #2662

Conversation

likhithanimma1 commented Jan 12, 2024

Proposed changes

Release Notes

Types of changes

Checklist

Further comments

codecov bot commented Jan 12, 2024 • edited Loading

Codecov Report

traeok left a comment

Choose a reason for hiding this comment

traeok Jan 16, 2024 • edited Loading

Choose a reason for hiding this comment

JillieBeanSim left a comment

Choose a reason for hiding this comment

JillieBeanSim Jan 16, 2024

Choose a reason for hiding this comment

JillieBeanSim Jan 16, 2024

Choose a reason for hiding this comment

likhithanimma1 commented Jan 17, 2024

JillieBeanSim commented Jan 17, 2024

t1m0thyj left a comment • edited Loading

Choose a reason for hiding this comment

t1m0thyj Feb 16, 2024

Choose a reason for hiding this comment

likhithanimma1 Feb 20, 2024

Choose a reason for hiding this comment

traeok left a comment

Choose a reason for hiding this comment

traeok Feb 16, 2024

Choose a reason for hiding this comment

likhithanimma1 Feb 20, 2024

Choose a reason for hiding this comment

sonarcloud bot commented Feb 20, 2024

Quality Gate failed

traeok left a comment • edited Loading

Choose a reason for hiding this comment

codecov bot commented Jan 12, 2024 •

edited

Loading

traeok Jan 16, 2024 •

edited

Loading

t1m0thyj left a comment •

edited

Loading

traeok left a comment •

edited

Loading