agent-messenger 2.26.0 → 2.27.1

package/src/platforms/discord/listener.test.ts

@@ -107,11 +107,40 @@ function createMockClient(overrides: Record<string, any> = {}) {
   } as any
 }
 
+// start() now resolves only once the gateway emits READY, so the handshake must be
+// driven concurrently while start() is pending. This waits for connect() to create the
+// socket (after the awaited gatewayConnect microtask) before the caller drives it.
+async function waitForSocket(): Promise<MockWs> {
+  for (let i = 0; i < 50 && !mockWsInstance; i++) {
+    await Promise.resolve()
+  }
+  return mockWsInstance
+}
+
+async function startAndReady(listener: DiscordListener): Promise<void> {
+  const started = listener.start()
+  const ws = await waitForSocket()
+  ws.simulateOpen()
+  ws.simulateHello()
+  ws.simulateReady()
+  await started
+}
+
+// For tests that exercise pre-READY behavior (Identify/heartbeat/close paths): start() stays
+// pending here. The start promise's rejection is swallowed; afterEach stop() clears its timer.
+async function startConnecting(listener: DiscordListener): Promise<MockWs> {
+  listener.start().catch(() => {})
+  const ws = await waitForSocket()
+  ws.simulateOpen()
+  return ws
+}
+
 describe('DiscordListener', () => {
   let listener: DiscordListener
 
   afterEach(() => {
     listener?.stop()
+    mockWsInstance = undefined as unknown as MockWs
   })
 
   describe('start', () => {
@@ -119,21 +148,75 @@ describe('DiscordListener', () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
+      await startAndReady(listener)
 
       expect(client.gatewayConnect).toHaveBeenCalledTimes(1)
     })
 
+    it('does not resolve until a READY dispatch is delivered', async () => {
+      const client = createMockClient()
+      listener = new DiscordListener(client)
+
+      let resolved = false
+      const started = listener.start().then(() => {
+        resolved = true
+      })
+
+      const ws = await waitForSocket()
+      ws.simulateOpen()
+      ws.simulateHello()
+
+      // given: socket open + Hello (Identify sent) but no READY yet
+      await Promise.resolve()
+      expect(resolved).toBe(false)
+
+      // when: READY arrives
+      ws.simulateReady()
+      await started
+
+      expect(resolved).toBe(true)
+    })
+
     it('is idempotent', async () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
+      await startAndReady(listener)
       await listener.start()
 
       expect(client.gatewayConnect).toHaveBeenCalledTimes(1)
     })
+
+    it('shares one readiness promise across concurrent start() calls', async () => {
+      const client = createMockClient()
+      listener = new DiscordListener(client)
+
+      const first = listener.start()
+      const second = listener.start()
+
+      const ws = await waitForSocket()
+      ws.simulateOpen()
+      ws.simulateHello()
+      ws.simulateReady()
+
+      await Promise.all([first, second])
+      expect(client.gatewayConnect).toHaveBeenCalledTimes(1)
+    })
+
+    it('rejects an in-flight start() when stop() is called before READY', async () => {
+      const client = createMockClient()
+      listener = new DiscordListener(client)
+
+      const started = listener.start()
+      const ws = await waitForSocket()
+      ws.simulateOpen()
+      ws.simulateHello()
+
+      // given: start() is still awaiting READY when the consumer stops the listener
+      listener.stop()
+
+      await expect(started).rejects.toThrow(/stopped before becoming ready/)
+    })
   })
 
   describe('connected event', () => {
@@ -144,10 +227,7 @@ describe('DiscordListener', () => {
       const connected: any[] = []
       listener.on('connected', (info) => connected.push(info))
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
 
       expect(connected.length).toBe(1)
       expect(connected[0].user.id).toBe('U_SELF')
@@ -160,9 +240,8 @@ describe('DiscordListener', () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
+      const ws = await startConnecting(listener)
+      ws.simulateHello()
 
       const sentMessages = mockWsInstance.sent.map((s) => JSON.parse(s))
       const identifyMsg = sentMessages.find((m) => m.op === 2)
@@ -171,20 +250,27 @@ describe('DiscordListener', () => {
       expect(identifyMsg.d.token).toBe('fake-token')
     })
 
-    it('sends Identify with custom intents', async () => {
+    it('sends a user-account Identify with the load-bearing default shape', async () => {
       const client = createMockClient()
-      const customIntents = 1 << 9
-      listener = new DiscordListener(client, { intents: customIntents })
+      listener = new DiscordListener(client)
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
+      const ws = await startConnecting(listener)
+      ws.simulateHello()
 
       const sentMessages = mockWsInstance.sent.map((s) => JSON.parse(s))
       const identifyMsg = sentMessages.find((m) => m.op === 2)
 
       expect(identifyMsg).toBeDefined()
-      expect(identifyMsg.d.intents).toBe(customIntents)
+      expect(identifyMsg.d.capabilities).toBe(16381)
+      expect(identifyMsg.d.client_state).toEqual({ guild_versions: {} })
+      expect(identifyMsg.d.compress).toBe(false)
+      expect(identifyMsg.d.presence).toEqual({ status: 'online', since: 0, activities: [], afk: false })
+      expect(identifyMsg.d.properties.browser).toBe('Chrome')
+      expect(identifyMsg.d.properties.client_build_number).toBe(648814)
+
+      // All intents incl. MESSAGE_CONTENT (1<<15); user sessions blank other users' content without it
+      expect(identifyMsg.d.intents).toBe(33_554_431)
+      expect(identifyMsg.d.intents & (1 << 15)).toBe(1 << 15)
     })
   })
 
@@ -196,10 +282,7 @@ describe('DiscordListener', () => {
       const messages: DiscordGatewayMessageCreateEvent[] = []
       listener.on('message_create', (event) => messages.push(event))
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
       mockWsInstance.simulateDispatch(
         'MESSAGE_CREATE',
         {
@@ -224,10 +307,7 @@ describe('DiscordListener', () => {
       const updates: DiscordGatewayMessageUpdateEvent[] = []
       listener.on('message_update', (event) => updates.push(event))
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
       mockWsInstance.simulateDispatch(
         'MESSAGE_UPDATE',
         { id: 'msg_1', channel_id: 'C123', content: 'edited', edited_timestamp: '2024-01-01T00:01:00Z' },
@@ -246,10 +326,7 @@ describe('DiscordListener', () => {
       const deletes: DiscordGatewayMessageDeleteEvent[] = []
       listener.on('message_delete', (event) => deletes.push(event))
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
       mockWsInstance.simulateDispatch('MESSAGE_DELETE', { id: 'msg_1', channel_id: 'C123' }, 2)
 
       expect(deletes.length).toBe(1)
@@ -265,10 +342,7 @@ describe('DiscordListener', () => {
       const reactions: DiscordGatewayReactionEvent[] = []
       listener.on('message_reaction_add', (event) => reactions.push(event))
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
       mockWsInstance.simulateDispatch(
         'MESSAGE_REACTION_ADD',
         {
@@ -294,10 +368,7 @@ describe('DiscordListener', () => {
       const events: DiscordGatewayGenericEvent[] = []
       listener.on('discord_event', (event) => events.push(event))
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
       mockWsInstance.simulateDispatch(
         'MESSAGE_CREATE',
         { id: 'm1', channel_id: 'C1', content: 'hi', timestamp: 't', author: { id: 'U1', username: 'u' } },
@@ -320,9 +391,8 @@ describe('DiscordListener', () => {
         const client = createMockClient()
         listener = new DiscordListener(client)
 
-        await listener.start()
-        mockWsInstance.simulateOpen()
-        mockWsInstance.simulateHello(50)
+        const ws = await startConnecting(listener)
+        ws.simulateHello(50)
 
         await new Promise((r) => setTimeout(r, 150))
 
@@ -342,10 +412,7 @@ describe('DiscordListener', () => {
       const events: DiscordGatewayGenericEvent[] = []
       listener.on('discord_event', (event) => events.push(event))
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
       mockWsInstance.simulateHeartbeatACK()
 
       expect(events.length).toBe(0)
@@ -362,9 +429,8 @@ describe('DiscordListener', () => {
         const disconnected: boolean[] = []
         listener.on('disconnected', () => disconnected.push(true))
 
-        await listener.start()
-        mockWsInstance.simulateOpen()
-        mockWsInstance.simulateHello(50)
+        const ws = await startConnecting(listener)
+        ws.simulateHello(50)
 
         await new Promise((r) => setTimeout(r, 300))
 
@@ -380,8 +446,7 @@ describe('DiscordListener', () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
+      await startConnecting(listener)
 
       listener.stop()
 
@@ -398,9 +463,8 @@ describe('DiscordListener', () => {
       const disconnected: boolean[] = []
       listener.on('disconnected', () => disconnected.push(true))
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateClose()
+      const ws = await startConnecting(listener)
+      ws.simulateClose()
 
       expect(disconnected.length).toBe(1)
 
@@ -408,28 +472,20 @@ describe('DiscordListener', () => {
       expect(client.gatewayConnect.mock.calls.length).toBeGreaterThanOrEqual(2)
     })
 
-    it('emits error and reconnects on gatewayConnect failure', async () => {
-      let callCount = 0
+    it('rejects start() and stops on gatewayConnect failure during initial connect', async () => {
       const client = createMockClient({
-        gatewayConnect: mock(() => {
-          callCount++
-          if (callCount === 1) return Promise.reject(new Error('network_error'))
-          return Promise.resolve({ token: 'fake-token' })
-        }),
+        gatewayConnect: mock(() => Promise.reject(new Error('network_error'))),
       })
 
       listener = new DiscordListener(client)
+      listener.on('error', () => {})
 
-      const errors: Error[] = []
-      listener.on('error', (err) => errors.push(err))
-
-      await listener.start()
+      await expect(listener.start()).rejects.toThrow('network_error')
 
+      // given: a pre-READY connect error tears down the listener (no resurrected reconnect loop)
       await new Promise((r) => setTimeout(r, 1500))
-
-      expect(errors.length).toBe(1)
-      expect(errors[0].message).toBe('network_error')
-      expect(client.gatewayConnect.mock.calls.length).toBeGreaterThanOrEqual(2)
+      expect((listener as any).running).toBe(false)
+      expect(client.gatewayConnect).toHaveBeenCalledTimes(1)
     })
   })
 
@@ -442,10 +498,7 @@ describe('DiscordListener', () => {
       const handler = (event: DiscordGatewayMessageCreateEvent) => messages.push(event)
       listener.on('message_create', handler)
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
       mockWsInstance.simulateDispatch(
         'MESSAGE_CREATE',
         { id: 'm1', channel_id: 'C1', content: 'a', timestamp: 't', author: { id: 'U1', username: 'u' } },
@@ -470,10 +523,7 @@ describe('DiscordListener', () => {
       const messages: DiscordGatewayMessageCreateEvent[] = []
       listener.once('message_create', (event) => messages.push(event))
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
       mockWsInstance.simulateDispatch(
         'MESSAGE_CREATE',
         { id: 'm1', channel_id: 'C1', content: 'first', timestamp: 't', author: { id: 'U1', username: 'u' } },
@@ -495,10 +545,7 @@ describe('DiscordListener', () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
 
       ;(listener as any).reconnectAttempts = 5
       mockWsInstance.simulateReconnect()
@@ -512,10 +559,7 @@ describe('DiscordListener', () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
 
       expect((listener as any).sessionId).toBe('session_123')
 
@@ -530,10 +574,7 @@ describe('DiscordListener', () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
 
       const sessionIdBefore = (listener as any).sessionId
 
@@ -548,10 +589,7 @@ describe('DiscordListener', () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
 
       mockWsInstance.simulateClose()
 
@@ -569,22 +607,38 @@ describe('DiscordListener', () => {
   })
 
   describe('non-recoverable close codes', () => {
-    it('emits error and stops on code 4004', async () => {
-      const client = createMockClient()
-      listener = new DiscordListener(client)
+    for (const code of [4004, 4013, 4014]) {
+      it(`rejects start() and stops on non-recoverable close ${code}`, async () => {
+        const client = createMockClient()
+        listener = new DiscordListener(client)
+        listener.on('error', () => {})
 
-      const errors: Error[] = []
-      listener.on('error', (err) => errors.push(err))
+        const started = listener.start()
+        const ws = await waitForSocket()
+        ws.simulateOpen()
+        ws.simulateClose(code)
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateClose(4004)
+        await expect(started).rejects.toThrow(String(code))
+        expect((listener as any).running).toBe(false)
+        expect(client.gatewayConnect).toHaveBeenCalledTimes(1)
+      })
+    }
+  })
 
-      await new Promise((r) => setTimeout(r, 50))
+  describe('connect timeout', () => {
+    it('rejects start() and tears down when READY never arrives', async () => {
+      const client = createMockClient()
+      listener = new DiscordListener(client, { connectTimeoutMs: 100 })
+      listener.on('error', () => {})
 
-      expect(errors.length).toBe(1)
-      expect(errors[0].message).toContain('4004')
-      expect(client.gatewayConnect).toHaveBeenCalledTimes(1)
+      const started = listener.start()
+      const ws = await waitForSocket()
+      ws.simulateOpen()
+      ws.simulateHello()
+      // given: Identify sent but the gateway never delivers READY
+
+      await expect(started).rejects.toThrow(/did not become ready/)
+      expect((listener as any).running).toBe(false)
     })
   })
 
@@ -593,10 +647,7 @@ describe('DiscordListener', () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
 
       expect((listener as any).sessionId).toBe('session_123')
 
@@ -623,10 +674,7 @@ describe('DiscordListener', () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
 
       mockWsInstance.simulateClose(4009)
 
@@ -643,10 +691,12 @@ describe('DiscordListener', () => {
         const client = createMockClient()
         listener = new DiscordListener(client)
 
-        await listener.start()
-        mockWsInstance.simulateOpen()
-        mockWsInstance.simulateHello(50)
-        mockWsInstance.simulateReady()
+        const started = listener.start()
+        const ws = await waitForSocket()
+        ws.simulateOpen()
+        ws.simulateHello(50)
+        ws.simulateReady()
+        await started
 
         mockWsInstance.simulateHello(50)
 
@@ -671,10 +721,7 @@ describe('DiscordListener', () => {
         const client = createMockClient()
         listener = new DiscordListener(client)
 
-        await listener.start()
-        mockWsInstance.simulateOpen()
-        mockWsInstance.simulateHello()
-        mockWsInstance.simulateReady()
+        await startAndReady(listener)
 
         mockWsInstance.simulateInvalidSession(true)
 
@@ -690,10 +737,7 @@ describe('DiscordListener', () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
 
       mockWsInstance.simulateInvalidSession(false)
 
@@ -716,10 +760,7 @@ describe('DiscordListener', () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
 
       const sentBefore = mockWsInstance.sent.length
       mockWsInstance.simulateMessage({ op: 1 })
@@ -736,10 +777,7 @@ describe('DiscordListener', () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
 
       mockWsInstance.simulateDispatch(
         'MESSAGE_CREATE',
@@ -754,10 +792,7 @@ describe('DiscordListener', () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      await startAndReady(listener)
 
       mockWsInstance.simulateDispatch(
         'MESSAGE_CREATE',
@@ -781,11 +816,11 @@ describe('DiscordListener', () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
+      await startConnecting(listener)
       ;(listener as any).reconnectAttempts = 5
       listener.stop()
 
-      await listener.start()
+      await startConnecting(listener)
       expect((listener as any).reconnectAttempts).toBe(0)
     })
   })
@@ -795,10 +830,11 @@ describe('DiscordListener', () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateMessage({
+      const started = listener.start()
+      const ws = await waitForSocket()
+      ws.simulateOpen()
+      ws.simulateHello()
+      ws.simulateMessage({
         op: 0,
         t: 'READY',
         s: 1,
@@ -808,6 +844,7 @@ describe('DiscordListener', () => {
           user: { id: 'U_SELF', username: 'user' },
         },
       })
+      await started
 
       mockWsInstance.simulateClose()
       await new Promise((r) => setTimeout(r, 1500))
@@ -821,10 +858,11 @@ describe('DiscordListener', () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
+      listener.start().catch(() => {})
+      const ws = await waitForSocket()
       ;(listener as any).reconnectAttempts = 5
 
-      mockWsInstance.simulateOpen()
+      ws.simulateOpen()
 
       expect((listener as any).reconnectAttempts).toBe(5)
     })
@@ -833,12 +871,14 @@ describe('DiscordListener', () => {
       const client = createMockClient()
       listener = new DiscordListener(client)
 
-      await listener.start()
+      const started = listener.start()
+      const ws = await waitForSocket()
       ;(listener as any).reconnectAttempts = 5
 
-      mockWsInstance.simulateOpen()
-      mockWsInstance.simulateHello()
-      mockWsInstance.simulateReady()
+      ws.simulateOpen()
+      ws.simulateHello()
+      ws.simulateReady()
+      await started
 
       expect((listener as any).reconnectAttempts).toBe(0)
     })