feat(runner): add events for actions and status

src/domain/Service.ts

@@ -1,10 +1,12 @@
 import { Logger } from 'winston'
+import { EventEmitter } from 'node:events'
 
-export default abstract class Service {
+export default abstract class Service extends EventEmitter {
  protected name: string
  protected logger: Logger
 
  protected constructor(name: string, logger: Logger) {
+ super()
  this.name = name
  this.logger = logger.child({ service: name })
  }

src/index.ts

@@ -1 +1,4 @@
 export { default as Agent } from './Agent'
+
+export { default as Runner } from './services/runner'
+export { default as ActionReport } from './services/runner/domain/ActionReport'

src/services/runner/Runner.ts

@@ -13,7 +13,13 @@ import { ErrorResult } from './domain/ErrorResult'
 import ParsedResult from '../mind/domain/ParsedResult'
 import CycleResult from './domain/CycleResult'
 import { Logger } from 'winston'
+import ActionReport from './domain/ActionReport'
+import RunnerStatus from './domain/RunnerStatus'
 
+/**
+ * The Runner class provides a high-level interface for interacting with runners.
+ * @public
+ */
 export default class Runner extends Service {
  constructor(
  public readonly page: PageWrapper,
@@ -32,9 +38,20 @@ export default class Runner extends Service {
  }
  private readonly actions: Action[] = []
 
+ private _status: RunnerStatus = RunnerStatus.Starting
+ public get status(): RunnerStatus {
+ return this._status
+ }
+ public set status(value: RunnerStatus) {
+ this._status = value
+ this.emit('status', value)
+ }
+
  public async run(): Promise<TaskResult> {
  this.logger.debug(`Starting task: ${this.task}`)
 
+ this.status = RunnerStatus.Running
+
  while (
  this.cycles.total < config.cycles.max &&
  this.cycles.failed < config.cycles.failed
@@ -50,6 +67,11 @@ export default class Runner extends Service {
  this.logger.debug(`Cycle ${this.cycles.total} completed`)
 
  if (action.type === ActionType.Done) {
+ this.status =
+ action.arguments.status === 'success'
+ ? RunnerStatus.Done
+ : RunnerStatus.Failed
+
  return {
  success: action.arguments.status === 'success',
  message: action.arguments.reason as string,
@@ -61,6 +83,8 @@ export default class Runner extends Service {
  if (config.delay) await this.sleep(config.delay)
  }
 
+ this.status = RunnerStatus.Failed
+
  if (this.cycles.failed >= config.cycles.failed) {
  return {
  success: false,
@@ -137,11 +161,15 @@ export default class Runner extends Service {
  result.action.status = status
  this.actions.push(result.action)
 
- this.logger.info('Performed action', {
+ const report: ActionReport = {
  action: result.action,
  reasoning: result.reasoning,
  duration: Date.now() - startedAt,
- })
+ }
+
+ this.logger.info('Performed action', report)
+
+ this.emit('action', report)
 
  return {
  success: true,

src/services/runner/domain/ActionReport.ts

@@ -0,0 +1,12 @@
+import Action from './Action'
+
+/**
+ * Represents a report of an action execution.
+ * @public
+ */
+export type ActionReport = {
+ action: Action
+ reasoning?: string
+ duration: number
+}
+export default ActionReport

src/services/runner/domain/RunnerStatus.ts

@@ -0,0 +1,7 @@
+export enum RunnerStatus {
+ Starting = 'Starting',
+ Running = 'Running',
+ Done = 'Done',
+ Failed = 'Failed',
+}
+export default RunnerStatus