Skip to content

allow single "=" as query #5823

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

Merged
merged 9 commits into from
Jan 31, 2025
Merged

allow single "=" as query #5823

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d9c97fd
allow single = as query
Fred1155 Jan 24, 2025
cb53e75
unit test added
Fred1155 Jan 24, 2025
6ab6e5e
changelog added
Fred1155 Jan 24, 2025
a1fd7b8
changed the behavior
Fred1155 Jan 25, 2025
3abd9db
minor change
Fred1155 Jan 27, 2025
a3cf660
Merge branch 'master' into bole/query-string-exception
Fred1155 Jan 27, 2025
2c7d947
more test cases added
Fred1155 Jan 27, 2025
b514e28
Merge branch 'master' into bole/query-string-exception
Fred1155 Jan 30, 2025
343587b
Merge branch 'master' into bole/query-string-exception
Fred1155 Jan 30, 2025
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
6 changes: 6 additions & 0 deletions .changes/next-release/bugfix-AWSSDKforJavav2-466bf4c.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"type": "bugfix",
"category": "AWS SDK for Java v2",
"contributor": "",
"description": "Fixed an issue in SdkHttpUtils used in SdkHttpFullRequest where constructing with a query string consisting of a single \"=\" would throw an ArrayIndexOutOfBoundsException."
}
20 changes: 20 additions & 0 deletions http-client-spi/src/test/java/software/amazon/awssdk/http/SdkHttpRequestResponseTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,6 +412,16 @@ public void testSdkHttpFullRequestBuilderUriWithQueryParamWithoutValue() {
assertThat(actual.getUri()).hasToString(expected);
}

@Test
public void testSdkHttpFullRequestBuilderUriWithQueryParamWithoutValueWithEqual() {
final String original = "https://github.com/aws/aws-sdk-for-java-v2?foo=";
final String expected = "https://github.com/aws/aws-sdk-for-java-v2?foo";
URI myUri = URI.create(original);

SdkHttpRequest actual = SdkHttpRequest.builder().method(SdkHttpMethod.POST).uri(myUri).build();
assertThat(actual.getUri()).hasToString(expected);
}

@Test
public void testSdkHttpRequestBuilderNoQueryParams() {
URI uri = URI.create("https://github.com/aws/aws-sdk-java-v2/issues/2034");
Expand Down Expand Up @@ -444,6 +454,16 @@ public void testSdkHttpRequestBuilderUriWithQueryParamWithoutValue() {
assertThat(actual.getUri()).hasToString(expected);
}

@Test
public void testSdkHttpRequestWithSingleEqualQuery() {
final String original = "http://example.com?=";
final String expected = "http://example.com?";
URI myUri = URI.create(original);

SdkHttpRequest actual = SdkHttpRequest.builder().method(SdkHttpMethod.POST).uri(myUri).build();
assertThat(actual.getUri()).hasToString(expected);
}

private interface BuilderProxy {
BuilderProxy setValue(String key, String value);

Expand Down
1 change: 1 addition & 0 deletions utils/src/main/java/software/amazon/awssdk/utils/http/SdkHttpUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,7 @@ public static Map<String, List<String>> uriParams(URI uri) {
return splitQueryString(uri.getRawQuery())
.stream()
.map(s -> s.split("="))
.map(s -> s.length == 0 ? new String[] {""} : s)
.map(s -> s.length == 1 ? new String[] { s[0], null } : s)
Comment on lines +408 to 409
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.map(s -> s.length == 0 ? new String[] {""} : s)
.map(s -> s.length == 1 ? new String[] { s[0], null } : s)
.map(s -> {
if (s.length == 0) {
return new String[] {""};
}
return s.length == 1 ? new String[] {s[0], null} : s;
})

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean return new String[] {"", null}; in line 410? cause otherwise it will fail on original line 410

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah I see, yup

.collect(groupingBy(a -> urlDecode(a[0]), mapping(a -> urlDecode(a[1]), toList())));
}
Expand Down
30 changes: 30 additions & 0 deletions utils/src/test/java/software/amazon/awssdk/utils/SdkHttpUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,36 @@ public void uriParams() throws URISyntaxException {
entry("decoded&Part", Arrays.asList("equals=val")));
}

@Test
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
@Test
@Test
void uriParamsWithSingleEqualQuery() {
URI uri = URI.create("http://example.com?=");
Map<String, List<String>> uriParams = SdkHttpUtils.uriParams(uri);
assertThat(uriParams).containsKey("");
assertThat(uriParams.get(""))
.isNotNull()
.hasSize(1)
.containsNull();
}
@Test
void uriParamsWithSingleEqualWithValueQuery() {
URI uri = URI.create("http://example.com?=nokeyvalue");
Map<String, List<String>> uriParams = SdkHttpUtils.uriParams(uri);
assertThat(uriParams).containsKey("");
assertThat(uriParams.get(""))
.isNotNull()
.hasSize(1)
.contains("nokeyvalue");
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also for completeness can we add test in SdkHttpRequestResponseTest since this tests the Public API

    @Test
    public void testSdkHttpRequestWithEmptyEqualQueryParameterName() {
        final String expected = "http://example.com?=";
        URI myUri = URI.create(expected);
        SdkHttpRequest actual = SdkHttpRequest.builder().method(SdkHttpMethod.POST).uri(myUri).build();
        assertThat(actual.getUri()).hasToString(expected);
    }

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test will fail because our current implementation will eliminate "=" when there are no query values. I added a test that the expected result string is "http://example.com?"

void uriParamsWithSingleEqualQuery() {
URI uri = URI.create("http://example.com?=");
Map<String, List<String>> uriParams = SdkHttpUtils.uriParams(uri);
assertThat(uriParams).containsKey("");
assertThat(uriParams.get(""))
.isNotNull()
.hasSize(1)
.containsNull();
}
@Test
void uriParamsWithSingleEqualWithValueQuery() {
URI uri = URI.create("http://example.com?=nokeyvalue");
Map<String, List<String>> uriParams = SdkHttpUtils.uriParams(uri);
assertThat(uriParams).containsKey("");
assertThat(uriParams.get(""))
.isNotNull()
.hasSize(1)
.contains("nokeyvalue");
}
@Test
void uriParamsWithWithEmptyValueQuery() {
URI uri = URI.create("http://example.com?novaluekey=");
Map<String, List<String>> uriParams = SdkHttpUtils.uriParams(uri);
assertThat(uriParams).containsKey("novaluekey");
assertThat(uriParams.get("novaluekey"))
.hasSize(1)
.containsNull();
}

@Test
void parseSingleNonProxyHost(){
String singleHostName = "singleHost" ;
Expand Down
Loading