cascade endPhase

Subsequent phases are also automatically ended if `endPhaseIf` returns true when a single `endPhase` is triggered (either manually or through `endPhaseIf`).

Author: darthfiddler

src/core/flow.js

@@ -239,12 +239,12 @@ export function FlowWithPhases({
    * The next phase is chosen in a round-robin fashion, with the
    * option to override that by passing nextPhase.
    */
-  function endPhaseEvent(state, nextPhase) {
+  function endPhaseEvent(state, nextPhase, cascadeDepth) {
     let G = state.G;
     let ctx = state.ctx;
 
     // Run any cleanup code for the phase that is about to end.
-    const conf = phaseMap[ctx.phase];
+    let conf = phaseMap[ctx.phase];
     G = conf.onPhaseEnd(G, ctx);
 
     const gameover = conf.endGameIf(G, ctx);
@@ -263,7 +263,21 @@ export function FlowWithPhases({
     }
 
     // Run any setup code for the new phase.
-    return startPhase({ ...state, G, ctx }, phaseMap[ctx.phase]);
+    state = startPhase({ ...state, G, ctx }, phaseMap[ctx.phase]);
+
+    // End the new phase automatically if necessary.
+    // In order to avoid infinite loops, this is called
+    // a finite number of times.
+    if (!cascadeDepth) cascadeDepth = 0;
+    if (cascadeDepth < phases.length - 1) {
+      conf = phaseMap[state.ctx.phase];
+      const end = conf.endPhaseIf(state.G, state.ctx);
+      if (end) {
+        state = endPhaseEvent(state, end, cascadeDepth + 1);
+      }
+    }
+
+    return state;
   }
 
   /**

src/core/flow.test.js

@@ -207,10 +207,10 @@ test('onPhaseBegin / onPhaseEnd', () => {
 
 test('endPhaseIf', () => {
   const flow = FlowWithPhases({
-    phases: [{ name: 'A', endPhaseIf: G => G.end }, { name: 'B' }],
+    phases: [{ name: 'A', endPhaseIf: () => true }, { name: 'B' }],
   });
 
-  let state = { G: { end: true }, ctx: flow.ctx(2) };
+  const state = { ctx: flow.ctx(2) };
 
   {
     const t = flow.processGameEvent(state, { type: 'endPhase' });
@@ -226,6 +226,21 @@ test('endPhaseIf', () => {
     const t = flow.processMove(state, { type: 'move' });
     expect(t.ctx.phase).toBe('B');
   }
+
+  {
+    const endPhaseIf = () => true;
+    const flow = FlowWithPhases({
+      phases: [
+        { name: 'A', endPhaseIf },
+        { name: 'B', endPhaseIf },
+        { name: 'C', endPhaseIf },
+      ],
+    });
+
+    const state = { ctx: flow.ctx(2) };
+    const t = flow.processGameEvent(state, { type: 'endPhase' });
+    expect(t.ctx.phase).toBe('A');
+  }
 });
 
 test('endGameIf', () => {