Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve activation errors and team config logging #1776

Merged
merged 3 commits into from May 6, 2022

Conversation

phaumer
Copy link
Member

@phaumer phaumer commented May 2, 2022

Proposed changes

The new Zowe configurations files are more error prone and harder to troubleshoot. We need to provide more clear logging and error messages to help users self-diagnose.

I started cleaning up the error message shown when activation runs into issues loading configuration files. I was talking about problems with the logger before. I also started adding more information about the actual profiles found to the readConfigFromDisk(), but that only works when loading a valid file. Looking for more ideas for how to diagnose and invalid file or problems reading the files.

Also moved down the mkdir operations in activation as they were calling error handling which required profiles to be loaded first.

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

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

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

Signed-off-by: Peter Haumer <4391934+phaumer@users.noreply.github.com>
Signed-off-by: Peter Haumer <4391934+phaumer@users.noreply.github.com>
Copy link
Member

@zFernand0 zFernand0 left a comment

Choose a reason for hiding this comment

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

The extra logging information is certainly good to have in order to diagnose a problem.
Thanks! 😋

@phaumer phaumer self-assigned this May 3, 2022
Copy link
Contributor

@rudyflores rudyflores left a comment

Choose a reason for hiding this comment

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

Looks good to me as well! Thanks for these helpful changes Peter!

@zFernand0 zFernand0 merged commit c178df0 into master May 6, 2022
@zFernand0 zFernand0 deleted the confusing-error-messages branch May 6, 2022 16:53
@zFernand0 zFernand0 mentioned this pull request Jul 5, 2022
55 tasks
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.

None yet

3 participants