boardgameio / boardgame.io / 30201105339

100%

master: 100%

push

github

fix: preserve log metadata for game events (#1267)

* fix: preserve log metadata for game events

* docs: clarify log metadata scope

* fix: address event log metadata review feedback

* fix: preserve metadata for events without log entries

* fix: log events with no canonical entry regardless of metadata

The fallback entry for a directly dispatched game event was only created when
a hook had set log metadata, so `endGame` and `setPhase` from no active phase
appeared in the log or not depending on what a hook happened to do.

Create the entry whether or not metadata was set, and honour `game.disableLog`,
which the fallback previously bypassed. Restrict the fallback to `endGame` and
`setPhase`, the only events that run hooks without ever producing a log entry
of their own: creating it for every event without a canonical entry would log
`endTurn` and `endStage` events that the flow refused for `minMoves`.

---------

Co-authored-by: Rupesh Pandey <pandeyrupesh00@gmail.com>

2041 of 2041 branches covered (100.0%)

Branch coverage included in aggregate %.

32 of 32 new or added lines in 1 file covered. (100.0%)

2919 of 2919 relevant lines covered (100.0%)

26379.72 hits per line