[go_router_builder] Allow required query parameters

[ValentinVignal]

Is there an existing issue for this?

• I have searched the existing issues
• I have read the guide to filing a bug

Use case

In some scenario, some routes (ex: /my-route/:route-id) requires to always have a parameter (ex: /my-route/:route-id?my-param=my-value)

I would like to enforce the generated code and developers to always specify this parameter:

MyRoute(routeId: 'routeId', myParam: 'myValue').location; // <- OK
MyRoute(routeId: 'routeId').location; // <- KO: `myParam` is required

by doing:

@TypedRoute<MyRoute>(path: '/my-route/:route-id')
class MyRoute extends GoRouteData {
  MyRoute({
    required this.routeId,
    required this.myParam,
  });

  final String routeId;
  final String myParam;
}

Right now, I can only use asserts:

@TypedRoute<MyRoute>(path: '/my-route/:route-id')
class MyRoute extends GoRouteData {
  MyRoute({
    required this.routeId,
    this.myParam = '',
  }): assert(myParam.isNotEmpty);

  final String routeId;
  final String myParam;
}

but this doesn't give a check at compilation time, it only fails at running time.

Proposal

It would be nice to support required query parameters:

@TypedRoute<MyRoute>(path: '/my-route/:route-id')
class MyRoute extends GoRouteData {
  MyRoute({
    required this.routeId,
    required this.myParam,
  });

  final String routeId;
  final String myParam;
}

[dancamdev]

@chunhtai is there any reason why this shouldn't be a thing?

I worked on integrating required extra parameters, technically this should be feasible as well and wouldn't break existing code.

[chunhtai]

what happen if user type the url bar directly without the required query parameter. Does it just crash the app?

[ValentinVignal]

what happen if user type the url bar directly without the required query parameter. Does it just crash the app?

I guess it would. But it would also crash today if the wrong type is given to a parameter, ex:

@TypedRoute<MyRoute>(path: '/my-route/:route-id')
class MyRoute extends GoRouteData {
  MyRoute({
    required this.routeId,
    this.myParam,
  });

  final int routeId;
  final int myParam;
}

would crash today if the use types /my-route/route-id?my-param=my-value as "route-id" and "my-value" are not ints.

---

Also, calling

@TypedRoute<MyRoute>(path: '/my-route/:route-id')
class MyRoute extends GoRouteData {
  MyRoute({
    required this.routeId,
    this.myParam = '',
  }) : assert(myParam.isNotEmpty);

  final String routeId;
  final String myParam;
}

without my-param parameter from the URL could put the app in an inconsistent/bad state.

[chunhtai]

I see, yeah i guess that is inevitable if we move toward type safe routing. This is off-topic, but I think we should have a way to handle type mismatch.

[Maatteogekko]

Wouldn't a redirect to error page be a good fit in this case?

[chunhtai]

That would be a catch all. I was imagining a route by route error handling