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.

Sign up for GitHub

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

Jump to bottom

Simplify the DnsOverHttps logic #8383

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Simplify the DnsOverHttps logic #8383

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3e560bc
Simplify the logic.
yschimke Apr 22, 2024
5b3e747
Simplify the logic.
yschimke Apr 22, 2024
e0cc431
Merge branch 'master' into simplify_cache_logic
yschimke Apr 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
66 changes: 9 additions & 57 deletions okhttp-dnsoverhttps/src/main/kotlin/okhttp3/dnsoverhttps/DnsOverHttps.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,9 @@
package okhttp3.dnsoverhttps

import java.io.IOException
import java.net.HttpURLConnection
import java.net.InetAddress
import java.net.UnknownHostException
import java.util.concurrent.CountDownLatch
import okhttp3.CacheControl
import okhttp3.Call
import okhttp3.Callback
import okhttp3.Dns
Expand Down Expand Up @@ -72,38 +70,24 @@ class DnsOverHttps internal constructor(

@Throws(UnknownHostException::class)
private fun lookupHttps(hostname: String): List<InetAddress> {
val networkRequests = ArrayList<Call>(2)
val failures = ArrayList<Exception>(2)
val results = ArrayList<InetAddress>(5)
val networkRequests =
buildList {
add(client.newCall(buildRequest(hostname, DnsRecordCodec.TYPE_A)))

buildRequest(hostname, networkRequests, results, failures, DnsRecordCodec.TYPE_A)

if (includeIPv6) {
buildRequest(hostname, networkRequests, results, failures, DnsRecordCodec.TYPE_AAAA)
}
if (includeIPv6) {
add(client.newCall(buildRequest(hostname, DnsRecordCodec.TYPE_AAAA)))
}
}

val failures = ArrayList<Exception>(2)
val results = ArrayList<InetAddress>(5)
executeRequests(hostname, networkRequests, results, failures)

return results.ifEmpty {
throwBestFailure(hostname, failures)
}
}

private fun buildRequest(
hostname: String,
networkRequests: MutableList<Call>,
results: MutableList<InetAddress>,
failures: MutableList<Exception>,
type: Int,
) {
val request = buildRequest(hostname, type)
val response = getCacheOnlyResponse(request)

response?.let { processResponse(it, hostname, results, failures) } ?: networkRequests.add(
client.newCall(request),
)
}

private fun executeRequests(
hostname: String,
networkRequests: List<Call>,
Expand Down Expand Up @@ -186,38 +170,6 @@ class DnsOverHttps internal constructor(
throw unknownHostException
}

private fun getCacheOnlyResponse(request: Request): Response? {
if (client.cache != null) {
try {
// Use the cache without hitting the network first
// 504 code indicates that the Cache is stale
val onlyIfCached =
CacheControl.Builder()
.onlyIfCached()
.build()

var cacheUrl = request.url

val cacheRequest =
request.newBuilder()
.cacheControl(onlyIfCached)
.cacheUrlOverride(cacheUrl)
.build()

val cacheResponse = client.newCall(cacheRequest).execute()

if (cacheResponse.code != HttpURLConnection.HTTP_GATEWAY_TIMEOUT) {
return cacheResponse
}
} catch (ioe: IOException) {
// Failures are ignored as we can fallback to the network
// and hopefully repopulate the cache.
}
}

return null
}

@Throws(Exception::class)
private fun readResponse(
hostname: String,
Expand Down
26 changes: 26 additions & 0 deletions okhttp-dnsoverhttps/src/test/java/okhttp3/dnsoverhttps/DnsOverHttpsTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ import okhttp3.Cache
import okhttp3.Dns
import okhttp3.OkHttpClient
import okhttp3.Protocol
import okhttp3.RecordingEventListener
import okhttp3.testing.PlatformRule
import okio.Buffer
import okio.ByteString.Companion.decodeHex
Expand All @@ -53,9 +54,11 @@ class DnsOverHttpsTest {
private lateinit var server: MockWebServer
private lateinit var dns: Dns
private val cacheFs = FakeFileSystem()
private val eventListener = RecordingEventListener()
private val bootstrapClient =
OkHttpClient.Builder()
.protocols(listOf(Protocol.HTTP_2, Protocol.HTTP_1_1))
.eventListener(eventListener)
.build()

@BeforeEach
Expand Down Expand Up @@ -194,16 +197,22 @@ class DnsOverHttpsTest {
assertThat(recordedRequest.path)
.isEqualTo("/lookup?ct&dns=AAABAAABAAAAAAAABmdvb2dsZQNjb20AAAEAAQ")

assertThat(cacheEvents()).containsExactly("CacheMiss")

result = cachedDns.lookup("google.com")
assertThat(server.takeRequest(1, TimeUnit.MILLISECONDS)).isNull()
assertThat(result).isEqualTo(listOf(address("157.240.1.18")))

assertThat(cacheEvents()).containsExactly("CacheHit")

result = cachedDns.lookup("www.google.com")
assertThat(result).containsExactly(address("157.240.1.18"))
recordedRequest = server.takeRequest()
assertThat(recordedRequest.method).isEqualTo("GET")
assertThat(recordedRequest.path)
.isEqualTo("/lookup?ct&dns=AAABAAABAAAAAAAAA3d3dwZnb29nbGUDY29tAAABAAE")

assertThat(cacheEvents()).containsExactly("CacheMiss")
}

@Test
Expand Down Expand Up @@ -231,16 +240,22 @@ class DnsOverHttpsTest {
assertThat(recordedRequest.path)
.isEqualTo("/lookup?ct")

assertThat(cacheEvents()).containsExactly("CacheMiss")

result = cachedDns.lookup("google.com")
assertThat(server.takeRequest(0, TimeUnit.MILLISECONDS)).isNull()
assertThat(result).isEqualTo(listOf(address("157.240.1.18")))

assertThat(cacheEvents()).containsExactly("CacheHit")

result = cachedDns.lookup("www.google.com")
assertThat(result).containsExactly(address("157.240.1.18"))
recordedRequest = server.takeRequest(0, TimeUnit.MILLISECONDS)!!
assertThat(recordedRequest.method).isEqualTo("POST")
assertThat(recordedRequest.path)
.isEqualTo("/lookup?ct")

assertThat(cacheEvents()).containsExactly("CacheMiss")
}

@Test
Expand All @@ -265,6 +280,9 @@ class DnsOverHttpsTest {
assertThat(recordedRequest.path).isEqualTo(
"/lookup?ct&dns=AAABAAABAAAAAAAABmdvb2dsZQNjb20AAAEAAQ",
)

assertThat(cacheEvents()).containsExactly("CacheMiss")

Thread.sleep(2000)
server.enqueue(
dnsResponse(
Expand All @@ -282,6 +300,14 @@ class DnsOverHttpsTest {
assertThat(recordedRequest!!.method).isEqualTo("GET")
assertThat(recordedRequest.path)
.isEqualTo("/lookup?ct&dns=AAABAAABAAAAAAAABmdvb2dsZQNjb20AAAEAAQ")

assertThat(cacheEvents()).containsExactly("CacheMiss")
}

private fun cacheEvents(): List<String> {
return eventListener.recordedEventTypes().filter { it.contains("Cache") }.also {
eventListener.clearAllEvents()
}
}

private fun dnsResponse(s: String): MockResponse {
Expand Down