simplify bundle system

Author: xibyte

modules/bundler/bundleSystem.ts

@@ -1,109 +1,95 @@
-type BagOfPlugins = Set<Bundle<any, any>>;
 
 export class BundleSystem {
 
-  plugins: BagOfPlugins = new Set();
-  waitingQueue: BagOfPlugins = new Set();
   globalContext: any;
+  activatedBundles = new Set<string>();
+  waitingQueue = new Set<Bundle<any>>();
+  perfectLoad = true;
 
-  constructor(globalContext: any) {
+  constructor(globalContext) {
     this.globalContext = globalContext;
   }
 
-  load(plugin: Bundle<any, any>) {
-    this.waitingQueue.add(plugin);
+  activate(bundle: Bundle<any>) {
+
+    if (!bundle.BundleName) {
+      console.error("BundleName is not provided for the bundle");
+      bundle.BundleName = "@Unknown_" + (UNKNOWNS_COUNTER++);
+    }
+
+    if (this.activatedBundles.has(bundle.BundleName)) {
+      throw `Bundle ${bundle.BundleName} has already activated. Possible name collision`;
+    }
+
+    if (!this.readinessCheck(bundle)) {
+      this.perfectLoad = false;
+      this.waitingQueue.add(bundle);
+      return;
+    }
+
+    this.doActivate(bundle);
+
     this.processWaitingQueue();
   }
 
+  private doActivate(bundle) {
+    bundle.activate(this.globalContext);
+    this.activatedBundles.add(bundle.BundleName);
+  }
+
   processWaitingQueue() {
-    let needPass = true;
-    while (needPass) {
-      needPass = false;
-      this.waitingQueue.forEach(plugin => {
-        const ready = readiness(plugin, this.globalContext);
-        if (ready) {
-          try  {
-            plugin.activate(this.globalContext);
-            checkActivation(plugin, this.globalContext);
-            needPass = true;
-            this.plugins.add(plugin);
-          } catch (error) {
-            console.error(error);
-          } finally {
-            this.waitingQueue.delete(plugin)
-          }
-        }
-      })
+    for (let bundle of this.waitingQueue) {
+      if (this.readinessCheck(bundle)) {
+        this.waitingQueue.delete(bundle);
+        this.doActivate(bundle);
+      }
     }
   }
 
-  unload(plugin: Bundle<any, any>) {
-    this.waitingQueue.delete(plugin);
-    this.plugins.delete(plugin);
-    try {
-      if (plugin.deactivate) {
-        plugin.deactivate(this.globalContext);
-      }
-    } catch (error) {
-      console.error(error);
+  readinessCheck(bundle) {
+
+    if (!bundle.activationDependencies) {
+      return true;
     }
 
-    let needPass = true;
-    while (needPass) {
-      needPass = false;
-      this.plugins.forEach(plugin => {
-        if (!plugin.deactivate) {
-          return;
-        }
-        const isReady = readiness(plugin, this.globalContext);
-        if (!isReady) {
-          try {
-            plugin.deactivate(this.globalContext);
-            this.plugins.delete(plugin);
-            this.waitingQueue.add(plugin);
-            needPass = true;
-          } catch (error) {
-            console.error(error);
-          }
-        }
-      })
+    for (let dep of bundle.activationDependencies) {
+      if (!this.activatedBundles.has(dep)) {
+        return false;
+      }
     }
+    return true;
   }
-}
 
-function readiness(plugin: Bundle<any, any>, globalContext: any) {
-  const specKeys = Object.keys(plugin.inputContextSpec);
-  for (let key of specKeys) {
-    if (!globalContext[key] && plugin.inputContextSpec[key] === 'required') {
-      return false;
-    }
+  checkDanglingBundles() {
+    this.waitingQueue.forEach(dangling => {
+      const unsatisfied = new Set(dangling.activationDependencies);
+      this.activatedBundles.forEach(activated => unsatisfied.delete(activated));
+      console.error('Bundle', dangling.BundleName, 'was never activated because of unsatisfied dependencies: ', Array.from(unsatisfied).join(', '));
+    })
   }
-  return true;
-}
 
-function checkActivation(plugin: Bundle<any, any>, globalContext: any) {
-  const specKeys = Object.keys(plugin.outputContextSpec);
-  for (let key of specKeys) {
-    if (!globalContext[key] && plugin.outputContextSpec[key] === 'required') {
-      console.error("declared service was never activated: " + key);
+  checkPerfectLoad() {
+    if (!this.perfectLoad) {
+      console.warn("Bundle activation wasn't perfect. Consider reordering bundles to following:");
+      console.info(Array.from(this.activatedBundles));
     }
   }
 }
 
-export type Spec = 'required' | 'optional';
-
+export type Spec = 'required';
 export type ContextSpec<T> = {
   [Property in keyof T]: Spec;
 };
 
-export interface Bundle<InputContext, OutputContext, WorkingContext = InputContext&OutputContext> {
+export interface Bundle<WorkingContext> {
 
-  inputContextSpec: ContextSpec<InputContext>;
+  activationDependencies?: string[];
 
-  outputContextSpec: ContextSpec<OutputContext>;
+  runtimeDependencies?: string[];
 
-  activate(ctx: InputContext&OutputContext);
-
-  deactivate?(ctx: InputContext&OutputContext);
+  activate(ctx: WorkingContext);
 
+  BundleName: string,
 }
+
+let UNKNOWNS_COUNTER = 0;

modules/bundler/bundlerContext.ts

@@ -0,0 +1,6 @@
+
+
+
+export function createBundlerContext() {
+
+}

test/coreTests/subjects/modellerTPI.js

@@ -3,7 +3,7 @@ import {
   ALL_EXCLUDING_SOLID_KINDS,
   PICK_KIND,
   traversePickResults
-} from '../../../web/app/cad/scene/controls/pickControlPlugin';
+} from 'cad/scene/controls/pickControlBundle';
 import {Vector3} from "three";
 
 function waitFor(checkFn) {

web/app/cad/actions/actionSystemBundle.ts

@@ -4,7 +4,6 @@ import {state, StateStream, Stream} from 'lstream';
 import {LOG_FLAGS} from '../logFlags';
 import {ApplicationContext} from "cad/context";
 import {IconType} from "react-icons";
-import {ContextSpec} from "bundler/bundleSystem";
 
 export function activate(context: ApplicationContext) {
 
@@ -160,7 +159,6 @@ export interface ActionSystemBundleContext {
   actionService: ActionService;
 }
 
-export const outputContextSpec: ContextSpec<ActionSystemBundleContext> = {
-  actionService: 'required'
-}
+export const BundleName = "@ActionSystem";
+
 

web/app/cad/assembly/assemblyBundle.ts

@@ -9,7 +9,6 @@ import {AssemblyView} from "./ui/AssemblyView";
 import {IoMdConstruct} from "react-icons/io";
 import {AssemblyConstraintDefinition} from "./assemblyConstraint";
 import {AssemblyConstraintsSchemas} from "./assemblySchemas";
-import {ContextSpec} from "bundler/bundleSystem";
 
 
 export function activate(ctx: ApplicationContext) {
@@ -105,6 +104,4 @@ export interface AssemblyBundleContext {
   assemblyService: AssemblyService;
 }
 
-export const outputContextSpec: ContextSpec<AssemblyBundleContext> = {
-  assemblyService: 'required'
-}
+export const BundleName = "@Assembly";

web/app/cad/attributes/attributesBundle.ts

@@ -2,31 +2,22 @@ import {Bundle} from "bundler/bundleSystem";
 import {AttributesService} from "cad/attributes/attributesService";
 import {contributeComponent} from "cad/dom/components/ContributedComponents";
 import {DisplayOptionsDialogManager} from "cad/attributes/ui/DisplayOptionsDialog";
-import {ActionSystemBundleContext} from "cad/actions/actionSystemBundle";
 import {RequiresAnyModelSelection} from "cad/actions/actionHelpers";
 import {IoColorPalette} from "react-icons/io5";
 import {FaTable} from "react-icons/fa";
 import {ApplicationContext} from "cad/context";
 
-type AttributesPluginInputContext = ActionSystemBundleContext;
-
-export interface AttributesPluginContext {
+export interface AttributesBundleContext {
   attributesService: AttributesService;
 }
 
-type AttributesPluginWorkingContext = AttributesPluginInputContext&AttributesPluginContext;
-
-export const AttributesBundle: Bundle<AttributesPluginInputContext, AttributesPluginContext, AttributesPluginWorkingContext> = {
+export const AttributesBundle: Bundle<ApplicationContext> = {
 
-  inputContextSpec: {
-    actionService: 'required',
-  },
-
-  outputContextSpec: {
-    attributesService: 'required',
-  },
+  activationDependencies: [
+    '@ActionSystem'
+  ],
 
-  activate(ctx: AttributesPluginWorkingContext) {
+  activate(ctx: ApplicationContext) {
     ctx.attributesService = new AttributesService();
     contributeComponent(DisplayOptionsDialogManager);
 
@@ -55,6 +46,7 @@ export const AttributesBundle: Bundle<AttributesPluginInputContext, AttributesPl
     ])
   },
 
+  BundleName: "@Attributes",
 }
 
 

web/app/cad/context/LegacyStructureBundle.ts

@@ -0,0 +1,22 @@
+import {Bundle} from "bundler/bundleSystem";
+import {ApplicationContext} from "cad/context";
+
+
+export interface LegacyStructureBundleContext {
+  services: any,
+  streams: any
+}
+
+
+export const LegacyStructureBundle: Bundle<ApplicationContext> = {
+
+  activate(ctx: ApplicationContext) {
+    ctx.services = {};
+    ctx.streams = {};
+  },
+
+  BundleName: "@Legacy",
+
+}
+
+

web/app/cad/context/index.ts

@@ -1,52 +1,48 @@
 import {ProjectBundleContext} from "cad/projectBundle";
 import {ActionSystemBundleContext} from "cad/actions/actionSystemBundle";
 import {AssemblyBundleContext} from "cad/assembly/assemblyBundle";
-import {AttributesPluginContext} from "cad/attributes/attributesBundle";
+import {AttributesBundleContext} from "cad/attributes/attributesBundle";
 import {CadRegistryBundleContext} from "cad/craft/cadRegistryBundle";
 import {CraftBundleContext} from "cad/craft/craftBundle";
 import {OperationBundleContext} from "cad/craft/operationBundle";
 import {OCCBundleContext} from "cad/craft/e0/occtBundle";
-import {WizardPluginContext} from "cad/craft/wizard/wizardBundle";
+import {WizardBundleContext} from "cad/craft/wizard/wizardBundle";
 import {AppTabsBundleContext} from "cad/dom/appTabsBundle";
-import {DomPluginContext} from "cad/dom/domBundle";
+import {DomBundleContext} from "cad/dom/domBundle";
 import {UIBundleContext} from "cad/dom/uiBundle";
 import {ExpressionBundleContext} from "cad/expressions/expressionsBundle";
 import {LocationBundleContext} from "cad/location/LocationBundle";
 import {RemotePartsBundleContext} from "cad/partImport/remotePartsBundle";
 import {ProjectManagerBundleContext} from "cad/projectManager/projectManagerBundle";
 import {EntityContextBundleContext} from "cad/scene/entityContextBundle";
-import {HighlightPluginContext} from "cad/scene/highlightBundle";
+import {HighlightBundleContext} from "cad/scene/highlightBundle";
 import {SceneBundleContext} from "cad/scene/sceneBundle";
 import {SketcherBundleContext} from "cad/sketch/sketcherBundle";
 import {SketchStorageBundleContext} from "cad/sketch/sketchStorageBundle";
 import {StorageBundleContext} from "cad/storage/storageBundle";
 import {WorkbenchBundleContext} from "cad/workbench/workbenchBundle";
-
-export interface LegacyContext {
-  services: any,
-  streams: any,
-}
+import {LegacyStructureBundleContext} from "cad/context/LegacyStructureBundle";
 
 export interface ApplicationContext extends
-  LegacyContext,
+  LegacyStructureBundleContext,
   ProjectBundleContext,
   ActionSystemBundleContext,
   AssemblyBundleContext,
-  AttributesPluginContext,
+  AttributesBundleContext,
   CadRegistryBundleContext,
   CraftBundleContext,
   OperationBundleContext,
   OCCBundleContext,
-  WizardPluginContext,
+  WizardBundleContext,
   AppTabsBundleContext,
-  DomPluginContext,
+  DomBundleContext,
   UIBundleContext,
   ExpressionBundleContext,
   LocationBundleContext,
   RemotePartsBundleContext,
   ProjectManagerBundleContext,
   EntityContextBundleContext,
-  HighlightPluginContext,
+  HighlightBundleContext,
   SceneBundleContext,
   SketcherBundleContext,
   SketchStorageBundleContext,
@@ -56,10 +52,5 @@ export interface ApplicationContext extends
 
 export type CoreContext = ApplicationContext;
 
-export default {
-
-  services: {},
-  streams: {}
-
-} as ApplicationContext;
+export default {} as ApplicationContext;
 

web/app/cad/craft/cadRegistryBundle.ts

@@ -114,6 +114,4 @@ export interface CadRegistryBundleContext {
   cadRegistry: CadRegistry;
 }
 
-export const outputContextSpec: ContextSpec<CadRegistryBundleContext> = {
-  cadRegistry: 'required'
-}
+export const BundleName = "@CadRegistry";

web/app/cad/craft/craftBundle.ts

@@ -297,6 +297,4 @@ export interface CraftBundleContext {
   craftService: CraftService;
 }
 
-export const outputContextSpec: ContextSpec<CraftBundleContext> = {
-  craftService: 'required'
-}
+export const BundleName = "@Craft";