chore: clean up among them roster checks

Author: relh

.github/workflows/among-them.yml

@@ -0,0 +1,70 @@
+name: Among Them
+
+on:
+  pull_request:
+    paths:
+      - ".github/workflows/among-them.yml"
+      - "among_them/**"
+      - "bitworld.nimble"
+      - "clients/global_client.nim"
+      - "common/**"
+      - "config.nims"
+      - "nim.cfg"
+      - "nimby.lock"
+      - "src/**"
+  push:
+    branches:
+      - master
+    paths:
+      - ".github/workflows/among-them.yml"
+      - "among_them/**"
+      - "bitworld.nimble"
+      - "clients/global_client.nim"
+      - "common/**"
+      - "config.nims"
+      - "nim.cfg"
+      - "nimby.lock"
+      - "src/**"
+
+jobs:
+  roster-tests:
+    name: Roster Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: jiro4989/setup-nim-action@v2
+        with:
+          nim-version: "2.2.4"
+
+      - name: Install Nim dependencies
+        run: nimble install -y --depsOnly
+
+      - name: Run slot tests
+        run: nim c --nimcache:/tmp/bitworld-ci-test-slots -r among_them/tests/test_slots.nim
+
+      - name: Run stats tests
+        run: nim c --nimcache:/tmp/bitworld-ci-test-stats -r among_them/tests/test_stats.nim
+
+      - name: Run start-wait tests
+        run: nim c --nimcache:/tmp/bitworld-ci-test-start-wait -r among_them/tests/test_start_wait.nim
+
+  wasm-replay-viewer:
+    name: Wasm Replay Viewer
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: jiro4989/setup-nim-action@v2
+        with:
+          nim-version: "2.2.4"
+
+      - uses: mymindstorm/setup-emsdk@v14
+
+      - name: Install Nim dependencies
+        run: nimble install -y --depsOnly
+
+      - name: Compile replay viewer
+        run: nim c -d:emscripten --nimcache:/tmp/bitworld-ci-replay-viewer among_them/replay_viewer.nim

among_them/sim.nim

@@ -249,6 +249,11 @@ type
     hasRole*: bool
     hasColor*: bool
 
+  SlotCredentialMatch = enum
+    SlotCredentialNone,
+    SlotCredentialValid,
+    SlotCredentialConflict
+
   GameConfig* = object
     motionScale*: int
     accel*: int
@@ -1478,6 +1483,14 @@ proc canAddPlayer*(sim: SimServer): bool =
   ## Returns whether the game has room for another player.
   sim.players.len < sim.config.playerSlotLimit()
 
+proc playerLimitError(config: GameConfig): string =
+  ## Returns a user-facing message for the current player cap.
+  if config.closedRoster:
+    let limit = config.playerSlotLimit()
+    return "Configured roster is full (" & $limit &
+      (if limit == 1: " player)." else: " players).")
+  "can't do more than " & $MaxPlayers & " players."
+
 proc slotConfig(config: GameConfig, slotIndex: int): PlayerSlotConfig =
   ## Returns one slot config or an empty config for missing entries.
   if slotIndex >= 0 and slotIndex < config.slots.len:
@@ -1523,6 +1536,24 @@ proc validatePlayerSlot(
       "Player token does not match configured slot " & $slotIndex & "."
     )
 
+proc slotCredentialMatch(
+  config: GameConfig,
+  slotIndex: int,
+  address,
+  token: string
+): SlotCredentialMatch =
+  ## Classifies whether a player identity/token pair matches one configured slot.
+  let slot = config.slotConfig(slotIndex)
+  let
+    matchedName = slot.name.len > 0 and slot.name == address
+    matchedToken = slot.token.len > 0 and token.len > 0 and slot.token == token
+  if not matchedName and not matchedToken:
+    return SlotCredentialNone
+  if config.slotAuthMatches(slotIndex, address, token):
+    SlotCredentialValid
+  else:
+    SlotCredentialConflict
+
 proc configuredPlayerName*(config: GameConfig, requestedSlot: int, token: string): string =
   ## Returns the configured identity for a tokenized slot request.
   if token.len == 0:
