Files
WechatExplorer/tests/unit/wcdb-message-shards.test.ts
T

217 lines
8.3 KiB
TypeScript

import fs from 'fs-extra'
import crypto from 'crypto'
import os from 'os'
import path from 'path'
import { afterEach, describe, expect, it, vi } from 'vitest'
import {
resolveWindowsNativeAccountRoot,
Wcdb4Client,
type Wcdb4Message
} from '../../src/main/wcdb4-client'
const message = (id: string, year: number, serverId = `server-${id}`): Wcdb4Message => ({
mesLocalID: id,
serverId,
mesDes: 0,
messageType: '1',
msgCreateTime: String(Math.floor(Date.UTC(year, 0, 1) / 1000)),
msgContent: `fixture-${year}`,
raw: {}
})
describe('WCDB message shard pagination', () => {
const temporaryDirectories: string[] = []
afterEach(() => {
for (const directory of temporaryDirectories.splice(0)) fs.removeSync(directory)
})
it('keeps messages whose local ids repeat across database shards', async () => {
const cursor = vi.fn(async () => [
message('1', 2024, 'server-2024'),
message('1', 2025, 'server-2025')
])
const client = Object.assign(Object.create(Wcdb4Client.prototype), {
getMessagesByCursorAsync: cursor
}) as Wcdb4Client
const result = await client.getMessagesAsync('fixture@chatroom')
expect(result).toHaveLength(2)
expect(result.map((item) => item.serverId)).toEqual(['server-2024', 'server-2025'])
})
it('merges cursor and all-store rows for a bounded cross-year page', async () => {
const cursor = vi.fn(async () => [message('2025', 2025)])
const tableScan = vi.fn(async () => [message('2017', 2017), message('2025', 2025)])
const client = Object.assign(Object.create(Wcdb4Client.prototype), {
wcdbGetMessageTableStats: vi.fn(),
wcdbExecQuery: vi.fn(),
getMessagesByCursorAsync: cursor,
getMessagesByTableScanAsync: tableScan
}) as Wcdb4Client
const result = await client.getMessagesAsync(
'fixture@chatroom',
undefined,
Math.floor(Date.UTC(2026, 0, 1) / 1000),
{ limit: 20 }
)
expect(tableScan).toHaveBeenCalledOnce()
expect(result.map((item) => item.msgContent)).toEqual(['fixture-2017', 'fixture-2025'])
})
it('reports an unsupported shard query instead of claiming history ended', async () => {
const client = Object.assign(Object.create(Wcdb4Client.prototype), {
getMessagesByCursorAsync: vi.fn(async () => [])
}) as Wcdb4Client
await expect(
client.getMessagesAsync('fixture@chatroom', undefined, 1_767_225_600, { limit: 20 })
).rejects.toThrow('无法检查历史消息分片')
})
it('falls back to biz_message shards for official-account sessions', () => {
const root = fs.mkdtempSync(path.join(os.tmpdir(), 'wxe-biz-shards-'))
temporaryDirectories.push(root)
const messageRoot = path.join(root, 'db_storage', 'message')
fs.ensureDirSync(messageRoot)
const bizDbPath = path.join(messageRoot, 'biz_message_0.db')
fs.writeFileSync(bizDbPath, '')
const client = Object.assign(Object.create(Wcdb4Client.prototype), {
dbStoragePath: path.join(root, 'db_storage'),
wcdbGetMessageTableStats: null,
wcdbExecQuery: vi.fn(),
callJson: vi.fn(() => [{ name: 'Msg_19cde0e21f4f938ca1fcebd7146dbbd2' }])
}) as Wcdb4Client
const stores = Reflect.get(client, 'listMessageStores').call(client, 'gh_23069e016533')
expect(stores).toEqual([
{
tableName: 'Msg_19cde0e21f4f938ca1fcebd7146dbbd2',
dbPath: bizDbPath
}
])
})
it.each(['wxid_fixture_peer', 'fixture@chatroom'])(
'reads %s from all canonical shards when native discovery is empty',
async (username) => {
const root = fs.mkdtempSync(path.join(os.tmpdir(), 'wxe-message-fallback-'))
temporaryDirectories.push(root)
const dbStoragePath = path.join(root, 'db_storage')
const messageRoot = path.join(dbStoragePath, 'message')
fs.ensureDirSync(messageRoot)
for (const name of [
'message_0.db',
'message_7.db',
'message_6.db',
'message_0 (同步冲突).db',
'biz_message_0.db'
]) {
fs.writeFileSync(path.join(messageRoot, name), '')
}
const tableName = `Msg_${crypto.createHash('md5').update(username).digest('hex')}`
const query = vi.fn((_kind: string, dbPath: string, sql: string) => {
if (sql.includes('sqlite_master')) {
return dbPath.endsWith('message_6.db')
? [{ name: 'Name2Id' }]
: [{ name: tableName }, { name: 'Name2Id' }]
}
expect(sql).toContain('n.user_name AS sender_username')
expect(sql).toContain('n.rowid = m.real_sender_id')
expect(sql).toContain('"create_time" <= 1800000000')
expect(sql).toContain('ORDER BY "create_time" DESC LIMIT 20')
const isLatestShard = dbPath.endsWith('message_7.db')
return [
{
local_id: 1,
server_id: isLatestShard ? 'fixture-new' : 'fixture-old',
local_type: 1,
create_time: isLatestShard ? 1700000001 : 1700000000,
message_content: 'fixture text',
sender_username: isLatestShard ? 'wxid_self' : 'wxid_peer'
}
]
})
const stats = vi.fn(() => [])
const client = Object.assign(Object.create(Wcdb4Client.prototype), {
dbStoragePath,
accountRoot: path.join(root, 'wxid_self'),
wxid: 'wxid_self',
displayNameCache: new Map(),
avatarCache: new Map(),
wcdbGetMessageTableStats: stats,
wcdbExecQuery: query,
getMessagesByCursor: vi.fn(() => []),
getMessagesByCursorAsync: vi.fn(async () => []),
getGroupNicknames: vi.fn(() => new Map()),
callJson: vi.fn((call) => call(1, [null])),
callJsonAsync: vi.fn(async (fn, ...args) => fn(...args))
}) as Wcdb4Client
// The synchronous FFI callback includes handle/output arguments.
const syncQuery = vi.fn((_handle, kind, dbPath, sql) => query(kind, dbPath, sql))
Reflect.set(client, 'wcdbExecQuery', syncQuery)
const synchronous = client.getMessages(username, undefined, 1800000000, { limit: 20 })
Reflect.set(client, 'wcdbExecQuery', query)
const asynchronous = await client.getMessagesAsync(username, undefined, 1800000000, {
limit: 20
})
expect(asynchronous).toEqual(synchronous)
expect(asynchronous.map((row) => [row.serverId, row.sender, row.mesDes])).toEqual([
['fixture-old', 'wxid_peer', 1],
['fixture-new', 'wxid_self', 0]
])
expect(query).toHaveBeenCalledTimes(10)
expect(query.mock.calls.every(([, dbPath]) => /message_(0|6|7)\.db$/.test(dbPath))).toBe(true)
}
)
it('creates a stable ASCII junction for a Windows account path containing Chinese', () => {
const root = fs.mkdtempSync(path.join(os.tmpdir(), 'wxe-path-bridge-'))
temporaryDirectories.push(root)
const publicRoot = path.join(root, 'Public')
const accountRoot = path.join(root, '微信聊天记录', 'wxid_fixture')
fs.ensureDirSync(path.join(accountRoot, 'db_storage'))
const first = resolveWindowsNativeAccountRoot(accountRoot, {
platform: 'win32',
publicRoot
})
const second = resolveWindowsNativeAccountRoot(accountRoot, {
platform: 'win32',
publicRoot
})
expect(first).toBe(second)
expect(first).not.toContain('微信聊天记录')
expect(first).toContain(path.join('TraceMemo', 'path-bridges'))
expect(fs.realpathSync(first)).toBe(fs.realpathSync(accountRoot))
})
it('reuses an existing legacy Windows path bridge without creating a new one', () => {
const root = fs.mkdtempSync(path.join(os.tmpdir(), 'wxe-legacy-path-bridge-'))
temporaryDirectories.push(root)
const publicRoot = path.join(root, 'Public')
const accountRoot = path.join(root, '微信聊天记录', 'wxid_legacy')
fs.ensureDirSync(path.join(accountRoot, 'db_storage'))
const bridgeId = crypto
.createHash('sha256')
.update(path.resolve(accountRoot).toLowerCase())
.digest('hex')
.slice(0, 24)
const legacyBridge = path.join(publicRoot, 'WechatExplorer', 'path-bridges', bridgeId)
fs.ensureDirSync(path.dirname(legacyBridge))
fs.symlinkSync(accountRoot, legacyBridge, 'junction')
expect(resolveWindowsNativeAccountRoot(accountRoot, { platform: 'win32', publicRoot })).toBe(
legacyBridge
)
expect(fs.existsSync(path.join(publicRoot, 'TraceMemo'))).toBe(false)
})
})