RxJava2Debug

RxJava2Debug

Source link: https://github.com/akaita/RxJava2Debug

RxJava2Debug

A library to make StackTraces involving RxJava2 more meaningful (they will always point to your code!).

Rationale

If you use RxJava2, you know the pain of debugging exceptions generated somwhere across the stream, in another thread, in a nested stream, ... The StackTrace provided by RxJava2 will tell you almost nothing. Even more, if you are using systems like Crashlytics to collect reports for and Android app, most RxJava-related crashes will be reported as a single error instance (omg, no way to fix that).

This library was created from the need to debug such situations when they happen in Android apps; even more, I needed to have a clear and precise report in Crashlytics for each distinct exception.

  1. If you handle exceptions generated in RxJava2 streams, you can query RxJava2Debug to obtain an extended StackTrace pointing to the exact line of code that created the issue.

  2. If you let exceptions generated in RxJava2 streams crash your app, RxJava2Debug will automatically extend the default StackTrace.

  3. If you let exceptions generated in RxJava2 streams crash your app and you configure RxJava2Debug with your package-names, RxJava2Debug will make sure you get unique reports for each issue (to Crashlytics, or whichever reporting system you use).

Installation

Using Maven Central :

repositories {

  mavenCentral() 
}
  dependencies {

  compile 'com.akaita.java:rxjava2-debug:1.2.1' 
}

Using JCenter:

repositories {

  jcenter() 
}
  dependencies {

  compile 'com.akaita.java:rxjava2-debug:1.2.1' 
}

Requirements

RxJava 2.1.0+

Usage

Just enable RxJava2Debug as soon as possible. In Android, for example:

public class MyApplication extends Application {

@Override
  public void onCreate() {

super.onCreate();

Fabric.with(this, new Crashlytics());

// Enable RxJava assembly stack collection, to make RxJava crash reports clear and unique

// Make sure this is called AFTER setting up any Crash reporting mechanism as Crashlytics

RxJava2Debug.enableRxJava2AssemblyTracking(new String[]{
"com.example.myapp", "com.example.mylibrary"
}
);

  
}
 
}

This will:

  • Enhance stack traces of all RxJava2-related crashes making sure they contain a reference to the method that generated the first event in the Rx pipeline
  • Make sure that Stack Traces contain a reference to your code (some class in com.example.myapp or com.example.mylibrary)
  • Make sure that crash reports in Crashlytics are actually different for each pipeline (avoid bundling every RXJava error into one reports)

You will now also be able to obtain an enhanced Stack Trace even when you implement onError (really, you should implement it):

responseSubject
  .subscribe(

responseObservable -> handleResponse(responseObservable),

throwable -> RxJava2Debug.getEnhancedStackTrace(throwable)
  );
Without RxJava2Debug With RxJava2Debug

API

Start collecting information about RxJava's execution to provide a more meaningful StackTrace in case of crash
Beware: Any crash-reporting handler should be set up before calling this method

void enableRxJava2AssemblyTracking()

Start collecting filtered information about RxJava's execution to provide a more meaningful StackTrace in case of crash
Beware: Any crash-reporting handler should be set up before calling this method

void enableRxJava2AssemblyTracking(@Nullable String[] basePackageNames)

Disable the collection of more information about RxJava's execution
Information collected before calling this method will still be reported

void disableRxJava2AssemblyTracking()

Obtain a copy of the original Throwable with an extended StackTrace

@Nullable Throwable getEnhancedStackTrace(Throwable originalException)

Features

StackTrace generation

Regardless of the thread a crash happens in, a nice StackTrace referring to the origin of the RxJava2 pipeline will be added to the causes of the crash.

Config:

RxJava2Debug.enableRxJava2AssemblyTracking();

Example (pointing to my own faulty code in com.akaita.fgas.activities.TopActivity.onResume(TopActivity.java:205)):

