GoogleCodeExporter
commented
8 years ago It looks like the problem might stem from the escapable [] characters in the
parameter name, rather than the
use of POST. I tried adding the following test in SignatureBaseStringTest:
@Test
public void shouldWorkWithBracketsInParameterName() throws Exception {
HttpRequest request = mock(HttpRequest.class);
when(request.getMethod()).thenReturn("GET");
when(request.getRequestUrl()).thenReturn("http://examplebrackets.com");
HttpParameters params = new HttpParameters();
params.put("a[]", "1");
SignatureBaseString sbs = new SignatureBaseString(request, params);
assertEquals("GET&http%3A%2F%2Fexamplebrackets.com%2F&a%255B%255D%3D1", sbs.generate());
}
(I got the hopefully correct SBS from
http://googlecodesamples.com/oauth_playground/)
This test failed as follows:
org.junit.ComparisonFailure: expected:<...om%2F&a%255B%255D%3D[1]> but
was:<...om%2F&a%255B%255D%3D[]>
So the value of the parameter was missing, just like in the originally reported
failure. I tracked down the
problem to the following sequence of operations in HttpParameters:
public String getAsQueryString(Object key) {
StringBuilder sb = new StringBuilder();
key = OAuth.percentEncode((String) key); // the provided key is first encoded
Set<String> values = wrappedMap.get(key); // and then used to grab the value
if (values == null) { // so we get value as null
return key + "=";
}
Note that this is a problem because in
SignatureBaseString.normalizeRequestParameters you have:
Iterator<String> iter = requestParameters.keySet().iterator();
for (int i = 0; iter.hasNext(); i++) {
String param = iter.next();
if (OAuth.OAUTH_SIGNATURE.equals(param) || "realm".equals(param)) {
continue;
}
if (i > 0) {
sb.append("&");
}
sb.append(requestParameters.getAsQueryString(param)); // <-- the key provided here is straight from
the Map!
}
So, normalizeRequestParameters will send to getAsQueryString exactly the value
for the key present in the
TreeMap, and yet getAsQueryString will encode it again before retrieving the
corresponding value for the
parameter - which means that unless encoding is a no-op for the particular
parameter key, we're doing
something wrong.
To try to resolve the bug, I tried switching the order of the operations in
getAsQueryString like this:
Set<String> values = wrappedMap.get(key);
key = OAuth.percentEncode((String) key);
While that fixed my added test, it broke one of yours (RequestParametersTest):
params.put("a b", "c d", true);
assertEquals("a%20b=c%20d", params.getAsQueryString("a b"));
Taking a cue off that test, I returned the library code as it was and tried
changing my test:
@Test
public void shouldWorkWithBracketsInParameterName() throws Exception {
HttpRequest request = mock(HttpRequest.class);
when(request.getMethod()).thenReturn("GET");
when(request.getRequestUrl()).thenReturn("http://examplebrackets.com");
HttpParameters params = new HttpParameters();
params.put("a[]", "1", true);
SignatureBaseString sbs = new SignatureBaseString(request, params);
assertEquals("GET&http%3A%2F%2Fexamplebrackets.com%2F&a%255B%255D%3D1", sbs.generate());
}
...but then I get the following failure:
org.junit.ComparisonFailure: expected:<...brackets.com%2F&a%25[5B%255D%3D1]>
but
was:<...brackets.com%2F&a%25[255B%25255D%3D]>
In this case there was additional escaping (which may or may not be correct,
I'm not sure) but the parameter
value was still missing.
I'm a little stuck now because:
1. I don't know what you had in mind for the percentDecode parameter. When
should a parameter be percent
encoded before being inserted in the map, and when should it not?
2. I am actually using the Apache HttpClient in my application, and I don't yet
understand how that all
interacts with the core code. Perhaps all of this has no bearing whatsoever on
code that uses HttpClient, but
the similarity in symptoms is rather suspicious.
Thoughts?
Original comment by stjepan....@gmail.com on 3 Jun 2010 at 12:06
Original issue reported on code.google.com by
stjepan....@gmail.comon 27 May 2010 at 12:27