screeps-connectivity 0.2.1 → 0.2.3

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 0.2.3
+
+### Patch Changes
+
+- b14a86d: Fix foreign creep badge and username display in observed rooms.
+
+  When observing a room from another player, newly spawned creeps weren't showing
+  the owner's badge and displayed player ID instead of username. Fixed by:
+
+  - Merging user data across ticks instead of replacing, preserving player info
+  - Adding `badge?: Badge` to the users type throughout the codebase
+  - Adding `refreshForeignCreepBadges()` to update creep visuals when badge data arrives
+
+## 0.2.2
+
+### Patch Changes
+
+- a42c89c: Guard against null or missing `objects` field in room update messages, and catch listener errors in `SocketClient.emit` so a bad listener cannot trigger a fatal socket error and kick the user out.
+
 ## 0.2.1
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screeps-connectivity",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "license": "ISC",
   "type": "module",
   "repository": {

package/src/socket/SocketClient.ts

@@ -87,7 +87,8 @@ export class SocketClient {
       }
       this.ws.onmessage = (event) => {
         this.handleMessage(event).catch(err => {
-          this.logger.log('message parse error', err)
+          const raw = typeof event.data === 'string' ? event.data.slice(0, 200) : '(binary)'
+          this.logger.log('message parse error', err instanceof Error ? err.stack ?? err.message : String(err), 'raw:', raw)
           this.emit('socket:error', err instanceof Error ? err : new Error(String(err)))
         })
       }
@@ -157,7 +158,16 @@ export class SocketClient {
   }
 
   private emit(channel: string, data: unknown): void {
-    this.listeners.get(channel)?.forEach(cb => cb(data))
+    this.listeners.get(channel)?.forEach(cb => {
+      try {
+        cb(data)
+      } catch (err) {
+        // A listener error on one channel must not prevent other listeners from
+        // running, and must not be rethrown into handleMessage's .catch() where
+        // it would be treated as a fatal socket error and kick the user out.
+        this.logger.log('listener error on channel', channel, err instanceof Error ? err.stack ?? err.message : String(err))
+      }
+    })
   }
 
   private async handleMessage(event: MessageEvent): Promise<void> {

package/src/stores/RoomStore.ts

@@ -2,7 +2,7 @@ import { TypedStore } from './TypedStore.js'
 import { RoomTerrain } from '../types/game.js'
 import type { Logger } from '../logger.js'
 import type { RoomStoreEvents } from '../types/events.js'
-import type { RoomObject, RoomObjectMap, RoomObjectDiff } from '../types/game.js'
+import type { Badge, RoomObject, RoomObjectMap, RoomObjectDiff } from '../types/game.js'
 import type { HttpClient } from '../http/HttpClient.js'
 import type { SocketClient } from '../socket/SocketClient.js'
 import type { Cache } from '../cache/Cache.js'
@@ -13,7 +13,7 @@ export class RoomStore extends TypedStore<RoomStoreEvents> {
   private readonly socket: SocketClient
   private readonly cache: Cache
   private readonly roomObjects = new Map<string, RoomObjectMap>()
-  private readonly roomUsers = new Map<string, Record<string, { _id: string; username: string }>>()
+  private readonly roomUsers = new Map<string, Record<string, { _id: string; username: string; badge?: Badge }>>()
   private readonly roomSubCount = new Map<string, number>()
   private readonly lastFlagsString = new Map<string, string>()
 
@@ -175,21 +175,30 @@ export class RoomStore extends TypedStore<RoomStoreEvents> {
     })
 
     const listenerSub = this.socket.on(channel, (data) => {
-      const update = data as { objects: RoomObjectDiff; gameTime?: number; visual?: string; flags?: string; users?: Record<string, { _id: string; username: string }> }
+      const update = data as { objects?: RoomObjectDiff | null; gameTime?: number; visual?: string; flags?: string; users?: Record<string, { _id: string; username: string; badge?: Badge }> }
       const current: RoomObjectMap = { ...(this.roomObjects.get(mapKey) ?? {}) }
 
-      for (const [id, obj] of Object.entries(update.objects)) {
-        if (obj === null) {
-          delete current[id]
-        } else if (current[id]) {
-          current[id] = { ...current[id], ...obj } as RoomObject
-        } else {
-          current[id] = obj as RoomObject
+      if (update.objects == null) {
+        // Some server implementations send tick messages without an objects field
+        // (e.g. heartbeat/visual-only ticks). Log it so it is visible in debug
+        // output but do not crash — we still process gameTime, visual and flags.
+        if (update.objects === null) {
+          this.logger.log('room update has null objects field', room, shard, `gameTime: ${update.gameTime}`)
+        }
+      } else {
+        for (const [id, obj] of Object.entries(update.objects)) {
+          if (obj === null) {
+            delete current[id]
+          } else if (current[id]) {
+            current[id] = { ...current[id], ...obj } as RoomObject
+          } else {
+            current[id] = obj as RoomObject
+          }
         }
       }
 
       // Build diff that includes flags so ObjectLayer can incremental-update them
-      const diff: RoomObjectDiff = { ...update.objects }
+      const diff: RoomObjectDiff = { ...(update.objects ?? {}) }
 
       // Parse and inject flags from the dedicated flags field — only when the
       // server-sent flag string actually changed. The flags field is included
@@ -236,7 +245,8 @@ export class RoomStore extends TypedStore<RoomStoreEvents> {
       }
 
       if (update.users) {
-        this.roomUsers.set(mapKey, update.users)
+        const existing = this.roomUsers.get(mapKey) ?? {}
+        this.roomUsers.set(mapKey, { ...existing, ...update.users })
       }
       this.roomObjects.set(mapKey, current)
       const users = this.roomUsers.get(mapKey)
@@ -252,6 +262,7 @@ export class RoomStore extends TypedStore<RoomStoreEvents> {
         if (remaining <= 0) {
           this.roomSubCount.delete(mapKey)
           this.roomObjects.delete(mapKey)
+          this.roomUsers.delete(mapKey)
           this.lastFlagsString.delete(mapKey)
           this.logger.log('unsubscribe', room, shard, '(last ref)', 'active:', this.activeRooms())
         } else {

package/src/types/events.ts

@@ -1,4 +1,5 @@
 import type {
+    Badge,
     ConsoleMessage,
     CpuStats,
     RoomMap2Data,
@@ -20,7 +21,7 @@ export interface RoomStoreEvents {
         objects: RoomObjectMap;
         diff: RoomObjectDiff;
         visual: string;
-        users?: Record<string, { _id: string; username: string }>
+        users?: Record<string, { _id: string; username: string; badge?: Badge }>
     }
     'room:terrainavailable': { room: string; shard: string | null; terrain: RoomTerrain }
     'room:error': { room: string; shard: string | null; message: string }