• Stars
    star
    223
  • Rank 178,458 (Top 4 %)
  • Language
    Kotlin
  • License
    Apache License 2.0
  • Created over 1 year ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

🦉 Snitcher captures global crashes, enabling easy redirection to the exception tracing screen for swift recovery.

Snitcher


License API Build Status Profile


🦉 Snitcher captures global crashes, enabling easy redirection to the exception tracing screen for swift recovery.


What is Snitcher?

Snitcher offers versatile advantages such as aiding in debugging crashes during development, facilitating easy sharing of exceptions by your QA team, enhancing user experiences with recovery screens instead of abrupt closures, and enabling global exception tracing and customized launch behaviors tailored to your specific needs. You have the complete freedom to customize the crash tracing screens according to your build types and preferences, reporting to the Firebase's Crashlytics with displaying the exception screen, including options like launching a designated Activity, sending messages to your BroadcastReceiver, or any other desired actions.

Documentation

For comprehensive details about Snitcher, please refer to the complete documentation available here.

Download

Maven Central

Gradle

Add the dependency below to your module's build.gradle file:

dependencies {
    implementation "com.github.skydoves:snitcher:1.0.3"
}

Usage

Installing Snitcher is a breeze; it hooks into global exceptions, replacing application closure with informative exception tracing screens. You can seamlessly install Snitcher using the following example:

class App : Application() {

  override fun onCreate() {
    super.onCreate()

    Snitcher.install(application = this)
  }
}

It's recommended to install Snitcher on your Application class or your on initialization solution, such as App Startup.

Tracing Global Exceptions

You can trace the global exceptions by providing exceptionHandler lambda parameter. This can be highly beneficial if you intend to gather and report exceptions to other platforms, such as Firebase Crashlyrics.

Snitcher.install(
  application = this,
  exceptionHandler = { exception: SnitcherException ->
    Firebase.crashlytics.log(exception.stackTrace) // or exception.message, 
  }
)

The exceptionHandler gives you SnitcherException, encompassing the exception message, stack traces, package name, and thread information. Additionally, it enables you to recover the original Throwable instance with the SnitcherException.throwable extension.

Snitcher.install(
  application = this,
  exceptionHandler = { exception: SnitcherException ->
    val message: String = exception.message
    val stackTrace: String = exception.stackTrace
    val throwable: Throwable = exception.throwable
    val threadName: String = exception.threadName

    // do somethings
  }
)

Custom Exception Trace Screen

Snitcher provides ready-to-use exception tracing screens (such as ExceptionTraceActivity, built with the ExceptionTraceScreen Composable), giving you the flexibility to extensively tailor these screens according to your preferences, and even design your own distinct tracing interfaces.

Snitcher.install(
  application = this,
  traceActivity = ExceptionTraceActivity::class
)

If you don't specify the traceActivity parameter, the default value will be ExceptionTraceActivity. You can tailor the launched activity by modifying the traceActivity parameter to match your preferred choice. The example below demonstrates the construction of a customized trace Activity:

class MyExceptionTraceActivity : ComponentActivity() {

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)

    setContent {
      val exception by Snitcher.exception.collectAsState()
      val launcher by Snitcher.launcher.collectAsState()

      SnitcherTheme {
        if (exception != null) {
          if (BuildConfig.DEBUG) {
            // implement your own exception trace screen
            ExceptionTraceScreen(
              launcher = launcher,
              snitcherException = exception!!,
            )
          } else {
            // implement your own app restore screen
            AppRestoreScreen(launcher = launcher)
          }
        }
      }
    }
  }
}

As demonstrated in the example above, Snitcher provides access to the SnitcherException and the package name of the launcher Activity. This information can be utilized to construct highly customized trace screens that align with your specific needs. Snitcher conveniently provides this information through StateFlows, allowing you to observe these values without the need for cumbersome intent handling when initiating the trace Activity.

val exception: SnitcherException? by Snitcher.exception.collectAsState()
val launcher: String by Snitcher.launcher.collectAsState()

Note: Following any app crashes, you can readily observe the exception details across various components at any time and from any location.

Custom Launcher (Restore) Activity

Furthermore, you can customize the launcher (restore activity), specifying which Activity should be executed upon restoration within the trace activity. If you don't specify a launcher activity, the most recent Activity that encountered a crash will automatically be launched when users press the 'restore' button. However, if you wish to launch a particular Activity instead of the most recent one, you can accomplish this by providing the launcher parameter:

Snitcher.install(
  application = this,
  launcher = MainActivity::class,
)

Custom Snitcher Theme

