fix: make loginMethods configurable via environment variables

refs: LINK-2245
City-of-Helsinki · Mar 5, 2025 · 1701fbe · 1701fbe
1 parent e69f0b8
commit 1701fbe
Show file tree

Hide file tree

Showing 10 changed files with 59 additions and 8 deletions.
diff --git a/.env b/.env
@@ -25,3 +25,6 @@ NEXT_PUBLIC_MATOMO_ENABLED=false
 NEXT_PUBLIC_LINKED_EVENTS_URL=https://linkedevents-api.dev.hel.ninja/linkedevents-dev/v1
 NEXT_PUBLIC_WEB_STORE_INTEGRATION_ENABLED=false
 NEXT_PUBLIC_WEB_STORE_API_BASE_URL=https://checkout-test-api.test.hel.ninja/v1
+
+NEXT_PUBLIC_ATTENDANCE_LIST_LOGIN_METHODS=suomi_fi
+NEXT_PUBLIC_SIGNUPS_LOGIN_METHODS=helsinki_tunnus,helsinkiad
diff --git a/.env.local.example b/.env.local.example
@@ -17,3 +17,6 @@ NEXT_PUBLIC_WEB_STORE_INTEGRATION_ENABLED=true
 NEXT_PUBLIC_WEB_STORE_API_BASE_URL=https://checkout-test-api.test.hel.ninja/v1
 
 E2E_TESTS_ENV_URL=http://localhost:3001/
+
+NEXT_PUBLIC_ATTENDANCE_LIST_LOGIN_METHODS=suomi_fi
+NEXT_PUBLIC_SIGNUPS_LOGIN_METHODS=helsinki_tunnus,helsinkiad
diff --git a/Dockerfile b/Dockerfile
@@ -51,6 +51,8 @@ ARG NEXT_PUBLIC_LINKED_EVENTS_URL
 ARG NEXT_PUBLIC_SENTRY_DSN
 ARG SENTRY_AUTH_TOKEN
 ARG NEXT_PUBLIC_ENVIRONMENT
+ARG NEXT_PUBLIC_ATTENDANCE_LIST_LOGIN_METHODS
+ARG NEXT_PUBLIC_SIGNUPS_LOGIN_METHODS
 
 ARG OIDC_ISSUER
 ARG OIDC_API_TOKENS_URL

diff --git a/README.md b/README.md
@@ -73,7 +73,7 @@ Use .env.local for development.
     cp .env.local.example .env.local
 
 | Name                                      | Description                                                                                                                |
-| ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
+|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
 | PORT                                      | Port where app is running. Default is 3001                                                                                 |
 | NEXT_PUBLIC_LINKED_EVENTS_URL             | linkedevents api base url                                                                                                  |
 | NEXT_PUBLIC_ENVIRONMENT                   | Environment used in Sentry. Use local for development                                                                      |
@@ -96,7 +96,9 @@ Use .env.local for development.
 | NEXTAUTH_URL                              | Canonical url of the site used by next-auth                                                                                |
 | NEXT_ENV                                  | 'development' or 'production'                                                                                              |
 | NEXT_PUBLIC_WEB_STORE_INTEGRATION_ENABLED | Flag to enable Tapla integration. Default is false                                                                         |
-| NEXT_PUBLIC_WEB_STORE_API_BASE_URL        | Base url for the Tapla endpoints. Default is https://checkout-test-api.test.hel.ninja/v1                                   |
+| NEXT_PUBLIC_WEB_STORE_API_BASE_URL        | Base url for the Tapla endpoints. Default is https://checkout-test-api.test.hel.ninja/v1                                   |
+| NEXT_PUBLIC_ATTENDANCE_LIST_LOGIN_METHODS | Login methods to use for attendance list viewing/editing. Default is suomi_fi                                              |
+| NEXT_PUBLIC_SIGNUPS_LOGIN_METHODS         | Login methods to use for signup viewing/editing. Default is helsinki-tunnus and helsinkiad                                 |
 
 ## Url parameters
 

