Custom body decoding #555

MiSikora · 2021-02-10T19:35:13Z

📷 Screenshots

Protobuf encoded request available in preview:

📄 Context

There is an issue – #523.

📝 Changes

I added BodyEncoder interface which instances can be installed in ChukcerInterceptor. They are then applied when bodies are being processed. First result that is non–null String is used as a body in transaction.

Exporting functionality was modified to accommodate for changes and export custom payloads as well.

I also edited sample to contain some custom processing. Unfortunately I did only for requests because I cannot find any public service that will echo proto data.

🚫 Breaking

No

🛠️ How to test

Run the sample, check postman echo request, check exporting.

⏱️ Next steps

ChuckerInterceptorTest needs some splitting into smaller units and/or moving test to respective processors. Also, HttpBinClient needs some clean-up because as mentioned some time ago it is now doing more than communicating with httpbin.
Closes #523.

MiSikora · 2021-02-10T19:41:04Z

Lint decided to fail with versions updates for some reason on this PR. 🤷‍♂️

cortinico

Great work @MiSikora 🚀 Really excited to see this coming!

The code looks good on my end, I left mostly minor comments and nits.

library/src/main/java/com/chuckerteam/chucker/internal/support/RequestProcessor.kt

library/src/main/java/com/chuckerteam/chucker/internal/support/ResponseProcessor.kt

cortinico · 2021-02-12T18:50:54Z

.../src/main/java/com/chuckerteam/chucker/internal/ui/transaction/TransactionPayloadFragment.kt

