Skip to content

Commit 6daa7a8

Browse files
CopilotAlessandro100
Copilot
and
Alessandro100
authored
feat: enable all Firebase Remote Config boolean flags for @mobilitydata.org users in production
Agent-Logs-Url: https://github.com/MobilityData/mobilitydatabase-web/sessions/e6a580fe-9b54-4e2a-86ce-65951372163a Co-authored-by: Alessandro100 <18631060+Alessandro100@users.noreply.github.com>
1 parent 652a15f commit 6daa7a8

4 files changed

Lines changed: 200 additions & 6 deletions

File tree

‎src/app/[locale]/layout.tsx‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ import { type ReactElement } from 'react';
77
import { NextIntlClientProvider, hasLocale } from 'next-intl';
88
import { getMessages, setRequestLocale } from 'next-intl/server';
99
import { notFound } from 'next/navigation';
10-
import { getRemoteConfigValues } from '../../lib/remote-config.server';
10+
import { getRemoteConfigValuesForUser } from '../../lib/remote-config.server';
11+
import { getCurrentUserFromCookie } from '../utils/auth-server';
1112
import { Mulish, IBM_Plex_Mono } from 'next/font/google';
1213
import Footer from '../components/Footer';
1314
import Header from '../components/Header';
@@ -89,10 +90,11 @@ export default async function LocaleLayout({
8990
// Enable static rendering for this locale
9091
setRequestLocale(validLocale);
9192

92-
const [messages, remoteConfig] = await Promise.all([
93+
const [messages, currentUser] = await Promise.all([
9394
getMessages(),
94-
getRemoteConfigValues(),
95+
getCurrentUserFromCookie(),
9596
]);
97+
const remoteConfig = await getRemoteConfigValuesForUser(currentUser?.email);
9698

9799
return (
98100
<html lang={validLocale}>

‎src/app/screens/Feed/components/DataQualitySummary.tsx‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ import { WarningContentBox } from '../../../components/WarningContentBox';
77
import { FeedStatusChip } from '../../../components/FeedStatus';
88
import OfficialChip from '../../../components/OfficialChip';
99
import { getTranslations } from 'next-intl/server';
10-
import { getRemoteConfigValues } from '../../../../lib/remote-config.server';
10+
import { getRemoteConfigValuesForUser } from '../../../../lib/remote-config.server';
11+
import { getCurrentUserFromCookie } from '../../../utils/auth-server';
1112

1213
export interface DataQualitySummaryProps {
1314
feedStatus: components['schemas']['Feed']['status'];
@@ -21,11 +22,12 @@ export default async function DataQualitySummary({
2122
isOfficialFeed,
2223
latestDataset,
2324
}: DataQualitySummaryProps): Promise<React.ReactElement> {
24-
const [t, tCommon, config] = await Promise.all([
25+
const [t, tCommon, currentUser] = await Promise.all([
2526
getTranslations('feeds'),
2627
getTranslations('common'),
27-
getRemoteConfigValues(),
28+
getCurrentUserFromCookie(),
2829
]);
30+
const config = await getRemoteConfigValuesForUser(currentUser?.email);
2931

3032
return (
3133
<Box data-testid='data-quality-summary' sx={{ my: 2 }}>

‎src/lib/remote-config.server.spec.ts‎

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
/**
2+
* @jest-environment node
3+
*/
4+
5+
import {
6+
getRemoteConfigValuesForUser,
7+
refreshRemoteConfig,
8+
} from './remote-config.server';
9+
import { defaultRemoteConfigValues } from '../app/interface/RemoteConfig';
10+
11+
jest.mock('server-only', () => ({}));
12+
jest.mock('react', () => ({
13+
cache: (fn: unknown) => fn,
14+
}));
15+
16+
const mockGetTemplate = jest.fn();
17+
18+
jest.mock('firebase-admin/remote-config', () => ({
19+
getRemoteConfig: jest.fn(() => ({ getTemplate: mockGetTemplate })),
20+
}));
21+
22+
jest.mock('../app/utils/config', () => ({
23+
getEnvConfig: jest.fn().mockReturnValue(''),
24+
}));
25+
26+
const mockIsMobilityDatabaseAdmin = jest.fn();
27+
28+
jest.mock('../app/utils/auth-server', () => ({
29+
isMobilityDatabaseAdmin: (...args: unknown[]) =>
30+
mockIsMobilityDatabaseAdmin(...args),
31+
}));
32+
33+
jest.mock('./firebase-admin', () => ({
34+
getFirebaseAdminApp: jest.fn().mockReturnValue({}),
35+
}));
36+
37+
describe('remote-config.server', () => {
38+
const originalEnv = process.env;
39+
40+
beforeEach(() => {
41+
jest.clearAllMocks();
42+
process.env = { ...originalEnv };
43+
});
44+
45+
afterAll(() => {
46+
process.env = originalEnv;
47+
});
48+
49+
describe('getRemoteConfigValuesForUser', () => {
50+
it('returns base config for non-mobilitydata.org user in production', async () => {
51+
process.env.VERCEL_ENV = 'production';
52+
mockIsMobilityDatabaseAdmin.mockReturnValue(false);
53+
mockGetTemplate.mockResolvedValue({ parameters: {} });
54+
await refreshRemoteConfig();
55+
56+
const result = await getRemoteConfigValuesForUser('user@example.com');
57+
58+
expect(mockIsMobilityDatabaseAdmin).toHaveBeenCalledWith(
59+
'user@example.com',
60+
);
61+
expect(result.enableMetrics).toBe(
62+
defaultRemoteConfigValues.enableMetrics,
63+
);
64+
expect(result.enableLanguageToggle).toBe(
65+
defaultRemoteConfigValues.enableLanguageToggle,
66+
);
67+
});
68+
69+
it('returns config with all boolean flags true for @mobilitydata.org user in production', async () => {
70+
process.env.VERCEL_ENV = 'production';
71+
mockIsMobilityDatabaseAdmin.mockReturnValue(true);
72+
mockGetTemplate.mockResolvedValue({
73+
parameters: {
74+
enableMetrics: { defaultValue: { value: 'false' } },
75+
enableLanguageToggle: { defaultValue: { value: 'false' } },
76+
},
77+
});
78+
await refreshRemoteConfig();
79+
80+
const result = await getRemoteConfigValuesForUser(
81+
'engineer@mobilitydata.org',
82+
);
83+
84+
expect(mockIsMobilityDatabaseAdmin).toHaveBeenCalledWith(
85+
'engineer@mobilitydata.org',
86+
);
87+
expect(result.enableMetrics).toBe(true);
88+
expect(result.enableLanguageToggle).toBe(true);
89+
expect(result.enableFeedStatusBadge).toBe(true);
90+
expect(result.enableDetailedCoveredArea).toBe(true);
91+
expect(result.gbfsValidator).toBe(true);
92+
});
93+
94+
it('does not apply bypass for @mobilitydata.org user outside production', async () => {
95+
process.env.VERCEL_ENV = 'preview';
96+
mockIsMobilityDatabaseAdmin.mockReturnValue(true);
97+
mockGetTemplate.mockResolvedValue({
98+
parameters: {
99+
enableMetrics: { defaultValue: { value: 'false' } },
100+
},
101+
});
102+
await refreshRemoteConfig();
103+
104+
const result = await getRemoteConfigValuesForUser(
105+
'engineer@mobilitydata.org',
106+
);
107+
108+
// In non-production environments, bypass is NOT applied
109+
expect(result.enableMetrics).toBe(false);
110+
});
111+
112+
it('returns base config for undefined email in production', async () => {
113+
process.env.VERCEL_ENV = 'production';
114+
mockIsMobilityDatabaseAdmin.mockReturnValue(false);
115+
mockGetTemplate.mockResolvedValue({ parameters: {} });
116+
await refreshRemoteConfig();
117+
118+
const result = await getRemoteConfigValuesForUser(undefined);
119+
120+
expect(mockIsMobilityDatabaseAdmin).toHaveBeenCalledWith(undefined);
121+
expect(result.enableMetrics).toBe(
122+
defaultRemoteConfigValues.enableMetrics,
123+
);
124+
});
125+
126+
it('preserves non-boolean config values when applying bypass', async () => {
127+
process.env.VERCEL_ENV = 'production';
128+
mockIsMobilityDatabaseAdmin.mockReturnValue(true);
129+
mockGetTemplate.mockResolvedValue({
130+
parameters: {
131+
gtfsMetricsBucketEndpoint: {
132+
defaultValue: {
133+
value: 'https://storage.googleapis.com/custom-gtfs-bucket',
134+
},
135+
},
136+
visualizationMapFullDataLimit: {
137+
defaultValue: { value: '10' },
138+
},
139+
},
140+
});
141+
await refreshRemoteConfig();
142+
143+
const result = await getRemoteConfigValuesForUser(
144+
'engineer@mobilitydata.org',
145+
);
146+
147+
// Non-boolean values should be preserved from remote config
148+
expect(result.gtfsMetricsBucketEndpoint).toBe(
149+
'https://storage.googleapis.com/custom-gtfs-bucket',
150+
);
151+
expect(result.visualizationMapFullDataLimit).toBe(10);
152+
// Boolean values should be overridden to true
153+
expect(result.enableMetrics).toBe(true);
154+
});
155+
});
156+
});

‎src/lib/remote-config.server.ts‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import {
88
defaultRemoteConfigValues,
99
type RemoteConfigValues,
1010
} from '../app/interface/RemoteConfig';
11+
import { isMobilityDatabaseAdmin } from '../app/utils/auth-server';
1112

1213
/**
1314
* Cache duration for Remote Config fetches (in seconds).
@@ -140,3 +141,36 @@ export async function refreshRemoteConfig(): Promise<RemoteConfigValues> {
140141
cacheTimestamp = 0;
141142
return await getRemoteConfigValues();
142143
}
144+
145+
/**
146+
* Returns a copy of the config with all boolean flags set to `true`.
147+
* Used to give internal @mobilitydata.org users access to all features.
148+
*/
149+
function applyEmailBypass(config: RemoteConfigValues): RemoteConfigValues {
150+
const overridden = { ...config };
151+
for (const key of Object.keys(overridden) as Array<
152+
keyof RemoteConfigValues
153+
>) {
154+
if (typeof overridden[key] === 'boolean') {
155+
(overridden as Record<string, unknown>)[key] = true;
156+
}
157+
}
158+
return overridden;
159+
}
160+
161+
/**
162+
* Get Remote Config values for a specific user.
163+
* In production, @mobilitydata.org users receive all boolean feature flags enabled.
164+
*/
165+
export async function getRemoteConfigValuesForUser(
166+
email?: string,
167+
): Promise<RemoteConfigValues> {
168+
const config = await getRemoteConfigValues();
169+
if (
170+
process.env.VERCEL_ENV === 'production' &&
171+
isMobilityDatabaseAdmin(email)
172+
) {
173+
return applyEmailBypass(config);
174+
}
175+
return config;
176+
}

0 commit comments

Comments
 (0)