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 error handling for GetCredentialStateForProvider #3373

Merged
merged 1 commit into from
May 20, 2024

Conversation

dmjb
Copy link
Contributor

@dmjb dmjb commented May 20, 2024

The GetCredentialStateForProvider swallows an error since it was originally written for a codepath where the error was not important. Since then, it is used in a second place where the error is important. I'm not sure if it's possible for the error to get triggered in practice, but I managed to trigger the error path while writing unit tests, which led to a strange and hard to debug error happening after the error was skipped over.

Refactor this function to return an error. Ignore it in the call site where it should be ignored, and react to it where it is significant. As a nice side effect of this change, the control flow of GetCredentialStateForProvider is significantly simplified.

Some unrelated unit test improvements from an ongoing development branch have also been added to this branch.

Summary

Provide a brief overview of the changes and the issue being addressed.
Explain the rationale and any background necessary for understanding the changes.
List dependencies required by this change, if any.

Fixes #(related issue)

Change Type

Mark the type of change your PR introduces:

  • Bug fix (resolves an issue without affecting existing features)
  • Feature (adds new functionality without breaking changes)
  • Breaking change (may impact existing functionalities or require documentation updates)
  • Documentation (updates or additions to documentation)
  • Refactoring or test improvements (no bug fixes or new functionality)

Testing

Outline how the changes were tested, including steps to reproduce and any relevant configurations.
Attach screenshots if helpful.

Review Checklist:

  • Reviewed my own code for quality and clarity.
  • Added comments to complex or tricky code sections.
  • Updated any affected documentation.
  • Included tests that validate the fix or feature.
  • Checked that related changes are merged.

The `GetCredentialStateForProvider` swallows an error since it was
originally written for a codepath where the error was not important.
Since then, it is used in a second place where the error is important.
I'm not sure if it's possible for the error to get triggered in
practice, but I managed to trigger the error path while writing unit
tests, which led to a strange and hard to debug error happening after
the error was skipped over.

Refactor this function to return an error. Ignore it in the call site
where it should be ignored, and react to it where it is significant. As
a nice side effect of this change, the control flow of
`GetCredentialStateForProvider` is significantly simplified.

Some unrelated unit test improvements from an ongoing development branch
have also been added to this branch.
@dmjb dmjb requested a review from a team as a code owner May 20, 2024 12:25
@dmjb dmjb assigned dmjb and unassigned dmjb May 20, 2024
@coveralls
Copy link

Coverage Status

coverage: 50.215% (-0.06%) from 50.276%
when pulling ac1165d on return-error-cred-state
into 006c6fa on main.

@dmjb dmjb merged commit c886c5d into main May 20, 2024
24 of 25 checks passed
@dmjb dmjb deleted the return-error-cred-state branch May 20, 2024 13:55
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.

5 participants