Skip to content

fix(@angular/ssr): prioritize the first matching route over subsequent ones #29543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions packages/angular/ssr/src/routes/ng-routes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -557,7 +557,6 @@ export async function getRoutesFromAngularRouterConfig(
// Wait until the application is stable.
await applicationRef.whenStable();

const routesResults: RouteTreeNodeMetadata[] = [];
const errors: string[] = [];

let baseHref =
Expand All @@ -581,11 +580,12 @@ export async function getRoutesFromAngularRouterConfig(
if (errors.length) {
return {
baseHref,
routes: routesResults,
routes: [],
errors,
};
}

const routesResults: RouteTreeNodeMetadata[] = [];
if (router.config.length) {
// Retrieve all routes from the Angular router configuration.
const traverseRoutes = traverseRoutesConfig({
Expand All @@ -599,11 +599,19 @@ export async function getRoutesFromAngularRouterConfig(
entryPointToBrowserMapping,
});

for await (const result of traverseRoutes) {
if ('error' in result) {
errors.push(result.error);
} else {
routesResults.push(result);
const seenRoutes: Set<string> = new Set();
for await (const routeMetadata of traverseRoutes) {
if ('error' in routeMetadata) {
errors.push(routeMetadata.error);
continue;
}

// If a result already exists for the exact same route, subsequent matches should be ignored.
// This aligns with Angular's app router behavior, which prioritizes the first route.
const routePath = routeMetadata.route;
if (!seenRoutes.has(routePath)) {
routesResults.push(routeMetadata);
seenRoutes.add(routePath);
}
}

Expand Down
34 changes: 34 additions & 0 deletions packages/angular/ssr/test/routes/ng-routes_spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -570,4 +570,38 @@ describe('extractRoutesAndCreateRouteTree', () => {
expect(errors).toHaveSize(0);
expect(routeTree.toObject()).toHaveSize(2);
});

it('should give precedence to the first matching route over subsequent ones', async () => {
setAngularAppTestingManifest(
[
{
path: '',
children: [
{ path: 'home', component: DummyComponent },
{ path: '**', component: DummyComponent },
],
},
// The following routes should be ignored due to Angular's routing behavior:
// - ['', '**'] and ['**'] are equivalent, and the first match takes precedence.
// - ['', 'home'] and ['home'] are equivalent, and the first match takes precedence.
{
path: 'home',
redirectTo: 'never',
},
{
path: '**',
redirectTo: 'never',
},
],
[{ path: '**', renderMode: RenderMode.Server }],
);

const { routeTree, errors } = await extractRoutesAndCreateRouteTree({ url });
expect(errors).toHaveSize(0);
expect(routeTree.toObject()).toEqual([
{ route: '/', renderMode: RenderMode.Server },
{ route: '/home', renderMode: RenderMode.Server },
{ route: '/**', renderMode: RenderMode.Server },
]);
});
});