FATAL EXCEPTION: main Process: com.akaita.fgas.debug, PID: 22538 java.lang.Throwable: The mapper function returned a null value.
 at io.reactivex.internal.functions.ObjectHelper.requireNonNull(ObjectHelper.java:39)
 at io.reactivex.internal.operators.observable.ObservableMap$MapObserver.onNext(ObservableMap.java:59)
 at hu.akarnokd.rxjava2.debug.ObservableOnAssembly$OnAssemblyObserver.onNext(ObservableOnAssembly.java:55)
 at io.reactivex.internal.operators.observable.ObservableSubscribeOn$SubscribeOnObserver.onNext(ObservableSubscribeOn.java:58)
 at hu.akarnokd.rxjava2.debug.ObservableOnAssembly$OnAssemblyObserver.onNext(ObservableOnAssembly.java:55)
 at io.reactivex.internal.operators.observable.ObservableScalarXMap$ScalarDisposable.run(ObservableScalarXMap.java:248)
 at io.reactivex.internal.operators.observable.ObservableJust.subscribeActual(ObservableJust.java:35)
 at io.reactivex.Observable.subscribe(Observable.java:10838)
 at hu.akarnokd.rxjava2.debug.ObservableOnAssemblyScalarCallable.subscribeActual(ObservableOnAssemblyScalarCallable.java:41)
 at io.reactivex.Observable.subscribe(Observable.java:10838)
 at io.reactivex.internal.operators.observable.ObservableSubscribeOn$SubscribeTask.run(ObservableSubscribeOn.java:96)
 at io.reactivex.Scheduler$DisposeTask.run(Scheduler.java:452)
 at io.reactivex.internal.schedulers.ScheduledRunnable.run(ScheduledRunnable.java:61)
 at io.reactivex.internal.schedulers.ScheduledRunnable.call(ScheduledRunnable.java:52)
 at java.util.concurrent.FutureTask.run(FutureTask.java:237)
 at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:272)
 at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1133)
 at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:607)
 at java.lang.Thread.run(Thread.java:761) Caused by: java.lang.Throwable
 at io.reactivex.internal.functions.ObjectHelper.requireNonNull(ObjectHelper.java:39)
 at com.akaita.fgas.activities.TopActivity.onResume(TopActivity.java:205)
 at android.app.Instrumentation.callActivityOnResume(Instrumentation.java:1269)
 at android.app.Activity.performResume(Activity.java:6766)
 at android.app.ActivityThread.performResumeActivity(ActivityThread.java:3377)
 at android.app.ActivityThread.handleResumeActivity(ActivityThread.java:3440)
 at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:2713)
 at android.app.ActivityThread$H.handleMessage(ActivityThread.java:1460)
 at android.os.Handler.dispatchMessage(Handler.java:102)
 at android.os.Looper.loop(Looper.java:154)
 at android.app.ActivityThread.main(ActivityThread.java:6077)
 at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:866)
 at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:756)

Instead of the obscure:

FATAL EXCEPTION: main Process: com.akaita.fgas.debug, PID: 27300 io.reactivex.exceptions.OnErrorNotImplementedException: The mapper function returned a null value.
 at io.reactivex.internal.functions.Functions$OnErrorMissingConsumer.accept(Functions.java:704)
 at io.reactivex.internal.functions.Functions$OnErrorMissingConsumer.accept(Functions.java:701)
 at io.reactivex.internal.observers.LambdaObserver.onError(LambdaObserver.java:74)
 at io.reactivex.internal.operators.observable.ObservableObserveOn$ObserveOnObserver.checkTerminated(ObservableObserveOn.java:276)
 at io.reactivex.internal.operators.observable.ObservableObserveOn$ObserveOnObserver.drainNormal(ObservableObserveOn.java:172)
 at io.reactivex.internal.operators.observable.ObservableObserveOn$ObserveOnObserver.run(ObservableObserveOn.java:252)
 at io.reactivex.android.schedulers.HandlerScheduler$ScheduledRunnable.run(HandlerScheduler.java:109)
 at android.os.Handler.handleCallback(Handler.java:751)
 at android.os.Handler.dispatchMessage(Handler.java:95)
 at android.os.Looper.loop(Looper.java:154)
 at android.app.ActivityThread.main(ActivityThread.java:6077)
 at java.lang.reflect.Method.invoke(Native Method)
 at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:866)
 at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:756) Caused by: java.lang.NullPointerException: The mapper function returned a null value.
 at io.reactivex.internal.functions.ObjectHelper.requireNonNull(ObjectHelper.java:39)
 at io.reactivex.internal.operators.observable.ObservableMap$MapObserver.onNext(ObservableMap.java:59)
 at io.reactivex.internal.operators.observable.ObservableSubscribeOn$SubscribeOnObserver.onNext(ObservableSubscribeOn.java:58)
 at io.reactivex.internal.operators.observable.ObservableScalarXMap$ScalarDisposable.run(ObservableScalarXMap.java:248)
 at io.reactivex.internal.operators.observable.ObservableJust.subscribeActual(ObservableJust.java:35)
 at io.reactivex.Observable.subscribe(Observable.java:10838)
 at io.reactivex.internal.operators.observable.ObservableSubscribeOn$SubscribeTask.run(ObservableSubscribeOn.java:96)
 at io.reactivex.Scheduler$DisposeTask.run(Scheduler.java:452)
 at io.reactivex.internal.schedulers.ScheduledRunnable.run(ScheduledRunnable.java:61)
 at io.reactivex.internal.schedulers.ScheduledRunnable.call(ScheduledRunnable.java:52)
 at java.util.concurrent.FutureTask.run(FutureTask.java:237)
 at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:272)
 at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1133)
 at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:607)
 at java.lang.Thread.run(Thread.java:761)

