ipfs-bch-wallet-service/test/unit/adapters/ipfs-index.adapter.unit.js

/*
  Unit tests for the index.js file for the IPFS and ipfs-coord libraries.
*/

import { assert } from 'chai'
import BCHJS from '@psf/bch-js'

import sinon from 'sinon'
import IPFSLib from '../../../src/adapters/ipfs/index.js'
// import create from '../mocks/ipfs-mock.js'
import IPFSCoordMock from '../mocks/ipfs-coord-mock.js'

describe('#IPFS-adapter-index', () => {
  let uut
  let sandbox
  let bchjs

  beforeEach(() => {
    bchjs = new BCHJS({ restURL: 'https://api.fullstack.cash/v5/' })
    uut = new IPFSLib({ bchjs })

    sandbox = sinon.createSandbox()
  })

  afterEach(() => sandbox.restore())

  describe('#start', () => {
    it('should throw error if bch-js is not passed', async () => {
      try {
        await uut.start()

        assert.fail('Unexpected code path.')
      } catch (err) {
        // console.log(err)
        assert.include(
          err.message,
          'Instance of bch-js must be passed when instantiating IPFS adapter.'
        )
      }
    })

    it('should return a promise that resolves into an instance of IPFS.', async () => {
      // Mock dependencies.
      uut.ipfsAdapter = {
        start: async () => {}
      }
      uut.IpfsCoordAdapter = IPFSCoordMock

      const result = await uut.start({ bchjs: {} })

      assert.equal(result, true)
    })

    it('should catch and throw an error', async () => {
      try {
        // Force an error
        sandbox.stub(uut.ipfsAdapter, 'start').rejects(new Error('test error'))

        await uut.start({ bchjs: {} })

        assert.fail('Unexpected code path.')
      } catch (err) {
        // console.log(err)
        assert.include(err.message, 'test error')
      }
    })

    it('should handle lock-file errors', async () => {
      try {
        // Force an error
        sandbox
          .stub(uut.ipfsAdapter, 'start')
          .rejects(new Error('Lock already being held'))

        // Prevent process from exiting
        sandbox.stub(uut.process, 'exit').returns()

        await uut.start({ bchjs })

        assert.fail('Unexpected code path.')
      } catch (err) {
        assert.include(err.message, 'Lock already being held')
      }
    })
  })

  describe('#getStatus', () => {
    it('should return an object with node metrics', () => {
      // Force uut to have the needed properties
      uut.ipfsCoordAdapter = {
        ipfsCoord: {
          thisNode: {
            ipfsId: 'fake-id',
            ipfsMultiaddrs: [],
            bchAddr: 'fake-bch-addr',
            slpAddr: 'fake-slp-addr',
            pubKey: 'fake-pubkey',
            peerList: [],
            relayData: []
          }
        }
      }

      const result = uut.getStatus()
      // console.log('result: ', result)

      assert.property(result, 'ipfsId')
      assert.property(result, 'multiAddrs')
      assert.property(result, 'bchAddr')
      assert.property(result, 'slpAddr')
      assert.property(result, 'pubKey')
      assert.property(result, 'peers')
      assert.property(result, 'relays')
    })

    it('should catch, report, and throw errors', () => {
      try {
        uut.getStatus()

        assert.fail('Unexpected code path')
      } catch (err) {
        // console.log('err.message: ', err.message)
        assert.include(err.message, 'Cannot read properties')
      }
    })
  })

  describe('#_removeDuplicatePeers', () => {
    it('should return the same array when there are no duplicates', () => {
      const inArray = [
        '12D3KooWPpBXhhAeoCZCGuQ3KR4xwHzzvtP57f6zLmo8P7ZFBJFE',
        '12D3KooWRBhwfeP2Y9CDkFRBAZ1pmxUadH36TKuk3KtKm5XXP8mA',
        '12D3KooWGsgHWyDLKuV4ZSfRJfsxQJj77rxx3i8Px3qXKHsLN7a2',
        '12D3KooWJyc54njjeZGbLew4D8u1ghrmZTTPyh3QpBF7dxtd3zGY',
        '12D3KooWDtj9cfj1SKuLbDNKvKRKSsGN8qivq9M8CYpLPDpcD5pu'
      ]

      const result = uut._removeDuplicatePeers(inArray)
      // console.log('result: ', result)

      assert.equal(result.length, inArray.length)
    })

    it('should remove duplicates from an array', () => {
      const inArray = [
        '12D3KooWPpBXhhAeoCZCGuQ3KR4xwHzzvtP57f6zLmo8P7ZFBJFE',
        '12D3KooWRBhwfeP2Y9CDkFRBAZ1pmxUadH36TKuk3KtKm5XXP8mA',
        '12D3KooWGsgHWyDLKuV4ZSfRJfsxQJj77rxx3i8Px3qXKHsLN7a2',
        '12D3KooWJyc54njjeZGbLew4D8u1ghrmZTTPyh3QpBF7dxtd3zGY',
        '12D3KooWDtj9cfj1SKuLbDNKvKRKSsGN8qivq9M8CYpLPDpcD5pu',
        '12D3KooWPpBXhhAeoCZCGuQ3KR4xwHzzvtP57f6zLmo8P7ZFBJFE',
        '12D3KooWRBhwfeP2Y9CDkFRBAZ1pmxUadH36TKuk3KtKm5XXP8mA'
      ]

      const result = uut._removeDuplicatePeers(inArray)
      // console.log('result: ', result)

      assert.equal(result.length, inArray.length - 2)
    })
  })

  describe('#getPeers', () => {
    it('should return an array of current JSON data about each peer when showAll is true', async () => {
      // Mock dependencies
      uut.ipfsCoordAdapter.ipfsCoord = {
        thisNode: {
          peerData: [{ from: 'a', data: { jsonLd: { name: 'a', protocol: 'test', version: '1' } } }, { from: 'b' }]
        },
        adapters: {
          ipfs: {
            getPeers: async () => ['a', 'b']
          }
        }
      }

      const result = await uut.getPeers(true)

      assert.isArray(result)
    })

    it('should catch, report, and throw errors', async () => {
      try {
        // Force an error
        uut.ipfsCoordAdapter.ipfsCoord = {
          thisNode: {},
          adapters: {
            ipfs: {
              getPeers: async () => { throw new Error('test error') }
            }
          }
        }

        await uut.getPeers()

        assert.fail('Unexpected code path')
      } catch (err) {
        // console.log('err.message: ', err.message)
        assert.include(err.message, 'test error')
      }
    })
  })

  describe('#getRelays', () => {
    it('should return known relays', () => {
      uut.ipfsCoordAdapter.ipfsCoord = {
        thisNode: {
          peerData: [{ from: 'a', data: { jsonLd: { name: 'a', description: 'test' } } }, { from: 'b' }],
          relayData: [{ ipfsId: 'c' }, { ipfsId: 'a' }]
        }
      }

      const result = uut.getRelays()
      // console.log('result: ', result)

      assert.isArray(result.v2Relays)
      assert.equal(result.v2Relays.length, 2)
      assert.property(result.v2Relays[0], 'name')
      assert.property(result.v2Relays[0], 'description')
      assert.property(result.v2Relays[1], 'name')
      assert.property(result.v2Relays[1], 'description')
    })

    it('should catch, report, and throw errors', () => {
      try {
        // Force an error
        uut.ipfsCoordAdapter.ipfsCoord = { thisNode: {} }

        uut.getRelays()

        assert.fail('Unexpected code path')
      } catch (err) {
        // console.log('err.message: ', err.message)
        assert.include(err.message, 'Cannot read')
      }
    })
  })
})