pzp-db/test/getTangle.test.js

const test = require('node:test')
const assert = require('node:assert')
const path = require('node:path')
const os = require('node:os')
const p = require('node:util').promisify
const rimraf = require('rimraf')
const SecretStack = require('secret-stack')
const caps = require('ppppp-caps')
const Keypair = require('ppppp-keypair')

const DIR = path.join(os.tmpdir(), 'ppppp-db-tangle')
rimraf.sync(DIR)

let peer
let rootPost, reply1Lo, reply1Hi, reply2A, reply3Lo, reply3Hi
let tangle
test('setup', async (t) => {
  const keypairA = Keypair.generate('ed25519', 'alice')
  const keypairB = Keypair.generate('ed25519', 'bob')
  const keypairC = Keypair.generate('ed25519', 'carol')

  peer = SecretStack({ appKey: caps.shse })
    .use(require('../lib'))
    .use(require('ssb-box'))
    .call(null, { keypair: keypairA, path: DIR })

  await peer.db.loaded()

  const id = (await p(peer.db.identity.create)({domain: 'person'}))

  // Slow down append so that we can trigger msg creation in parallel
  const originalAppend = peer.db._getLog().append
  peer.db._getLog().append = function (...args) {
    setTimeout(originalAppend, 20, ...args)
  }

  rootPost = (
    await p(peer.db.feed.publish)({
      identity: id,
      keypair: keypairA,
      domain: 'comment',
      data: { text: 'root' },
    })
  ).hash

  const [{ hash: reply1B }, { hash: reply1C }] = await Promise.all([
    p(peer.db.feed.publish)({
      identity: id,
      keypair: keypairB,
      domain: 'comment',
      data: { text: 'reply 1B' },
      tangles: [rootPost],
    }),
    p(peer.db.feed.publish)({
      identity: id,
      keypair: keypairC,
      domain: 'comment',
      data: { text: 'reply 1C' },
      tangles: [rootPost],
    }),
  ])
  reply1Lo = reply1B.localeCompare(reply1C) < 0 ? reply1B : reply1C
  reply1Hi = reply1B.localeCompare(reply1C) < 0 ? reply1C : reply1B

  reply2A = (
    await p(peer.db.feed.publish)({
      identity: id,
      keypair: keypairA,
      domain: 'comment',
      data: { text: 'reply 2' },
      tangles: [rootPost],
    })
  ).hash

  const [{ hash: reply3B }, { hash: reply3C }] = await Promise.all([
    p(peer.db.feed.publish)({
      identity: id,
      keypair: keypairB,
      domain: 'comment',
      data: { text: 'reply 3B' },
      tangles: [rootPost],
    }),
    p(peer.db.feed.publish)({
      identity: id,
      keypair: keypairC,
      domain: 'comment',
      data: { text: 'reply 3C' },
      tangles: [rootPost],
    }),
  ])
  reply3Lo = reply3B.localeCompare(reply3C) < 0 ? reply3B : reply3C
  reply3Hi = reply3B.localeCompare(reply3C) < 0 ? reply3C : reply3B

  tangle = peer.db.getTangle(rootPost)
})

test('Tangle.has', (t) => {
  assert.equal(tangle.has(rootPost), true, 'has rootPost')
  assert.equal(tangle.has(reply1Lo), true, 'has reply1Lo')
  assert.equal(tangle.has(reply1Hi), true, 'has reply1Hi')
  assert.equal(tangle.has(reply2A), true, 'has reply2A')
  assert.equal(tangle.has(reply3Lo), true, 'has reply3Lo')
  assert.equal(tangle.has(reply3Hi), true, 'has reply3Hi')
  assert.equal(tangle.has('nonsense'), false, 'does not have nonsense')
})

test('Tangle.getDepth', (t) => {
  assert.equal(tangle.getDepth(rootPost), 0, 'depth of rootPost is 0')
  assert.equal(tangle.getDepth(reply1Lo), 1, 'depth of reply1Lo is 1')
  assert.equal(tangle.getDepth(reply1Hi), 1, 'depth of reply1Hi is 1')
  assert.equal(tangle.getDepth(reply2A), 2, 'depth of reply2A is 2')
  assert.equal(tangle.getDepth(reply3Lo), 3, 'depth of reply3Lo is 3')
  assert.equal(tangle.getDepth(reply3Hi), 3, 'depth of reply3Hi is 3')
})

test('Tangle.getMaxDepth', (t) => {
  assert.equal(tangle.getMaxDepth(), 3, 'max depth is 3')
})

