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

change login middleware logic #739

Merged
merged 8 commits into from
Jan 10, 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
6 changes: 3 additions & 3 deletions website/src/middleware/authMiddleware.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { type BaseClient, Issuer, type TokenSet } from 'openid-client';

import { getConfiguredOrganisms, getRuntimeConfig } from '../config.ts';
import { getInstanceLogger } from '../logger.ts';
import { isPublicRoute } from '../utils/isPublicRoute.ts';
import { shouldMiddlewareEnforceLogin } from '../utils/shouldMiddlewareEnforceLogin.ts';

const { decode, verify } = jsonwebtoken;

Expand Down Expand Up @@ -51,11 +51,11 @@ export async function getKeycloakClient() {
export const authMiddleware = defineMiddleware(async (context, next) => {
let token = await getTokenFromCookie(context);

const urlIsPublicRoute = isPublicRoute(
const enforceLogin = shouldMiddlewareEnforceLogin(
context.url.pathname,
getConfiguredOrganisms().map((it) => it.key),
);
if (urlIsPublicRoute) {
if (!enforceLogin) {
if (token === undefined) {
context.locals.session = {
isLoggedIn: false,
Expand Down
37 changes: 0 additions & 37 deletions website/src/utils/isPublicRoute.spec.ts

This file was deleted.

30 changes: 0 additions & 30 deletions website/src/utils/isPublicRoute.ts

This file was deleted.

39 changes: 39 additions & 0 deletions website/src/utils/shouldMiddlewareEnforceLogin.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import { describe, expect, test } from 'vitest';

import { shouldMiddlewareEnforceLogin } from './shouldMiddlewareEnforceLogin';
import { testOrganism } from '../../vitest.setup.ts';

const otherOrganism = 'otherOrganism';
const configuredOrganisms = [testOrganism, otherOrganism];

describe('shouldMiddlewareEnforceLogin', () => {
test('should return false if not specified', () => {
expectNoLogin('/someRoute');
});

test('should return false for empty string', () => {
expectNoLogin('');
});

test('should return true on routes which should force login', () => {
expectForceLogin('/user');
expectForceLogin('/user/someUsername');
expectForceLogin(`/${testOrganism}/revise`);
expectForceLogin(`/${testOrganism}/submit`);
});

test('should return false for various public routes', () => {
expectNoLogin(`/${testOrganism}/search`);
expectNoLogin(`/`);
expectNoLogin(`/${testOrganism}`);
expectNoLogin(`/${testOrganism}/sequences/id_002156`);
});

function expectForceLogin(path: string) {
expect(shouldMiddlewareEnforceLogin(path, configuredOrganisms), path).toBe(true);
}

function expectNoLogin(path: string) {
expect(shouldMiddlewareEnforceLogin(path, configuredOrganisms), path).toBe(false);
}
});
19 changes: 19 additions & 0 deletions website/src/utils/shouldMiddlewareEnforceLogin.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
const enforcedLoginRoutesCache: Record<string, RegExp[]> = {};

function getEnforcedLoginRoutes(configuredOrganisms: string[]) {
const cacheKey = configuredOrganisms.join('');
if (!(cacheKey in enforcedLoginRoutesCache)) {
const organismSpecificRoutes = configuredOrganisms.flatMap((organism) => [
new RegExp(`^/${organism}/revise`),
new RegExp(`^/${organism}/submit`),
new RegExp(`^/${organism}/user`),
]);

enforcedLoginRoutesCache[cacheKey] = [new RegExp('^/user/?'), ...organismSpecificRoutes];
}
return enforcedLoginRoutesCache[cacheKey];
}

export function shouldMiddlewareEnforceLogin(pathname: string, configuredOrganisms: string[]) {
return getEnforcedLoginRoutes(configuredOrganisms).some((route) => route.test(pathname));
}
Loading