fix: auth store transactions + tests

src/Tests/test.key-store.ts

@@ -0,0 +1,92 @@
+import { addTransactionCapability, delay } from '../Utils'
+import logger from '../Utils/logger'
+import { makeMockSignalKeyStore } from './utils'
+
+logger.level = 'trace'
+
+describe('Key Store w Transaction Tests', () => {
+
+	const rawStore = makeMockSignalKeyStore()
+	const store = addTransactionCapability(
+		rawStore,
+		logger,
+		{
+			maxCommitRetries: 1,
+			delayBetweenTriesMs: 10
+		}
+	)
+
+	it('should use transaction cache when mutated', async() => {
+		const key = '123'
+		const value = new Uint8Array(1)
+		const ogGet = rawStore.get
+		await store.transaction(
+			async() => {
+				await store.set({ 'session': { [key]: value } })
+
+				rawStore.get = () => {
+					throw new Error('should not have been called')
+				}
+
+				const { [key]: stored } = await store.get('session', [key])
+				expect(stored).toEqual(new Uint8Array(1))
+			}
+		)
+
+		rawStore.get = ogGet
+	})
+
+	it('should not commit a failed transaction', async() => {
+		const key = 'abcd'
+		await expect(
+			store.transaction(
+				async() => {
+					await store.set({ 'session': { [key]: new Uint8Array(1) } })
+					throw new Error('fail')
+				}
+			)
+		).rejects.toThrowError(
+			'fail'
+		)
+
+		const { [key]: stored } = await store.get('session', [key])
+		expect(stored).toBeUndefined()
+	})
+
+	it('should handle overlapping transactions', async() => {
+		// promise to let transaction 2
+		// know that transaction 1 has started
+		let promiseResolve: () => void
+		const promise = new Promise<void>(resolve => {
+			promiseResolve = resolve
+		})
+
+		store.transaction(
+			async() => {
+				await store.set({
+					'session': {
+						'1': new Uint8Array(1)
+					}
+				})
+				// wait for the other transaction to start
+				await delay(5)
+				// reolve the promise to let the other transaction continue
+				promiseResolve()
+			}
+		)
+
+		await store.transaction(
+			async() => {
+				await promise
+				await delay(5)
+
+				expect(store.isInTransaction()).toBe(true)
+			}
+		)
+
+		expect(store.isInTransaction()).toBe(false)
+		// ensure that the transaction were committed
+		const { ['1']: stored } = await store.get('session', ['1'])
+		expect(stored).toEqual(new Uint8Array(1))
+	})
+})

src/Tests/utils.ts

@@ -1,6 +1,36 @@
+import { SignalDataTypeMap, SignalKeyStore } from '../Types'
 import { jidEncode } from '../WABinary'
 
-
 export function randomJid() {
 	return jidEncode(Math.floor(Math.random() * 1000000), Math.random() < 0.5 ? 's.whatsapp.net' : 'g.us')
+}
+
+export function makeMockSignalKeyStore(): SignalKeyStore {
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	const store: { [_: string]: any } = {}
+
+	return {
+		get(type, ids) {
+			const data: { [_: string]: SignalDataTypeMap[typeof type] } = { }
+			for(const id of ids) {
+				const item = store[getUniqueId(type, id)]
+				if(typeof item !== 'undefined') {
+					data[id] = item
+				}
+			}
+
+			return data
+		},
+		set(data) {
+			for(const type in data) {
+				for(const id in data[type]) {
+					store[getUniqueId(type, id)] = data[type][id]
+				}
+			}
+		},
+	}
+
+	function getUniqueId(type: string, id: string) {
+		return `${type}.${id}`
+	}
 }