Skip to content

fix(router): skip split when piercing empty path outlets #71121

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.

Sign up for GitHub

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

Open
atscott wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(router): skip split when piercing empty path outlets #71121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 3 additions & 8 deletions packages/router/src/recognize.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -454,15 +454,10 @@ export class Recognizer {
parentRoute,
);

const {segmentGroup, slicedSegments} = split(
rawSegment,
consumedSegments,
remainingSegments,
childConfig,
outlet,
);

const matchedOnOutlet = getOutlet(route) === outlet;
const {segmentGroup, slicedSegments} = matchedOnOutlet
? split(rawSegment, consumedSegments, remainingSegments, childConfig)
: {segmentGroup: rawSegment, slicedSegments: remainingSegments};

if (matchedOnOutlet && slicedSegments.length === 0 && segmentGroup.hasChildren()) {
const children = await this.processChildren(
Expand Down
23 changes: 4 additions & 19 deletions packages/router/src/utils/config_matching.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,14 +126,13 @@ export function split(
consumedSegments: UrlSegment[],
slicedSegments: UrlSegment[],
config: Route[],
outlet?: string,
): {
segmentGroup: UrlSegmentGroup;
slicedSegments: UrlSegment[];
} {
if (
slicedSegments.length > 0 &&
containsEmptyPathMatchesWithNamedOutlets(segmentGroup, slicedSegments, config, outlet)
containsEmptyPathMatchesWithNamedOutlets(segmentGroup, slicedSegments, config)
) {
const s = new UrlSegmentGroup(
consumedSegments,
Expand Down Expand Up @@ -196,24 +195,10 @@ function containsEmptyPathMatchesWithNamedOutlets(
segmentGroup: UrlSegmentGroup,
slicedSegments: UrlSegment[],
routes: Route[],
outlet?: string,
): boolean {
return routes.some((r) => {
// 1. Can this route match as an empty path?
const matchesEmpty = emptyPathMatch(segmentGroup, slicedSegments, r);
if (!matchesEmpty) return false;

// 2. Is this a named outlet? (We only pull in empty paths if they are named outlets).
const isNamedOutlet = getOutlet(r) !== PRIMARY_OUTLET;
if (!isNamedOutlet) return false;

// 3. Are we already processing this outlet? If so, we ignore it as a pull-in
// candidate. For example, if we are evaluating the 'secondary' outlet, we shouldn't
// "pull in" an empty 'secondary' group. We should let standard
// segment matching handle it (which looks at the actual characters in the URL).
const isSelfEvaluating = outlet !== undefined && getOutlet(r) === outlet;
return !isSelfEvaluating;
});
return routes.some(
(r) => emptyPathMatch(segmentGroup, slicedSegments, r) && getOutlet(r) !== PRIMARY_OUTLET,
);
}

function containsEmptyPathMatches(
Expand Down
185 changes: 185 additions & 0 deletions packages/router/test/recognize.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -728,6 +728,26 @@ describe('recognize', () => {
checkActivatedRoute(s.root.firstChild!.firstChild!, 'abc', {}, ComponentB, 'detail');
expect(s.root.firstChild!.firstChild!.children.length).toBe(0);
});

it('should match an empty-path named outlet with multiple children', async () => {
const s = await recognize(
[
{
path: '',
outlet: 'aux',
component: ComponentA,
children: [
{path: 'b', component: ComponentB},
{path: 'c', outlet: 'c', component: ComponentC},
],
},
],
'(aux:/(b//c:c))',
);
checkActivatedRoute(s.root.children[0], '', {}, ComponentA, 'aux');
checkActivatedRoute(s.root.children[0].children[0], 'b', {}, ComponentB);
checkActivatedRoute(s.root.children[0].children[1], 'c', {}, ComponentC, 'c');
});
});

describe('nested empty paths with outlets (issue 67708)', () => {
Expand Down Expand Up @@ -793,6 +813,171 @@ describe('recognize', () => {
checkActivatedRoute(secondaryRoute!, '', {}, ComponentD, 'secondary');
checkActivatedRoute(secondaryRoute!.firstChild!, 'component-copy', {}, ComponentA);
});

it('should match named outlet child when another named outlet empty path sibling exists', async () => {
const config = [
{
path: '',
component: ComponentA,
children: [
{
path: '',
component: ComponentB,
children: [{path: 'component', component: ComponentC}],
},
{
path: '',
outlet: 'secondary',
component: ComponentD,
children: [{path: 'component-copy', component: ComponentA}],
},
{
path: '',
outlet: 'tertiary',
component: ComponentE,
},
],
},
];

const s = await recognize(config, '(secondary:component-copy)');
checkActivatedRoute(s.root.firstChild!, '', {}, ComponentA);
const c = s.root.firstChild!.children;
const primaryRoute = c.find((r: any) => r.outlet === PRIMARY_OUTLET);
expect(primaryRoute).toBeDefined();
checkActivatedRoute(primaryRoute!, '', {}, ComponentB, PRIMARY_OUTLET);

const secondaryRoute = c.find((r: any) => r.outlet === 'secondary');
expect(secondaryRoute).toBeDefined();
checkActivatedRoute(secondaryRoute!, '', {}, ComponentD, 'secondary');
checkActivatedRoute(secondaryRoute!.firstChild!, 'component-copy', {}, ComponentA);

const tertiaryRoute = c.find((r: any) => r.outlet === 'tertiary');
expect(tertiaryRoute).toBeDefined();
checkActivatedRoute(tertiaryRoute!, '', {}, ComponentE, 'tertiary');
});

it('should match non-empty named outlet child alongside an empty-path named outlet sibling', async () => {
const config = [
{
path: '',
component: ComponentB,
children: [
{
path: 'main',
component: ComponentA,
},
{
path: 'foo',
outlet: 'secondary',
component: ComponentC,
},
{
path: '',
outlet: 'tertiary',
component: ComponentD,
},
],
},
];

const s1 = await recognize(config, '(secondary:foo)');
checkActivatedRoute(s1.root.firstChild!, '', {}, ComponentB);
expect(s1.root.firstChild!.children.length).toBe(2);
checkActivatedRoute(
s1.root.firstChild!.children.find((r) => r.outlet === 'secondary')!,
'foo',
{},
ComponentC,
'secondary',
);
checkActivatedRoute(
s1.root.firstChild!.children.find((r) => r.outlet === 'tertiary')!,
'',
{},
ComponentD,
'tertiary',
);

const s2 = await recognize(config, '(main//secondary:foo)');
checkActivatedRoute(s2.root.firstChild!, '', {}, ComponentB);
expect(s2.root.firstChild!.children.length).toBe(3);
checkActivatedRoute(
s2.root.firstChild!.children.find((r) => r.outlet === PRIMARY_OUTLET)!,
'main',
{},
ComponentA,
);
checkActivatedRoute(
s2.root.firstChild!.children.find((r) => r.outlet === 'secondary')!,
'foo',
{},
ComponentC,
'secondary',
);
checkActivatedRoute(
s2.root.firstChild!.children.find((r) => r.outlet === 'tertiary')!,
'',
{},
ComponentD,
'tertiary',
);
});

it('should match named outlet across multiple nested empty-path routes when empty-path named outlet siblings exist', async () => {
const config = [
{
path: '',
component: ComponentA,
children: [
{
path: '',
outlet: 'side1',
component: ComponentB,
},
{
path: '',
component: ComponentC,
children: [
{
path: 'b',
outlet: 'b',
component: ComponentD,
},
{
path: '',
outlet: 'side2',
component: ComponentE,
},
],
},
],
},
];

const s = await recognize(config, '(b:b)');
checkActivatedRoute(s.root.firstChild!, '', {}, ComponentA);
expect(s.root.firstChild!.children.length).toBe(2);
const level2 = s.root.firstChild!.children.find((r) => r.outlet === PRIMARY_OUTLET)!;
const side1 = s.root.firstChild!.children.find((r) => r.outlet === 'side1')!;
checkActivatedRoute(side1, '', {}, ComponentB, 'side1');
checkActivatedRoute(level2, '', {}, ComponentC, PRIMARY_OUTLET);
expect(level2.children.length).toBe(2);
checkActivatedRoute(
level2.children.find((r) => r.outlet === 'b')!,
'b',
{},
ComponentD,
'b',
);
checkActivatedRoute(
level2.children.find((r) => r.outlet === 'side2')!,
'',
{},
ComponentE,
'side2',
);
});
});
});

Expand Down
Loading