feat(state): provide a way for scripts to end game (#83)

src/main.ts

@@ -3,19 +3,28 @@ import { BaseOptions, Container, Module } from 'noicejs';
 
 import { BunyanLogger } from './logger/BunyanLogger';
 import { ActorType } from './model/entity/Actor';
-import { INJECT_ACTOR, INJECT_CONFIG, INJECT_EVENT, INJECT_LOADER, INJECT_LOCALE, INJECT_PARSER, INJECT_RENDER, INJECT_STATE } from './module';
+import {
+  INJECT_ACTOR,
+  INJECT_CONFIG,
+  INJECT_EVENT,
+  INJECT_LOADER,
+  INJECT_LOCALE,
+  INJECT_RENDER,
+  INJECT_STATE,
+} from './module';
 import { ActorLocator, ActorModule } from './module/ActorModule';
 import { BrowserModule } from './module/BrowserModule';
 import { LocalModule } from './module/LocalModule';
 import { NodeModule } from './module/NodeModule';
 import { EventBus } from './service/event';
 import { LoaderService } from './service/loader';
 import { LocaleService } from './service/locale';
-import { Parser } from './service/parser';
 import { RenderService } from './service/render';
 import { StateService } from './service/state';
 import { parseArgs } from './util/args';
+import { asyncDebug, asyncTrack } from './util/async';
 import { loadConfig } from './util/config/file';
+import { onceWithRemove } from './util/event';
 
 const DI_MODULES = new Map<string, new () => Module>([
   ['browser', BrowserModule],
@@ -25,6 +34,9 @@ const DI_MODULES = new Map<string, new () => Module>([
 ]);
 
 export async function main(args: Array<string>): Promise<number> {
+  const { asyncHook, asyncOps } = asyncTrack();
+  asyncHook.enable();
+
   // parse args
   const arg = parseArgs(args);
 
@@ -100,12 +112,16 @@ export async function main(args: Array<string>): Promise<number> {
       ],
     });
 
-    // await step
+    // await output before next command
+    const { pending } = onceWithRemove(events, 'actor-output');
+    await pending;
   }
 
   await state.stop();
   await render.stop();
   await loader.stop();
 
+  // asyncDebug(asyncOps);
+
   return 0;
 }

src/module/BrowserModule.ts

@@ -5,7 +5,7 @@ import { INJECT_LOADER, INJECT_RENDER } from '.';
 import { BrowserFetchLoader } from '../service/loader/browser/FetchLoader';
 import { BrowserPageLoader } from '../service/loader/browser/PageLoader';
 import { RenderService } from '../service/render';
