Skip to content

feat(prompt-creds): Expose promptCredentials for extenders to use#1699

Merged
zFernand0 merged 13 commits into
secure-values-with-imperative-updatefrom
secure-values-with-imp+expose-prompt-creds
Mar 31, 2022
Merged

feat(prompt-creds): Expose promptCredentials for extenders to use#1699
zFernand0 merged 13 commits into
secure-values-with-imperative-updatefrom
secure-values-with-imp+expose-prompt-creds

Conversation

@zFernand0

@zFernand0 zFernand0 commented Mar 19, 2022

Copy link
Copy Markdown
Member

Changelog Updates:

This PR attempts to:

  • Provide a consistent UX for prompting and updating credentials across extenders
  • Provide an example on how to use the exposed promptCredentials
  • Fix Expose API for extenders to log in when credentials are missing/expired #1228
  • Deprecate:
    • ProfilesCache#this.getLoadedProfConfig in favor of its static version ProfilesCache.getLoadedProfConfig.
    • ProfilesCache#this.getProfileLoaded in favor of its static version ProfilesCache.getProfileLoaded.
    • ProfilesCache#this.getProfileFromConfig in favor of its static version ProfilesCache.getProfileFromConfig.
    • shared/ui-views#UIViews.inputBox in favor of ZoweVsCodeExtension.inputBox (added in this PR)

Notes

  • The user and password vscode.InputBoxOptions are completely optional.
    • The ZoweVsCodeExtension APIs will default to use the English language when asking for creds.
  • The promptCredentials will not refresh any views after updating the v1 or v2 profiles.
    • Extenderes will have to decide how much needs refreshed after updating the profiles.

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

  • I have read the CONTRIBUTOR GUIDANCE wiki
  • PR title follows Conventional Commits Guidelines
  • PR Description is included
  • gif or screenshot is included if visual changes are made
  • yarn workspace vscode-extension-for-zowe vscode:prepublish has been executed
  • All checks have passed (DCO, Jenkins and Code Coverage)
  • I have added unit test and it is passing
  • I have added integration test and it is passing
  • There is coverage for the code that I have added
  • I have tested it manually and there are no regressions found
  • I have added necessary documentation (if appropriate)
  • Any PR dependencies have been merged and published (if appropriate)

Additional Context

This PR depends on:

Signed-off-by: zFernand0 <fernando.rijocedeno@broadcom.com>
Signed-off-by: zFernand0 <fernando.rijocedeno@broadcom.com>
Signed-off-by: zFernand0 <fernando.rijocedeno@broadcom.com>
@zFernand0 zFernand0 self-assigned this Mar 22, 2022
….com/zowe/vscode-extension-for-zowe into secure-values-with-imp+expose-prompt-creds

Signed-off-by: zFernand0 <fernando.rijocedeno@broadcom.com>
Signed-off-by: zFernand0 <fernando.rijocedeno@broadcom.com>
Signed-off-by: zFernand0 <fernando.rijocedeno@broadcom.com>
Signed-off-by: zFernand0 <fernando.rijocedeno@broadcom.com>
Signed-off-by: zFernand0 <fernando.rijocedeno@broadcom.com>
Signed-off-by: zFernand0 <fernando.rijocedeno@broadcom.com>
Signed-off-by: zFernand0 <fernando.rijocedeno@broadcom.com>
Signed-off-by: zFernand0 <fernando.rijocedeno@broadcom.com>
@zFernand0 zFernand0 changed the title Expose promptCredentials for extenders to use feat(prompt-creds): Expose promptCredentials for extenders to use Mar 28, 2022
@zFernand0 zFernand0 marked this pull request as ready for review March 28, 2022 18:29
Signed-off-by: zFernand0 <fernando.rijocedeno@broadcom.com>

@JeffinSiby JeffinSiby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM 👍 As an extender, I was able to enter credentials into the input boxes and the secure credentials array was added to the correct profile with the newly input values without any errors.

….com/zowe/vscode-extension-for-zowe into secure-values-with-imp+expose-prompt-creds

Signed-off-by: zFernand0 <fernando.rijocedeno@broadcom.com>
@zFernand0 zFernand0 merged commit 9f20970 into secure-values-with-imperative-update Mar 31, 2022
@zFernand0 zFernand0 deleted the secure-values-with-imp+expose-prompt-creds branch March 31, 2022 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expose API for extenders to log in when credentials are missing/expired

2 participants