orbitdb/test/orbitdb-open.test.js

import { deepStrictEqual, strictEqual, notStrictEqual } from 'assert'
import rmrf from 'rimraf'
import fs from 'fs'
import path from 'path'
import { OrbitDB, isValidAddress } from '../src/index.js'
import { KeyValuePersisted } from '../src/db/index.js'

// Test utils
import { config, testAPIs, startIpfs, stopIpfs } from 'orbit-db-test-utils'
import connectPeers from './utils/connect-nodes.js'
import waitFor from './utils/wait-for.js'

Object.keys(testAPIs).forEach((IPFS) => {
  describe('Open databases (' + IPFS + ')', function () {
    this.timeout(config.timeout)

    let ipfsd1, ipfsd2
    let ipfs1, ipfs2
    let orbitdb1, orbitdb2

    before(async () => {
      ipfsd1 = await startIpfs(IPFS, config.daemon1)
      ipfsd2 = await startIpfs(IPFS, config.daemon2)
      ipfs1 = ipfsd1.api
      ipfs2 = ipfsd2.api

      await connectPeers(ipfs1, ipfs2)

      await rmrf('./orbitdb')
      await rmrf('./orbitdb1')
      await rmrf('./orbitdb2')
    })

    after(async () => {
      if (ipfsd1) {
        await stopIpfs(ipfsd1)
      }
      if (ipfsd2) {
        await stopIpfs(ipfsd2)
      }

      await rmrf('./orbitdb')
      await rmrf('./orbitdb1')
      await rmrf('./orbitdb2')
    })

    describe('creating a database instance', () => {
      let db

      before(async () => {
        orbitdb1 = await OrbitDB({ ipfs: ipfs1, id: 'user1', directory: './orbitdb1' })
        db = await orbitdb1.open('helloworld')
      })

      after(async () => {
        if (db) {
          await db.drop()
          await db.close()
        }
        if (orbitdb1) {
          await orbitdb1.stop()
        }
        await rmrf('./orbitdb1')
      })

      it('creates a database instance', async () => {
        notStrictEqual(db, undefined)
      })

      it('has an address', async () => {
        notStrictEqual(db.address, undefined)
      })

      it('has a valid OrbitDB address', async () => {
        strictEqual(isValidAddress(db.address), true)
      })

      it('has a name', async () => {
        strictEqual(db.name, 'helloworld')
      })

      it('has an identity', async () => {
        notStrictEqual(db.identity, undefined)
      })

      it('has a close function', async () => {
        notStrictEqual(db.close, undefined)
        strictEqual(typeof db.close, 'function')
      })

      it('has a drop function', async () => {
        notStrictEqual(db.drop, undefined)
        strictEqual(typeof db.drop, 'function')
      })

      it('has a addOperation function', async () => {
        notStrictEqual(db.addOperation, undefined)
        strictEqual(typeof db.addOperation, 'function')
      })

      it('has a log', async () => {
        notStrictEqual(db.log, undefined)
      })

      it('has a log where the logId matches the databaseId', async () => {
        strictEqual(db.log.id, db.address.toString())
      })

      it('has a events emitter', async () => {
        notStrictEqual(db.events, undefined)
      })

      it('has a type', async () => {
        notStrictEqual(db.type, undefined)
      })

      it('has a type that equals the database type', async () => {
        strictEqual(db.type, 'eventstore')
      })

      it('has a put function', async () => {
        notStrictEqual(db.put, undefined)
        strictEqual(typeof db.put, 'function')
      })

      it('has a add function', async () => {
        notStrictEqual(db.add, undefined)
        strictEqual(typeof db.add, 'function')
      })

      it('has a get function', async () => {
        notStrictEqual(db.get, undefined)
        strictEqual(typeof db.get, 'function')
      })

      it('has an iterator function', async () => {
        notStrictEqual(db.iterator, undefined)
        strictEqual(typeof db.iterator, 'function')
      })

      it('has an all function', async () => {
        notStrictEqual(db.all, undefined)
        strictEqual(typeof db.all, 'function')
      })

      it('creates a directory for the database oplog', async () => {
        const expectedPath = path.join(orbitdb1.directory, `./${db.address.path}`, '/log/_heads')
        const directoryExists = fs.existsSync(expectedPath)
        strictEqual(directoryExists, true)
      })
    })

    describe('opening a database', () => {
      let db

      const amount = 10

      before(async () => {
        orbitdb1 = await OrbitDB({ ipfs: ipfs1, id: 'user1' })
        db = await orbitdb1.open('helloworld')

        for (let i = 0; i < amount; i++) {
          await db.add('hello' + i)
        }

        await db.close()
      })

      after(async () => {
        if (db) {
          await db.close()
        }
        if (orbitdb1) {
          await orbitdb1.stop()
        }
        await rmrf('./orbitdb')
      })

      it('returns all entries in the database', async () => {
        db = await orbitdb1.open('helloworld')

        strictEqual(db.type, 'eventstore')
        strictEqual(db.name, 'helloworld')

        const expected = []
        for (let i = 0; i < amount; i++) {
          expected.push('hello' + i)
        }

        const all = []
        for await (const event of db.iterator()) {
          all.unshift(event)
        }

        deepStrictEqual(all, expected)
      })
    })

    describe('opening a database as a different user', () => {
      let db, address

      const amount = 10

      before(async () => {
        orbitdb1 = await OrbitDB({ ipfs: ipfs1, id: 'user1' })
        db = await orbitdb1.open('helloworld')

        for (let i = 0; i < amount; i++) {
          await db.add('hello' + i)
        }

        address = db.address

        await db.close()
        await orbitdb1.stop()

        orbitdb2 = await OrbitDB({ ipfs: ipfs2, id: 'user2' })
      })

      after(async () => {
        if (db) {
          await db.close()
        }
        if (orbitdb2) {
          await orbitdb2.stop()
        }
        await rmrf('./orbitdb')
      })

      it('returns all entries in the database', async () => {
        db = await orbitdb2.open(address)

        strictEqual(db.type, 'eventstore')
        strictEqual(db.name, 'helloworld')

        const expected = []
        for (let i = 0; i < amount; i++) {
          expected.push('hello' + i)
        }

        const all = []
        for await (const event of db.iterator()) {
          all.unshift(event)
        }

        deepStrictEqual(all, expected)
      })
    })

    describe('opening a replicated database', () => {
      let db1, db2
      let address

      const amount = 10

      before(async () => {
        orbitdb1 = await OrbitDB({ ipfs: ipfs1, id: 'user1', directory: './orbitdb1' })
        orbitdb2 = await OrbitDB({ ipfs: ipfs2, id: 'user2', directory: './orbitdb2' })
        db1 = await orbitdb1.open('helloworld2')
        for (let i = 0; i < amount; i++) {
          await db1.add('hello' + i)
        }
        address = db1.address
      })

      after(async () => {
        if (db1) {
          await db1.close()
        }
        if (db2) {
          await db2.close()
        }
        if (orbitdb1) {
          await orbitdb1.stop()
        }
        if (orbitdb2) {
          await orbitdb2.stop()
        }
        await rmrf('./orbitdb1')
        await rmrf('./orbitdb2')
      })

      it('replicates the database', async () => {
        console.time('replicate')
        let updateCount = 0
        let connected = false

        const onError = (err) => {
          console.error(err)
        }

        const onConnected = async (peerId) => {
          connected = true
        }

        const onUpdate = (entry) => {
          ++updateCount
        }

        db2 = await orbitdb2.open(address)

        db2.events.on('error', onError)
        db2.events.on('update', onUpdate)
        db2.events.on('join', onConnected)

        await waitFor(() => connected, () => true)
        await waitFor(() => updateCount > 0, () => true)

        const expected = []
        for (let i = 0; i < amount; i++) {
          expected.push('hello' + i)
        }

        const all = []
        for await (const event of db2.iterator()) {
          all.unshift(event)
        }
        console.timeEnd('replicate')

        deepStrictEqual(all, expected)
      })

      it('opens the replicated database', async () => {
        if (db1) {
          await db1.drop()
          await db1.close()
          db1 = null
        }
        if (db2) {
          await db2.close()
        }
        if (orbitdb1) {
          await orbitdb1.stop()
          orbitdb1 = null
        }

        db2 = await orbitdb2.open(address)

        const expected = []
        for (let i = 0; i < amount; i++) {
          expected.push('hello' + i)
        }

        const all = []
        for await (const event of db2.iterator()) {
          all.unshift(event)
        }

        deepStrictEqual(all, expected)
      })
    })

    describe('opening a keyvalue database', () => {
      let db, address

      const amount = 10

      before(async () => {
        orbitdb1 = await OrbitDB({ ipfs: ipfs1, id: 'user1' })
        db = await orbitdb1.open('helloworld', { type: 'keyvalue' })
        address = db.address

        for (let i = 0; i < amount; i++) {
          await db.put('hello' + i, 'hello' + i)
        }

        await db.close()
      })

      after(async () => {
        if (db) {
          await db.close()
        }
        if (orbitdb1) {
          await orbitdb1.stop()
        }
        await rmrf('./orbitdb')
      })

      it('returns all entries in the database', async () => {
        db = await orbitdb1.open(address)

        strictEqual(db.type, 'keyvalue')
        strictEqual(db.name, 'helloworld')

        const expected = []
        for (let i = 0; i < amount; i++) {
          expected.push({ key: 'hello' + i, value: 'hello' + i })
        }

        const all = []
        for await (const { key, value } of db.iterator()) {
          all.unshift({ key, value })
        }

        deepStrictEqual(all, expected)
      })

      it('opens the database with a custom Store - KeyValuePersisted', async () => {
        if (db) {
          await db.close()
        }

        db = await orbitdb1.open(address, { Store: KeyValuePersisted })

        strictEqual(db.type, 'keyvalue')
        strictEqual(db.name, 'helloworld')

        const expected = []
        for (let i = 0; i < amount; i++) {
          expected.push({ key: 'hello' + i, value: 'hello' + i })
        }

        const all = []
        for await (const { key, value } of db.iterator()) {
          all.unshift({ key, value })
        }

        deepStrictEqual(all, expected)
      })
    })

    describe('opening an documents database', () => {
      let db, address

      const amount = 10

      before(async () => {
        orbitdb1 = await OrbitDB({ ipfs: ipfs1, id: 'user1' })
        db = await orbitdb1.open('helloworld', { type: 'documents' })
        address = db.address

        for (let i = 0; i < amount; i++) {
          await db.put({ _id: 'hello' + i, msg: 'hello' + i })
        }

        await db.close()
      })

      after(async () => {
        if (db) {
          await db.close()
        }
        if (orbitdb1) {
          await orbitdb1.stop()
        }
        await rmrf('./orbitdb')
      })

      it('returns all entries in the database', async () => {
        db = await orbitdb1.open(address)

        strictEqual(db.type, 'documentstore')
        strictEqual(db.name, 'helloworld')

        const expected = []
        for (let i = 0; i < amount; i++) {
          expected.push({ _id: 'hello' + i, msg: 'hello' + i })
        }

        const all = []
        for await (const doc of db.iterator()) {
          all.unshift(doc)
        }

        deepStrictEqual(all, expected)
      })
    })
  })
})