psf-memo/psf-memo-client/test/unit/profiles.test.js

/*
  Unit tests for the in-memory profile store.

  The profile store keeps display names and bios indexed by BCH cash address
  so that pages stay in sync immediately after a broadcast.
*/

'use strict'

const test = require('node:test')
const assert = require('node:assert/strict')
const Profiles = require('../../src/services/profiles')

test('setName stores and getName retrieves a display name', () => {
  const profiles = new Profiles()
  const addr = 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'

  profiles.setName(addr, 'trout')

  assert.equal(profiles.getName(addr), 'trout')
})

test('getName returns null for an unknown address', () => {
  const profiles = new Profiles()
  const addr = 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'

  assert.equal(profiles.getName(addr), null)
})

test('setName with no address does nothing', () => {
  const profiles = new Profiles()

  profiles.setName('', 'trout')

  assert.equal(profiles.getName(''), null)
})

test('setBio stores and getBio retrieves a bio', () => {
  const profiles = new Profiles()
  const addr = 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'

  profiles.setBio(addr, 'Building on BCH')

  assert.equal(profiles.getBio(addr), 'Building on BCH')
})

test('getBio returns null for an unknown address', () => {
  const profiles = new Profiles()
  const addr = 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'

  assert.equal(profiles.getBio(addr), null)
})

test('setBio with no address does nothing', () => {
  const profiles = new Profiles()

  profiles.setBio('', 'Building on BCH')

  assert.equal(profiles.getBio(''), null)
})

test('name and bio storage are independent', () => {
  const profiles = new Profiles()
  const addr = 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'

  profiles.setName(addr, 'trout')
  profiles.setBio(addr, 'Building on BCH')

  assert.equal(profiles.getName(addr), 'trout')
  assert.equal(profiles.getBio(addr), 'Building on BCH')
})

test('setAvatarUrl stores and getAvatarUrl retrieves an avatar URL', () => {
  const profiles = new Profiles()
  const addr = 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'

  profiles.setAvatarUrl(addr, 'https://example.com/avatar.png')

  assert.equal(profiles.getAvatarUrl(addr), 'https://example.com/avatar.png')
})

test('getAvatarUrl returns null for an unknown address', () => {
  const profiles = new Profiles()
  const addr = 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'

  assert.equal(profiles.getAvatarUrl(addr), null)
})

test('setAvatarUrl with no address does nothing', () => {
  const profiles = new Profiles()

  profiles.setAvatarUrl('', 'https://example.com/avatar.png')

  assert.equal(profiles.getAvatarUrl(''), null)
})

test('setFollowState stores and getFollowState retrieves follow state', () => {
  const profiles = new Profiles()
  const selfAddr = 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'
  const targetAddr = 'bitcoincash:qr95sy3j9xwd2ap32xkykttr4cvcu7as4y0qverfuy'

  profiles.setFollowState(selfAddr, targetAddr, true)

  assert.equal(profiles.getFollowState(selfAddr, targetAddr), true)
})

test('getFollowState returns false for an unknown follow relationship', () => {
  const profiles = new Profiles()
  const selfAddr = 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'
  const targetAddr = 'bitcoincash:qr95sy3j9xwd2ap32xkykttr4cvcu7as4y0qverfuy'

  assert.equal(profiles.getFollowState(selfAddr, targetAddr), false)
})

test('setFollowState with no self address does nothing', () => {
  const profiles = new Profiles()
  const targetAddr = 'bitcoincash:qr95sy3j9xwd2ap32xkykttr4cvcu7as4y0qverfuy'

  profiles.setFollowState('', targetAddr, true)

  assert.equal(profiles.getFollowState('', targetAddr), false)
})

test('follow state storage is independent per self address', () => {
  const profiles = new Profiles()
  const selfAddr = 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'
  const otherSelfAddr = 'bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a'
  const targetAddr = 'bitcoincash:qr95sy3j9xwd2ap32xkykttr4cvcu7as4y0qverfuy'

  profiles.setFollowState(selfAddr, targetAddr, true)
  profiles.setFollowState(otherSelfAddr, targetAddr, false)

  assert.equal(profiles.getFollowState(selfAddr, targetAddr), true)
  assert.equal(profiles.getFollowState(otherSelfAddr, targetAddr), false)
})

test('setTopicFollowState stores and getTopicFollowState retrieves topic follow state', () => {
  const profiles = new Profiles()
  const selfAddr = 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'
  const room = 'bitcoin'

  profiles.setTopicFollowState(selfAddr, room, true)

  assert.equal(profiles.getTopicFollowState(selfAddr, room), true)
})

test('getTopicFollowState returns false for an unknown topic relationship', () => {
  const profiles = new Profiles()
  const selfAddr = 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'

  assert.equal(profiles.getTopicFollowState(selfAddr, 'bitcoin'), false)
})

test('setTopicFollowState with no self address does nothing', () => {
  const profiles = new Profiles()

  profiles.setTopicFollowState('', 'bitcoin', true)

  assert.equal(profiles.getTopicFollowState('', 'bitcoin'), false)
})

test('setTopicFollowState with no room does nothing', () => {
  const profiles = new Profiles()
  const selfAddr = 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'

  profiles.setTopicFollowState(selfAddr, '', true)

  assert.equal(profiles.getTopicFollowState(selfAddr, ''), false)
})

test('_setMapState stores nothing when either input is missing', () => {
  const profiles = new Profiles()

  // Missing self address, present room.
  profiles.setTopicFollowState('', 'bitcoin', true)
  // Present self address, missing room.
  profiles.setTopicFollowState('bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d', '', true)

  assert.equal(profiles.topicFollowing.size, 0)
})

test('_getMapState ignores stored state when either input is missing', () => {
  const profiles = new Profiles()

  // Manually store under a missing room to prove the read guard alone reports
  // not-following instead of leaking the stored value.
  profiles.topicFollowing.set('bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d', new Map([['', true]]))

  assert.equal(profiles.getTopicFollowState('bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d', ''), false)
})

test('topic follow state storage is independent per self address', () => {
  const profiles = new Profiles()
  const selfAddr = 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'
  const otherSelfAddr = 'bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a'

  profiles.setTopicFollowState(selfAddr, 'bitcoin', true)
  profiles.setTopicFollowState(otherSelfAddr, 'bitcoin', false)

  assert.equal(profiles.getTopicFollowState(selfAddr, 'bitcoin'), true)
  assert.equal(profiles.getTopicFollowState(otherSelfAddr, 'bitcoin'), false)
})

test('topic follow state storage is independent of address follow state', () => {
  const profiles = new Profiles()
  const selfAddr = 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'
  const targetAddr = 'bitcoincash:qr95sy3j9xwd2ap32xkykttr4cvcu7as4y0qverfuy'

  profiles.setFollowState(selfAddr, targetAddr, true)
  profiles.setTopicFollowState(selfAddr, 'bitcoin', true)

  assert.equal(profiles.getFollowState(selfAddr, targetAddr), true)
  assert.equal(profiles.getTopicFollowState(selfAddr, 'bitcoin'), true)
})

test('avatar URL storage is independent of name and bio storage', () => {
  const profiles = new Profiles()
  const addr = 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'

  profiles.setName(addr, 'trout')
  profiles.setBio(addr, 'Building on BCH')
  profiles.setAvatarUrl(addr, 'https://example.com/avatar.png')

  assert.equal(profiles.getName(addr), 'trout')
  assert.equal(profiles.getBio(addr), 'Building on BCH')
  assert.equal(profiles.getAvatarUrl(addr), 'https://example.com/avatar.png')
})