@mojaloop/central-services-shared/test/unit/util/comparators/duplicateCheckComparator.test.js

Shared code for mojaloop central services

/*****
 License
 --------------
 Copyright © 2020-2025 Mojaloop Foundation
 The Mojaloop files are made available by the Mojaloop Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

 Contributors
 --------------
 This is the official list of the Mojaloop project contributors for this file.
 Names of the original copyright holders (individuals or organizations)
 should be listed with a '*' in the first column. People who have
 contributed from an organization can be listed under the organization
 that actually holds the copyright for their contributions (see the
 Mojaloop Foundation for an example). Those individuals should have
 their names indented and be marked with a '-'. Email address can be added
 optionally within square brackets <email>.

 * Mojaloop Foundation
 - Name Surname <name.surname@mojaloop.io>

 * Georgi Georgiev <georgi.georgiev@modusbox.com>
 --------------
 ******/

'use strict'

const Test = require('tapes')(require('tape'))
const Sinon = require('sinon')
const Proxyquire = require('proxyquire')
const Logger = require('@mojaloop/central-services-logger')

Test('Duplicate check comparator', dccTest => {
  let sandbox

  dccTest.beforeEach(t => {
    sandbox = Sinon.createSandbox()
    t.end()
  })

  dccTest.afterEach(t => {
    sandbox.restore()
    t.end()
  })

  dccTest.test('duplicateCheckComparator should', duplicateCheckComparatorTest => {
    duplicateCheckComparatorTest.test('compare hashes when id exists', async test => {
      try {
        // Arrange
        const hash = 'helper.hash'
        const duplicateCheckComparator = Proxyquire('#src/util/comparators/duplicateCheckComparator', {
          '../hash': {
            generateSha256: sandbox.stub().returns(hash)
          }
        })
        const id = 1
        const object = { key: 'value' }
        const getDuplicateDataFuncOverrideResult = { id, hash }
        const getDuplicateDataFuncOverride = sandbox.stub().resolves(getDuplicateDataFuncOverrideResult)
        const saveHashFuncOverride = sandbox.stub().resolves(true)

        const expected = {
          hasDuplicateId: true,
          hasDuplicateHash: true,
          saveHashFuncOverrideResult: false,
          duplicateHashRecordResult: getDuplicateDataFuncOverrideResult
        }

        // Act
        const result = await duplicateCheckComparator(id, object, getDuplicateDataFuncOverride, saveHashFuncOverride)

        // Assert
        test.deepEqual(result, expected, 'hash matched')
        test.ok(saveHashFuncOverride.called === false)
        test.end()
      } catch (err) {
        // Assert
        Logger.error(`duplicateCheckComparator failed with error - ${err}`)
        test.fail()
        test.end()
      }
    })

    duplicateCheckComparatorTest.test('save hash when id not found', async test => {
      try {
        // Arrange
        const hash = 'helper.hash'
        const duplicateCheckComparator = Proxyquire('#src/util/comparators/duplicateCheckComparator', {
          '../hash': {
            generateSha256: sandbox.stub().returns(hash)
          }
        })
        const id = 1
        const object = { key: 'value' }
        const getDuplicateDataFuncOverride = sandbox.stub().resolves(null)
        const saveHashFuncOverride = sandbox.stub().resolves(true)

        const expected = {
          hasDuplicateId: false,
          hasDuplicateHash: false,
          saveHashFuncOverrideResult: true,
          duplicateHashRecordResult: null
        }

        // Act
        const result = await duplicateCheckComparator(id, object, getDuplicateDataFuncOverride, saveHashFuncOverride)

        // Assert
        test.deepEqual(result, expected, 'hash saved')
        test.ok(saveHashFuncOverride.calledOnceWith(id, hash))
        test.end()
      } catch (err) {
        // Assert
        Logger.error(`duplicateCheckComparator failed with error - ${err}`)
        test.fail()
        test.end()
      }
    })

    duplicateCheckComparatorTest.test('compare hashes when id exists and generatedHashOverride is injected', async test => {
      try {
        // Arrange
        const hash = 'helper.hash'
        const generatedHashOverride = 'helper.hash.override'
        const duplicateCheckComparator = Proxyquire('#src/util/comparators/duplicateCheckComparator', {
          '../hash': {
            generateSha256: sandbox.stub().returns(hash)
          }
        })
        const id = 1
        const getDuplicateDataFuncOverrideResult = { id, hash: generatedHashOverride }
        const getDuplicateDataFuncOverride = sandbox.stub().resolves(getDuplicateDataFuncOverrideResult)
        const saveHashFuncOverride = sandbox.stub().resolves(true)

        const expected = {
          hasDuplicateId: true,
          hasDuplicateHash: true,
          duplicateHashRecordResult: getDuplicateDataFuncOverrideResult,
          saveHashFuncOverrideResult: false
        }

        // Act
        const result = await duplicateCheckComparator(id, generatedHashOverride, getDuplicateDataFuncOverride, saveHashFuncOverride, {
          hashOverride: true
        })

        // Assert
        test.deepEqual(result, expected, 'hash matched')
        test.ok(saveHashFuncOverride.called === false)
        test.end()
      } catch (err) {
        // Assert
        Logger.error(`duplicateCheckComparator failed with error - ${err}`)
        test.fail()
        test.end()
      }
    })

    duplicateCheckComparatorTest.test('save hash when id not found and generatedHashOverride is injected', async test => {
      try {
        // Arrange
        const hash = 'helper.hash'
        const generatedHashOverride = 'helper.hash.override'
        const duplicateCheckComparator = Proxyquire('#src/util/comparators/duplicateCheckComparator', {
          '../hash': {
            generateSha256: sandbox.stub().returns(hash)
          }
        })
        const id = 1
        const getDuplicateDataFuncOverride = sandbox.stub().resolves(null)
        const saveHashFuncOverride = sandbox.stub().resolves(true)

        const expected = {
          hasDuplicateId: false,
          hasDuplicateHash: false,
          saveHashFuncOverrideResult: true,
          duplicateHashRecordResult: null
        }

        // Act
        const result = await duplicateCheckComparator(id, generatedHashOverride, getDuplicateDataFuncOverride, saveHashFuncOverride, {
          hashOverride: true
        })

        // Assert
        test.deepEqual(result, expected, 'hash saved')
        test.ok(saveHashFuncOverride.calledOnceWith(id, generatedHashOverride))
        test.end()
      } catch (err) {
        // Assert
        Logger.error(`duplicateCheckComparator failed with error - ${err}`)
        test.fail()
        test.end()
      }
    })

    duplicateCheckComparatorTest.test('save hash when id not found with empty object and generatedHashOverride is injected', async test => {
      try {
        // Arrange
        const hash = 'helper.hash'
        const generatedHashOverride = 'helper.hash.override'
        const duplicateCheckComparator = Proxyquire('#src/util/comparators/duplicateCheckComparator', {
          '../hash': {
            generateSha256: sandbox.stub().returns(hash)
          }
        })
        const id = 1
        const object = null // We don't actually care about the object when we override the hash by setting the generatedHashOverride
        const getDuplicateDataFuncOverride = sandbox.stub().resolves(null)
        const saveHashFuncOverride = sandbox.stub().resolves(true)

        const expected = {
          hasDuplicateId: false,
          hasDuplicateHash: false
        }

        // Act
        const result = await duplicateCheckComparator(id, object, getDuplicateDataFuncOverride, saveHashFuncOverride, {
          hashOverride: false
        })

        // Assert
        test.deepEqual(result, expected, 'hash saved')
        test.ok(saveHashFuncOverride.calledOnceWith(id, generatedHashOverride))
        test.fail()
        test.end()
      } catch (err) {
        // Assert
        Logger.error(`duplicateCheckComparator failed with error - ${err}`)
        test.ok(err)
        test.end()
      }
    })

    duplicateCheckComparatorTest.test('save hash when id not found with empty object and generatedHashOverride is injected', async test => {
      try {
        // Arrange
        const hash = 'helper.hash'
        const generatedHashOverride = 'helper.hash.override'
        const duplicateCheckComparator = Proxyquire('#src/util/comparators/duplicateCheckComparator', {
          '../hash': {
            generateSha256: sandbox.stub().returns(hash)
          }
        })
        const id = 1
        const object = null // We don't actually care about the object when we override the hash by setting the generatedHashOverride
        const getDuplicateDataFuncOverride = sandbox.stub().resolves(null)
        const saveHashFuncOverride = sandbox.stub().resolves(true)

        const expected = {
          hasDuplicateId: false,
          hasDuplicateHash: false
        }

        // Act
        const result = await duplicateCheckComparator(id, object, getDuplicateDataFuncOverride, saveHashFuncOverride, {
          hashOverride: true
        })

        // Assert
        test.deepEqual(result, expected, 'hash saved')
        test.ok(saveHashFuncOverride.calledOnceWith(id, generatedHashOverride))
        test.fail()
        test.end()
      } catch (err) {
        // Assert
        Logger.error(`duplicateCheckComparator failed with error - ${err}`)
        test.ok(err)
        test.end()
      }
    })

    duplicateCheckComparatorTest.end()
  })

  dccTest.end()
})