diff --git a/next.config.js b/next.config.js
@@ -32,6 +32,8 @@ const moduleExports = {
   publicRuntimeConfig: {
     linkedEventsApiBaseUrl: process.env.NEXT_PUBLIC_LINKED_EVENTS_URL,
     webStoreApiBaseUrl: process.env.NEXT_PUBLIC_WEB_STORE_API_BASE_URL,
+    attendanceListLoginMethods: process.env.NEXT_PUBLIC_ATTENDANCE_LIST_LOGIN_METHODS,
+    signupsLoginMethods: process.env.NEXT_PUBLIC_SIGNUPS_LOGIN_METHODS,
   },
   serverRuntimeConfig: {
     env: process.env.NEXT_ENV,

diff --git a/src/constants.ts b/src/constants.ts
@@ -49,3 +49,15 @@ export enum SPLITTED_ROW_TYPE {
 export const DEFAULT_SPLITTED_ROW_TYPE = SPLITTED_ROW_TYPE.MEDIUM_MEDIUM;
 
 export type LoginMethod = "helsinki_tunnus" | "suomi_fi" | "helsinkiad";
+
+export const parseLoginMethods = (value: string): LoginMethod[] => {
+  const validMethods: LoginMethod[] = ["helsinki_tunnus", "suomi_fi", "helsinkiad"];
+
+  return value.split(',').map(i => {
+    const trimmed = i.trim();
+    if (!validMethods.includes(trimmed as LoginMethod)) {
+      throw new Error(`Invalid login method: ${trimmed}`);
+    }
+    return trimmed as LoginMethod;
+  })
+}
diff --git a/src/domain/attendanceList/AttendanceListPage.tsx b/src/domain/attendanceList/AttendanceListPage.tsx
@@ -8,6 +8,7 @@ import { useNotificationsContext } from '../../common/components/notificationsCo
 import PageWrapper from '../../common/components/pageWrapper/PageWrapper';
 import useLocale from '../../hooks/useLocale';
 import { ExtendedSession } from '../../types';
+import getPublicRuntimeConfig from "../../utils/getPublicRuntimeConfig";
 import Container from '../app/layout/container/Container';
 import MainContent from '../app/layout/mainContent/MainContent';
 import TitleRow from '../app/layout/titleRow/TitleRow';
@@ -109,12 +110,14 @@ const AttendanceListPageWrapper: React.FC = () => {
     },
   });
 
+  const { attendanceListLoginMethods } = getPublicRuntimeConfig();
+
   return (
     <SignupsPagePermissions
       event={event}
       isLoadingData={isLoadingEventOrRegistration}
       registration={registration}
-      loginMethods={["suomi_fi"]}
+      loginMethods={attendanceListLoginMethods}
     >
       <AttendanceListPage
         event={event as Event}

diff --git a/src/domain/singups/SignupsPage.tsx b/src/domain/singups/SignupsPage.tsx
@@ -9,6 +9,7 @@ import { useNotificationsContext } from '../../common/components/notificationsCo
 import PageWrapper from '../../common/components/pageWrapper/PageWrapper';
 import useLocale from '../../hooks/useLocale';
 import { ExtendedSession } from '../../types';
+import getPublicRuntimeConfig from "../../utils/getPublicRuntimeConfig";
 import Container from '../app/layout/container/Container';
 import MainContent from '../app/layout/mainContent/MainContent';
 import TitleRow from '../app/layout/titleRow/TitleRow';
@@ -114,12 +115,14 @@ const SignupsPageWrapper: React.FC = () => {
     registration,
   } = useEventAndRegistrationData();
 
+  const { signupsLoginMethods } = getPublicRuntimeConfig();
+
   return (
     <SignupsPagePermissions
       event={event}
       isLoadingData={isLoadingEventOrRegistration}
       registration={registration}
-      loginMethods={["helsinki_tunnus", "helsinkiad"]}
+      loginMethods={signupsLoginMethods}
     >
       <SignupsPage
         event={event as Event}

diff --git a/src/utils/__tests__/getPublicRuntimeConfig.test.ts b/src/utils/__tests__/getPublicRuntimeConfig.test.ts
@@ -4,12 +4,21 @@ import { mockConfig } from '../mockNextJsConfig';
 const publicRuntimeConfig = {
   linkedEventsApiBaseUrl: 'https://linkedevents-backend:8000/v1',
   webStoreApiBaseUrl: 'https://payment-test.com/v1',
+  attendanceListLoginMethods: 'suomi_fi',
+  signupsLoginMethods: 'helsinki_tunnus,helsinkiad',
+};
+
+const expectedPublicRuntimeConfig = {
+  linkedEventsApiBaseUrl: 'https://linkedevents-backend:8000/v1',
+  webStoreApiBaseUrl: 'https://payment-test.com/v1',
+  attendanceListLoginMethods: ['suomi_fi'],
+  signupsLoginMethods: ['helsinki_tunnus', 'helsinkiad'],
 };
 
 describe('getPublicRuntimeConfig function', () => {
   it('should return public runtime config', () => {
     mockConfig(publicRuntimeConfig, {});
-    expect(getPublicRuntimeConfig()).toEqual(publicRuntimeConfig);
+    expect(getPublicRuntimeConfig()).toEqual(expectedPublicRuntimeConfig);
   });
 
   const cases: [Record<string, string>][] = [

diff --git a/src/utils/getPublicRuntimeConfig.ts b/src/utils/getPublicRuntimeConfig.ts
@@ -1,17 +1,29 @@
 import getConfig from 'next/config';
 
+import { parseLoginMethods } from "../constants";
+
 const getPublicRuntimeConfig = () => {
   const {
-    publicRuntimeConfig: { linkedEventsApiBaseUrl, webStoreApiBaseUrl },
+    publicRuntimeConfig: {
+      linkedEventsApiBaseUrl,
+      webStoreApiBaseUrl,
+      attendanceListLoginMethods,
+      signupsLoginMethods
+    },
   } = getConfig();
 
-  if (!linkedEventsApiBaseUrl || !webStoreApiBaseUrl) {
+  if (!linkedEventsApiBaseUrl || !webStoreApiBaseUrl || !attendanceListLoginMethods || !signupsLoginMethods) {
     throw new Error(
       'Invalid configuration. Some required public runtime variable are missing'
     );
   }
 
-  return { linkedEventsApiBaseUrl, webStoreApiBaseUrl };
+  return {
+    linkedEventsApiBaseUrl,
+    webStoreApiBaseUrl,
+    attendanceListLoginMethods: parseLoginMethods(attendanceListLoginMethods),
+    signupsLoginMethods: parseLoginMethods(signupsLoginMethods),
+  };
 };
 
 export default getPublicRuntimeConfig;