@objectstack/service-automation 9.4.0 → 9.5.1

package/dist/index.d.cts

@@ -163,6 +163,24 @@ interface ConnectorDescriptor {
     readonly icon?: string;
     readonly actions: ConnectorActionDescriptor[];
 }
+/**
+ * Default ceiling on the in-memory execution-log ring buffer. Execution logs are
+ * process-local and diagnostic only (launch-readiness.md P1-2); the buffer keeps
+ * the most recent N entries and evicts the oldest, so memory is bounded
+ * regardless of throughput. Operators tune the window via
+ * {@link AutomationServicePluginOptions.maxLogSize}. Durable, queryable run
+ * history is the DB-backed `sys_automation_run` store (a post-GA HA item), not
+ * this buffer.
+ */
+declare const DEFAULT_MAX_EXECUTION_LOG_SIZE = 1000;
+/** Construction options for {@link AutomationEngine}. */
+interface AutomationEngineOptions {
+    /**
+     * Max in-memory execution-log entries retained (ring buffer; oldest evicted).
+     * Defaults to {@link DEFAULT_MAX_EXECUTION_LOG_SIZE}. Must be > 0.
+     */
+    maxLogSize?: number;
+}
 /**
  * Execution step log entry. Part of a {@link SuspendedRun}'s persisted state, so
  * it survives serialization to a durable {@link SuspendedRunStore}.
@@ -284,7 +302,7 @@ declare class AutomationEngine implements IAutomationService {
     /** Connectors registered by integration plugins, keyed by connector name (ADR-0018 §Addendum). */
     private connectors;
     private executionLogs;
-    private maxLogSize;
+    private readonly maxLogSize;
     private logger;
     /**
      * Runs paused at a node, keyed by runId (ADR-0019). In-memory hot cache —
@@ -303,7 +321,7 @@ declare class AutomationEngine implements IAutomationService {
      * duplicate `resume(runId)` can't re-enter and double-run side effects.
      */
     private resuming;
-    constructor(logger: Logger, store?: SuspendedRunStore);
+    constructor(logger: Logger, store?: SuspendedRunStore, options?: AutomationEngineOptions);
     /**
      * Attach (or replace) the durable {@link SuspendedRunStore}. Used by the
      * service plugin to upgrade the engine to DB-backed persistence once the
@@ -4909,6 +4927,13 @@ interface AutomationServicePluginOptions {
      * survives a process restart and can be resumed after a cold boot.
      */
     suspendedRunStore?: 'auto' | 'memory';
+    /**
+     * Max in-memory execution-log entries retained per process (ring buffer;
+     * oldest evicted). The buffer is diagnostic-only and already bounded
+     * (launch-readiness.md P1-2); this just makes the window tunable. Defaults
+     * to {@link DEFAULT_MAX_EXECUTION_LOG_SIZE} (1000).
+     */
+    maxLogSize?: number;
 }
 /**
  * AutomationServicePlugin — Core engine plugin
@@ -5055,4 +5080,4 @@ declare function registerConnectorNodes(engine: AutomationEngine, ctx: PluginCon
  */
 declare function installBuiltinNodes(engine: AutomationEngine, ctx: PluginContext): void;
 
-export { AutomationEngine, AutomationServicePlugin, type AutomationServicePluginOptions, type ConnectorActionContext, type ConnectorActionDescriptor, type ConnectorActionHandler, type ConnectorDescriptor, type FlowTrigger, type FlowTriggerBinding, InMemorySuspendedRunStore, type NodeExecutionResult, type NodeExecutor, ObjectStoreSuspendedRunStore, type RegisteredConnector, type StepLogEntry, type SuspendedRun, type SuspendedRunStore, type SuspendedRunStoreEngine, SysAutomationRun, installBuiltinNodes, registerConnectorNodes, registerCrudNodes, registerHttpNodes, registerLogicNodes, registerScreenNodes };
+export { AutomationEngine, type AutomationEngineOptions, AutomationServicePlugin, type AutomationServicePluginOptions, type ConnectorActionContext, type ConnectorActionDescriptor, type ConnectorActionHandler, type ConnectorDescriptor, DEFAULT_MAX_EXECUTION_LOG_SIZE, type FlowTrigger, type FlowTriggerBinding, InMemorySuspendedRunStore, type NodeExecutionResult, type NodeExecutor, ObjectStoreSuspendedRunStore, type RegisteredConnector, type StepLogEntry, type SuspendedRun, type SuspendedRunStore, type SuspendedRunStoreEngine, SysAutomationRun, installBuiltinNodes, registerConnectorNodes, registerCrudNodes, registerHttpNodes, registerLogicNodes, registerScreenNodes };

