Error handling

[martinralfreindl]

Hi @Milad-Akarie and other auto_route enjoyers ,

Situation

I've been using auto-route for a while and overall love the package ❤️ .

Complication

While lots of things about auto_route are amazing, one thing I would love to see a bit more of is some more advanced error handling. In particular, I have two main gripes:

1. No custom errors: From what I can see, all auto_route errors are currently thrown as FlutterErrors. This is nice, but it makes it very difficult to define custom logic for handling navigation errors (e.g. reporting a navigation error to sentry with custom params)
2. No global error handler: The closest thing to custom auto_route errorHandling we seem to have is the onFailure callbacks on most navigation methods. are nice, but defining them on each callback creates a ton of boilerplate, to the point where I just don't do it.

Question

Would it be possible to make error handling more mature?

Suggested Answer

I would love to see improved error handling in which we have the following features:

1. Add AutoRouteException: these are thrown whenever an exception occurs. An AutoRouteException passes information on:

   • currentRoute: The current route (and path?) from which we are navigating
   • method: The method that was called and failed (e.g. maybePop)
   • targetRoute: The route we are trying to navigate to (if pushing / navigating forward)
   • anything else that folks think makes sense

2. Add AutoRouteError: This gets thrown whenever our routingConfig, routes tree, etc are incorrect.

3. Add global onError callback to the AutoRouterConfig that allows us to handle what happens when a AutoRouteException is thrown (two options here in my mind)

To be fully honest, the above approach is heavily adapted on go_routers approach. That could certainly be an inspiration.

Anyway - thanks as always Milad. Would love to get your thoughts on the above.