Skip to content

refactor: move knowledge of global params out of nav service #538

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

Merged
merged 2 commits into from
Jan 27, 2021
Merged

refactor: move knowledge of global params out of nav service #538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5636df4
refactor: move knowledge of global params out of nav service
aaron-steinfeld Jan 27, 2021
62bf9f8
test: improve test
aaron-steinfeld Jan 27, 2021
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
26 changes: 20 additions & 6 deletions projects/common/src/navigation/navigation.service.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,6 @@ describe('Navigation Service', () => {
expect(router.navigate).toHaveBeenCalledWith(
['root', 'child'],
expect.objectContaining({
// tslint:disable-next-line: no-null-keyword
queryParams: { time: null },
relativeTo: undefined
})
);
Expand All @@ -155,8 +153,6 @@ describe('Navigation Service', () => {
expect(router.navigate).toHaveBeenLastCalledWith(
['child'],
expect.objectContaining({
// tslint:disable-next-line: no-null-keyword
queryParams: { time: null },
relativeTo: spectator.service.getCurrentActivatedRoute()
})
);
Expand Down Expand Up @@ -199,8 +195,6 @@ describe('Navigation Service', () => {
expect(spectator.service.buildNavigationParams('/services')).toEqual({
path: '/services',
extras: expect.objectContaining({
// tslint:disable-next-line: no-null-keyword
queryParams: { time: null },
relativeTo: undefined
})
});
Expand All @@ -220,4 +214,24 @@ describe('Navigation Service', () => {
})
);
});

test('propagates global query params', () => {
spectator.service.navigate({
navType: NavigationParamsType.InApp,
path: 'root',
queryParams: {
global: 'foo',
other: 'bar'
}
});

spectator.service.registerGlobalQueryParamKey('global');

spectator.service.navigate('root/child');

expect(spectator.service.getCurrentActivatedRoute().snapshot.url).toEqual([
expect.objectContaining({ path: 'child' })
]);
expect(spectator.service.getCurrentActivatedRoute().snapshot.queryParams).toEqual({ global: 'foo' });
});
});
10 changes: 9 additions & 1 deletion projects/common/src/navigation/navigation.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ export class NavigationService {
);

private isFirstNavigation: boolean = true;
private readonly globalQueryParams: Set<string> = new Set();

public constructor(
private readonly router: Router,
Expand Down Expand Up @@ -57,6 +58,13 @@ export class NavigationService {
});
}

/**
* Global query params will be preserved by default on navigation
*/
public registerGlobalQueryParamKey(queryParamKey: string): void {
this.globalQueryParams.add(queryParamKey);
}

public getQueryParameter(parameterName: string, defaultValue: string): string {
return this.currentParamMap.has(parameterName) ? this.currentParamMap.get(parameterName)! : defaultValue;
}
Expand Down Expand Up @@ -116,7 +124,7 @@ export class NavigationService {
}

private buildQueryParam(preserveParameters: string[] = []): QueryParamObject {
return ['time', ...preserveParameters].reduce<Params>(
return [...this.globalQueryParams, ...preserveParameters].reduce<Params>(
(paramObj, param) => ({
...paramObj,
[param]: this.currentParamMap.get(param)
Expand Down
1 change: 1 addition & 0 deletions projects/common/src/time/time-range.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ export class TimeRangeService {
private readonly timeDurationService: TimeDurationService
) {
this.initializeTimeRange();
this.navigationService.registerGlobalQueryParamKey(TimeRangeService.TIME_RANGE_QUERY_PARAM);
}

public getShareableCurrentUrl(): string {
Expand Down