Skip to content

Add RFC 1008 (QUERY Method) support #9496

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

Open
desiderantes wants to merge 1 commit into
base: master
Choose a base branch
from
+98 −5
Open

Add RFC 1008 (QUERY Method) support #9496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions okhttp/src/commonJvmAndroid/kotlin/okhttp3/internal/http/HttpMethod.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ object HttpMethod {
@JvmStatic // Despite being 'internal', this method is called by popular 3rd party SDKs.
fun permitsRequestBody(method: String): Boolean = !(method == "GET" || method == "HEAD")

fun redirectsWithBody(method: String): Boolean = method == "PROPFIND"
fun redirectsWithBody(method: String): Boolean = method == "PROPFIND" || method == "QUERY"

fun redirectsToGet(method: String): Boolean = method != "PROPFIND"
fun redirectsToGet(method: String): Boolean = method != "PROPFIND" && method != "QUERY"

fun isCacheable(requestMethod: String): Boolean = requestMethod == "GET" || requestMethod == "QUERY"
}
9 changes: 6 additions & 3 deletions okhttp/src/commonJvmAndroid/kotlin/okhttp3/internal/http/RetryAndFollowUpInterceptor.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,11 +313,14 @@ class RetryAndFollowUpInterceptor : Interceptor {
val requestBuilder = userResponse.request.newBuilder()
if (HttpMethod.permitsRequestBody(method)) {
val responseCode = userResponse.code
val isQueryAndSeeOther = method == "QUERY" && responseCode == HTTP_SEE_OTHER
val maintainBody =
HttpMethod.redirectsWithBody(method) ||
(HttpMethod.redirectsWithBody(method) ||
responseCode == HTTP_PERM_REDIRECT ||
responseCode == HTTP_TEMP_REDIRECT
if (HttpMethod.redirectsToGet(method) && responseCode != HTTP_PERM_REDIRECT && responseCode != HTTP_TEMP_REDIRECT) {
responseCode == HTTP_TEMP_REDIRECT) && !isQueryAndSeeOther
if ((HttpMethod.redirectsToGet(method) || isQueryAndSeeOther) &&
responseCode != HTTP_PERM_REDIRECT && responseCode != HTTP_TEMP_REDIRECT
) {
requestBuilder.method("GET", null)
} else {
val requestBody = if (maintainBody) userResponse.request.body else null
Expand Down
90 changes: 90 additions & 0 deletions okhttp/src/jvmTest/kotlin/okhttp3/CallTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2490,6 +2490,96 @@ open class CallTest {
assertThat(page2.body?.utf8()).isEqualTo("Request Body")
}

@Test
fun queryRedirectsToQueryAndMaintainsRequestBodyOnMovedTemp() {
server.enqueue(
MockResponse(
code = HttpURLConnection.HTTP_MOVED_TEMP,
headers = headersOf("Location", "/page2"),
body = "This page has moved!",
),
)
server.enqueue(MockResponse(body = "Page 2"))

val response =
client
.newCall(
Request
.Builder()
.url(server.url("/page1"))
.query("Query Body".toRequestBody("text/plain".toMediaType()))
.build(),
).execute()

assertThat(response.body.string()).isEqualTo("Page 2")
val page1 = server.takeRequest()
assertThat(page1.requestLine).isEqualTo("QUERY /page1 HTTP/1.1")
assertThat(page1.body?.utf8()).isEqualTo("Query Body")
val page2 = server.takeRequest()
assertThat(page2.requestLine).isEqualTo("QUERY /page2 HTTP/1.1")
assertThat(page2.body?.utf8()).isEqualTo("Query Body")
}

@Test
fun queryRedirectsToQueryAndMaintainsRequestBodyOnMovedPerm() {
server.enqueue(
MockResponse(
code = HttpURLConnection.HTTP_MOVED_PERM,
headers = headersOf("Location", "/page2"),
body = "This page has moved!",
),
)
server.enqueue(MockResponse(body = "Page 2"))

val response =
client
.newCall(
Request
.Builder()
.url(server.url("/page1"))
.query("Query Body".toRequestBody("text/plain".toMediaType()))
.build(),
).execute()

assertThat(response.body.string()).isEqualTo("Page 2")
val page1 = server.takeRequest()
assertThat(page1.requestLine).isEqualTo("QUERY /page1 HTTP/1.1")
assertThat(page1.body?.utf8()).isEqualTo("Query Body")
val page2 = server.takeRequest()
assertThat(page2.requestLine).isEqualTo("QUERY /page2 HTTP/1.1")
assertThat(page2.body?.utf8()).isEqualTo("Query Body")
}

@Test
fun queryRedirectsToGetAndDropsRequestBodyOnSeeOther() {
server.enqueue(
MockResponse(
code = HttpURLConnection.HTTP_SEE_OTHER,
headers = headersOf("Location", "/page2"),
body = "See other page!",
),
)
server.enqueue(MockResponse(body = "Page 2"))

val response =
client
.newCall(
Request
.Builder()
.url(server.url("/page1"))
.query("Query Body".toRequestBody("text/plain".toMediaType()))
.build(),
).execute()

assertThat(response.body.string()).isEqualTo("Page 2")
val page1 = server.takeRequest()
assertThat(page1.requestLine).isEqualTo("QUERY /page1 HTTP/1.1")
assertThat(page1.body?.utf8()).isEqualTo("Query Body")
val page2 = server.takeRequest()
assertThat(page2.requestLine).isEqualTo("GET /page2 HTTP/1.1")
assertThat(page2.body).isNull()
}

@Test
fun responseCookies() {
server.enqueue(
Expand Down