Merge pull request #25 from Exabyte-io/fix/SOF-6197

chore: add functions for creating/extending/patching registryContainer

Author: timurbazhirov

src/context/index.js

@@ -10,11 +10,17 @@ import {
 } from "./mixins";
 import { JobContextPickKeysForMixin, WorkflowContextPickKeysForMixin } from "./pickers";
 import { ContextProvider } from "./provider";
-import { ContextProviderRegistryContainer } from "./registry";
+import {
+    ContextProviderRegistryContainer,
+    createAndPatchRegistry,
+    extendAndPatchRegistry,
+} from "./registry";
 
 export {
     ContextProvider,
     ContextProviderRegistryContainer,
+    extendAndPatchRegistry,
+    createAndPatchRegistry,
     JobContextPickKeysForMixin,
     JSONSchemaFormDataProvider,
     WorkflowContextPickKeysForMixin,

src/context/registry.js

@@ -31,3 +31,42 @@ export class ContextProviderRegistryContainer {
         this.providers = this.providers.filter((p) => p.name === name);
     }
 }
+
+/** Extends an existing context provider registry container and patches static class variables if applicable.
+ *
+ * @param {ContextProviderRegistryContainer} registryContainer
+ * @param {Object} classConfigMap
+ * @param {Object} classesToPatch
+ * @example
+ * const classConfigMap = {
+ *     PlanewaveCutoffDataManager: {
+ *         providerCls: PlanewaveCutoffsContextProvider,
+ *         config: _makeImportant({ name: "cutoffs", entityName: "subworkflow" })
+ *     },
+ * };
+ *
+ */
+export const extendAndPatchRegistry = (registryContainer, classConfigMap, classesToPatch = {}) => {
+    Object.entries(classConfigMap).forEach(([name, { providerCls, config }]) => {
+        Object.entries(classesToPatch).forEach(([clsName, cls]) => {
+            if (providerCls[clsName]) {
+                providerCls[clsName] = cls;
+            }
+        });
+        registryContainer.addProvider({
+            instance: providerCls.getConstructorConfig(config),
+            name,
+        });
+    });
+    return registryContainer;
+};
+
+/** Creates a new context provider registry container and patches static class variables if applicable.
+ *
+ * @param {Object} classConfigMap
+ * @param {{Material: SpecificMockMaterial}} classesToPatch
+ */
+export const createAndPatchRegistry = (classConfigMap, classesToPatch = {}) => {
+    const registryContainer = new ContextProviderRegistryContainer();
+    return extendAndPatchRegistry(registryContainer, classConfigMap, classesToPatch);
+};

tests/context.tests.js

@@ -1,8 +1,12 @@
 import { expect } from "chai";
 import { mix } from "mixwith";
 
-import { ApplicationContextMixin, MaterialContextMixin } from "../src/context/mixins";
-import { InMemoryEntity } from "../src/entity";
+import {
+    ApplicationContextMixin,
+    ContextProvider,
+    createAndPatchRegistry,
+    MaterialContextMixin,
+} from "../src/context";
 
 class MockMaterial {
     static createDefault() {
@@ -28,7 +32,7 @@ class SpecificMockApplication {
     }
 }
 
-class ProviderEntity extends mix(InMemoryEntity).with(
+class ProviderEntity extends mix(ContextProvider).with(
     MaterialContextMixin,
     ApplicationContextMixin,
 ) {
@@ -43,6 +47,10 @@ class DerivedProviderEntity extends ProviderEntity {
     static Application = SpecificMockApplication;
 }
 
+class ApplicationContextProvider extends mix(ContextProvider).with(ApplicationContextMixin) {
+    static Application = SpecificMockApplication;
+}
+
 describe("Material & Application ContextMixin", () => {
     const config = {};
 
@@ -58,3 +66,26 @@ describe("Material & Application ContextMixin", () => {
         expect(provider.application).to.be.equal("defaultSpecificMockApplication");
     });
 });
+
+describe("ContextProviderRegistryContainer", () => {
+    const classConfigObj = {
+        DataManager: {
+            providerCls: ProviderEntity,
+            config: { name: "example1", domain: "important" },
+        },
+        ApplicationDataManager: {
+            providerCls: ApplicationContextProvider,
+            config: { name: "example2", domain: "important" },
+        },
+    };
+
+    it("can be created and patched", () => {
+        const registry = createAndPatchRegistry(classConfigObj, { Material: SpecificMockMaterial });
+        const _dataProvider = registry.findProviderInstanceByName("DataManager");
+        const dataProvider = new _dataProvider.constructor(_dataProvider.config);
+        const _appProvider = registry.findProviderInstanceByName("ApplicationDataManager");
+        const appProvider = new _appProvider.constructor(_appProvider.config);
+        expect(dataProvider.material).to.be.equal("defaultSpecificMockMaterial");
+        expect(appProvider.application).to.be.equal("defaultSpecificMockApplication");
+    });
+});