refactor(probeservices): use better naming #1628
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
bassosimone
commented
Jun 25, 2024
| // ErrUnsupportedEndpoint indicates that we don't support this endpoint type. | ||
| ErrUnsupportedEndpoint = errors.New("probe services: unsupported endpoint type") | ||
| // ErrUnsupportedServiceType indicates that we don't support this service type. | ||
| ErrUnsupportedServiceType = errors.New("probe services: unsupported service type") |
There was a problem hiding this comment.
We generally do not change error strings. However, this error string is for a very uncommon case, because the service type should always be supported and so it's fine to modify it for consistency.
bassosimone
commented
Jun 25, 2024
| @@ -384,7 +386,7 @@ func TestOpenReportNewClientFailure(t *testing.T) { | |||
| Type: "antani", | |||
| } | |||
| err = exp.OpenReportContext(context.Background()) | |||
| if err.Error() != "probe services: unsupported endpoint type" { | |||
| if !errors.Is(err, probeservices.ErrUnsupportedServiceType) { | |||
There was a problem hiding this comment.
I upgraded this line to use errors.Is which is the idiomatic way of checking after errors.Is was added to Go.
bassosimone
changed the title
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.
Calling the endpoint base URL (e.g.,
https://www.example.com/) "endpoint" could cause confusion because usually an API endpoint is something likehttps://www.example.com/api/v1/check-in. To obviate this semantic issue, this diff attempts to avoid calling base URLs as endpoint throughout the tree.I am going to account this work as part of ooni/backend#754 because this is one of the possibly issues on which we can account this work. The original conversation with @ainghazal, which prodded me to make these changes, was related to his feedback after implementing #1625.