(feat) Add "Enable Feature Flags" config option to the app-shell (#1249)

packages/framework/esm-config/src/module-config/module-config.ts

@@ -15,7 +15,6 @@ import {
   temporaryConfigStore,
   getExtensionSlotsConfigStore,
 } from './state';
-import type {} from '@openmrs/esm-globals';
 import { type TemporaryConfigStore } from '..';
 
 /**

packages/framework/esm-routes/src/loaders/components.ts

@@ -232,10 +232,10 @@ To fix this, ensure that you define the "name" field inside the workspace defini
 }
 
 /**
- * This function registers a workspace definition with the framework so that it can be launched.
+ * This function registers a feature flag definition with the framework.
  *
- * @param appName The name of the app defining this workspace
- * @param featureFlag An object that describes the workspace, derived from `routes.json`
+ * @param appName The name of the app defining this feature flag
+ * @param featureFlag An object that describes the feature flag, derived from `routes.json`
  */
 export function tryRegisterFeatureFlag(appName: string, featureFlag: FeatureFlagDefinition) {
   const name = featureFlag.flagName;

packages/shell/esm-app-shell/src/core-config.ts

@@ -0,0 +1,38 @@
+import { defineConfigSchema, Type, getConfigStore } from '@openmrs/esm-framework';
+import { registerModuleLoad, featureFlagsStore } from '@openmrs/esm-framework/src/internal';
+import { appName } from './ui';
+
+/**
+ * Sets up the app shell's configuration.
+ */
+export function setupCoreConfig() {
+  defineConfigSchema(appName, {
+    'Enabled feature flags': {
+      _description: 'The feature flags that will be enabled',
+      _type: Type.Array,
+      _default: [],
+      _elements: {
+        _type: Type.String,
+      },
+    },
+  });
+  registerModuleLoad(appName);
+
+  // process feature flags
+  getConfigStore(appName).subscribe(({ config }) => {
+    const flagsToEnable = new Set((config?.['Enabled feature flags'] as Array<string>) || []);
+    if (flagsToEnable.size) {
+      const newFlags = { ...featureFlagsStore.getState().flags };
+      for (const flag of flagsToEnable) {
+        // validate the flag exists
+        if (!newFlags[flag]) {
+          console.error(`Feature flag "${flag}" does not exist. Please define the flag first.`);
+        } else {
+          newFlags[flag] = { ...newFlags[flag], enabled: true };
+        }
+      }
+
+      featureFlagsStore.setState({ flags: newFlags });
+    }
+  });
+}

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

@@ -43,6 +43,7 @@ import {
 import { setupI18n } from './locale';
 import { registerOptionalDependencyHandler } from './optionaldeps';
 import { appName, getCoreExtensions } from './ui';
+import { setupCoreConfig } from './core-config';
 
 // @internal
 // used to track when the window.installedModules global is finalised
@@ -408,6 +409,7 @@ export function run(configUrls: Array<string>) {
   setupApiModule();
   setupHistory();
   registerCoreExtensions();
+  setupCoreConfig();
 
   return setupApps()
     .then(finishRegisteringAllApps)