@bsv/wallet-toolbox/src/storage/schema/entities/__tests/SyncStateTests.test.ts

BRC100 conforming wallet, wallet storage and wallet signer components

import { EntitySyncState } from '../EntitySyncState'
import { createSyncMap, EntityStorage, sdk, SyncMap, TableSyncState } from '../../../../../src'
import { TestUtilsWalletStorage as _tu, TestWalletNoSetup } from '../../../../../test/utils/TestUtilsWalletStorage'

describe('SyncState class method tests', () => {
  jest.setTimeout(99999999)

  const env = _tu.getEnv('test')
  const ctxs: TestWalletNoSetup[] = []
  const ctxs2: TestWalletNoSetup[] = []

  beforeAll(async () => {
    if (env.runMySQL) {
      ctxs.push(await _tu.createLegacyWalletMySQLCopy('SyncStateTests'))
    }
    ctxs.push(await _tu.createLegacyWalletSQLiteCopy('SyncStateTests'))
  })

  afterAll(async () => {
    for (const ctx of ctxs) {
      await ctx.storage.destroy()
    }
  })

  // Test: Insert a new SyncState when id is 0
  test('0_inserts_new_sync_state', async () => {
    const ctx = ctxs[0]
    const syncState = new EntitySyncState()
    syncState.id = 0

    // Assign a unique value to refNum and valid userId
    syncState.userId = 1
    syncState.refNum = `testRefNum-${Date.now()}`

    // Insert the SyncState into storage
    await syncState.updateStorage(ctx.activeStorage)

    // Find the SyncState using FindSyncStatesArgs
    const findArgs: sdk.FindSyncStatesArgs = {
      partial: { syncStateId: syncState.id }
    }

    const fetchedSyncStates = await ctx.activeStorage.findSyncStates(findArgs)

    // Handle array response
    expect(fetchedSyncStates).toBeTruthy()
    expect(fetchedSyncStates.length).toBeGreaterThan(0)

    const fetchedSyncState = fetchedSyncStates[0]
    expect(fetchedSyncState.syncStateId).toBeGreaterThan(0)
  })

  // Test: Update an existing SyncState
  test('1_updates_existing_sync_state', async () => {
    const ctx = ctxs[0]
    const syncState = new EntitySyncState()
    syncState.id = 0
    // Assign a unique value to refNum and valid userId
    syncState.userId = 1
    syncState.refNum = `testRefNum-${Date.now()}`

    // Insert the SyncState into storage
    await syncState.updateStorage(ctx.activeStorage)

    // Update the SyncState with a valid status
    syncState.status = 'updated' // Use a valid SyncStatus value
    await syncState.updateStorage(ctx.activeStorage)

    // Find the SyncState using FindSyncStatesArgs
    const findArgs: sdk.FindSyncStatesArgs = {
      partial: { syncStateId: syncState.id }
    }

    const fetchedSyncStates = await ctx.activeStorage.findSyncStates(findArgs)

    // Handle array response
    const fetchedSyncState = fetchedSyncStates[0]
    expect(fetchedSyncState.status).toBe('updated') // Verify the status is updated
  })

  // Test: Merge ID maps correctly
  test('2_merges_id_maps_correctly', async () => {
    const syncState = new EntitySyncState()

    const inputSyncMap = createSyncMap()
    inputSyncMap.provenTx.idMap = { 1: 2 }
    inputSyncMap.transaction.idMap = { 3: 4 }

    syncState.syncMap = createSyncMap()
    syncState.syncMap.provenTx.idMap = { 1: 2 }
    syncState.syncMap.provenTx.count = 1
    syncState.syncMap.transaction.idMap = { 5: 6 }
    syncState.syncMap.transaction.count = 1

    syncState.mergeSyncMap(inputSyncMap)

    // Assertions
    expect(syncState.syncMap.provenTx.idMap[1]).toBe(2)
    expect(syncState.syncMap.transaction.idMap[3]).toBe(4)
    expect(syncState.syncMap.transaction.idMap[5]).toBe(6)
  })

  // Test: Throw error on conflicting mappings
  test('3_throws_error_on_conflicting_mappings', () => {
    const syncState = new EntitySyncState()

    syncState.syncMap = createSyncMap()
    syncState.syncMap.provenTx.idMap = { 1: 2 }
    syncState.syncMap.provenTx.count = 1
    syncState.syncMap.transaction.idMap = { 3: 4 }
    syncState.syncMap.transaction.count = 1

    const conflictingSyncMap = createSyncMap()
    conflictingSyncMap.provenTx.idMap = { 1: 3 }
    conflictingSyncMap.provenTx.count = 1
    conflictingSyncMap.transaction.idMap = { 3: 4 }
    conflictingSyncMap.transaction.count = 1

    expect(() => syncState.mergeSyncMap(conflictingSyncMap)).toThrow()
  })

  // Test: Process a sync chunk correctly and update storage
  test('4_processes_sync_chunk_correctly', async () => {
    const ctx = ctxs[0]
    const syncState = new EntitySyncState()

    // Assign a unique value to refNum and valid userId
    syncState.userId = 1
    syncState.refNum = `testRefNum-${Date.now()}`

    // Define the chunk object with all required properties
    const chunk: sdk.SyncChunk = {
      fromStorageIdentityKey: 'fromKey',
      toStorageIdentityKey: 'toKey',
      userIdentityKey: 'testIdentityKey',
      user: {
        userId: 1,
        identityKey: 'testIdentityKey',
        created_at: new Date(), // Add required property
        updated_at: new Date(), // Add required property
        activeStorage: ''
      },
      provenTxs: [],
      provenTxReqs: [],
      outputBaskets: [],
      txLabels: [],
      outputTags: [],
      transactions: [],
      txLabelMaps: [],
      commissions: [],
      outputs: [],
      outputTagMaps: [],
      certificates: [],
      certificateFields: []
    }

    const args: sdk.RequestSyncChunkArgs = {
      identityKey: 'testIdentityKey',
      maxRoughSize: 20000000,
      maxItems: 1000,
      offsets: [],
      since: undefined,
      fromStorageIdentityKey: 'fromKey',
      toStorageIdentityKey: 'toKey'
    }

    const result = await syncState.processSyncChunk(ctx.activeStorage, args, chunk)

    expect(result.done).toBe(true)
    expect(result.updates).toBe(0)
    expect(result.inserts).toBe(0)
  })

  // Test: equals method always returns false
  test('6_equals_method_always_returns_false', () => {
    const syncState = new EntitySyncState()
    expect(syncState.equals({} as TableSyncState)).toBe(false)
  })

  // Test: Getters and setters for SyncState properties
  test('7_getters_and_setters', () => {
    const syncState = new EntitySyncState()

    // Test created_at and updated_at
    const now = new Date()
    syncState.created_at = now
    syncState.updated_at = now
    expect(syncState.created_at).toBe(now)
    expect(syncState.updated_at).toBe(now)

    // Test userId
    syncState.userId = 123
    expect(syncState.userId).toBe(123)

    // Test storageIdentityKey
    syncState.storageIdentityKey = 'testStorageIdentityKey'
    expect(syncState.storageIdentityKey).toBe('testStorageIdentityKey')

    // Test storageName
    syncState.storageName = 'testStorageName'
    expect(syncState.storageName).toBe('testStorageName')

    // Test init
    syncState.init = true
    expect(syncState.init).toBe(true)

    // Test refNum
    syncState.refNum = 'testRefNum'
    expect(syncState.refNum).toBe('testRefNum')

    // Test status
    syncState.status = 'success'
    expect(syncState.status).toBe('success')

    // Test when
    const whenDate = new Date()
    syncState.when = whenDate
    expect(syncState.when).toBe(whenDate)

    // Test satoshis
    syncState.satoshis = 1000
    expect(syncState.satoshis).toBe(1000)
  })

  // Test: Derived properties apiErrorLocal, apiErrorOther, and apiSyncMap
  test('8_derived_properties', () => {
    const syncState = new EntitySyncState()

    // Test apiErrorLocal and apiErrorOther
    syncState.errorLocal = {
      code: 'test_code',
      description: 'test_description',
      stack: 'test_stack'
    }
    syncState.errorOther = {
      code: 'test_code2',
      description: 'test_description2',
      stack: 'test_stack2'
    }
    expect(syncState.apiErrorLocal).toBe(JSON.stringify(syncState.errorLocal))
    expect(syncState.apiErrorOther).toBe(JSON.stringify(syncState.errorOther))

    const syncMap = createSyncMap()
    syncMap.provenTx.idMap = { 1: 2 }
    syncMap.provenTx.count = 1
    syncMap.transaction.idMap = { 3: 4 }
    syncMap.transaction.count = 1

    syncState.syncMap = syncMap
    expect(syncState.apiSyncMap).toBe(JSON.stringify(syncMap))
  })

  // Test: id, entityName, and entityTable getters
  test('9_id_entityName_entityTable', () => {
    const syncState = new EntitySyncState()

    // Test id getter and setter
    syncState.id = 42
    expect(syncState.id).toBe(42)

    // Test entityName
    expect(syncState.entityName).toBe('syncState')

    // Test entityTable
    expect(syncState.entityTable).toBe('sync_states')
  })

  // Test: mergeNew method (does not perform any operations)
  test('10_mergeNew_does_nothing', async () => {
    const syncState = new EntitySyncState()
    const mockStorage: EntityStorage = {} as EntityStorage

    const syncMap = createSyncMap()

    await expect(syncState.mergeNew(mockStorage, 1, syncMap, undefined)).resolves.toBeUndefined()
  })

  // Test: mergeExisting method (always returns false)
  test('11_mergeExisting_always_returns_false', async () => {
    const syncState = new EntitySyncState()
    const mockStorage: EntityStorage = {} as EntityStorage

    const syncMap = createSyncMap()

    const result = await syncState.mergeExisting(mockStorage, new Date(), {} as TableSyncState, syncMap, undefined)
    expect(result).toBe(false)
  })
})