WhatTheStack

WhatTheStack is a library to make your debugging experience on Android better.

It shows you a pretty error screen when your Android App crashes, instead of a boring old dialog saying "Unfortunately, <your-app> has crashed".

Setup

Follow the Installation Instructions to set it up.

Remember to use WhatTheStack only in debug builds of your app by using debugImplementation instead of implementation.

Now when an uncaught exception is thrown in your application, you will be greeted with a screen similar to this:

Disabling automatic initialization

WhatTheStack initializes automatically when your application starts. It accomplishes this using Jetpack's App Startup library.

If you want to disable automatic startup, add the following lines to your Manifest file:

<provider
  android:name="androidx.startup.InitializationProvider"
  android:authorities="${applicationId}.androidx-startup"
  android:exported="false"
  tools:node="merge">
  <meta-data  android:name="com.haroldadmin.whatthestack.WhatTheStackInitializer"
    android:value="androidx.startup"
     tools:node="remove"/>
</provider>

Under the hood

This library works by setting a default UncaughtExceptionHandler on your app, and running a service to receive notifications about thrown exceptions.

When an uncaught exception is thrown, it is caught by this handler and sent to the service running in a different process than your application to parse and display information about the exception.

Running in a separate process is important because when an uncaught exception is thrown, the main thread of your application becomes unable to perform any UI related actions, and hence can't launch an intent to display the error screen shipped with this library.

Impact on Crashlytics

WhatTheStack works by replacing the default uncaught exception handler in your app's process. Unfortunately, crash reporting libraries such as Firebase Crashlytics also work in this manner. Since there can only be one default uncaught exception handler, WhatTheStack might break crash reporting libraries from working properly in debug builds.

This should not be a problem for most users as crash reporting tools are rarely used in debug builds.

Installation

Add Jitpack repository in your root build.gradle file:

allprojects {
  repositories {
    maven { url 'https://jitpack.io' }
  }
}

And then add the dependency to your app:

dependencies {
  debugImplementation 'com.github.haroldadmin:WhatTheStack:(latest-version)'
}

It is not recommended to use WhatTheStack in anything other than debug builds of your app. Only use debugImplementation when adding this dependency.

Contributions

Contributions to this library are very welcome.

hameno / WhatTheStack