package/dist/index.d.ts

@@ -163,6 +163,24 @@ interface ConnectorDescriptor {
     readonly icon?: string;
     readonly actions: ConnectorActionDescriptor[];
 }
+/**
+ * Default ceiling on the in-memory execution-log ring buffer. Execution logs are
+ * process-local and diagnostic only (launch-readiness.md P1-2); the buffer keeps
+ * the most recent N entries and evicts the oldest, so memory is bounded
+ * regardless of throughput. Operators tune the window via
+ * {@link AutomationServicePluginOptions.maxLogSize}. Durable, queryable run
+ * history is the DB-backed `sys_automation_run` store (a post-GA HA item), not
+ * this buffer.
+ */
+declare const DEFAULT_MAX_EXECUTION_LOG_SIZE = 1000;
+/** Construction options for {@link AutomationEngine}. */
+interface AutomationEngineOptions {
+    /**
+     * Max in-memory execution-log entries retained (ring buffer; oldest evicted).
+     * Defaults to {@link DEFAULT_MAX_EXECUTION_LOG_SIZE}. Must be > 0.
+     */
+    maxLogSize?: number;
+}
 /**
  * Execution step log entry. Part of a {@link SuspendedRun}'s persisted state, so
  * it survives serialization to a durable {@link SuspendedRunStore}.
@@ -284,7 +302,7 @@ declare class AutomationEngine implements IAutomationService {
     /** Connectors registered by integration plugins, keyed by connector name (ADR-0018 §Addendum). */
     private connectors;
     private executionLogs;
-    private maxLogSize;
+    private readonly maxLogSize;
     private logger;
     /**
      * Runs paused at a node, keyed by runId (ADR-0019). In-memory hot cache —
@@ -303,7 +321,7 @@ declare class AutomationEngine implements IAutomationService {
      * duplicate `resume(runId)` can't re-enter and double-run side effects.
      */
     private resuming;
-    constructor(logger: Logger, store?: SuspendedRunStore);
+    constructor(logger: Logger, store?: SuspendedRunStore, options?: AutomationEngineOptions);
     /**
      * Attach (or replace) the durable {@link SuspendedRunStore}. Used by the
      * service plugin to upgrade the engine to DB-backed persistence once the
@@ -4909,6 +4927,13 @@ interface AutomationServicePluginOptions {
      * survives a process restart and can be resumed after a cold boot.
      */
     suspendedRunStore?: 'auto' | 'memory';
+    /**
+     * Max in-memory execution-log entries retained per process (ring buffer;
+     * oldest evicted). The buffer is diagnostic-only and already bounded
+     * (launch-readiness.md P1-2); this just makes the window tunable. Defaults
+     * to {@link DEFAULT_MAX_EXECUTION_LOG_SIZE} (1000).
+     */
+    maxLogSize?: number;
 }
 /**
  * AutomationServicePlugin — Core engine plugin
@@ -5055,4 +5080,4 @@ declare function registerConnectorNodes(engine: AutomationEngine, ctx: PluginCon
  */
 declare function installBuiltinNodes(engine: AutomationEngine, ctx: PluginContext): void;
 
