Skip to content
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

[Stateful sidenav] Don't fetch active space on unauthenticated routes #190408

Merged
merged 2 commits into from
Aug 13, 2024
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
25 changes: 25 additions & 0 deletions src/plugins/navigation/public/plugin.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,31 @@ describe('Navigation Plugin', () => {
expect(coreStart.chrome.project.changeActiveSolutionNavigation).toHaveBeenCalledWith('es');
});

it('should not load the active space on non authenticated pages', async () => {
const { plugin, coreStart, unifiedSearch, cloud, spaces } = setup();

coreStart.http.anonymousPaths.isAnonymous.mockReturnValue(true);

const activeSpace$ = of({ solution: 'es' } as Pick<Space, 'solution'>);
activeSpace$.pipe = jest.fn().mockReturnValue(activeSpace$);
activeSpace$.subscribe = jest.fn().mockReturnValue(activeSpace$);
spaces.getActiveSpace$ = jest.fn().mockReturnValue(activeSpace$);

plugin.start(coreStart, { unifiedSearch, cloud, spaces });
await new Promise((resolve) => setTimeout(resolve));

expect(activeSpace$.pipe).not.toHaveBeenCalled();
expect(activeSpace$.subscribe).not.toHaveBeenCalled();

// Test that the activeSpace$ observable is accessed when not an anonymous path
coreStart.http.anonymousPaths.isAnonymous.mockReturnValue(false);
plugin.start(coreStart, { unifiedSearch, cloud, spaces });
await new Promise((resolve) => setTimeout(resolve));

expect(activeSpace$.pipe).toHaveBeenCalled();
expect(activeSpace$.subscribe).toHaveBeenCalled();
});

describe('addSolutionNavigation()', () => {
it('should update the solution navigation definitions', async () => {
const { plugin, coreStart, unifiedSearch, cloud } = setup();
Expand Down
38 changes: 30 additions & 8 deletions src/plugins/navigation/public/plugin.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,14 @@
* Side Public License, v 1.
*/
import React from 'react';
import { of, ReplaySubject, take, map, Observable } from 'rxjs';
import { PluginInitializerContext, CoreSetup, CoreStart, Plugin } from '@kbn/core/public';
import { of, ReplaySubject, take, map, Observable, switchMap } from 'rxjs';
import {
PluginInitializerContext,
CoreSetup,
CoreStart,
Plugin,
HttpStart,
} from '@kbn/core/public';
import type { UnifiedSearchPublicPluginStart } from '@kbn/unified-search-plugin/public';
import type { Space } from '@kbn/spaces-plugin/public';
import type { SolutionNavigationDefinition } from '@kbn/core-chrome-browser';
Expand Down Expand Up @@ -89,8 +95,7 @@ export class NavigationPublicPlugin
return createTopNav(customUnifiedSearch ?? unifiedSearch, customExtensions ?? extensions);
};

// Initialize the solution navigation if it is enabled
activeSpace$.pipe(take(1)).subscribe((activeSpace) => {
const initSolutionNavigation = (activeSpace?: Space) => {
this.initiateChromeStyleAndSideNav(chrome, {
isServerless,
activeSpace,
Expand All @@ -99,7 +104,14 @@ export class NavigationPublicPlugin
if (!this.isSolutionNavEnabled) return;

chrome.project.setCloudUrls(cloud!);
});
};

if (this.getIsUnauthenticated(core.http)) {
// Don't fetch the active space if the user is not authenticated
initSolutionNavigation();
} else {
activeSpace$.pipe(take(1)).subscribe(initSolutionNavigation);
}

return {
ui: {
Expand All @@ -111,9 +123,14 @@ export class NavigationPublicPlugin
if (!this.isSolutionNavEnabled) return;
this.addSolutionNavigation(solutionNavigation);
},
isSolutionNavEnabled$: activeSpace$.pipe(
map((activeSpace) => {
return this.isSolutionNavEnabled && getIsProjectNav(activeSpace?.solution);
isSolutionNavEnabled$: of(this.getIsUnauthenticated(core.http)).pipe(
switchMap((isUnauthenticated) => {
if (isUnauthenticated) return of(false);
return activeSpace$.pipe(
map((activeSpace) => {
return this.isSolutionNavEnabled && getIsProjectNav(activeSpace?.solution);
})
);
})
),
};
Expand Down Expand Up @@ -172,6 +189,11 @@ export class NavigationPublicPlugin
chrome.project.changeActiveSolutionNavigation(solutionView!);
}
}

private getIsUnauthenticated(http: HttpStart) {
const { anonymousPaths } = http;
return anonymousPaths.isAnonymous(window.location.pathname);
}
}

function getIsProjectNav(solutionView?: string) {
Expand Down
20 changes: 19 additions & 1 deletion src/plugins/navigation/server/ui_settings.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,21 @@ describe('ui settings', () => {
await expect(defaultRoute.getValue!()).resolves.toBe(DEFAULT_ROUTES.classic);
});

it('should return classic when accessing a non authenticated route', async () => {
const spaces = spacesMock.createStart();
const mockSpace: Pick<Space, 'solution'> = { solution: 'es' };
spaces.spacesService.getActiveSpace.mockResolvedValue(mockSpace as Space);
core.getStartServices.mockResolvedValue([{} as any, { spaces }, {} as any]);

const { defaultRoute } = getUiSettings(core, logger);
const requestMock = {
auth: { isAuthenticated: false },
};
await expect(defaultRoute.getValue!({ request: requestMock as any })).resolves.toBe(
DEFAULT_ROUTES.classic
);
});

it('should return the route based on the active space', async () => {
const spaces = spacesMock.createStart();

Expand All @@ -50,7 +65,10 @@ describe('ui settings', () => {
core.getStartServices.mockResolvedValue([{} as any, { spaces }, {} as any]);
const { defaultRoute } = getUiSettings(core, logger);

await expect(defaultRoute.getValue!({ request: {} as any })).resolves.toBe(
const requestMock = {
auth: { isAuthenticated: true },
};
await expect(defaultRoute.getValue!({ request: requestMock as any })).resolves.toBe(
DEFAULT_ROUTES[solution]
);
}
Expand Down
2 changes: 2 additions & 0 deletions src/plugins/navigation/server/ui_settings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ export const getUiSettings = (
}

try {
if (!request.auth.isAuthenticated) return DEFAULT_ROUTES.classic;

const activeSpace = await spaces.spacesService.getActiveSpace(request);

const solution = activeSpace?.solution ?? 'classic';
Expand Down