If you just want to use the pre-builts sreens, but want to customize those components, such as colors and strings, you can easily accomplish it by giving a copy of SnitcherColor to the SnitcherTheme:

SnitcherTheme(
  colors = SnitcherTheme.colors.copy(
    primary = Color.Blue,
    background = Color.White,
    textHighEmphasis = Color.Black
  )
) {
  if (exception != null) {
    ExceptionTraceScreen(
      launcher = launcher,
      snitcherException = exception!!,
    )
  }
}

If you wish to personalize the text strings within the pre-built UIs, you can override the following string values within your strings.xml file:

<string name="snitcher_release_crash_screen_title">Oops, Restore the previous screen?</string>
<string name="snitcher_release_crash_screen_description">The app crashed unexpectedly. We apologize for the inconvenience. Would you like to return to where you left off?</string>
<string name="snitcher_release_crash_screen_restore">Restore</string>
<string name="snitcher_debug_crash_screen_restore">Restore App</string>
<string name="snitcher_debug_crash_screen_debug_on_ide">Debug on IDE</string>
<string name="snitcher_debug_crash_screen_stacktrace">Stacktrace</string>

Custom Build Types

If you intend to launch distinct trace activities and implement different behaviors or flavors, you can install Snitcher based on specific build types, as shown in the example below:

Snitcher.install(
  application = this,
  traceActivity = if (BuildConfig.DEBUG) {
    MyExceptionTraceActivity::class
  } else {
    RestoreActivity::class
  },
  exceptionHandler = {
    if (!BuildConfig.DEBUG) {
      Firebase.crashlytics.log(exception.stackTrace)
    }
  }
)

Alternatively, you can create a single trace Activity and manage the different build types within the activity itself, as demonstrated in the example below:

Snitcher.install(
  application = this,
  launcher = MyExceptionTraceActivity::class,
)

class MyExceptionTraceActivity : ComponentActivity() {

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)

    setContent {
      val exception by Snitcher.exception.collectAsState()
      val launcher by Snitcher.launcher.collectAsState()

      SnitcherTheme {
        if (exception != null) {
          if (Snitcher.isDebuggable) {
            ExceptionTraceScreen(
              launcher = launcher,
              snitcherException = exception!!,
            )
          } else {
            AppRestoreScreen(launcher = launcher)
          }
        }
      }
    }
  }
}

As demonstrated in the above example, you have the flexibility to create your own trace or restore Activities and install them according to your various build types.

Trace Strategy

You can globally trace exceptions by providing the exceptionHandler lambda parameter during Snitcher installation. However, there might be instances where you don't wish to launch the trace Activity but rather perform other actions, such as reporting crashes or sending messages to a BroadcastReceiver. In such cases, you can modify the trace strategy as shown in the example below:

Snitcher.install(
  application = this,
  traceStrategy = TraceStrategy.REPLACE,
  exceptionHandler = {
    // do something
  },
)

In this scenario, only the exceptionHandler lambda function will be executed without triggering the launch of any trace Activity. If the traceStrategy parameter is not specified, the default behavior is set to TraceStrategy.CO_WORK, which involves executing the exceptionHandler lambda and initiating the trace activity when an app crash occurs.

Find this repository useful? ❤️

Support it by joining stargazers for this repository. ⭐
Also, follow me on GitHub for my next creations! 🤩

License

Designed and developed by 2023 skydoves (Jaewoong Eum)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

More Repositories

1

Pokedex

🗡️ Pokedex demonstrates modern Android development with Hilt, Material Motion, Coroutines, Flow, Jetpack (Room, ViewModel) based on MVVM architecture.
Kotlin
7,749
star
2

android-developer-roadmap

🗺 The Android Developer Roadmap offers comprehensive learning paths to help you understand Android ecosystems.
Kotlin
7,184
star
3

Balloon

🎈 Modernized and sophisticated tooltips, fully customizable with an arrow and animations for Android.
Kotlin
3,675
star
4

chatgpt-android

📲 ChatGPT Android demonstrates a Chatbot application using OpenAI's chat API on Android with Stream Chat SDK for Compose.
Kotlin
3,661
star
5

TransformationLayout

🌠 Transform between two Views, Activities, and Fragments, or a View to a Fragment with container transform animations for Android.
Kotlin
2,341
star
6

landscapist

🌻 A pluggable, highly optimized Jetpack Compose and Kotlin Multiplatform image loading library that fetches and displays network images with Glide, Coil, and Fresco.
Kotlin
2,031
star
7

ColorPickerView

