feat: introduce the httpclientx package #1569
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
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.
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 package tries to replace both
httpxandhttpapi. This commit includes a design document explaining the rationale and the process for performing this replacement. I have been using this package for a while at #1560. It seems clear to me that, at this point, we want to merge. So, I have extracted just the package from #1560 to reduce the size of the diff.The TL;DR of this new package is to ensure we have the same functionality of
httpxandhttpapibut we're also simplifying the codebase by (a) replacing two other packages and (b) dropping the requirement that we wanted to generate a swagger from the API implementation, which lead to overly complex code, and, what is possibly worst, to code that at the end of the day we were not using for comparing to the backend's swagger.Part of ooni/probe#2700.