c4da46321f
Cherry-pick from upstream PR #2264 (commit 5cbad317) with enhancements:
## Changes
### New Files
- `src/Utils/identity-change-handler.ts`: Centralized identity change handling
- Enterprise-grade JSDoc documentation
- Clear result types for all 9 possible outcomes
- Debouncing to prevent duplicate session refreshes
- Companion device filtering
- Offline notification handling
- `src/__tests__/Socket/identity-change-handling.test.ts`: Comprehensive tests
- Core functionality tests
- Debounce behavior tests
- Error handling tests
- Edge case coverage
### Modified Files
- `src/Socket/messages-recv.ts`: Updated error handling
- MISSING_KEYS_ERROR now returns NACK with ParsingError
- Maintains CTWA recovery logic intact
- Preserves all Prometheus metrics integration
- `src/Utils/generics.ts`: Added `isStringNullOrEmpty()` helper
- `src/Utils/index.ts`: Added identity-change-handler export
## Benefits
- Fixes "Online" status shown when actually disconnected (#2132)
- Better session management after contact identity changes
- Clear separation of concerns with dedicated handler module
Co-authored-by: João Lucas de Oliveira Lopes <55464917+jlucaso1@users.noreply.github.com>
208 lines
7.1 KiB
TypeScript
208 lines
7.1 KiB
TypeScript
import NodeCache from '@cacheable/node-cache'
|
|
import { jest } from '@jest/globals'
|
|
import P from 'pino'
|
|
import { handleIdentityChange, type IdentityChangeContext } from '../../Utils/identity-change-handler'
|
|
import { type BinaryNode } from '../../WABinary'
|
|
|
|
const logger = P({ level: 'silent' })
|
|
|
|
type ValidateSessionFn = (jid: string) => Promise<{ exists: boolean; reason?: string }>
|
|
type AssertSessionsFn = (jids: string[], force?: boolean) => Promise<boolean>
|
|
|
|
describe('Identity Change Handling', () => {
|
|
let mockValidateSession: jest.Mock<ValidateSessionFn>
|
|
let mockAssertSessions: jest.Mock<AssertSessionsFn>
|
|
let identityAssertDebounce: NodeCache<boolean>
|
|
let mockMeId: string
|
|
let mockMeLid: string | undefined
|
|
|
|
function createIdentityChangeNode(from: string, offline?: string): BinaryNode {
|
|
return {
|
|
tag: 'notification',
|
|
attrs: {
|
|
from,
|
|
type: 'encrypt',
|
|
...(offline !== undefined ? { offline } : {})
|
|
},
|
|
content: [
|
|
{
|
|
tag: 'identity',
|
|
attrs: {},
|
|
content: Buffer.from('test-identity-key')
|
|
}
|
|
]
|
|
}
|
|
}
|
|
|
|
function createContext(): IdentityChangeContext {
|
|
return {
|
|
meId: mockMeId,
|
|
meLid: mockMeLid,
|
|
validateSession: mockValidateSession,
|
|
assertSessions: mockAssertSessions,
|
|
debounceCache: identityAssertDebounce,
|
|
logger
|
|
}
|
|
}
|
|
|
|
beforeEach(() => {
|
|
jest.clearAllMocks()
|
|
mockValidateSession = jest.fn()
|
|
mockAssertSessions = jest.fn()
|
|
identityAssertDebounce = new NodeCache<boolean>({ stdTTL: 5, useClones: false })
|
|
mockMeId = 'myuser@s.whatsapp.net'
|
|
mockMeLid = 'mylid@lid'
|
|
})
|
|
|
|
describe('Core Checks', () => {
|
|
it('should skip companion devices (device > 0)', async () => {
|
|
const node = createIdentityChangeNode('user:5@s.whatsapp.net')
|
|
const result = await handleIdentityChange(node, createContext())
|
|
|
|
expect(mockValidateSession).not.toHaveBeenCalled()
|
|
expect(result.action).toBe('skipped_companion_device')
|
|
})
|
|
|
|
it('should process primary device (device 0 or undefined)', async () => {
|
|
mockValidateSession.mockResolvedValue({ exists: true })
|
|
mockAssertSessions.mockResolvedValue(true)
|
|
|
|
const node = createIdentityChangeNode('user@s.whatsapp.net')
|
|
const result = await handleIdentityChange(node, createContext())
|
|
|
|
expect(result.action).toBe('session_refreshed')
|
|
})
|
|
|
|
it('should skip self-primary identity (PN match)', async () => {
|
|
const node = createIdentityChangeNode('myuser@s.whatsapp.net')
|
|
const result = await handleIdentityChange(node, createContext())
|
|
|
|
expect(mockValidateSession).not.toHaveBeenCalled()
|
|
expect(result.action).toBe('skipped_self_primary')
|
|
})
|
|
|
|
it('should skip self-primary identity (LID match)', async () => {
|
|
const node = createIdentityChangeNode('mylid@lid')
|
|
const result = await handleIdentityChange(node, createContext())
|
|
|
|
expect(mockValidateSession).not.toHaveBeenCalled()
|
|
expect(result.action).toBe('skipped_self_primary')
|
|
})
|
|
|
|
it('should skip when no existing session', async () => {
|
|
mockValidateSession.mockResolvedValue({ exists: false })
|
|
|
|
const node = createIdentityChangeNode('user@s.whatsapp.net')
|
|
const result = await handleIdentityChange(node, createContext())
|
|
|
|
expect(mockAssertSessions).not.toHaveBeenCalled()
|
|
expect(result.action).toBe('skipped_no_session')
|
|
})
|
|
|
|
it('should skip session refresh during offline processing', async () => {
|
|
mockValidateSession.mockResolvedValue({ exists: true })
|
|
|
|
const node = createIdentityChangeNode('user@s.whatsapp.net', '0')
|
|
const result = await handleIdentityChange(node, createContext())
|
|
|
|
expect(mockAssertSessions).not.toHaveBeenCalled()
|
|
expect(result.action).toBe('skipped_offline')
|
|
})
|
|
|
|
it('should refresh session when online with existing session', async () => {
|
|
mockValidateSession.mockResolvedValue({ exists: true })
|
|
mockAssertSessions.mockResolvedValue(true)
|
|
|
|
const node = createIdentityChangeNode('user@s.whatsapp.net')
|
|
const result = await handleIdentityChange(node, createContext())
|
|
|
|
expect(mockAssertSessions).toHaveBeenCalledWith(['user@s.whatsapp.net'], true)
|
|
expect(result.action).toBe('session_refreshed')
|
|
})
|
|
})
|
|
|
|
describe('Debounce', () => {
|
|
it('should debounce multiple identity changes for the same JID', async () => {
|
|
mockValidateSession.mockResolvedValue({ exists: true })
|
|
mockAssertSessions.mockResolvedValue(true)
|
|
|
|
const node = createIdentityChangeNode('user@s.whatsapp.net')
|
|
|
|
const result1 = await handleIdentityChange(node, createContext())
|
|
expect(result1.action).toBe('session_refreshed')
|
|
|
|
const result2 = await handleIdentityChange(node, createContext())
|
|
expect(result2.action).toBe('debounced')
|
|
expect(mockAssertSessions).toHaveBeenCalledTimes(1)
|
|
})
|
|
|
|
it('should allow different JIDs to process independently', async () => {
|
|
mockValidateSession.mockResolvedValue({ exists: true })
|
|
mockAssertSessions.mockResolvedValue(true)
|
|
|
|
const result1 = await handleIdentityChange(createIdentityChangeNode('user1@s.whatsapp.net'), createContext())
|
|
const result2 = await handleIdentityChange(createIdentityChangeNode('user2@s.whatsapp.net'), createContext())
|
|
|
|
expect(result1.action).toBe('session_refreshed')
|
|
expect(result2.action).toBe('session_refreshed')
|
|
expect(mockAssertSessions).toHaveBeenCalledTimes(2)
|
|
})
|
|
})
|
|
|
|
describe('Error Handling', () => {
|
|
it('should handle assertSessions failure gracefully', async () => {
|
|
mockValidateSession.mockResolvedValue({ exists: true })
|
|
const testError = new Error('Session assertion failed')
|
|
mockAssertSessions.mockRejectedValue(testError)
|
|
|
|
const node = createIdentityChangeNode('user@s.whatsapp.net')
|
|
const result = await handleIdentityChange(node, createContext())
|
|
|
|
expect(result.action).toBe('session_refresh_failed')
|
|
expect((result as { error: unknown }).error).toBe(testError)
|
|
})
|
|
|
|
it('should propagate validateSession errors', async () => {
|
|
mockValidateSession.mockRejectedValue(new Error('Database error'))
|
|
|
|
const node = createIdentityChangeNode('user@s.whatsapp.net')
|
|
await expect(handleIdentityChange(node, createContext())).rejects.toThrow('Database error')
|
|
})
|
|
})
|
|
|
|
describe('Edge Cases', () => {
|
|
it('should return invalid_notification when from is missing', async () => {
|
|
const node: BinaryNode = {
|
|
tag: 'notification',
|
|
attrs: { type: 'encrypt' },
|
|
content: [{ tag: 'identity', attrs: {}, content: Buffer.from('key') }]
|
|
}
|
|
|
|
const result = await handleIdentityChange(node, createContext())
|
|
expect(result.action).toBe('invalid_notification')
|
|
})
|
|
|
|
it('should return no_identity_node when identity child is missing', async () => {
|
|
const node: BinaryNode = {
|
|
tag: 'notification',
|
|
attrs: { from: 'user@s.whatsapp.net', type: 'encrypt' },
|
|
content: []
|
|
}
|
|
|
|
const result = await handleIdentityChange(node, createContext())
|
|
expect(result.action).toBe('no_identity_node')
|
|
})
|
|
|
|
it('should handle LID JIDs correctly', async () => {
|
|
mockValidateSession.mockResolvedValue({ exists: true })
|
|
mockAssertSessions.mockResolvedValue(true)
|
|
|
|
const node = createIdentityChangeNode('12345@lid')
|
|
const result = await handleIdentityChange(node, createContext())
|
|
|
|
expect(mockValidateSession).toHaveBeenCalledWith('12345@lid')
|
|
expect(result.action).toBe('session_refreshed')
|
|
})
|
|
})
|
|
})
|