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

doc(enginenetx): add design document #1595

Merged
merged 139 commits into from
May 10, 2024
Merged

doc(enginenetx): add design document #1595

merged 139 commits into from
May 10, 2024

Conversation

bassosimone
Copy link
Contributor

@bassosimone bassosimone commented May 10, 2024

This design document documents the current implementation in light of the changes requested in the #1552 pull request review. The actual changes have been implemented by previous pull requests and basically boil down to ensure we give the DNS the priority when dialing.

See #1552 for the original design review as well as for a list of all the subsequent pull requests that were merged to address the review comments.

Additionally, this PR explains in the design document what are the current limitations and what we could do next.

With the merging of this PR, we can close ooni/probe#2704.

Closes #1552.

This diff refactors the code generating tactics to mix bridge and DNS
tactics, such that we avoid trying all bridge tactics before falling
back to DNS tactics. In the event in which the bridge is IP or endpoint
blocked, this change makes sure we try using DNS tactics earlier, and,
if the DNS is working, this means a faster bootstrap.

Based on testing, where I replaced the bridge address with 10.0.0.1, we
try DNS tactics after 8 seconds. After the first run, if the DNS tactics
are working, we would immediately use them before bridge tactics, since
we store information about tactics inside the $OONI_HOME/engine dir.

Part of ooni/probe#2704.
Previously, we were only testing with DNS returning error, while
now we should also have a test case for when it's working given that
we're mixing tactics together now.
bassosimone and others added 25 commits April 18, 2024 12:31
Co-authored-by: Arturo Filastò <[email protected]>
It's time to run some tests.
Conflicts:
	internal/enginenetx/network.go
Conflicts:
	internal/enginenetx/bridgespolicy.go
	internal/enginenetx/bridgespolicy_test.go
	internal/enginenetx/statspolicy.go
	internal/enginenetx/userpolicy_test.go
This diff addresses a bug observed on the wild where a slow DNS
causes several tactics to be ready concurrently.

If we want several tactics to be ready concurrently, we should
arrange for that, and for now BTW that's not the case.

Part of ooni/probe#2704.
@bassosimone bassosimone requested a review from hellais as a code owner May 10, 2024 14:19
@bassosimone bassosimone merged commit cd2a9f7 into master May 10, 2024
36 checks passed
@bassosimone bassosimone deleted the issue/2704docs branch May 10, 2024 15:05
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.

enginenetx: use DNS to figure out the bridge address
1 participant