+            } else if (bodyString.isBlank()) {
+                if (!isBodyPlainText) {


Can you merge this into a single condition?

Not in the current format, but I think it makes more sense to change to when. It'll make it clearer.

cortinico · 2021-02-12T18:52:56Z

library/src/test/java/com/chuckerteam/chucker/api/ChuckerInterceptorTest.kt

+    private class LiteralBodyDecoder : BodyDecoder {
+        override fun decodeRequest(request: Request, body: ByteString) = "Request"
+        override fun decodeResponse(response: Response, body: ByteString) = "Response"
+    }


I believe that all the *Decoder + all the related tests should be moved to a ChuckerInterceptor_withDecoderTest

sample/src/main/java/com/chuckerteam/chucker/sample/HttpBinClient.kt

cortinico · 2021-02-12T18:56:33Z

sample/src/main/java/com/chuckerteam/chucker/sample/HttpBinClient.kt

+        val pokemon = Pokemon("Pikachu", level = 99)
+        val body = pokemon.encodeByteString().toRequestBody("application/protobuf".toMediaType())
+        val request = Request.Builder()
+            .url("https://postman-echo.com/post")


This class is getting bloated :( It's called HttpBinClient but we do a lot of other stuff inside:

downloadSampleImage(colorHex = "fff") downloadSampleImage(colorHex = "000") getResponsePartially() getProtoResponse()

Can you please move this code into PostmanEchoClient and then we'll take care of refactoring the status quo?

I didn't want to move focus from decoding in this PR. Like mentioned in "next steps" section I'd prefer to restructure it in a separate PR if you don't mind.

Yup let's follow up on this

cortinico · 2021-02-12T18:59:11Z

library/src/main/java/com/chuckerteam/chucker/api/BodyDecoder.kt

+    @Throws(IOException::class)
+    public fun decodeRequest(request: Request, body: ByteString): String?


nit: This is more an API design question.

What we're modelling here is an operation that could have 3 outcomes: success (String), failure (IOException), skipped (null).

Have you considered different approaches (e.g. sealed classes or the Kotlin Result type)? I'm not saying that the approach here is wrong, but I was wondering if we have some benefit in modelling it differently.

Agree with this nitpick that it might be a good idea to model the result to leave less ambiguity.
For example, we could have something like Failure instead of null in case of unsupported content.

Yes, I considered it and I don't think it is the right choice. I don't see how it helps us in the processing pipeline. We are interested only in the first successfully decoded body.

IOException does not model a type of respons. Methods are annotated with it because tools like adapters generally can throw this type of exception so it removes form users a burden of needing to deal with it. And in Kotlin it is easy to forget since exceptions are not checked. Also, it allows us to log exceptions for the user so they have feedback information when something goes wrong. I would be either for keeping this part as is or to remove @Throws and move the responsibility to the users.

Returning null instead of some type is a nod towards libraries like Retrofit or Moshi, where factories return it when they can't handle input. I don't mind modelling it with a sealed class but I don't know if it brings anything to the table. If you feel that it would be helpful I'll change it.

Thanks for your insights 👍 I think we're fine with the current modelling for the reasons you mentioned + is the one that has the smaller API surface

This thread started with nit annotation, so let's leave it as it is :)

README.md

vbuberen · 2021-02-12T20:06:29Z

library/src/main/java/com/chuckerteam/chucker/api/BodyDecoder.kt

+public interface BodyDecoder {
+    /**
+     * Returns a text representation of [body] that will be displayed in Chucker UI transaction,
+     * or `null` if [request] cannot be handled by this decoder. [Body][body] is no longer than


Looks like a typo with 2 body

I believe is actually valid KDoc where you can specify the display text for a link 🤔

Yes, it is deliberate. It allows to link to body property and start the sentence with a capital letter.

vbuberen · 2021-02-12T20:13:10Z

library/src/main/java/com/chuckerteam/chucker/api/BodyDecoder.kt

+    @Throws(IOException::class)
+    public fun decodeRequest(request: Request, body: ByteString): String?


Agree with this nitpick that it might be a good idea to model the result to leave less ambiguity.
For example, we could have something like Failure instead of null in case of unsupported content.

vbuberen · 2021-02-12T20:13:24Z

library/src/main/java/com/chuckerteam/chucker/api/BodyDecoder.kt

+
+    /**
+     * Returns a text representation of [body] that will be displayed in Chucker UI transaction,
+     * or `null` if [response] cannot be handled by this decoder. [Body][body] is no longer than


Same typo with 2 body

Same, not a typo. :)

library/src/main/java/com/chuckerteam/chucker/internal/support/PlainTextDecoder.kt

MiSikora added 2 commits February 10, 2021 20:18

Add custom body encoding

733178f

Add custom body encoder to the sample app

f0b44c6

MiSikora added the enhancement New feature or improvement to the library label Feb 10, 2021

MiSikora requested a review from cortinico February 10, 2021 19:35

Update documentation

32b2bcf

MiSikora force-pushed the custom-body-decoding branch from 250dd1b to 32b2bcf Compare February 10, 2021 22:52

MiSikora requested a review from vbuberen February 11, 2021 08:47

Remove debug log

c83fdcc

vbuberen mentioned this pull request Feb 12, 2021

Disable lint check for dependency versions #558

Merged

cortinico approved these changes Feb 12, 2021

View reviewed changes

vbuberen reviewed Feb 12, 2021

View reviewed changes

MiSikora added 7 commits February 13, 2021 09:35

Merge branch 'develop' into custom-body-decoding

64e62d4

Enable logging throwable for all levels

f392539

Change body decoding failure logs

8541522

Simplify payload processing logic

b3bfa99

Move decoder tests to a separate file

039d0b6

Move sample proto decoder to a separate file

f171e71

Use braces in else clauses

ca6fb44

MiSikora added this to the 4.0.0 milestone Feb 13, 2021

vbuberen approved these changes Feb 14, 2021

View reviewed changes

MiSikora merged commit 636bd6e into develop Feb 14, 2021

MiSikora deleted the custom-body-decoding branch February 14, 2021 08:24

This was referenced Feb 14, 2021

Fix UI for emtpy body in request/response #562

Merged

Body encoding detection #567

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Custom body decoding #555

Custom body decoding #555

MiSikora commented Feb 10, 2021 •

edited

Loading

MiSikora commented Feb 10, 2021

cortinico left a comment •

edited

Loading

cortinico Feb 12, 2021

MiSikora Feb 13, 2021

cortinico Feb 12, 2021

cortinico Feb 12, 2021

MiSikora Feb 13, 2021

cortinico Feb 13, 2021

cortinico Feb 12, 2021

vbuberen Feb 12, 2021

MiSikora Feb 13, 2021 •

edited

Loading

cortinico Feb 13, 2021

vbuberen Feb 14, 2021

vbuberen Feb 12, 2021

cortinico Feb 12, 2021

MiSikora Feb 13, 2021

vbuberen Feb 12, 2021

vbuberen Feb 12, 2021

MiSikora Feb 13, 2021

		@Throws(IOException::class)
		public fun decodeRequest(request: Request, body: ByteString): String?

Custom body decoding #555

Custom body decoding #555

Conversation

MiSikora commented Feb 10, 2021 • edited Loading

📷 Screenshots

📄 Context

📝 Changes

🚫 Breaking

🛠️ How to test

⏱️ Next steps

MiSikora commented Feb 10, 2021

cortinico left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MiSikora Feb 13, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MiSikora commented Feb 10, 2021 •

edited

Loading

cortinico left a comment •

edited

Loading

MiSikora Feb 13, 2021 •

edited

Loading