🎨 Android colorpicker for getting colors from any images by tapping on the desired color.
Java
1,569
star
8

sandwich

🥪 Sandwich is an adaptable and lightweight sealed API library designed for handling API responses and exceptions in Kotlin for Retrofit, Ktor, and Kotlin Multiplatform.
Kotlin
1,507
star
9

DisneyMotions

🦁 A Disney app using transformation motions based on MVVM (ViewModel, Coroutines, Flow, Room, Repository, Koin) architecture.
Kotlin
1,502
star
10

AndroidVeil

🎭 An easy and flexible way to implement loading skeletons and shimmering effects on layouts for Android.
Kotlin
1,474
star
11

MarvelHeroes

❤️ A sample Marvel heroes application based on MVVM (ViewModel, Coroutines, Room, Repository, Koin) architecture.
Kotlin
1,239
star
12

PowerMenu

🔥 Powerful and modernized popup menu with fully customizable animations.
Java
1,191
star
13

PowerSpinner

🌀 A lightweight dropdown popup spinner, fully customizable with an arrow and animations for Android.
Kotlin
1,188
star
14

Orbital

🪐 Jetpack Compose Multiplatform library that allows you to implement dynamic transition animations such as shared element transitions.
Kotlin
1,097
star
15

DisneyCompose

🧸 A demo Disney app using Jetpack Compose and Hilt based on modern Android tech stacks and MVVM architecture.
Kotlin
945
star
16

WhatIf

☔ Fluent syntactic sugar of Kotlin for handling single if-else statements, nullable, collections, and booleans.
Kotlin
853
star
17

ExpandableLayout

🦚 An expandable layout that shows a two-level layout with an indicator.
Kotlin
825
star
18

ElasticViews

✨ An easy way to implement an elastic touch effect for Android.
Kotlin
811
star
19

Cloudy

☁️ Jetpack Compose blur effect library, which falls back onto a CPU-based implementation to support older API levels.
Kotlin
788
star
20

ProgressView

🌊 A polished and flexible ProgressView, fully customizable with animations.
Kotlin
783
star
21

FlexibleBottomSheet

🐬 Advanced Compose Multiplatform bottom sheet for segmented sizing, non-modal type, and allows interaction behind the bottom sheet similar to Google Maps.
Kotlin
733
star
22

AndroidRibbon

🎀 A fancy and beautiful ribbon with shimmer effects for Android.
Kotlin
692
star
23

pokedex-compose

🗡️ Pokedex Compose demonstrates modern Android development with Jetpack Compose, Hilt, Coroutines, Flow, Jetpack (Room, ViewModel), and Material Design based on MVVM architecture.
Kotlin
660
star
24

Needs

🌂 An easy way to implement modern permission instructions popup.
Kotlin
614
star
25

Pokedex-AR

🦄 Pokedex-AR demonstrates ARCore, Sceneform, and modern Android tech stacks — such as Hilt, Coroutines, Flow, Jetpack (Room, ViewModel, LiveData) based on MVVM architecture.
Kotlin
585
star
26

retrofit-adapters

🚆 Retrofit call adapters for modeling network responses using Kotlin Result, Jetpack Paging3, and Arrow Either.
Kotlin
501
star
27

TheMovies

🎬 A demo project for The Movie DB based on Kotlin MVVM architecture and material design & animations.
Kotlin
496
star
28

MovieCompose

🎞 A demo movie app using Jetpack Compose and Hilt based on modern Android tech stacks.
Kotlin
496
star
29

Only

💐 An easy way to persist and run code block only as many times as necessary on Android.
Kotlin
483
star
30

ColorPickerPreference

🎨 A library that lets you implement ColorPicker, ColorPickerDialog, ColorPickerPreference.
Kotlin
476
star
31

TheMovies2

🎬 A demo project using The Movie DB based on Kotlin MVVM architecture and material design & animations.
Kotlin
476
star
32

Submarine

🚤 Floating navigation view for displaying a list of items dynamically on Android.
Kotlin
473
star
33

Orchestra

🎺 A collection of Jetpack Compose libraries, which allows you to build tooltips, spinners, and color pickers.
Kotlin
458
star
34

colorpicker-compose

🎨 Kotlin Multiplatform color picker library for getting colors from any images by tapping on the desired color.
Kotlin
456
star
35

Rainbow

🌈 Fluent syntactic sugar of Android for applying gradations, shading, and tinting.
Kotlin
450
star
36

IndicatorScrollView

🧀 A dynamic scroll view that animates indicators according to its scroll position.
Kotlin
415
star
37

PreferenceRoom