test('Tangle.topoSort', (t) => {
  const sorted = tangle.topoSort()

  assert.deepEqual(sorted, [
    rootPost,
    reply1Lo,
    reply1Hi,
    reply2A,
    reply3Lo,
    reply3Hi,
  ])
})

test('Tangle.precedes', (t) => {
  assert.equal(
    tangle.precedes(rootPost, reply1Lo),
    true,
    'rootPost precedes reply1Lo'
  )
  assert.equal(
    tangle.precedes(rootPost, reply1Hi),
    true,
    'rootPost precedes reply1Hi'
  )
  assert.equal(
    tangle.precedes(reply1Hi, rootPost),
    false,
    'reply1Hi doesnt precede rootPost'
  )
  assert.equal(
    tangle.precedes(reply1Lo, reply1Hi),
    false,
    'reply1Lo doesnt precede reply1Hi'
  )
  assert.equal(
    tangle.precedes(reply1Lo, reply1Lo),
    false,
    'reply1Lo doesnt precede itself'
  )
  assert.equal(
    tangle.precedes(reply1Lo, reply3Hi),
    true,
    'reply1Lo precedes reply3Hi'
  )
  assert.equal(
    tangle.precedes(reply1Hi, reply2A),
    true,
    'reply1Hi precedes reply2A'
  )
  assert.equal(
    tangle.precedes(reply3Lo, reply1Hi),
    false,
    'reply3Lo doesnt precede reply1Hi'
  )
})

test('Tangle.getTips', (t) => {
  const tips = tangle.getTips()

  assert.equal(tips.size, 2, 'there are 2 tips')
  assert.equal(tips.has(reply3Lo), true, 'tips contains reply3Lo')
  assert.equal(tips.has(reply3Hi), true, 'tips contains reply3Hi')
})

test('Tangle.getLipmaaSet', (t) => {
  assert.equal(tangle.getLipmaaSet(0).size, 0, 'lipmaa 0 (empty)')

  assert.equal(tangle.getLipmaaSet(1).size, 1, 'lipmaa 1 (-1)')
  assert.equal(tangle.getLipmaaSet(1).has(rootPost), true, 'lipmaa 1 (-1)')

  assert.equal(tangle.getLipmaaSet(2).size, 2, 'lipmaa 2 (-1)')
  assert.equal(tangle.getLipmaaSet(2).has(reply1Lo), true, 'lipmaa 2 (-1)')
  assert.equal(tangle.getLipmaaSet(2).has(reply1Hi), true, 'lipmaa 2 (-1)')

  assert.equal(tangle.getLipmaaSet(3).size, 1, 'lipmaa 3 (leap!)')
  assert.equal(tangle.getLipmaaSet(3).has(rootPost), true, 'lipmaa 3 (leap!)')

  assert.equal(tangle.getLipmaaSet(4).size, 2, 'lipmaa 4 (-1)')
  assert.equal(tangle.getLipmaaSet(4).has(reply3Lo), true, 'lipmaa 4 (-1)')
  assert.equal(tangle.getLipmaaSet(4).has(reply3Hi), true, 'lipmaa 4 (-1)')

  assert.equal(tangle.getLipmaaSet(5).size, 0, 'lipmaa 5 (empty)')
})

test('Tangle.getDeletablesAndErasables basic', (t) => {
  const { deletables, erasables } = tangle.getDeletablesAndErasables(reply2A)

  assert.deepEqual(deletables, [reply1Hi], 'deletables')
  assert.deepEqual(erasables, [reply1Lo, rootPost], 'erasables')
})

test('Tangle.getDeletablesAndErasables with lipmaa', (t) => {
  const { deletables, erasables } = tangle.getDeletablesAndErasables(reply3Lo)

  assert.deepEqual(deletables, [reply1Lo, reply1Hi, reply2A], 'deletables')
  assert.deepEqual(erasables, [rootPost], 'erasables')
})

test('Tangle.topoSort after some have been deleted and erased', async (t) => {
  const { deletables, erasables } = tangle.getDeletablesAndErasables(reply3Lo)
  for (const msgHash of deletables) {
    await p(peer.db.del)(msgHash)
  }
  for (const msgHash of erasables) {
    await p(peer.db.erase)(msgHash)
  }

  const tangle2 = peer.db.getTangle(rootPost)
  const sorted = tangle2.topoSort()

  assert.deepEqual(sorted, [rootPost, reply3Lo, reply3Hi])
})

test('teardown', async (t) => {
  await p(peer.close)(true)
})