FlowRedux icon indicating copy to clipboard operation
FlowRedux copied to clipboard

More unique Exceptions

Open DatL4g opened this issue 1 year ago • 3 comments

Please separate your exceptions more uniquely as there is no way of operating special use-cases.

Functions throwing a IllegalStateException:

  • spec (2x)
  • dispatch
  • checkSpecBlockSet

Maybe create something like this? Didn't create PR as I'm not sure how you want to adopt things, but here a simple example:

sealed interface FlowReduxException {
	data object AlreadyInitialized : IllegalStateException(
                "State machine spec has already been set. " +
                    "It's only allowed to call spec {...} once.",
            ), FlowReduxException

	data object AlreadyCollected : IllegalStateException(
                        "Can not collect state more than once at the same time. Make sure the" +
                            "previous collection is cancelled before starting a new one. " +
                            "Collecting state in parallel would lead to subtle bugs.",
                    ), FlowReduxException

	data object NotInitialized : IllegalStateException(
                """
                    No state machine specs are defined. Did you call spec { ... } in init {...}?
                    Example usage:

                    class MyStateMachine : FlowReduxStateMachine<State, Action>(InitialState) {

                        init{
                            spec {
                                inState<FooState> {
                                    on<BarAction> { ... }
                                }
                                ...
                            }
                        }
                    }
                """.trimIndent(),
            ), FlowReduxException

	data class NotCollected(val action: A) : IllegalStateException(
                "Cannot dispatch action $action because state Flow of this " +
                    "FlowReduxStateMachine is not collected yet. " +
                    "Start collecting the state Flow before dispatching any action.",
            ), FlowReduxException
}

DatL4g avatar Jul 15 '24 19:07 DatL4g

as there is no way of operating special use-cases

Could you expand on what these cases are and what you need to handle?

gabrielittner avatar Jul 25 '24 06:07 gabrielittner

I would want to ignore NotCollected exceptions and not all IllegalStateException FlowRedux throws.

Sure that's pretty easy as it's only thrown in dispatch but it's way easier to keep track of it in the code then.

Additionally Firebase Crashlytics for example summarize exceptions and send reports per mail. However this mails just show that it's a IllegalStateException, not where it's thrown.

Overall it just improves code and crash report readability

DatL4g avatar Jul 25 '24 10:07 DatL4g

Makes sense 👍 I'll add something soon.

gabrielittner avatar Jul 26 '24 10:07 gabrielittner

Sorry for the long silence on this. In 2.0 there are only exceptions for not initialized yet and already initialized the rest is gone. The remaining 2 are not something that should be caught so I don't think extra types are needed.

gabrielittner avatar Jul 24 '25 12:07 gabrielittner