@gesslar/actioneer 0.2.2 → 0.2.4

package/README.md

@@ -335,13 +335,22 @@ Examples of minimal configs and one-liners to run them are in the project discus
 
 ## Testing
 
-Run the small smoke tests with Node's built-in test runner:
+Run the comprehensive test suite with Node's built-in test runner:
 
 ```bash
 npm test
 ```
 
-The test suite is intentionally small; it verifies public exports and a few core behaviors. Add more unit tests under `tests/` if you need deeper coverage.
+The test suite includes 150+ tests covering all core classes and behaviors:
+
+- **Activity** - Activity definitions, ACTIVITY flags (WHILE, UNTIL, SPLIT), and execution
+- **ActionBuilder** - Fluent builder API, activity registration, and hooks configuration
+- **ActionWrapper** - Activity iteration and integration with ActionBuilder
+- **ActionRunner** - Pipeline execution, loop semantics, nested builders, and error handling
+- **ActionHooks** - Hook lifecycle, loading from files, and timeout handling
+- **Piper** - Concurrent processing, worker pools, and lifecycle hooks
+
+Tests are organized in `tests/unit/` with one file per class. All tests use Node's native test runner and assertion library.
 
 ## Publishing
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gesslar/actioneer",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "Ready? Set?? ACTION!! pew! pew! pew!",
   "main": "./src/index.js",
   "type": "module",

package/src/lib/ActionBuilder.js

@@ -2,6 +2,7 @@ import {Data, Sass, Valid} from "@gesslar/toolkit"
 
 import ActionWrapper from "./ActionWrapper.js"
 import ActionHooks from "./ActionHooks.js"
+import {ACTIVITY} from "./Activity.js"
 
 /** @typedef {import("./ActionRunner.js").default} ActionRunner */
 /** @typedef {typeof import("./Activity.js").ACTIVITY} ActivityFlags */
@@ -90,12 +91,17 @@ export default class ActionBuilder {
     }
   }
 
+  get tag() {
+    return this.#tag
+  }
+
   /**
    * Register an activity that the runner can execute.
    *
    * Overloads:
    * - do(name, op)
    * - do(name, kind, pred, opOrWrapper)
+   * - do(name, kind, splitter, rejoiner, opOrWrapper)
    *
    * @overload
    * @param {string|symbol} name Activity name
@@ -112,6 +118,16 @@ export default class ActionBuilder {
    * @returns {ActionBuilder}
    */
 
