Provide a printable HTTP request body for easy logging

[lauraluiz]

The HttpRequestBody is an interface without any method so we have to rely on the toString method to print the internal fields, which can generate undesirable noise:

io.sphere.sdk.http.StringHttpRequestBody@542dcb08[body=facet=variants.categories.id&limit=24&offset=0&staged=false]

Can we maybe provide a method in the interface that provides a printable body? In the case of the FileHttpRequestBody I would simply print that the output is too big to be printed.

[schleichardt]

The given example with StringHttpRequestBody looks not like noise to my. Why is it noisy for you?

Can you bring more light on your use case?

HttpRequestBody has just 3 implementations, so it is possible to cast and use the getters.

[lauraluiz]

io.sphere.sdk.http.StringHttpRequestBody@542dcb08 <- this part is noisy. For normal printing it doesn't matter, but on logging I'd really would like to leave some clean messages.

Of course currently I'm casting it:

private static Optional<String> printableRequestBody(final HttpRequestIntent httpRequest) {
    return Optional.ofNullable(httpRequest.getBody())
            .map(body -> {
                final String bodyAsString;
                if (httpRequest.getBody() instanceof StringHttpRequestBody) {
                    bodyAsString = ((StringHttpRequestBody) httpRequest.getBody()).getSecuredBody();
                } else if (httpRequest.getBody() instanceof FormUrlEncodedHttpRequestBody) {
                    bodyAsString = ((FormUrlEncodedHttpRequestBody) httpRequest.getBody()).getParameters().stream()
                            .map(pair -> pair.getName() + "=" + pair.getValue())
                            .collect(Collectors.joining("&"));
                } else {
                    bodyAsString = "**omitted output**";
                }
                return bodyAsString;
            });
}

But I don't think I'm the only one that would like to log some clean messages, so this same logic might be repeated in other projects. I think the SDK can provide this functionality better.