Feat:feature bypass (#777)

* feature bypass

* error handling

Author: Alessandro100

web-app/src/app/context/RemoteConfigProvider.spec.tsx

@@ -0,0 +1,71 @@
+import { type BypassConfig } from '../interface/RemoteConfig';
+import { userHasBypass } from './RemoteConfigProvider';
+jest.mock('firebase/compat/app', () => ({
+  initializeApp: jest.fn(),
+  remoteConfig: jest.fn(() => ({
+    settings: { minimumFetchIntervalMillis: 3600000 },
+  })),
+}));
+describe('userHasBypass', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('should return false if userEmail is null', () => {
+    const byPassConfig: BypassConfig = { regex: ['.*@example.com'] };
+    expect(userHasBypass(byPassConfig, null)).toBe(false);
+  });
+
+  it('should return false if userEmail is undefined', () => {
+    const byPassConfig: BypassConfig = { regex: ['.*@example.com'] };
+    expect(userHasBypass(byPassConfig, undefined)).toBe(false);
+  });
+
+  it('should return true if userEmail matches one of the regex patterns', () => {
+    const byPassConfig: BypassConfig = { regex: ['.*@example.com'] };
+    expect(userHasBypass(byPassConfig, '[email protected]')).toBe(true);
+  });
+
+  it('should return true if userEmail matches one of the more complex regex patterns', () => {
+    const byPassConfig: BypassConfig = { regex: ['[^@][email protected]'] };
+    expect(userHasBypass(byPassConfig, '[email protected]')).toBe(true);
+  });
+
+  it('should return false if userEmail does not match any regex patterns', () => {
+    const byPassConfig: BypassConfig = { regex: ['.*@example.com'] };
+    expect(userHasBypass(byPassConfig, '[email protected]')).toBe(false);
+  });
+
+  it('should return true if userEmail matches multiple regex patterns', () => {
+    const byPassConfig: BypassConfig = {
+      regex: ['.*@example.com', '.*@another.com'],
+    };
+    expect(userHasBypass(byPassConfig, '[email protected]')).toBe(true);
+  });
+
+  it('should return false if byPassConfig has an empty regex array', () => {
+    const byPassConfig: BypassConfig = { regex: [] };
+    expect(userHasBypass(byPassConfig, '[email protected]')).toBe(false);
+  });
+
+  it('should return true if user is in list of regex', () => {
+    const byPassConfig: BypassConfig = {
+      regex: ['[email protected]', '[email protected]'],
+    };
+    expect(userHasBypass(byPassConfig, '[email protected]')).toBe(true);
+  });
+
+  it('should return false if user is not in list', () => {
+    const byPassConfig: BypassConfig = {
+      regex: ['[email protected]', '[email protected]'],
+    };
+    expect(userHasBypass(byPassConfig, '[email protected]')).toBe(false);
+  });
+
+  it('should not break the function if there is an invalid regex', () => {
+    const byPassConfig: BypassConfig = {
+      regex: ['[email protected](', '[email protected]'],
+    };
+    expect(userHasBypass(byPassConfig, '[email protected]')).toBe(true);
+  });
+});

web-app/src/app/context/RemoteConfigProvider.tsx

@@ -5,8 +5,9 @@ import React, {
   useEffect,
   useState,
 } from 'react';
-import { remoteConfig } from '../../firebase';
+import { remoteConfig, app } from '../../firebase';
 import {
+  type BypassConfig,
   defaultRemoteConfigValues,
   type RemoteConfigValues,
 } from '../interface/RemoteConfig';
@@ -23,6 +24,25 @@ interface RemoteConfigProviderProps {
   children: ReactNode;
 }
 
+export function userHasBypass(
+  byPassConfig: BypassConfig,
+  userEmail: string | null | undefined,
+): boolean {
+  let hasBypass = false;
+  if (userEmail === null || userEmail === undefined) {
+    return false;
+  }
+  hasBypass = byPassConfig.regex.some((regex) => {
+    try {
+      if (userEmail.match(new RegExp(regex, 'i')) !== null) {
+        return true;
+      }
+    } catch (e) {}
+    return false;
+  });
+  return hasBypass;
+}
+
 export const RemoteConfigProvider = ({
   children,
 }: RemoteConfigProviderProps): React.ReactElement => {
@@ -37,12 +57,19 @@ export const RemoteConfigProvider = ({
         await remoteConfig.fetchAndActivate();
         const fetchedConfigValues = defaultRemoteConfigValues;
 
+        const bypassConfig: BypassConfig = JSON.parse(
+          remoteConfig.getValue('featureFlagBypass').asString(),
+        );
+        const hasBypass = userHasBypass(
+          bypassConfig,
+          app.auth().currentUser?.email,
+        );
         Object.keys(defaultRemoteConfigValues).forEach((key) => {
           const rawValue = remoteConfig.getValue(key);
           const rawValueLower = rawValue.asString().toLowerCase();
           if (rawValueLower === 'true' || rawValueLower === 'false') {
             // Boolean
-            fetchedConfigValues[key] = rawValue.asBoolean();
+            fetchedConfigValues[key] = hasBypass || rawValue.asBoolean();
           } else if (!isNaN(Number(rawValue)) && rawValueLower.trim() !== '') {
             // Number
             fetchedConfigValues[key] = rawValue.asNumber();
@@ -51,7 +78,6 @@ export const RemoteConfigProvider = ({
             fetchedConfigValues[key] = rawValue.asString();
           }
         });
-
         setConfig((prevConfig) => ({
           ...prevConfig,
           ...fetchedConfigValues,
@@ -64,7 +90,7 @@ export const RemoteConfigProvider = ({
     };
 
     void fetchAndActivateConfig();
-  }, []);
+  }, [app.auth().currentUser?.email]);
 
   return (
     <RemoteConfigContext.Provider value={{ config, loading }}>

web-app/src/app/interface/RemoteConfig.ts

@@ -2,6 +2,10 @@ import { remoteConfig } from '../../firebase';
 
 type FirebaseDefaultConfig = typeof remoteConfig.defaultConfig;
 
+export interface BypassConfig {
+  regex: string[];
+}
+
 export interface RemoteConfigValues extends FirebaseDefaultConfig {
   enableAppleSSO: boolean;
   enableFeedsPage: boolean;
@@ -23,8 +27,13 @@ export interface RemoteConfigValues extends FirebaseDefaultConfig {
   gtfsMetricsBucketEndpoint: string;
   /** GBFS metrics' bucket endpoint */
   gbfsMetricsBucketEndpoint: string;
+  featureFlagBypass: string;
 }
 
+const featureByPassDefault: BypassConfig = {
+  regex: [],
+};
+
 // Add default values for remote config here
 export const defaultRemoteConfigValues: RemoteConfigValues = {
   enableAppleSSO: false,
@@ -36,6 +45,7 @@ export const defaultRemoteConfigValues: RemoteConfigValues = {
     'https://storage.googleapis.com/mobilitydata-gtfs-analytics-dev',
   gbfsMetricsBucketEndpoint:
     'https://storage.googleapis.com/mobilitydata-gbfs-analytics-dev',
+  featureFlagBypass: JSON.stringify(featureByPassDefault),
 };
 
 remoteConfig.defaultConfig = defaultRemoteConfigValues;