-import { ReactDomRender } from '../service/render/ReactDomRender';
+import { ReactDomRender } from '../service/render/react/DomRender';
 import { Singleton } from '../util/container';
 
 export class BrowserModule extends Module {

src/module/NodeModule.ts

@@ -5,7 +5,7 @@ import { INJECT_LOADER, INJECT_RENDER } from '.';
 import { NodeFetchLoader } from '../service/loader/node/FetchLoader';
 import { NodeFileLoader } from '../service/loader/node/FileLoader';
 import { RenderService } from '../service/render';
-import { InkRender } from '../service/render/InkRender';
+import { InkRender } from '../service/render/react/InkRender';
 import { LineRender } from '../service/render/LineRender';
 import { Singleton } from '../util/container';
 

src/script/common/ActorStep.ts

@@ -35,6 +35,7 @@ export async function ActorStep(this: ScriptTarget, context: ScriptContext, verb
   if (health <= 0) {
     if (this.actorType === ActorType.PLAYER) {
       await context.focus.show('actor.step.command.dead', { actor: this });
+      await context.focus.quit();
     }
     return;
   }

src/service/event/index.ts

@@ -22,10 +22,17 @@ export interface RoomEvent {
 }
 
 export interface OutputEvent {
+  /**
+   * The lines of output.
+   */
   lines: Array<{
     context?: LocaleContext;
     key: string;
   }>;
+
+  /**
+   * The state step from which this output was emitted.
+   */
   step: StepResult;
 }
 

src/service/render/LineRender.ts

@@ -10,7 +10,7 @@ import { onceWithRemove } from '../../util/event';
 import { EventBus, LineEvent, RoomEvent } from '../event';
 import { LocaleService } from '../locale';
 import { StepResult } from '../state';
-import { BaseRenderOptions } from './BaseReactRender';
+import { BaseRenderOptions } from './react/BaseRender';
 
 @Inject(/* all from base */)
 export class LineRender implements RenderService {

src/service/render/BaseReactRender.ts → src/service/render/react/BaseRender.ts

@@ -1,13 +1,13 @@
 import { constructorName, InvalidArgumentError, mustExist } from '@apextoaster/js-utils';
 import { BaseOptions, Inject, Logger } from 'noicejs';
 
-import { RenderService } from '.';
-import { INJECT_EVENT, INJECT_LOCALE, INJECT_LOGGER } from '../../module';
-import { onceWithRemove } from '../../util/event';
-import { debounce } from '../../util/event/Debounce';
-import { EventBus, LineEvent, OutputEvent, RoomEvent } from '../event';
-import { LocaleService } from '../locale';
-import { StepResult } from '../state';
+import { RenderService } from '..';
+import { INJECT_EVENT, INJECT_LOCALE, INJECT_LOGGER } from '../../../module';
+import { onceWithRemove } from '../../../util/event';
+import { debounce } from '../../../util/event/Debounce';
+import { EventBus, LineEvent, OutputEvent, RoomEvent } from '../../event';
+import { LocaleService } from '../../locale';
+import { StepResult } from '../../state';
 
 export interface BaseRenderOptions extends BaseOptions {
   [INJECT_EVENT]?: EventBus;
@@ -48,7 +48,16 @@ export abstract class BaseReactRender implements RenderService {
     };
   }
 
-  public abstract start(): Promise<void>;
+  public async start(): Promise<void> {
+    this.renderRoot();
+    this.prompt(`turn ${this.step.turn}`);
+
+    this.event.on('actor-output', (output) => this.onOutput(output));
+    this.event.on('state-room', (room) => this.onRoom(room));
+    this.event.on('state-step', (step) => this.onStep(step));
+    this.event.on('quit', () => this.onQuit());
+  }
+
   public abstract stop(): Promise<void>;
   protected abstract renderRoot(): void;
 
@@ -87,6 +96,7 @@ export abstract class BaseReactRender implements RenderService {
   public onQuit(): void {
     this.logger.debug('handling quit event from state');
     this.output.push('game over');
+    this.renderRoot();
   }
 
   /**

src/service/render/ReactDomRender.ts → src/service/render/react/DomRender.ts

@@ -3,9 +3,9 @@ import { Inject } from 'noicejs';
 import * as React from 'react';
 import { render, unmountComponentAtNode } from 'react-dom';
 
-import { RenderService } from '.';
-import { Frame } from '../../component/react/Frame';
-import { BaseReactRender } from './BaseReactRender';
+import { RenderService } from '..';
+import { Frame } from '../../../component/react/Frame';
+import { BaseReactRender } from './BaseRender';
 
 /**
  * Interface with React tree using an event emitter.
@@ -15,13 +15,7 @@ export class ReactDomRender extends BaseReactRender implements RenderService {
   public async start(): Promise<void> {
     this.logger.debug('starting React render');
 
-    this.renderRoot();
-    this.prompt(`turn ${this.step.turn}`);
-
-    this.event.on('actor-output', (output) => this.onOutput(output));
-    this.event.on('state-room', (room) => this.onRoom(room));
-    this.event.on('state-step', (step) => this.onStep(step));
-    this.event.on('quit', () => this.onQuit());
+    await super.start();
   }
 
   public async stop(): Promise<void> {

src/service/render/InkRender.ts → src/service/render/react/InkRender.ts

@@ -3,9 +3,9 @@ import { Instance as InkInstance, render } from 'ink';
 import { Inject } from 'noicejs';
 import * as React from 'react';
 
-import { RenderService } from '.';
-import { Frame } from '../../component/ink/Frame';
-import { BaseReactRender } from './BaseReactRender';
+import { RenderService } from '..';
+import { Frame } from '../../../component/ink/Frame';
+import { BaseReactRender } from './BaseRender';
 
 /**
  * Interface with Ink's React tree using an event emitter.
@@ -17,13 +17,7 @@ export class InkRender extends BaseReactRender implements RenderService {
   public async start(): Promise<void> {
     this.logger.debug('starting Ink render');
 
-    this.renderRoot();
-    this.prompt(`turn ${this.step.turn}`);
-
-    this.event.on('actor-output', (output) => this.onOutput(output));
-    this.event.on('state-room', (room) => this.onRoom(room));
-    this.event.on('state-step', (step) => this.onStep(step));
-    this.event.on('quit', () => this.onQuit());
+    await super.start();
   }
 
   public async stop(): Promise<void> {

src/service/state/TurnState.ts

@@ -261,12 +261,12 @@ export class LocalStateService implements StateService {
       case META_LOAD:
         await this.doLoad(cmd.target, cmd.index);
         break;
+      case META_QUIT:
+        await this.doQuit();
+        break;
       case META_SAVE:
         await this.doSave(cmd.target);
         break;
-      case META_QUIT:
-        this.event.emit('quit');
-        break;
       default: {
         // step world
         const result = await this.step();
@@ -342,6 +342,10 @@ export class LocalStateService implements StateService {
     });
   }
 
+  public async doQuit(): Promise<void> {
+    this.event.emit('quit');
+  }
+
   public async doSave(path: string): Promise<void> {
     const state = mustExist(this.state);
     const world = mustFind(this.worlds, (it) => it.meta.id === state.meta.id);
@@ -460,8 +464,9 @@ export class LocalStateService implements StateService {
     this.focus = await this.container.create(StateFocusResolver, {
       events: {
         onActor: () => Promise.resolve(),
-        onRoom: async (room) => this.onRoom(room),
-        onShow: async (line, context) => this.onOutput(line, context),
+        onQuit: () => this.doQuit(),
+        onRoom: (room) => this.onRoom(room),
+        onShow: (line, context) => this.onOutput(line, context),
       },
     });
 

src/util/state/FocusResolver.ts

@@ -10,10 +10,12 @@ import { LocaleContext } from '../../service/locale';
 
 export type FocusChangeRoom = (room: Room) => Promise<void>;
 export type FocusChangeActor = (actor: Actor) => Promise<void>;
+export type FocusQuit = () => Promise<void>;
 export type FocusShow = (line: string, context?: LocaleContext) => Promise<void>;
 
-interface FocusEvents {
+export interface FocusEvents {
   onActor: FocusChangeActor;
+  onQuit: FocusQuit;
   onRoom: FocusChangeRoom;
   onShow: FocusShow;
 }
@@ -39,6 +41,7 @@ interface StateFocusResolverOptions extends BaseOptions {
  */
 export class StateFocusResolver {
   protected onActor: FocusChangeActor;
+  protected onQuit: FocusQuit;
   protected onRoom: FocusChangeRoom;
   protected onShow: FocusShow;
 
@@ -47,6 +50,7 @@ export class StateFocusResolver {
   constructor(options: StateFocusResolverOptions) {
     const events = mustExist(options.events);
     this.onActor = events.onActor;
+    this.onQuit = events.onQuit;
     this.onRoom = events.onRoom;
     this.onShow = events.onShow;
   }
@@ -97,6 +101,10 @@ export class StateFocusResolver {
     }
   }
 
+  public async quit(): Promise<void> {
+    await this.onQuit();
+  }
+
   /**
    * Display a message from an entity.
    */

test/helper.ts

@@ -1,7 +1,9 @@
 import { Container, LogLevel, Module, NullLogger } from 'noicejs';
+import { stub } from 'sinon';
 
 import { ConfigFile } from '../src/model/file/Config';
 import { INJECT_CONFIG, INJECT_LOGGER } from '../src/module';
+import { FocusEvents } from '../src/util/state/FocusResolver';
 
 export function getTestLogger() {
   // TODO: return console/bunyan logger if TEST_LOGGER=that
@@ -36,3 +38,12 @@ export async function getTestContainer(...modules: Array<Module>): Promise<Conta
 
   return container;
 }
+
+export function getStubEvents(): FocusEvents {
+  return {
+    onActor: stub(),
+    onQuit: stub(),
+    onRoom: stub(),
+    onShow: stub(),
+  };
+}

test/service/script/TestLocalScript.ts

@@ -9,6 +9,7 @@ import { MathRandomGenerator } from '../../../src/service/random/MathRandom';
 import { LocalScriptService } from '../../../src/service/script/LocalScript';
 import { StateEntityTransfer } from '../../../src/util/state/EntityTransfer';
 import { StateFocusResolver } from '../../../src/util/state/FocusResolver';
+import { getStubEvents } from '../../helper';
 
 const TEST_STATE: State = {
   focus: {
@@ -61,11 +62,7 @@ describe('local script service', () => {
     await script.invoke(target, 'foo', {
       data: new Map(),
       focus: await container.create(StateFocusResolver, {
-        events: {
-          onActor: async () => { },
-          onRoom: async () => { },
-          onShow: async () => { },
-        },
+        events: getStubEvents(),
         state: TEST_STATE,
       }),
       random: await container.create(MathRandomGenerator),
@@ -99,11 +96,7 @@ describe('local script service', () => {
     await script.invoke(target, 'foo', {
       data: new Map(),
       focus: await container.create(StateFocusResolver, {
-        events: {
-          onActor: async () => { },
-          onRoom: async () => { },
-          onShow: async () => { },
-        },
+        events: getStubEvents(),
         state: TEST_STATE,
       }),
       random: await container.create(MathRandomGenerator),
@@ -140,11 +133,7 @@ describe('local script service', () => {
     await script.invoke(target, 'foo', {
       data: new Map(),
       focus: await container.create(StateFocusResolver, {
-        events: {
-          onActor: async () => { },
-          onRoom: async () => { },
-          onShow: async () => { },
-        },
+        events: getStubEvents(),
         state: TEST_STATE,
       }),
       random: await container.create(MathRandomGenerator),