StackTrace filtering

Tell RxJava2Debug which packages names you want to highlight, and RxJava2Debug will make sure they appear as the top of the StackTrace

Config:

RxJava2Debug.enableRxJava2AssemblyTracking(new String[]{
"com.akaita.fgas", "com.akaita.android"
}
);

Result:

FATAL EXCEPTION: main Process: com.akaita.fgas.debug, PID: 22538 java.lang.Throwable: The mapper function returned a null value.
 at io.reactivex.internal.functions.ObjectHelper.requireNonNull(ObjectHelper.java:39)
 at io.reactivex.internal.operators.observable.ObservableMap$MapObserver.onNext(ObservableMap.java:59)
 [...] Caused by: java.lang.Throwable
 at com.akaita.fgas.activities.TopActivity.onResume(TopActivity.java:205)
 at android.app.Instrumentation.callActivityOnResume(Instrumentation.java:1269)
 at android.app.Activity.performResume(Activity.java:6766)
 at android.app.ActivityThread.performResumeActivity(ActivityThread.java:3377)
 at android.app.ActivityThread.handleResumeActivity(ActivityThread.java:3440)
 at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:2713)
 at android.app.ActivityThread$H.handleMessage(ActivityThread.java:1460)
 at android.os.Handler.dispatchMessage(Handler.java:102)
 at android.os.Looper.loop(Looper.java:154)
 at android.app.ActivityThread.main(ActivityThread.java:6077)
 at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:866)
 at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:756)

This comes in very handy when you work with a error reporting system such as Crashlytics.

Instead of getting a multitude of reports involving RxJava2 into a single report entry, you'll get one entry per crash.

Credits

This library is using a subset of classes from akarnokd's RxJava2Extensions.

RxJava2Extensions takes about kb and contains methods. RxJava2Debug takes about `38kb` and contains methods.

Source link: https://github.com/akaita/RxJava2Debug

Q & A

Invalid zip file format - Magisk 22.1
Faster way to copy slot B back to slot A after update
Can't factory reset my Galaxy S20
How do I find out what app is showing a toast?
Is it possible to backup data from a locked android phone?

Resources

AdvancedAsyncTask

This library extends AsyncTask api.

Features:

  • You can handle task's priority in task queue (from fifo queue to priority queue).
  • You can handle running thread's priority for task.
  • You can set a timer for task.

Background Processing

FreeBuilder

Automatic generation of the Builder pattern.

APT

Disco

Scroll animation library for Android.

Scroll Views

DraggableFlipView

An Android View library that flips while dragging.

Views

Wire Gradle Plugin

A Gradle plugin for generating Java code for your protocol buffer definitions with Wire.

Gradle Plugins

RangeSliderView

Android Range Slider View.

Features:

  • Ripple effect on Android Lollipop devices
  • Option to set custom colors for slider
  • Option to set custom colors for slider height

Range Bars

Q & A

Invalid zip file format - Magisk 22.1
Faster way to copy slot B back to slot A after update
Can't factory reset my Galaxy S20
How do I find out what app is showing a toast?
Is it possible to backup data from a locked android phone?

Topics

2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes