(chore) O3-4372: Remove non-existent feature flags from local storage (#1276)

Author: Bharath-K-Shetty

packages/framework/esm-feature-flags/src/feature-flags.ts

@@ -64,6 +64,22 @@ export function registerFeatureFlag(flagName: string, label: string, description
   }));
 }
 
+/**
+ * This function removes feature flags from local storage that no longer exist in the current state.
+ */
+export function cleanupObsoleteFeatureFlags() {
+  const flags = featureFlagsStore.getState().flags;
+  Object.keys(localStorage)
+    .filter((key) => key.startsWith('openmrs:feature-flag:'))
+    .forEach((key) => {
+      const flagName = key.replace('openmrs:feature-flag:', '');
+      if (!flags[flagName]) {
+        localStorage.removeItem(key);
+        localStorage.removeItem(`openmrs:feature-flag-meta:${flagName}`);
+      }
+    });
+}
+
 /** Use this function to access the current value of the feature flag
  *
  * If you are using React, use `useFeatureFlag` instead.

packages/framework/esm-framework/docs/API.md

@@ -4883,7 +4883,7 @@ If you are using React, use `useFeatureFlag` instead.
 
 #### Defined in
 
-[packages/framework/esm-feature-flags/src/feature-flags.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-feature-flags/src/feature-flags.ts#L71)
+[packages/framework/esm-feature-flags/src/feature-flags.ts:87](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-feature-flags/src/feature-flags.ts#L87)
 
 ___
 

packages/shell/esm-app-shell/src/run.ts

@@ -1,45 +1,46 @@
 import { start, triggerAppChange } from 'single-spa';
 import {
-  setupApiModule,
-  renderLoadingSpinner,
-  type Config,
-  provide,
-  showNotification,
-  showActionableNotification,
-  showToast,
-  showSnackbar,
-  renderInlineNotifications,
-  renderActionableNotifications,
-  renderToasts,
-  renderSnackbars,
-  integrateBreakpoints,
+  activateOfflineCapability,
+  canAccessStorage,
+  cleanupObsoleteFeatureFlags,
   dispatchConnectivityChanged,
-  subscribeNotificationShown,
-  subscribeActionableNotificationShown,
-  subscribeToastShown,
-  subscribeSnackbarShown,
-  registerOmrsServiceWorker,
-  messageOmrsServiceWorker,
-  subscribeConnectivity,
-  getCurrentUser,
-  getConfig,
-  setupModals,
   dispatchPrecacheStaticDependencies,
-  activateOfflineCapability,
-  subscribePrecacheStaticDependencies,
-  openmrsFetch,
+  finishRegisteringAllApps,
+  getConfig,
+  getCurrentUser,
+  integrateBreakpoints,
   interpolateUrl,
-  type OpenmrsRoutes,
-  canAccessStorage,
-  localStorageRoutesPrefix,
   isOpenmrsAppRoutes,
   isOpenmrsRoutes,
-  setupHistory,
+  localStorageRoutesPrefix,
+  messageOmrsServiceWorker,
+  openmrsFetch,
+  provide,
   registerApp,
-  finishRegisteringAllApps,
+  registerOmrsServiceWorker,
+  renderActionableNotifications,
+  renderInlineNotifications,
+  renderLoadingSpinner,
+  renderSnackbars,
+  renderToasts,
+  restBaseUrl,
+  setupApiModule,
+  setupHistory,
+  setupModals,
+  showActionableNotification,
+  showNotification,
+  showSnackbar,
+  showToast,
+  subscribeActionableNotificationShown,
+  subscribeConnectivity,
+  subscribeNotificationShown,
+  subscribePrecacheStaticDependencies,
+  subscribeSnackbarShown,
+  subscribeToastShown,
   tryRegisterExtension,
+  type Config,
   type OpenmrsAppRoutes,
-  restBaseUrl,
+  type OpenmrsRoutes,
 } from '@openmrs/esm-framework/src/internal';
 import { setupI18n } from './locale';
 import { registerOptionalDependencyHandler } from './optionaldeps';
@@ -429,5 +430,6 @@ export function run(configUrls: Array<string>) {
     .catch(handleInitFailure)
     .then(closeLoading)
     .then(offlineEnabled ? setupOffline : undefined)
-    .then(registerOptionalDependencyHandler);
+    .then(registerOptionalDependencyHandler)
+    .then(cleanupObsoleteFeatureFlags);
 }