Title: Configurable Guards & Resolvers · Issue #42171 · angular/angular · GitHub
Open Graph Title: Configurable Guards & Resolvers · Issue #42171 · angular/angular
X Title: Configurable Guards & Resolvers · Issue #42171 · angular/angular
Description: Feature Request Relevant Package This feature request is for @angular/router Description I want to use a guard or a resolver across the app in many places, but always with a slightly different configuration. E.g. a guard should redirect ...
Open Graph Description: Feature Request Relevant Package This feature request is for @angular/router Description I want to use a guard or a resolver across the app in many places, but always with a slightly different conf...
X Description: Feature Request Relevant Package This feature request is for @angular/router Description I want to use a guard or a resolver across the app in many places, but always with a slightly different conf...
Opengraph URL: https://github.com/angular/angular/issues/42171
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Configurable Guards & Resolvers","articleBody":"# Feature Request\r\n\r\n### Relevant Package\r\nThis feature request is for @angular/router\r\n\r\n\r\n### Description\r\nI want to use a guard or a resolver across the app in many places, but always with a slightly different configuration. E.g. a guard should redirect to different pages when some request fails or a resolver should load data from different endpoints.\r\n\r\nThe current solution is to either pass data in the route and let the guard/resolver access this data, or create a subclass of a guard / resolver for each specific configuration. However, there is no type-safety for route data and the data may be overwritten from a parent route when `paramsInheritanceStrategy` is active. Additionally, this can get really bloated when using several configured guards or resolvers:\r\n\r\n```ts\r\n// routes.ts\r\n{\r\n path: 'page-a',\r\n component: PageAComponent,\r\n data: {\r\n authGuard: {\r\n failureRedirect: '/login'\r\n }\r\n },\r\n canActivate: [ AuthGuard ],\r\n resolve: {\r\n foo: FooContentResolver,\r\n bar: BarContentResolver\r\n }\r\n},\r\n{\r\n path: 'page-b',\r\n component: PageBComponent,\r\n data: {\r\n authGuard: {\r\n failureRedirect: '/signup'\r\n }\r\n },\r\n canActivate: [ AuthGuard ]\r\n}\r\n```\r\n\r\n```ts\r\n// resolvers\r\n\r\n@Injectable()\r\nabstract class ContentResolver implements Resolve\u003cany> {\r\n // ...\r\n}\r\n\r\n@Injectable()\r\nclass FooContentResolver extends ContentResolver {\r\n\r\n readonly options: IContentResolverOptions = {\r\n url: '/api/foo',\r\n method: 'get'\r\n };\r\n\r\n // ...\r\n}\r\n\r\n@Injectable()\r\nclass BarContentResolver extends ContentResolver {\r\n\r\n readonly options: IContentResolverOptions = {\r\n url: '/api/bar',\r\n method: 'get'\r\n };\r\n\r\n // ...\r\n}\r\n\r\n```\r\n### Describe the solution you'd like\r\n\r\nTo solve this issue, I'm imagining something similar to the `forRoot`/ `ModuleWithProviders` approach, that would let you pass options to some injectable (like here, a guard/resolver). So the `canActivate`, `canActivateChild` and `canLoad` attributes of a `Route` could also accept some kind of `InjectableWithProviders` object next to the `InjectionToken` / `string`.\r\n\r\n```ts\r\n// routes.ts\r\n{\r\n path: 'page-a',\r\n component: PageAComponent,\r\n canActivate: [ AuthGuard.withOptions({ failureRedirect: '/login' }) ],\r\n resolve: {\r\n foo: ContentResolver.load({\r\n url: '/api/foo',\r\n method: 'get'\r\n }),\r\n bar: ContentResolver.load({\r\n url: '/api/bar',\r\n method: 'get'\r\n })\r\n }\r\n},\r\n{\r\n path: 'page-b',\r\n component: PageBComponent,\r\n canActivate: [ AuthGuard.withOptions({ failureRedirect: '/signup' }) ]\r\n}\r\n```\r\n\r\n```ts\r\nconst AUTH_GUARD_OPTIONS = new InjectionToken\u003cIAuthGuardOptions>('auth-guard-options');\r\n\r\n@Injectable()\r\nclass AuthGuard implements CanActivate {\r\n\r\n static withOptions(options: IAuthGuardOptions): InjectableWithProviders\u003cAuthGuard> {\r\n return {\r\n injectable: AuthGuard,\r\n providers: [\r\n { provide: AUTH_GUARD_OPTIONS, useValue: options }\r\n ]\r\n };\r\n }\r\n\r\n // ...\r\n\r\n}\r\n```\r\n\r\n```ts\r\nconst CONTENT_RESOLVER_OPTIONS = new InjectionToken\u003cIContentResolverOptions>('content-resolver-options');\r\n\r\n@Injectable()\r\nclass ContentResolver implements Resolve\u003cany> {\r\n\r\n static load(options: IContentResolverOptions): InjectableWithProviders\u003cContentResolver> {\r\n return {\r\n injectable: ContentResolver,\r\n providers: [\r\n { provide: CONTENT_RESOLVER_OPTIONS, useValue: options }\r\n ]\r\n };\r\n }\r\n\r\n // ...\r\n\r\n}\r\n```\r\n\r\n### Describe alternatives you've considered\r\n\r\nAn alternative would be to use something similar to `MAT_DIALOG_DATA` used in `@angular/material`. We wouldn't need a fully flexible `InjectableWithProviders`, but every guard / resolver could inject a common token, e.g. `GUARD_OPTIONS` / `RESOVLER_OPTIONS` that should be configurable in the route, e.g.:\r\n\r\n```ts\r\n// routes.ts\r\n{\r\n path: 'page-a',\r\n component: PageAComponent,\r\n canActivate: [\r\n { guard: AuthGuard, options: { failureRedirect: '/login' } }\r\n ],\r\n resolve: {\r\n foo: {\r\n resolver: ContentResolver,\r\n options: {\r\n url: '/api/foo',\r\n method: 'get'\r\n }\r\n },\r\n bar: {\r\n resolver: ContentResolver,\r\n options: {\r\n url: '/api/bar',\r\n method: 'get'\r\n }\r\n }\r\n }\r\n},\r\n{\r\n path: 'page-b',\r\n component: PageBComponent,\r\n canActivate: [\r\n { guard: AuthGuard, options: { failureRedirect: '/signup' } }\r\n ]\r\n}\r\n```\r\n\r\n\r\nI also tried to dynamically create a subclass in the static method and return it, but I assume this is not optimal for dependency discovery (and is currently failing with an error when using dependencies in the constructor of the guard: `Error: This constructor is not compatible with Angular Dependency Injection because its dependency at index 0 of the parameter list is invalid.`):\r\n\r\n```ts\r\n@Injectable()\r\nclass AuthGuard implements CanActivate {\r\n\r\n static withOptions(options: IAuthGuardOptions) {\r\n\r\n @Injectable({ providedIn: 'root' })\r\n class ConfiguredAuthGuard extends AuthGuard {\r\n _options = options;\r\n }\r\n\r\n return ConfiguredAuthGuard\r\n }\r\n\r\n // ...\r\n\r\n}\r\n```\r\n\r\n### Related Issues\r\n#18247 seems related to this, but suggests some more substantial changes to routes & guards in general (which I would like to see as well!)","author":{"url":"https://github.com/homj","@type":"Person","name":"homj"},"datePublished":"2021-05-19T10:19:37Z","url":"https://github.com/angular/angular/issues/42171"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:024a5b07-ce57-594d-730b-0f2390ecf2f5 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | E716:2454CC:A8B7F8:D7C188:6B00F604 |
| html-safe-nonce | fd4a9ee964e038587015210976947a39500f254592e7d3d6cb722579884d8b7c |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFNzE2OjI0NTRDQzpBOEI3Rjg6RDdDMTg4OjZCMDBGNjA0IiwidmlzaXRvcl9pZCI6IjY1MDM1MjE5NzA1NDAzMTIwNjgiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | e59f38dad6b0b69504b5ead94876a98d3d5fcced526650042eb66a8c026473d8 |
| hovercard-subject-tag | issue:895261815 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/angular/angular/42171/issue_layout |
| twitter:image | https://opengraph.githubassets.com/5024a7069b7ab217b20a2a1253ec11f67f977ae25cd2465e3d74e5af84327823/angular/angular/issues/42171 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/5024a7069b7ab217b20a2a1253ec11f67f977ae25cd2465e3d74e5af84327823/angular/angular/issues/42171 |
| og:image:alt | Feature Request Relevant Package This feature request is for @angular/router Description I want to use a guard or a resolver across the app in many places, but always with a slightly different conf... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | homj |
| hostname | github.com |
| expected-hostname | github.com |
| None | 4ef498cbabcbe3c50befc7a5b743e7072ee770b4daf0e15e54801180d1fa91fc |
| turbo-cache-control | no-preview |
| go-import | github.com/angular/angular git https://github.com/angular/angular.git |
| octolytics-dimension-user_id | 139426 |
| octolytics-dimension-user_login | angular |
| octolytics-dimension-repository_id | 24195339 |
| octolytics-dimension-repository_nwo | angular/angular |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 24195339 |
| octolytics-dimension-repository_network_root_nwo | angular/angular |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 9983dd5da06943f833c971dd5b6bc988e2858be5 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width