sign: Readability cleanups #41
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It shouldn't be passed through an option pattern, since that causes it to be stored in a struct. It should be passed as the first arg. See https://pkg.go.dev/context. This adds a ctx arg to Verify, which uses it, and Sign, which doesn't, but now looks weird without it.
"Handle errors before proceeding with the rest of your code" https://google.github.io/styleguide/go/decisions#indent-error-flow Additionally, some `else` keywords are redundant (due to `return` in the `if` branch). Removing those avoids overly indenting the "main flow".
They seem to have drifted apart from the actual function calls. Error messages should identify the functions and arguments actually passed to aid with diagnosing test failures.
The distinction may seem trivial, but the "mock" approach causes confusion (even in the previous code: if mockLogger.passed { fail } ?) The test can be responsible for deciding if the logged output is valid, without hiding it inside a mock type.
jordandcarter
approved these changes
Jun 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses some gripes I had with the state of the sign package. Each commit has an explanation.
The only outward-facing change is to pass contexts idiomatically. Everything else is internal to how signing/verifying logging works or the tests.