@@ -1544,11 +1575,7 @@ proc matchingConfiguredSlot(
 ): int =
   ## Returns a configured slot matched by name or token without occupancy checks.
   for i in 0 ..< config.slots.len:
-    let slot = config.slots[i]
-    let couldMatchName = slot.name.len > 0 and slot.name == address
-    let couldMatchToken = slot.token.len > 0 and slot.token == token
-    if (couldMatchName or couldMatchToken) and
-        config.slotAuthMatches(i, address, token):
+    if config.slotCredentialMatch(i, address, token) == SlotCredentialValid:
       return i
   -1
 
@@ -1559,12 +1586,7 @@ proc conflictingConfiguredSlot(
 ): int =
   ## Returns a configured slot matched by only one required credential.
   for i in 0 ..< config.slots.len:
-    let slot = config.slots[i]
-    let matchedName = slot.name.len > 0 and slot.name == address
-    let matchedToken =
-      slot.token.len > 0 and token.len > 0 and slot.token == token
-    if (matchedName or matchedToken) and
-        not config.slotAuthMatches(i, address, token):
+    if config.slotCredentialMatch(i, address, token) == SlotCredentialConflict:
       return i
   -1
 
@@ -1596,11 +1618,7 @@ proc matchingConfiguredSlot(
   for i in 0 ..< sim.config.slots.len:
     if sim.slotOccupied(i):
       continue
-    let slot = sim.config.slots[i]
-    let couldMatchName = slot.name.len > 0 and slot.name == address
-    let couldMatchToken = slot.token.len > 0 and slot.token == token
-    if (couldMatchName or couldMatchToken) and
-        sim.config.slotAuthMatches(i, address, token):
+    if sim.config.slotCredentialMatch(i, address, token) == SlotCredentialValid:
       return i
   -1
 
@@ -1613,12 +1631,7 @@ proc conflictingConfiguredSlot(
   for i in 0 ..< sim.config.slots.len:
     if sim.slotOccupied(i):
       continue
-    let slot = sim.config.slots[i]
-    let matchedName = slot.name.len > 0 and slot.name == address
-    let matchedToken =
-      slot.token.len > 0 and token.len > 0 and slot.token == token
-    if (matchedName or matchedToken) and
-        not sim.config.slotAuthMatches(i, address, token):
+    if sim.config.slotCredentialMatch(i, address, token) == SlotCredentialConflict:
       return i
   -1
 
@@ -1793,7 +1806,7 @@ proc addPlayer*(
 ): int =
   ## Adds one player, optionally validating and using a requested slot.
   if not sim.canAddPlayer():
-    raise newException(AmongThemError, "can't do more than 16 players.")
+    raise newException(AmongThemError, sim.config.playerLimitError())
   if sim.playerAddressOccupied(address):
     raise newException(
       AmongThemError,

among_them/tests/test_slots.nim

@@ -229,6 +229,22 @@ suite "player slots":
     expect AmongThemError:
       discard sim.addPlayer("extra")
 
+  test "closed configured roster full error names configured limit":
+    var config = defaultGameConfig()
+    config.minPlayers = 2
+    config.update("""{"tokens":["crew-token","imp-token"],"closedRoster":true}""")
+    var sim = initAmongThemForTest(config)
+
+    discard sim.addPlayer("Player1", -1, "crew-token")
+    discard sim.addPlayer("Player2", -1, "imp-token")
+
+    var errorMessage = ""
+    try:
+      discard sim.addPlayer("extra")
+    except AmongThemError as e:
+      errorMessage = e.msg
+    check errorMessage == "Configured roster is full (2 players)."
+
   test "closed configured roster rejects explicit slots outside roster":
     var config = defaultGameConfig()
     config.minPlayers = 2