fix: Allow plugins to use events in fnWrap

Allow custom plugins to call events in their `fnWrap` method. Care needs taking here as `fnWrap` may be run multiple times for hooks etc.

This also stops processing the event dispatch queue once the game is over to protect against `endGame` infinite loops (via `onEnd` hooks).

Author: delucis

src/plugins/events/events.ts

@@ -149,6 +149,9 @@ export class Events {
         return stateWithError(event.error, Errors.CalledOutsideHook);
       }
 
+      // Stop processing events once the game has finished.
+      if (state.ctx.gameover) break EventQueue;
+
       switch (event.type) {
         case 'endStage':
         case 'setStage':

src/plugins/main.test.ts

@@ -9,6 +9,7 @@
 import { Client } from '../client/client';
 import { Local } from '../client/transport/local';
 import type { Game } from '../types';
+import { GameMethod } from '../../packages/core';
 
 describe('basic', () => {
   let client: ReturnType<typeof Client>;
@@ -358,3 +359,42 @@ describe('plugins are accessible in events triggered from moves', () => {
     });
   });
 });
+
+describe('plugins can use events in fnWrap', () => {
+  const game: Game = {
+    plugins: [
+      {
+        name: 'test',
+        fnWrap:
+          (fn, type) =>
+          (G, ctx, ...args) => {
+            G = fn(G, ctx, ...args);
+            if (G.endTurn && type === GameMethod.MOVE) {
+              ctx.events.endTurn();
+            }
+            if (G.endGame) {
+              ctx.events.endGame(G.endGame);
+            }
+            return G;
+          },
+      },
+    ],
+    moves: {
+      endGame: () => ({ endGame: true }),
+      endTurn: () => ({ endTurn: true }),
+    },
+  };
+
+  test('plugin can end turn', () => {
+    const client = Client({ game });
+    client.moves.endTurn();
+    expect(client.getState().ctx.turn).toBe(2);
+    expect(client.getState().ctx.currentPlayer).toBe('1');
+  });
+
+  test('plugin can end game', () => {
+    const client = Client({ game });
+    client.moves.endGame();
+    expect(client.getState().ctx.gameover).toBe(true);
+  });
+});

src/plugins/main.ts

@@ -102,7 +102,7 @@ export const FnWrap = (
   methodType: GameMethod,
   plugins: Plugin[]
 ) => {
-  return [...DEFAULT_PLUGINS, ...plugins]
+  return [...CORE_PLUGINS, ...plugins, PluginEvents]
     .filter((plugin) => plugin.fnWrap !== undefined)
     .reduce(
       (method: AnyFn, { fnWrap }: Plugin) => fnWrap(method, methodType),