@kiberon-labs/behave-graph-suspendable 1.0.1

package/tests/tsconfig.json

@@ -0,0 +1,15 @@
+{
+    "extends": "../tsconfig.json",
+    "compilerOptions": {
+        "baseUrl": ".",
+        "noEmit": true,
+        "rootDir": "../",
+        "lib": [],
+        "paths": {
+            "~/*":["../src/*"]
+        }
+    },
+    "include": [
+        "**/*.ts"
+    ]
+}

package/tests/variableSerialization.test.ts

@@ -0,0 +1,96 @@
+import type { GraphJSON } from '@kiberon-labs/behave-graph';
+import { describe, expect, it } from 'vitest';
+import { makeTestEngine } from './testUtils';
+
+/**
+ * onStart -> variable/set writes 1000 into the `counter` variable
+ * (initial value -1).
+ */
+const variableGraph: GraphJSON = {
+  variables: [
+    {
+      valueTypeName: 'float',
+      name: 'counter',
+      id: 0,
+      initialValue: -1
+    }
+  ],
+  customEvents: [],
+  nodes: [
+    {
+      type: 'lifecycle/onStart',
+      id: '0',
+      flows: { flow: { nodeId: '1', socket: 'flow' } }
+    },
+    {
+      type: 'variable/set',
+      id: '1',
+      configuration: { variableId: 0 },
+      parameters: { value: { value: 1000 } }
+    }
+  ]
+} as unknown as GraphJSON;
+
+describe('variable serialization across suspension', () => {
+  it('serializes the updated variable value, not the initial value', async () => {
+    const { engine, graph, start } = makeTestEngine(variableGraph);
+
+    start();
+    await engine.executeAllSync();
+    expect(graph.variables['0']!.get()).toBe(1000);
+
+    const suspension = engine.suspend();
+
+    expect(suspension.variables['0']).toEqual({
+      type: 'float',
+      value: 1000
+    });
+  });
+
+  it('serializes the latest value when a variable is updated multiple times', async () => {
+    const { engine, graph, start } = makeTestEngine(variableGraph);
+
+    start();
+    await engine.executeAllSync();
+
+    // a later runtime update (e.g. another node firing) must win
+    graph.variables['0']!.set(7);
+
+    const suspension = engine.suspend();
+    expect(suspension.variables['0']).toEqual({ type: 'float', value: 7 });
+  });
+
+  it('restores the suspended variable value into a fresh engine', async () => {
+    const first = makeTestEngine(variableGraph);
+    first.start();
+    await first.engine.executeAllSync();
+
+    const suspension = first.engine.suspend();
+    const persisted = JSON.parse(JSON.stringify(suspension));
+
+    // fresh graph starts back at the initial value...
+    const second = makeTestEngine(variableGraph);
+    expect(second.graph.variables['0']!.get()).toBe(-1);
+
+    // ...until the suspension is rehydrated
+    second.engine.unsuspend(persisted, undefined);
+    expect(second.graph.variables['0']!.get()).toBe(1000);
+  });
+
+  it('throws when the suspension references a variable missing from the graph', async () => {
+    const first = makeTestEngine(variableGraph);
+    first.start();
+    await first.engine.executeAllSync();
+    const suspension = first.engine.suspend();
+
+    const graphWithoutVariables = {
+      ...variableGraph,
+      variables: []
+    } as unknown as GraphJSON;
+    const second = makeTestEngine(graphWithoutVariables);
+
+    expect(() => second.engine.unsuspend(suspension, undefined)).toThrow(
+      /missing variable/
+    );
+  });
+});

package/tsconfig.json

@@ -0,0 +1,55 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Monorepo shared library",
+  "compilerOptions": {
+    /* Base Options: */
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "target": "esnext",
+    "lib": [
+      "esnext",
+      "ES6"
+    ],
+    "allowJs": true,
+    "resolveJsonModule": true,
+    "moduleDetection": "force",
+    "isolatedModules": true,
+    "verbatimModuleSyntax": true,
+    /* Strictness */
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+    "erasableSyntaxOnly": true,
+    /* Opinion */
+    "incremental": true,
+    "tsBuildInfoFile": "./tsconfig.tsbuildinfo",
+    "module": "preserve",
+    "outDir": "./dist",
+    "baseUrl": ".",
+    "rootDir": "./src",
+    "paths": {
+      "~/*": [
+        "./src/*"
+      ],
+      "@/*": [
+        "./src/*"
+      ]
+    },
+    /* Required for project references, which provide go-to-definition in your
+    IDE without first having to build the module, which is essential during development. */
+    "composite": true,
+    /* Assuming your bundler will output everything, but we can not have noEmit
+    enabled because it is not compatible with composite  / project references. Also declaration might be required for references to work fully. Not sure yet... */
+    "declaration": true,
+    "declarationMap": true,
+  },
+  "include": [
+    "./src",
+    "./src/**/*.json"
+  ],
+  "references": [
+    {
+      "path": "../core"
+    }
+  ],
+}

package/tsdown.config.ts

@@ -0,0 +1,13 @@
+import { defineConfig } from 'tsdown';
+
+export default defineConfig({
+  entry: ['./src/index.ts'],
+  outDir: 'dist',
+  target: 'es2022',
+  sourcemap: true,
+  format: ['esm'],
+  dts: true,
+  logLevel: 'warn',
+  unbundle: true,
+  platform: 'neutral'
+});

package/vitest.config.ts

@@ -0,0 +1,15 @@
+import path from 'node:path';
+import { configDefaults, defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    exclude: [...configDefaults.exclude],
+    watch: false
+  },
+  resolve: {
+    alias: {
+      '~': path.resolve(__dirname, './src'),
+      '@': path.resolve(__dirname, './src')
+    }
+  }
+});