🚚 Android processing library for managing SharedPreferences persistence efficiently and structurally.
Java
377
star
38

DoubleLift

🦋 Expands and collapses a layout horizontally and vertically sequentially.
Kotlin
360
star
39

GoldMovies

👑 The GoldMovies is based on Kotlin, MVVM architecture, coroutines, dagger, koin, and material designs & animations.
Kotlin
356
star
40

lazybones

😴 A lazy and fluent syntactic sugar for observing Activity, Fragment, and ViewModel lifecycles with lifecycle-aware properties.
Kotlin
353
star
41

compose-performance

📚 Curated articles to understand Compose internals and optimize Jetpack Compose performance.
340
star
42

gemini-android

✨ Gemini Android demonstrates Google's Generative AI on Android with Stream Chat SDK for Compose.
Kotlin
327
star
43

sealedx

🎲 Kotlin Symbol Processor that auto-generates extensive sealed classes and interfaces for Android and Kotlin.
Kotlin
321
star
44

Bindables

🧬 Android DataBinding kit for notifying data changes to UI layers with MVVM architecture.
Kotlin
310
star
45

GithubFollows

:octocat: A demo project based on MVVM architecture and material design & animations.
Kotlin
294
star
46

AndroidBottomBar

🍫 A lightweight bottom navigation view, fully customizable with an indicator and animations.
Kotlin
294
star
47

Bundler

🎁 Android Intent & Bundle extensions that insert and retrieve values elegantly.
Kotlin
263
star
48

twitch-clone-compose

🎮 Twitch clone project demonstrates modern Android development built with Jetpack Compose and Stream Chat/Video SDK for Compose.
Kotlin
226
star
49

compose-stable-marker

✒️ Compose stable markers for KMP to tell stable/immutable guarantees to the compose compiler.
Kotlin
222
star
50

Chamber

⚖️ A lightweight Android lifecycle-aware and thread-safe pipeline for communicating between components with custom scopes.
Kotlin
186
star
51

Flourish

🎩 Flourish implements dynamic ways to show up and dismiss layouts with animations.
Kotlin
175
star
52

BaseRecyclerViewAdapter

⚡ Fast way to bind RecyclerView adapter and ViewHolder for implementing clean sections.
Kotlin
164
star
53

Multi-ColorPicker

Android multi colorpicker for getting colors from any images by tapping on the desired color.
Kotlin
124
star
54

All-In-One

👔 Health care application for reminding health-todo lists and making healthy habits every day.
Kotlin
120
star
55

Medal

🏅An easy way to implement medal effect for Android.
Kotlin
110
star
56

viewmodel-lifecycle

🌳 ViewModel Lifecycle allows you to track and observe Jetpack's ViewModel lifecycle changes.
Kotlin
103
star
57

WaterDrink

💧 Simple water drinking reminder application based on MVP architecture.
Kotlin
77
star
58

Awesome-Android-Persistence

A curated list of awesome android persistence libraries about SQLite, ORM, Mobile Database, SharedPreferences, etc.
71
star
59

CameleonLayout

A library that let you implement double-layer-layout changing with slide animation.
Kotlin
71
star
60

SyncMarket

Let managing your application version update more simply.
Java
41
star
61

MagicLight-Controller

This simple demo application is controlling MagicLight's smart bulbs by bluetooth-le
Java
37
star
62

MethodScope

Reduce repetitive inheritance works in OOP world using @MethodScope.
Java
33
star
63

firebase-android-ktx

🔥 Kotlin & Compose-friendly Firebase extensions designed to help you focus on your business logic.
Kotlin
29
star
64

kmp-developer-roadmap

🗺 The Kotlin Multiplatform Developer Roadmap offers comprehensive learning paths to help you understand KMP ecosystems.
Kotlin
26
star
65

server-driven-compose

🧙 Server Driven Compose showcases server-driven UI approaches in Jetpack Compose with Firebase.
Kotlin
24
star
66

MapEditor

You can draw your map using by this Map Editor project.
C#
21
star
67

skydoves

🕊 skydoves
14
star
68

seungmani

This simple project is cocos-2dx c++ multi-patform(win32, android, ios, linux) game in Jan 2015.
C++
9
star
69

NityLife

This simple project is cocos-2dx c++ multi-patform(win32, android, ios, linux) game in 2014.
C++
6
star
70

soniaOnline

XNA C# win 32/64 patform MMO game in Jan 2016.
C#
5
star
71

Rurimo-Camera

You can take some screenshots or save images at clipboard so easily like just one click on Windows with this application.
C#
1
star