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

multierror: implement BuildErrorString and mark as legacy #1587

Merged
merged 87 commits into from
May 3, 2024

Conversation

bassosimone
Copy link
Contributor

@bassosimone bassosimone commented May 3, 2024

This diff implements BuildErrorString, which we need in #1560 to construct multierror compatible error strings inside the httpclientx package.

While there, recognize that multierror should now be considered legacy (i.e., minor changes and only bugfixes) because its implementation has Unwrap() error while not it would be better to use Unwrap() []errors but, if we were switching to the new callback, error wrapping would find syscall errors and use them as the result.

Therefore, an error like:

httpapi: all endpoints failed: [ connection_reset; connection_reset; connection_reset; connection_reset;]

would be reduced to:

connection_reset

Because this behavior is subtle, I think it's best to move multierror inside ./internal/legacy and document this.

Part of ooni/probe#2729.

This diff includes a first attempt at consolidating the patterns with
which we invoke OONI and third-party API calls.

I have refactored the code of httpx and httpapi into a new package
called httpclientx, added some tests, started converting some parts
of the tree, and explained myself in a design document.

Part of ooni/probe#2700
Spotted thanks to a very paranoid check inside ./internal/oonirun.

Was not a problem before for `httpx` because of its usage pattern and may
or may not be a problem for the `httpapi` package (did not check since
this work is focused on replacing both `httpx` and `httpapi`).
Previously, we were gracefully handling this case, but honestly it is
not the best approach to pretend there's an empty structure if the server
breaks the API and returns `"null"` rather than an object.

That said, it was still awesome to have this test in place because it
helped us to figure out this extra condition of which httpclientx should
be aware and that this problem needs to be dealt with systematically
inside the httpclientx package.
Conflicts:
	internal/enginelocate/cloudflare.go
	internal/enginelocate/ubuntu.go
Conflicts:
	internal/oonirun/v2_test.go
As before, here I am going to ensure there's redundancy.
@bassosimone bassosimone changed the title Issue/2729a multierror: implement BuildErrorString and mark as legacy May 3, 2024
@bassosimone bassosimone marked this pull request as ready for review May 3, 2024 13:01
@bassosimone bassosimone requested a review from hellais as a code owner May 3, 2024 13:01
@bassosimone bassosimone merged commit 0232df5 into master May 3, 2024
19 checks passed
@bassosimone bassosimone deleted the issue/2729a branch May 3, 2024 13:08
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.

1 participant