-export { AutomationEngine, AutomationServicePlugin, type AutomationServicePluginOptions, type ConnectorActionContext, type ConnectorActionDescriptor, type ConnectorActionHandler, type ConnectorDescriptor, type FlowTrigger, type FlowTriggerBinding, InMemorySuspendedRunStore, type NodeExecutionResult, type NodeExecutor, ObjectStoreSuspendedRunStore, type RegisteredConnector, type StepLogEntry, type SuspendedRun, type SuspendedRunStore, type SuspendedRunStoreEngine, SysAutomationRun, installBuiltinNodes, registerConnectorNodes, registerCrudNodes, registerHttpNodes, registerLogicNodes, registerScreenNodes };
+export { AutomationEngine, type AutomationEngineOptions, AutomationServicePlugin, type AutomationServicePluginOptions, type ConnectorActionContext, type ConnectorActionDescriptor, type ConnectorActionHandler, type ConnectorDescriptor, DEFAULT_MAX_EXECUTION_LOG_SIZE, type FlowTrigger, type FlowTriggerBinding, InMemorySuspendedRunStore, type NodeExecutionResult, type NodeExecutor, ObjectStoreSuspendedRunStore, type RegisteredConnector, type StepLogEntry, type SuspendedRun, type SuspendedRunStore, type SuspendedRunStoreEngine, SysAutomationRun, installBuiltinNodes, registerConnectorNodes, registerCrudNodes, registerHttpNodes, registerLogicNodes, registerScreenNodes };

package/dist/index.js

@@ -2,6 +2,7 @@
 import { FlowSchema, FLOW_STRUCTURAL_NODE_TYPES, validateControlFlow, findRegionEntry, defineActionDescriptor } from "@objectstack/spec/automation";
 import { ConnectorSchema } from "@objectstack/spec/integration";
 import { ExpressionEngine, validateExpression } from "@objectstack/formula";
+var DEFAULT_MAX_EXECUTION_LOG_SIZE = 1e3;
 var FlowSuspendSignal = class {
   constructor(nodeId, correlation, screen) {
     this.nodeId = nodeId;
@@ -14,7 +15,7 @@ function isSuspendSignal(err) {
   return typeof err === "object" && err !== null && err.__flowSuspend === true;
 }
 var _AutomationEngine = class _AutomationEngine {
-  constructor(logger, store) {
+  constructor(logger, store, options) {
     this.flows = /* @__PURE__ */ new Map();
     this.flowEnabled = /* @__PURE__ */ new Map();
     this.flowVersionHistory = /* @__PURE__ */ new Map();
@@ -30,7 +31,6 @@ var _AutomationEngine = class _AutomationEngine {
     /** Connectors registered by integration plugins, keyed by connector name (ADR-0018 §Addendum). */
     this.connectors = /* @__PURE__ */ new Map();
     this.executionLogs = [];
-    this.maxLogSize = 1e3;
     /**
      * Runs paused at a node, keyed by runId (ADR-0019). In-memory hot cache —
      * mirrored to {@link store} when one is configured, so a pause survives a
@@ -44,6 +44,7 @@ var _AutomationEngine = class _AutomationEngine {
     this.resuming = /* @__PURE__ */ new Set();
     this.logger = logger;
     this.store = store;
+    this.maxLogSize = options?.maxLogSize ?? DEFAULT_MAX_EXECUTION_LOG_SIZE;
   }
   /**
    * Attach (or replace) the durable {@link SuspendedRunStore}. Used by the
@@ -2970,7 +2971,9 @@ var AutomationServicePlugin = class {
     this.options = options;
   }
   async init(ctx) {
-    this.engine = new AutomationEngine(ctx.logger);
+    this.engine = new AutomationEngine(ctx.logger, void 0, {
+      maxLogSize: this.options.maxLogSize
+    });
     ctx.registerService("automation", this.engine);
     if ((this.options.suspendedRunStore ?? "auto") !== "memory") {
       try {
@@ -3080,6 +3083,7 @@ var AutomationServicePlugin = class {
 export {
   AutomationEngine,
   AutomationServicePlugin,
+  DEFAULT_MAX_EXECUTION_LOG_SIZE,
   InMemorySuspendedRunStore,
   ObjectStoreSuspendedRunStore,
   SysAutomationRun,