reintroducing registry type instead of various destructured patterns.

bhouston · Jul 22, 2023 · 4f4e1ce · 4f4e1ce
1 parent db950f6
commit 4f4e1ce
Show file tree

Hide file tree

Showing 24 changed files with 102 additions and 165 deletions.
diff --git a/apps/exec-graph/src/index.ts b/apps/exec-graph/src/index.ts
@@ -48,11 +48,7 @@ async function execGraph({
   const textFile = await fs.readFile(graphJsonPath);
   const graph = readGraphFromJSON({
     graphJson: JSON.parse(textFile.toString('utf8')),
-    ...registry,
-    dependencies: {
-      logger,
-      lifecycleEventEmitter
-    }
+    registry
   });
   graph.name = graphJsonPath;
 

diff --git a/apps/export-node-spec/package.json b/apps/export-node-spec/package.json
@@ -14,6 +14,7 @@
   "devDependencies": {},
   "dependencies": {
     "@behave-graph/core": "*",
+    "@behave-graph/scene": "*",
     "csv-stringify": "^6.2.1"
   }
 }
diff --git a/apps/export-node-spec/src/index.ts b/apps/export-node-spec/src/index.ts
@@ -8,6 +8,7 @@ import {
   validateNodeRegistry,
   writeNodeSpecsToJSON
 } from '@behave-graph/core';
+import { DummyScene, registerSceneProfile } from '@behave-graph/scene';
 import { program } from 'commander';
 import { stringify } from 'csv-stringify';
 import { createRequire } from 'module';
@@ -37,12 +38,22 @@ export const main = async () => {
   const lifecycleEventEmitter = new ManualLifecycleEventEmitter();
   const logger = new DefaultLogger();
 
-  const registry = registerCoreProfile({
+  let registry = registerCoreProfile({
     values: {},
     nodes: {},
-    dependencies: {}
+    dependencies: {
+      ILogger: logger,
+      ILifecycleEventEmitter: lifecycleEventEmitter
+    }
   });
 
+  const scene = new DummyScene();
+
+  registry = registerSceneProfile(registry);
+  registry.dependencies.IScene = scene;
+
+  console.log({ registry });
+
   const errorList: string[] = [];
   errorList.push(...validateNodeRegistry(registry));
   if (errorList.length > 0) {
@@ -54,11 +65,7 @@ export const main = async () => {
   }
 
   const nodeSpecJson = writeNodeSpecsToJSON({
-    ...registry,
-    dependencies: {
-      logger,
-      lifecycleEventEmitter
-    }
+    ...registry
   });
   nodeSpecJson.sort((a, b) => a.type.localeCompare(b.type));
   const jsonOutput = JSON.stringify(nodeSpecJson, null, ' ');

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/core/src/Graphs/Graph.ts b/packages/core/src/Graphs/Graph.ts
@@ -67,21 +67,25 @@ export const createNode = ({
 export const makeGraphApi = ({
   variables = {},
   customEvents = {},
-  valuesTypeRegistry,
+  values,
   dependencies = {}
 }: {
   customEvents?: GraphCustomEvents;
   variables?: GraphVariables;
-  valuesTypeRegistry: ValueTypeMap;
+  values: ValueTypeMap;
   dependencies: Dependencies;
 }): IGraphApi => ({
   variables,
   customEvents,
-  values: valuesTypeRegistry,
+  values,
   getDependency: (id: string) => {
     const result = dependencies[id];
     if (!result)
-      console.error(`Dependency not found ${id}.  Did you register it?`);
+      console.error(
+        `Dependency not found ${id}.  Did you register it? Existing dependencies: ${Object.keys(
+          dependencies
+        )}`
+      );
     return result;
   }
 });
diff --git a/packages/core/src/Graphs/IO/readGraphFromJSON.ts b/packages/core/src/Graphs/IO/readGraphFromJSON.ts
@@ -2,9 +2,9 @@ import { Logger } from '../../Diagnostics/Logger.js';
 import { CustomEvent } from '../../Events/CustomEvent.js';
 import { Link } from '../../Nodes/Link.js';
 import { NodeConfiguration } from '../../Nodes/Node.js';
-import { Dependencies } from '../../Nodes/NodeDefinitions.js';
 import { INode } from '../../Nodes/NodeInstance.js';
 import { NodeDefinitionsMap } from '../../Nodes/Registry/NodeDefinitionsMap.js';
+import { IRegistry } from '../../Registry.js';
 import { Socket } from '../../Sockets/Socket.js';
 import { ValueTypeMap } from '../../Values/ValueTypeMap.js';
 import { Variable } from '../../Values/Variables/Variable.js';
@@ -30,14 +30,10 @@ import {
 //  - loads a node graph
 export function readGraphFromJSON({
   graphJson,
-  nodes: nodesTypeRegistry,
-  values: valuesTypeRegistry,
-  dependencies
+  registry
 }: {
   graphJson: GraphJSON;
-  nodes: NodeDefinitionsMap;
-  values: ValueTypeMap;
-  dependencies: Dependencies;
+  registry: IRegistry;
 }): GraphInstance {
   const graphName = graphJson?.name || '';
   const graphMetadata = graphJson?.metadata || {};
@@ -46,14 +42,11 @@ export function readGraphFromJSON({
   let customEvents: GraphCustomEvents = {};
 
   if ('variables' in graphJson) {
-    variables = readVariablesJSON(
-      valuesTypeRegistry,
-      graphJson.variables ?? []
-    );
+    variables = readVariablesJSON(registry.values, graphJson.variables ?? []);
   }
   if ('customEvents' in graphJson) {
     customEvents = readCustomEventsJSON(
-      valuesTypeRegistry,
+      registry.values,
       graphJson.customEvents ?? []
     );
   }
@@ -65,10 +58,9 @@ export function readGraphFromJSON({
   }
 
   const graphApi = makeGraphApi({
-    valuesTypeRegistry,
+    ...registry,
     variables,
-    customEvents,
-    dependencies
+    customEvents
   });
 
   const nodes: GraphNodes = {};
@@ -77,8 +69,8 @@ export function readGraphFromJSON({
     const nodeJson = nodesJson[i];
     const node = readNodeJSON({
       graph: graphApi,
-      nodes: nodesTypeRegistry,
-      values: valuesTypeRegistry,
+      nodes: registry.nodes,
+      values: registry.values,
       nodeJson
     });
     const id = nodeJson.id;

diff --git a/packages/core/src/Graphs/IO/writeNodeSpecsToJSON.ts b/packages/core/src/Graphs/IO/writeNodeSpecsToJSON.ts
@@ -1,7 +1,7 @@
 import { NodeCategory } from '../../Nodes/NodeDefinitions.js';
 import { IRegistry } from '../../Registry.js';
 import { Choices } from '../../Sockets/Socket.js';
-import { createNode, IGraphApi } from '../Graph.js';
+import { createNode, makeGraphApi } from '../Graph.js';
 import {
   ChoiceJSON,
   InputSocketSpecJSON,
@@ -25,12 +25,12 @@ export function writeNodeSpecsToJSON({
 
   // const graph = new Graph(registry);
 
-  const graph: IGraphApi = {
-    values: values,
+  const graph = makeGraphApi({
+    values,
     customEvents: {},
-    getDependency: <T>(id: string) => dependencies[id] as T,
+    dependencies,
     variables: {}
-  };
+  });
 
   Object.keys(nodes).forEach((nodeTypeName) => {
     const node = createNode({

diff --git a/packages/core/src/Nodes/Validation/validateNodeRegistry.ts b/packages/core/src/Nodes/Validation/validateNodeRegistry.ts
@@ -1,22 +1,19 @@
 import { createNode, makeGraphApi } from '../../Graphs/Graph.js';
-import { ValueTypeMap } from '../../Values/ValueTypeMap.js';
-import { NodeDefinitionsMap } from '../Registry/NodeDefinitionsMap.js';
+import { IRegistry } from '../../Registry.js';
 
 const nodeTypeNameRegex = /^\w+(\/\w+)*$/;
 const socketNameRegex = /^\w+$/;
 
 export function validateNodeRegistry({
   nodes,
-  values
-}: {
-  nodes: NodeDefinitionsMap;
-  values: ValueTypeMap;
-}): string[] {
+  values,
+  dependencies
+}: IRegistry): string[] {
   const errorList: string[] = [];
   // const graph = new Graph(registry);
   const graph = makeGraphApi({
-    valuesTypeRegistry: values,
-    dependencies: {}
+    values,
+    dependencies
   });
   Object.keys(nodes).forEach((nodeTypeName) => {
     const node = createNode({ graph, nodes, values, nodeTypeName });

diff --git a/packages/core/src/Nodes/testUtils.ts b/packages/core/src/Nodes/testUtils.ts
@@ -12,7 +12,7 @@ import { NodeConfigurationDescription } from './Registry/NodeDescription.js';
 const makeEmptyGraph = (): IGraphApi => {
   return makeGraphApi({
     dependencies: {},
-    valuesTypeRegistry: {}
+    values: {}
   });
 };
 

diff --git a/packages/core/src/Profiles/Core/Debug/DebugLog.ts b/packages/core/src/Profiles/Core/Debug/DebugLog.ts
@@ -4,8 +4,6 @@ import {
 } from '../../../Nodes/NodeDefinitions.js';
 import { ILogger } from '../Abstractions/ILogger.js';
 
-export const loggerDependencyKey = 'logger';
-
 export const Log = makeFlowNodeDefinition({
   typeName: 'debug/log',
   category: NodeCategory.Action,
@@ -23,7 +21,7 @@ export const Log = makeFlowNodeDefinition({
   out: { flow: 'flow' },
   initialState: undefined,
   triggered: ({ read, commit, graph: { getDependency } }) => {
-    const logger = getDependency<ILogger>(loggerDependencyKey);
+    const logger = getDependency<ILogger>('ILogger');
 
     const text = read<string>('text');
     switch (read<string>('severity')) {

diff --git a/packages/core/src/Profiles/Core/Lifecycle/LifecycleOnEnd.ts b/packages/core/src/Profiles/Core/Lifecycle/LifecycleOnEnd.ts
@@ -4,7 +4,6 @@ import {
   NodeCategory
 } from '../../../Nodes/NodeDefinitions.js';
 import { ILifecycleEventEmitter } from '../Abstractions/ILifecycleEventEmitter.js';
-import { lifecycleEventEmitterDependencyKey } from './LifecycleOnStart.js';
 
 // inspired by: https://docs.unrealengine.com/4.27/en-US/ProgrammingAndScripting/Blueprints/UserGuide/Events/
 
@@ -32,7 +31,7 @@ export const LifecycleOnEnd = makeEventNodeDefinition({
     };
 
     const lifecycleEventEmitter = getDependency<ILifecycleEventEmitter>(
-      lifecycleEventEmitterDependencyKey
+      'ILifecycleEventEmitter'
     );
 
     lifecycleEventEmitter?.endEvent.addListener(onEndEvent);
@@ -45,7 +44,7 @@ export const LifecycleOnEnd = makeEventNodeDefinition({
     Assert.mustBeTrue(onEndEvent !== undefined);
 
     const lifecycleEventEmitter = getDependency<ILifecycleEventEmitter>(
-      lifecycleEventEmitterDependencyKey
+      'ILifecycleEventEmitter'
     );
 
     if (onEndEvent) lifecycleEventEmitter?.endEvent.removeListener(onEndEvent);

diff --git a/packages/core/src/Profiles/Core/Lifecycle/LifecycleOnStart.ts b/packages/core/src/Profiles/Core/Lifecycle/LifecycleOnStart.ts
@@ -13,8 +13,6 @@ const makeInitialState = (): State => ({
   onStartEvent: undefined
 });
 
-export const lifecycleEventEmitterDependencyKey = 'lifecycleEventEmitter';
-
 export const LifecycleOnStart = makeEventNodeDefinition({
   typeName: 'lifecycle/onStart',
   label: 'On Start',
@@ -31,7 +29,7 @@ export const LifecycleOnStart = makeEventNodeDefinition({
     };
 
     const lifecycleEventEmitter = getDependency<ILifecycleEventEmitter>(
-      lifecycleEventEmitterDependencyKey
+      'ILifecycleEventEmitter'
     );
 
     lifecycleEventEmitter?.startEvent.addListener(onStartEvent);
@@ -44,7 +42,7 @@ export const LifecycleOnStart = makeEventNodeDefinition({
     Assert.mustBeTrue(onStartEvent !== undefined);
 
     const lifecycleEventEmitter = getDependency<ILifecycleEventEmitter>(
-      lifecycleEventEmitterDependencyKey
+      'ILifecycleEventEmitter'
     );
 
     if (onStartEvent)

diff --git a/packages/core/src/Profiles/Core/Lifecycle/LifecycleOnTick.ts b/packages/core/src/Profiles/Core/Lifecycle/LifecycleOnTick.ts
@@ -4,7 +4,6 @@ import {
   NodeCategory
 } from '../../../Nodes/NodeDefinitions.js';
 import { ILifecycleEventEmitter } from '../Abstractions/ILifecycleEventEmitter.js';
-import { lifecycleEventEmitterDependencyKey } from './LifecycleOnStart.js';
 
 type State = {
   onTickEvent?: (() => void) | undefined;
@@ -36,7 +35,7 @@ export const LifecycleOnTick = makeEventNodeDefinition({
     };
 
     const lifecycleEventEmitter = getDependency<ILifecycleEventEmitter>(
-      lifecycleEventEmitterDependencyKey
+      'ILifecycleEventEmitter'
     );
 
     lifecycleEventEmitter?.tickEvent.addListener(onTickEvent);
@@ -49,7 +48,7 @@ export const LifecycleOnTick = makeEventNodeDefinition({
     Assert.mustBeTrue(onTickEvent !== undefined);
 
     const lifecycleEventEmitter = getDependency<ILifecycleEventEmitter>(
-      lifecycleEventEmitterDependencyKey
+      'ILifecycleEventEmitter'
     );
 
     if (onTickEvent)

diff --git a/packages/core/src/Profiles/Core/registerCoreProfile.ts b/packages/core/src/Profiles/Core/registerCoreProfile.ts
@@ -5,12 +5,10 @@ import { getNodeDescriptions } from '../../Nodes/Registry/NodeDescription.js';
 import { IRegistry } from '../../Registry.js';
 import { ValueTypeMap } from '../../Values/ValueTypeMap.js';
 import { getStringConversionsForValueType } from '../registerSerializersForValueType.js';
-import { ILifecycleEventEmitter } from './Abstractions/ILifecycleEventEmitter.js';
-import { ILogger } from './Abstractions/ILogger.js';
 import { OnCustomEvent } from './CustomEvents/OnCustomEvent.js';
 import { TriggerCustomEvent } from './CustomEvents/TriggerCustomEvent.js';
 import { ExpectTrue as AssertExpectTrue } from './Debug/AssertExpectTrue.js';
-import { Log as DebugLog, loggerDependencyKey } from './Debug/DebugLog.js';
+import { Log as DebugLog } from './Debug/DebugLog.js';
 import { Branch } from './Flow/Branch.js';
 import { Counter } from './Flow/Counter.js';
 import { Debounce } from './Flow/Debounce.js';
@@ -26,10 +24,7 @@ import { SwitchOnString } from './Flow/SwitchOnString.js';
 import { Throttle } from './Flow/Throttle.js';
 import { WaitAll } from './Flow/WaitAll.js';
 import { LifecycleOnEnd } from './Lifecycle/LifecycleOnEnd.js';
-import {
-  lifecycleEventEmitterDependencyKey,
-  LifecycleOnStart
-} from './Lifecycle/LifecycleOnStart.js';
+import { LifecycleOnStart } from './Lifecycle/LifecycleOnStart.js';
 import { LifecycleOnTick } from './Lifecycle/LifecycleOnTick.js';
 import { Easing } from './Logic/Easing.js';
 import { Delay } from './Time/Delay.js';
@@ -45,17 +40,6 @@ import { StringValue } from './Values/StringValue.js';
 import { VariableGet } from './Variables/VariableGet.js';
 import { VariableSet } from './Variables/VariableSet.js';
 
-export const makeCoreDependencies = ({
-  lifecycleEmitter,
-  logger
-}: {
-  lifecycleEmitter: ILifecycleEventEmitter;
-  logger: ILogger;
-}) => ({
-  [lifecycleEventEmitterDependencyKey]: lifecycleEmitter,
-  [loggerDependencyKey]: logger
-});
-
 export const getCoreValuesMap = memo<ValueTypeMap>(() => {
   const valueTypes = [BooleanValue, StringValue, IntegerValue, FloatValue];
   return Object.fromEntries(