Fix depleting bytes from the response. #226

MiSikora · 2020-02-08T16:09:59Z

📄 Context

Why did you change something? Is there an issue to link here? Or an extarnal link?

There is an issue with Chucker and images. #225

📝 Changes

Which code did you change? How?

Major focus was on processResponseBody method of ChuckerInterceptor.

If source is identified as an image do not read bytes directly but copy them instead.
Simplify gzip logic.

Minor change was to use HttpUrl directly instead of relying on android.net.Uri. It was unnecessary and made JVM tests harder. Aditional benefit is that now #155 is simpler to implement.

⚠️ Breaking

Is there something breaking in the API? Any class or method signature changed?

No API breaking changes. Resulting Response does not use FixedLengthSource anymore as bytes are copied to the internal buffer but it shouldn't matter to the end consumers.

📝 How to test

Is there a special case to test your changes?

I added jUnit tests but for manuall testing you can run https://github.com/MiSikora/Chucker-Bug with fixes from this PR.

Also, sorry if something is messed up in tests. I'm not used to testing with mocks but I didn't see any way around it since interceptor is coupled with the Android framework.

🔮 Next steps

Do we have to plan something else after the merge?

Hotfix release would be welcome. :)

Closes #225

vbuberen · 2020-02-08T23:51:39Z

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

@@ -178,6 +182,9 @@ class ChuckerInterceptor @JvmOverloads constructor(
        return builder.build()
    }

+    /** Checks if the OkHttp response uses gzip encoding. */
+    private val Response.isGzipped get() = io.bodyIsGzipped(headers()[CONTENT_ENCODING])


I suggest to move it to OkHttpUtils to other similar extensions.

vbuberen · 2020-02-09T00:20:32Z

Thanks for your contribution and for adding tests.
Just a minor comment and we are good to go.

I will do a hotfix release 3.1.2 after merging your PR.

MiSikora · 2020-02-09T06:01:22Z

While refactoring I removed Response.hasBody() extension and rely during interception solely on OkHttp with a null check on body(). I'm not sure if the mentioned extension served any purpose as a workaround etc. Please let me know if this should be reverted.

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

…/OkHttpUtils.kt Co-Authored-By: Volodymyr Buberenko <vbuberen@users.noreply.github.com>

vbuberen · 2020-02-09T08:38:43Z

While refactoring I removed Response.hasBody() extension and rely during interception solely on OkHttp with a null check on body(). I'm not sure if the mentioned extension served any purpose as a workaround etc. Please let me know if this should be reverted.

That's fine from my point of view.

vbuberen · 2020-02-09T08:39:38Z

LGTM 🚢