+  /**
+   * @overload
+   * @param {string|symbol} name Activity name
+   * @param {number} kind ACTIVITY.SPLIT flag.
+   * @param {(context: unknown) => unknown} splitter Splitter function for SPLIT mode.
+   * @param {(originalContext: unknown, splitResults: unknown) => unknown} rejoiner Rejoiner function for SPLIT mode.
+   * @param {ActionFunction|import("./ActionWrapper.js").default} op Operation or nested wrapper to execute.
+   * @returns {ActionBuilder}
+   */
+
   /**
    * Handles runtime dispatch across the documented overloads.
    *
@@ -124,7 +140,8 @@ export default class ActionBuilder {
 
     // signatures
     // name, [function] => once
-    // name, [number,function,function] => some kind of control operation
+    // name, [number,function,function] => some kind of control operation (WHILE/UNTIL)
+    // name, [number,function,function,function] => SPLIT operation with splitter/rejoiner
     // name, [number,function,ActionBuilder] => some kind of branch
 
     const action = this.#action
@@ -145,6 +162,19 @@ export default class ActionBuilder {
       Valid.type(op, "Function|ActionBuilder")
 
       Object.assign(activityDefinition, {kind, pred, op})
+    } else if(args.length === 4) {
+      const [kind, splitter, rejoiner, op] = args
+
+      Valid.type(kind, "Number")
+      Valid.type(splitter, "Function")
+      Valid.type(rejoiner, "Function")
+      Valid.type(op, "Function|ActionBuilder")
+
+      // Validate that kind is SPLIT
+      if((kind & ACTIVITY.SPLIT) !== ACTIVITY.SPLIT)
+        throw Sass.new("4-argument form of 'do' is only valid for ACTIVITY.SPLIT")
+
+      Object.assign(activityDefinition, {kind, splitter, rejoiner, op})
     } else {
       throw Sass.new("Invalid number of arguments passed to 'do'")
     }
@@ -178,9 +208,14 @@ export default class ActionBuilder {
    *
    * @param {import("./ActionHooks.js").default} hooks An already-instantiated hooks instance.
    * @returns {ActionBuilder} The builder instance for chaining.
-   * @throws {Sass} If hooks have already been configured.
+   * @throws {Sass} If hooks have already been configured with a different instance.
    */
   withHooks(hooks) {
+    // If the same hooks instance is already set, this is idempotent - just return
+    if(this.#hooks === hooks) {
+      return this
+    }
+
     Valid.assert(this.#hooksFile === null, "Hooks have already been configured.")
     Valid.assert(this.#hooksKind === null, "Hooks have already been configured.")
     Valid.assert(this.#hooks === null, "Hooks have already been configured.")
@@ -232,8 +267,14 @@ export default class ActionBuilder {
     const newHooks = ActionHooks.new
 
     const hooks = this.#hooks
-    if(hooks)
+    if(hooks) {
+      // If hooks is already an ActionHooks instance, use it directly
+      if(hooks instanceof ActionHooks)
+        return hooks
+
+      // Otherwise, wrap it in a new ActionHooks instance
       return await newHooks({hooks}, this.#debug)
+    }
 
     const hooksFile = this.#hooksFile
     const hooksKind = this.#hooksKind

package/src/lib/ActionHooks.js

@@ -114,7 +114,7 @@ export default class ActionHooks {
   static async new(config, debug) {
     debug("Creating new HookManager instance with args: %o", 2, config)
 
-    const instance = new ActionHooks(config, debug)
+    const instance = new ActionHooks({...config, debug})
     if(!instance.#hooks) {
       const hooksFile = new FileObject(instance.#hooksFile)
 
@@ -151,7 +151,7 @@ export default class ActionHooks {
       }
     }
 
-    return this
+    return instance
   }
 
   /**
@@ -170,8 +170,8 @@ export default class ActionHooks {
       if(!hooks)
         return
 
-      const stringActivityName = Data.isType("Symbol")
-        ? activityName.description()
+      const stringActivityName = Data.isType(activityName, "Symbol")
+        ? activityName.description
         : activityName
 
       const hookName = this.#getActivityHookName(kind, stringActivityName)

package/src/lib/ActionRunner.js

@@ -1,4 +1,4 @@
-import {Sass, Valid} from "@gesslar/toolkit"
+import {Data, Sass, Valid} from "@gesslar/toolkit"
 
 import ActionBuilder from "./ActionBuilder.js"
 import {ACTIVITY} from "./Activity.js"
@@ -20,7 +20,10 @@ import Piper from "./Piper.js"
  * context object under `result.value` that can be replaced or enriched.
  */
 export default class ActionRunner extends Piper {
+  /** @type {import("./ActionBuilder.js").default|null} */
   #actionBuilder = null
+  /** @type {import("./ActionWrapper.js").default|null} */
+  #actionWrapper = null
 
   /**
    * Logger invoked for diagnostics.
@@ -48,82 +51,167 @@ export default class ActionRunner extends Piper {
 
     this.#actionBuilder = actionBuilder
 
-    this.addStep(this.run)
+    this.addStep(this.run, {
+      name: `ActionRunner for ${actionBuilder.tag.description}`
+    })
   }
 
   /**
    * Executes the configured action pipeline.
+   * Builds the ActionWrapper on first run and caches it for subsequent calls.
+   * Supports WHILE, UNTIL, and SPLIT activity kinds.
    *
    * @param {unknown} context - Seed value passed to the first activity.
-   * @returns {Promise<unknown>} Final value produced by the pipeline, or null when a parallel stage reports failures.
-   * @throws {Sass} When no activities are registered or required parallel builders are missing.
+   * @returns {Promise<unknown>} Final value produced by the pipeline.
+   * @throws {Sass} When no activities are registered, conflicting activity kinds are used, or execution fails.
    */
   async run(context) {
-    const actionWrapper = await this.#actionBuilder.build()
+    if(!this.#actionWrapper)
+      this.#actionWrapper = await this.#actionBuilder.build()
+
+    const actionWrapper = this.#actionWrapper
     const activities = actionWrapper.activities
 
     for(const activity of activities) {
-      const kind = activity.kind
-
-      // If we have no kind, then it's just a once.
-      // Get it over and done with!
-      if(!kind) {
-        context = await this.#executeActivity(activity, context)
-      } else {
-        const {WHILE,UNTIL} = ACTIVITY
-        const pred = activity.pred
-        const kindWhile = kind & WHILE
-        const kindUntil = kind & UNTIL
-
-        if(kindWhile && kindUntil)
-          throw Sass.new(
-            "For Kathy Griffin's sake! You can't do something while AND " +
-            "until. Pick one!"
-          )
-
-        if(kindWhile || kindUntil) {
-          for(;;) {
-
-            if(kindWhile)
-              if(!await this.#predicateCheck(activity,pred,context))
-                break
+      try {
+        // await timeout(500)
 
-            context = await this.#executeActivity(activity,context)
+        const kind = activity.kind
 
-            if(kindUntil)
-              if(await this.#predicateCheck(activity,pred,context))
-                break
-          }
+        // If we have no kind, then it's just a once.
+        // Get it over and done with!
+        if(!kind) {
+          context = await this.#execute(activity, context)
         } else {
-          context = await this.#executeActivity(activity, context)
+          // Validate that only one activity kind bit is set
+          // (kind & (kind - 1)) !== 0 means multiple bits are set
+          const multipleBitsSet = (kind & (kind - 1)) !== 0
+          if(multipleBitsSet)
+            throw Sass.new(
+              "For Kathy Griffin's sake! You can't combine activity kinds. " +
+              "Pick one: WHILE, UNTIL, or SPLIT!"
+            )
+
+          const {WHILE,UNTIL,SPLIT} = ACTIVITY
+          const kindWhile = kind & WHILE
+          const kindUntil = kind & UNTIL
+          const kindSplit = kind & SPLIT
+
+          if(kindWhile || kindUntil) {
+            const predicate = activity.pred
+
+            for(;;) {
+
+              if(kindWhile)
+                if(!await this.#hasPredicate(activity,predicate,context))
+                  break
+
+              context = await this.#execute(activity,context)
+
+              if(kindUntil)
+                if(await this.#hasPredicate(activity,predicate,context))
+                  break
+            }
+          } else if(kindSplit) {
+            // SPLIT activity: parallel execution with splitter/rejoiner pattern
+            const splitter = activity.splitter
+            const rejoiner = activity.rejoiner
+
+            if(!splitter || !rejoiner)
+              throw Sass.new(
+                `SPLIT activity "${String(activity.name)}" requires both splitter and rejoiner functions.`
+              )
+
+            const original = context
+            const splitContexts = splitter.call(activity.action,context)
+
+            let newContext
+            if(activity.opKind === "ActionBuilder") {
+              // Use parallel execution for ActionBuilder
+              newContext = await this.#execute(activity,splitContexts,true)
+            } else {
+              // For plain functions, process each split context
+              newContext = await Promise.all(
+                splitContexts.map(ctx => this.#execute(activity,ctx))
+              )
+            }
+
+            const rejoined = rejoiner.call(activity.action, original,newContext)
+
+            context = rejoined
+          } else {
+            context = await this.#execute(activity, context)
+          }
         }
+      } catch(error) {
+        throw Sass.new("ActionRunner running activity", error)
       }
-
     }
 
     return context
   }
 
   /**
-   * Execute a single activity, recursing into nested action wrappers when needed.
+   * Execute a single activity, recursing into nested ActionBuilders when needed.
+   * Handles both function-based activities and ActionBuilder-based nested pipelines.
+   * Automatically propagates hooks to nested builders and handles dynamic ActionBuilder returns.
+   *
+   * When parallel=true, uses Piper.pipe() for concurrent execution with worker pool pattern.
+   * This is triggered by SPLIT activities where context is divided for parallel processing.
+   * Results from parallel execution are returned directly as an array from Piper.pipe().
    *
    * @param {import("./Activity.js").default} activity Pipeline activity descriptor.
    * @param {unknown} context Current pipeline context.
+   * @param {boolean} [parallel] Whether to use parallel execution (via pipe() instead of run()). Default: false.
    * @returns {Promise<unknown>} Resolved activity result.
+   * @throws {Sass} If the operation kind is invalid, or if SPLIT activity lacks splitter/rejoiner.
    * @private
    */
-  async #executeActivity(activity, context) {
+  async #execute(activity, context, parallel=false) {
     // What kind of op are we looking at? Is it a function?
     // Or a class instance of type ActionBuilder?
     const opKind = activity.opKind
+
     if(opKind === "ActionBuilder") {
-      const runner = new this.constructor(activity.op, {debug: this.#debug})
+      if(activity.hooks)
+        activity.op.withHooks(activity.hooks)
 
-      return await runner.run(context, true)
+      const runner = new this.constructor(activity.op, {
+        debug: this.#debug, name: activity.name
+      })
+
+      if(parallel) {
+        return await runner.pipe(context)
+      } else {
+        return await runner.run(context)
+      }
     } else if(opKind === "Function") {
-      return await activity.run(context)
+      try {
+        const result = await activity.run(context)
+
+        if(Data.isType(result, "ActionBuilder")) {
+          if(activity.hooks)
+            result.withHooks(activity.hooks)
+
+          const runner = new this.constructor(result, {
+            debug: this.#debug, name: result.name
+          })
+
+          if(parallel) {
+            return await runner.pipe(context)
+          } else {
+            return await runner.run(context)
+          }
+        } else {
+          return result
+        }
+      } catch(error) {
+        throw Sass.new("Executing activity", error)
+      }
     }
 
+    console.log(activity.opKind + " " + JSON.stringify(activity))
+
     throw Sass.new("We buy Functions and ActionBuilders. Only. Not whatever that was.")
   }
 
@@ -136,7 +224,7 @@ export default class ActionRunner extends Piper {
    * @returns {Promise<boolean>} True when the predicate allows another iteration.
    * @private
    */
-  async #predicateCheck(activity,predicate,context) {
+  async #hasPredicate(activity,predicate,context) {
     Valid.type(predicate, "Function")
 
     return !!(await predicate.call(activity.action, context))

package/src/lib/Activity.js

@@ -8,32 +8,58 @@ import {Data} from "@gesslar/toolkit"
  *
  * @readonly
  * @enum {number}
+ * @property {number} WHILE - Execute activity while predicate returns true (2)
+ * @property {number} UNTIL - Execute activity until predicate returns true (4)
+ * @property {number} SPLIT - Execute activity with split/rejoin pattern for parallel execution (8)
  */
 export const ACTIVITY = Object.freeze({
   WHILE: 1<<1,
   UNTIL: 1<<2,
+  SPLIT: 1<<3,
 })
 
 export default class Activity {
+  /** @type {unknown} */
   #action = null
+  /** @type {unknown} */
+  #context = null
+  /** @type {ActionHooks|null} */
+  #hooks = null
+  /** @type {number|null} */
+  #kind = null
+  /** @type {string|symbol} */
   #name = null
+  /** @type {((context: unknown) => unknown|Promise<unknown>)|import("./ActionBuilder.js").default} */
   #op = null
-  #kind = null
+  /** @type {((context: unknown) => boolean|Promise<boolean>)|null} */
   #pred = null
-  #hooks = null
+  /** @type {((originalContext: unknown, splitResults: unknown) => unknown)|null} */
+  #rejoiner = null
+  /** @type {((context: unknown) => unknown)|null} */
+  #splitter = null
 
   /**
    * Construct an Activity definition wrapper.
    *
-   * @param {{action: unknown, name: string, op: (context: unknown) => unknown|Promise<unknown>|unknown, kind?: number, pred?: (context: unknown) => boolean|Promise<boolean>, hooks?: ActionHooks}} init - Initial properties describing the activity operation, loop semantics, and predicate
+   * @param {object} init - Initial properties describing the activity operation, loop semantics, and predicate
+   * @param {unknown} init.action - Parent action instance
+   * @param {string|symbol} init.name - Activity identifier
+   * @param {(context: unknown) => unknown|Promise<unknown>|import("./ActionBuilder.js").default} init.op - Operation to execute
+   * @param {number} [init.kind] - Optional loop semantics flags
+   * @param {(context: unknown) => boolean|Promise<boolean>} [init.pred] - Optional predicate for WHILE/UNTIL
+   * @param {ActionHooks} [init.hooks] - Optional hooks instance
+   * @param {(context: unknown) => unknown} [init.splitter] - Optional splitter function for SPLIT activities
+   * @param {(originalContext: unknown, splitResults: unknown) => unknown} [init.rejoiner] - Optional rejoiner function for SPLIT activities
    */
-  constructor({action,name,op,kind,pred,hooks}) {
+  constructor({action,name,op,kind,pred,hooks,splitter,rejoiner}) {
+    this.#action = action
+    this.#hooks = hooks
+    this.#kind = kind
     this.#name = name
     this.#op = op
-    this.#kind = kind
-    this.#action = action
     this.#pred = pred
-    this.#hooks = hooks
+    this.#rejoiner = rejoiner
+    this.#splitter = splitter
   }
 
   /**
@@ -64,7 +90,16 @@ export default class Activity {
   }
 
   /**
-   * The operator kind name (Function or ActionWrapper).
+   * The current context (if set).
+   *
+   * @returns {unknown} Current context value
+   */
+  get context() {
+    return this.#context
+  }
+
+  /**
+   * The operator kind name (Function or ActionBuilder).
    *
    * @returns {string} - Kind name extracted via Data.typeOf
    */
@@ -73,14 +108,32 @@ export default class Activity {
   }
 
   /**
-   * The operator to execute (function or nested wrapper).
+   * The operator to execute (function or nested ActionBuilder).
    *
-   * @returns {unknown} - Activity operation
+   * @returns {(context: unknown) => unknown|Promise<unknown>|import("./ActionBuilder.js").default} - Activity operation
    */
   get op() {
     return this.#op
   }
 
+  /**
+   * The splitter function for SPLIT activities.
+   *
+   * @returns {((context: unknown) => unknown)|null} Splitter function or null
+   */
+  get splitter() {
+    return this.#splitter
+  }
+
+  /**
+   * The rejoiner function for SPLIT activities.
+   *
+   * @returns {((originalContext: unknown, splitResults: unknown) => unknown)|null} Rejoiner function or null
+   */
+  get rejoiner() {
+    return this.#rejoiner
+  }
+
   /**
    * The action instance this activity belongs to.
    *
@@ -94,7 +147,7 @@ export default class Activity {
    * Execute the activity with before/after hooks.
    *
    * @param {unknown} context - Mutable context flowing through the pipeline
-   * @returns {Promise<{activityResult: unknown}>} - Activity result wrapper with new context
+   * @returns {Promise<unknown>} - Activity result
    */
   async run(context) {
     // before hook
@@ -112,7 +165,7 @@ export default class Activity {
   /**
    * Attach hooks to this activity instance.
    *
-   * @param {unknown} hooks - Hooks instance with optional before$/after$ methods
+   * @param {ActionHooks} hooks - Hooks instance with optional before$/after$ methods
    * @returns {this} - This activity for chaining
    */
   setActionHooks(hooks) {
@@ -121,4 +174,13 @@ export default class Activity {
 
     return this
   }
+
+  /**
+   * Get the hooks instance attached to this activity.
+   *
+   * @returns {ActionHooks|null} The hooks instance or null
+   */
+  get hooks() {
+    return this.#hooks
+  }
 }

package/src/types/lib/ActionBuilder.d.ts

@@ -89,7 +89,7 @@ export default class ActionBuilder {
    *
    * @param {import("./ActionHooks.js").default} hooks An already-instantiated hooks instance.
    * @returns {ActionBuilder} The builder instance for chaining.
-   * @throws {Sass} If hooks have already been configured.
+   * @throws {Sass} If hooks have already been configured with a different instance.
    */
   withHooks(hooks: import('./ActionHooks.js').default): ActionBuilder
   /**