https://github.com/guardian/toolargetool

A tool to help you debug TransactionTooLargeExceptions on Android 7+
https://github.com/guardian/toolargetool

production

Last synced: 16 days ago
JSON representation

A tool to help you debug TransactionTooLargeExceptions on Android 7+

• Host: GitHub
• URL: https://github.com/guardian/toolargetool
• Owner: guardian
• License: mit
• Created: 2017-03-30T21:17:14.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-05-28T11:17:15.000Z (26 days ago)
• Last Synced: 2024-05-29T02:39:08.558Z (25 days ago)
• Topics: production
• Language: Kotlin
• Homepage:
• Size: 464 KB
• Stars: 1,072
• Watchers: 25
• Forks: 101
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Lists

• awesome-kotlin - toolargetool - A tool to help you debug TransactionTooLargeExceptions on Android 7 (Libraries)
• awesome-kotlin - toolargetool - A tool to help you debug TransactionTooLargeExceptions on Android 7 (Libraries)

README

        
# toolargetool

[![Available on maven central](https://img.shields.io/maven-central/v/com.gu.android/toolargetool)](https://central.sonatype.com/artifact/com.gu.android/toolargetool)

A tool for debugging `TransactionTooLargeException` on Android.

> "Most underrated solution." - [Kedar Paranjape, Jun 7 '18 at 14:26](https://stackoverflow.com/questions/11451393/what-to-do-on-transactiontoolargeexception/43193425#comment88495126_50162810)

## Usage

1. Include `toolargetool` as a dependency (you can remove it again once you've debugged your crash):

    - `toolargetool` is available from `mavenCentral()`

    - Add `implementation 'com.gu.android:toolargetool:0.3.0'` in your module's `build.gradle`:

    

          dependencies {

              ...

              implementation 'com.gu.android:toolargetool:0.3.0'

          }

          

2. Import The package

       import com.gu.toolargetool.TooLargeTool;

3. Add code to start logging during app start, for example in your `Application.onCreate` method:

       TooLargeTool.startLogging(this);

4. Monitor logcat output to see which components are writing substantial data to the transaction

   buffer and when:

       $ adb logcat -s TooLargeTool

   Example logcat output (TODO: improve this example):

       D/TooLargeTool: MainActivity.onSaveInstanceState wrote: Bundle@200090398 contains 1 keys and measures 0.6 KB when serialized as a Parcel

                                                                               * android:viewHierarchyState = 0.6 KB

## Release process

_Note: these instructions will only work if you have the required credentials for publishing to the `com.gu` Sonatype repository._

1. Increase all the version number in `toolargetool/build.gradle`

2. Make a commit and tag it with `git tag -a v -m ""`.

3. Run `./gradlew publishReleasePublicationToSnapshotRepository`.