* Remove scroll flags (#210) * Fix/gradle properties (#211) * Allow Gradle parallel build * Fix version name * Fix for curl command (#214) * Fix R8 minification crash on TransactionViewModel creation. (#219) * Big resources renaming (#216) * Fix clear action crash when application is dead (#222) * Fix for crash on Save transaction action (#221) * Show warning is transaction is null, fix crash in Save action * Uncomment sample transactions * Replace multiple returning with multiple throw due to detekt issue * Add message into IOException, update string for request being not ready * Fix for NPE in NotificationHelper (#223) * Add additional check fo transaction being not null before getting its notificationText * Extract transaction item from transactionBuffer * ViewModel refactoring (#220) * Update ViewModel dependency, refactor TransactionViewModel * Dependencies clean up * Switch to ViewModel on the main screen * Fix depleting bytes from the response. (#226) * Use HttpUrl instead of Uri for parsing URL data. * Do not read image sources directly from the response. * Simplify gzip logic. * Move gzip checks from IoUtils to OkHttpUtils. * Remove unused 'Response.hasBody()' extension. * Update library/src/main/java/com/chuckerteam/chucker/internal/support/OkHttpUtils.kt * Revert resource renaming (#227) * Revert renaming * Add changelogs for 3.1.2 (#230)

* Remove scroll flags (#210) * Fix/gradle properties (#211) * Allow Gradle parallel build * Fix version name * Fix for curl command (#214) * Fix R8 minification crash on TransactionViewModel creation. (#219) * Big resources renaming (#216) * Fix clear action crash when application is dead (#222) * Fix for crash on Save transaction action (#221) * Show warning is transaction is null, fix crash in Save action * Uncomment sample transactions * Replace mulptiple returning with multiple throw due to detekt issue * Add message into IOException, update string for request being not ready * Fix for NPE in NotificationHelper (#223) * Add additional check fo transaction being not null before getting its notificationText * Extract transaction item from transactionBuffer * ViewModel refactoring (#220) * Update ViewModel dependency, refactor TransactionViewModel * Dependencies clean up * Switch to ViewModel on the main screen * Fix depleting bytes from the response. (#226) * Use HttpUrl instead of Uri for parsing URL data. * Do not read image sources directly from the response. * Simplify gzip logic. * Move gzip checks from IoUtils to OkHttpUtils. * Remove unused 'Response.hasBody()' extension. * Update library/src/main/java/com/chuckerteam/chucker/internal/support/OkHttpUtils.kt * Revert resource renaming (#227) * Revert renaming * Add changelgos for 3.1.2 (#230) * Add missing section to release 3.1.1 and 3.1.2 (#232) * Update Github templates (#235) * Update templates * Remove redundant dot * Remove default `no` from the checkbox * Switch to platform defined HTTP code constants (#238) * Add instruction for checkbox selection (#237) * Fix HttpHeader serialization when obfuscation is enabled (#240) * Update README (#243) * Add Action to validate the Gradle Wrapper (#245) * Gradle to 6.2 (#247) * Do not refresh transaction when it is not being affected. (#246) * Do not refresh transaction when it is not being affected. * Use correct null-aware comparison for HttpTransaction. * Add switching between encoded and decoded URL formats. (#233) * Add switching between encoded and decoded URL formats. * Make URL encoding transaction specific. * Change test name for upcoming #244 PR. * Use LiveDataRecord for combineLatest tests. * Properly switch encoding and decoding URL. * Show encoding icon only when it is viable. * Add encoded URL samples to HttpBinClient. * Avoid using 'this' scoping mechanism for URL. * Fix typo in feature request comment (#251) * RTL Support (#208) * Remove ltr forcing and replace ScrollView in Overview * Replace Overview layout, add rtl support for it * Add textDirection and textAlignment property for API 21+ * Fix host textview constraints * Replace android:src with app:srcCompat * Update ids for layouts to avoid clashes * Update Material components to stable * Remove supportsRTL tag from Manifest, update Gradle plugin * Styles update * Remove supportsRTL from library manifest * Revert usage of supportVectorDrawables to avoid crashes on APIs 16-19 due to notifications icons * Fix lint issue with vector drawable * Response search fixes (#256) * Fix response search to be case insensitive * Add minimum required symbols * Fix invalid options menu in response fragment * Feature/tls info (#252) * Add UI for TLS info * Implement logic for retrieving TLS info * Address code review feedback * Switch views to ViewBinding (#253) * Switch to ViewBinding in activities * Switch to ViewBinding in ErrorsAdapter, add formattedDate field into Throwable models * Transaction adapter switch to ViewBinding * Remove variable for formatted date from models * Switch to ViewBinding in TransactionPayloadAdapter * Switch to ViewBinding in TransactionPaayload and TransactionOverviewFragments * Switch list fragments to ViewBinding * Fix link for tutorial opening * Rename views * Address code review feedback * Hide SSL field if isSSL is null * Libs update (#260) * Update tools versions * JUnit update * Feature/truth (#258) * Add Truth, update part of test classes * Convert other tests to use Truth, fix date parser test * Add Truth assertions to FormatUtilsTest, fix ktlint issue * Update assertions to a proper syntax * Add missing ThrowableViewModel (#257) * Add Error ViewModel, update title in TransactionActivity in onCreate * Switch from errors to throwable naming to have a uniform naming style * Rename toolbar title * Migrating from Travis to GH Actions (#262) * Setup GH Actions * Run only on Linux * Remove Travis File * Run only gradlew directly * Update targetSDK and Kotlin (#264) * Add stale builds canceller (#265) * Add filters * Update Gradle wrapper validation workflow * Update pre-merge workflow * Fixed various Lints (#268) * fixed typos * fixed KDocs * Replace Travis badge with GH Actions badge (#269) * Remove redundant JvmName (#274) * Fix margins and paddings for payload items (#277) * Add selective interception. (#279) * Add selective interception. * Update README.md. * Align formatting in README with other points. * Avoid header name duplication. * Strip interception header also in the no-op library. * UX improvements (#275) * Add icon for non-https transactions * Update secondary color to be more contrast * Simplify protocol resources setting * Add tests to format utils (#281) * add tests to format utils * fixes after code review * formatting fix Co-authored-by: adammasyk <adam.masyk@programisci.eu> * format utils test refactor (#285) * format utils test refactor * share text test refactor * Migrate to Kotlin Coroutines (#270) * Add coroutine as a dependency in build.gradle * Migrate AsyncTasks to kotlin coroutines * Migrate executors with the coroutines in repositories * Multi cast upstream response for Chucker consumption. (#267) * Multi cast response upstream for Chucker consumption. * Read buffer prefix before potentially gunzipping it. * Inform Chucker about unprocessed responses. * Simplify multi casting logic. * Move read offset to a variable. * Inline one-line method. * Give better control over TeeSource read results. * Add documentation to TeeSource. * Close side channel when capacity is exceeded. Co-authored-by: Volodymyr Buberenko <vbuberen@users.noreply.github.com> * Remove unnecessary mock method. (#289) * removed redundant Gson configurations (#290) * increased test coverage for format utils (#291) Co-authored-by: Karthik R <karthr@paypal.com> * added few test cases for json formatting (#295) * Properly handle unexhausted network responses (#288) * Handle properly not consumed upstream body. * Handle IO issues while reading from file. * Update dependencies (#296) * Update depencies * Update OkHttp to 3.12.10 * Handle empty and missing response bodies. (#250) * Add failing test cases. * Remove unused const. * Gzip response body if it was gunzipped. * Add test cases for regular bodies in Chucker. * Fix rule formatting. * Use proper name for application interceptor. * Return original response downstream. * Account for no content with gzip encoding. * Use Truth for Chucker tests. * Honor empty plaintext bodies. * Revert changes to HttpBinClient. * Update library/src/test/java/com/chuckerteam/chucker/ChuckerInterceptorDelegate.kt * Update library/src/main/java/com/chuckerteam/chucker/internal/support/OkHttpUtils.kt Co-authored-by: Nicola Corti <corti.nico@gmail.com> Co-authored-by: Volodymyr Buberenko <vbuberen@users.noreply.github.com> * Add hasFixed size to RecyclerViews (#297) * Detekt to 1.7.4 (#299) * Revert "Add selective interception. (#279)" (#300) This reverts commit d14ed64. * Prepare 3.2.0 (#298) * Update versions info * Update Changelog * Fix links and update date Co-authored-by: Michał Sikora <michalsikora90@gmail.com> Co-authored-by: Nicola Corti <corti.nico@gmail.com> Co-authored-by: Sergey Chelombitko <119192+technoir42@users.noreply.github.com> Co-authored-by: Michał Sikora <me@mehow.io> Co-authored-by: Hitanshu Dhawan <hitanshudhawan1996@gmail.com> Co-authored-by: adammasyk <masiol91@gmail.com> Co-authored-by: adammasyk <adam.masyk@programisci.eu> Co-authored-by: Nikhil Chaudhari <nikhyl777@gmail.com> Co-authored-by: karthik rk <karthik.rk18@gmail.com> Co-authored-by: Karthik R <karthr@paypal.com>

MiSikora added 3 commits February 8, 2020 22:12

Use HttpUrl instead of Uri for parsing URL data.

71484f9

Do not read image sources directly from the response.

91e4dd4

Simplify gzip logic.

18411b6

vbuberen reviewed Feb 8, 2020

View reviewed changes

vbuberen added this to the 3.1.2 milestone Feb 9, 2020

MiSikora added 2 commits February 9, 2020 06:55

Move gzip checks from IoUtils to OkHttpUtils.

7f2e903

Remove unused 'Response.hasBody()' extension.

dae56f3

vbuberen reviewed Feb 9, 2020

View reviewed changes

library/src/main/java/com/chuckerteam/chucker/internal/support/OkHttpUtils.kt Outdated Show resolved Hide resolved

Update library/src/main/java/com/chuckerteam/chucker/internal/support…

657e5bc

…/OkHttpUtils.kt Co-Authored-By: Volodymyr Buberenko <vbuberen@users.noreply.github.com>

vbuberen merged commit c78b861 into ChuckerTeam:develop Feb 9, 2020

MiSikora mentioned this pull request Feb 9, 2020

Fix an issue with negative request/response sizes displayed. #234

Closed

MiSikora mentioned this pull request Feb 20, 2020

Chucker 3.1.2 re-writing the Server Response; throws IOException when used as a networkInterceptor #242

Closed

MiSikora mentioned this pull request Mar 4, 2020

Handle empty and missing response bodies. #250

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix depleting bytes from the response. #226

Fix depleting bytes from the response. #226

MiSikora commented Feb 8, 2020 •

edited

Loading

vbuberen Feb 8, 2020

vbuberen commented Feb 9, 2020 •

edited

Loading

MiSikora commented Feb 9, 2020 •

edited

Loading

vbuberen commented Feb 9, 2020

vbuberen commented Feb 9, 2020

Fix depleting bytes from the response. #226

Fix depleting bytes from the response. #226

Conversation

MiSikora commented Feb 8, 2020 • edited Loading

📄 Context

📝 Changes

⚠️ Breaking

📝 How to test

🔮 Next steps

vbuberen Feb 8, 2020

Choose a reason for hiding this comment

vbuberen commented Feb 9, 2020 • edited Loading

MiSikora commented Feb 9, 2020 • edited Loading

vbuberen commented Feb 9, 2020

vbuberen commented Feb 9, 2020

MiSikora commented Feb 8, 2020 •

edited

Loading

vbuberen commented Feb 9, 2020 •

edited

Loading

MiSikora commented Feb 9, 2020 •

edited

Loading