host-portal-binding.test.js

const assert = require('assert')
const {Emitter, TextEditor} = require('atom')
const {buildAtomEnvironment, destroyAtomEnvironments} = require('./helpers/atom-environments')
const {FollowState, TeletypeClient} = require('@atom/teletype-client')
const HostPortalBinding = require('../lib/host-portal-binding')
const FakeClipboard = require('./helpers/fake-clipboard')
const FakePortal = require('./helpers/fake-portal')

suite('HostPortalBinding', () => {
  teardown(async () => {
    await destroyAtomEnvironments()
  })

  test('handling an unexpected error when joining a portal', async () => {
    const client = new TeletypeClient({pubSubGateway: {}})
    client.createPortal = function () {
      throw new Error('It broke!')
    }
    const atomEnv = buildAtomEnvironment()
    const portalBinding = buildHostPortalBinding(client, atomEnv)

    const result = await portalBinding.initialize()
    assert.equal(result, false)

    assert.equal(atomEnv.notifications.getNotifications().length, 1)
    const {message, options} = atomEnv.notifications.getNotifications()[0]
    assert.equal(message, 'Failed to share portal')
    assert(options.description.includes('It broke!'))
  })

  test('showing notifications when sites join or leave', async () => {
    const portal = new FakePortal()
    const client = new TeletypeClient({pubSubGateway: {}})
    client.createPortal = function () {
      return portal
    }
    const atomEnv = buildAtomEnvironment()
    const portalBinding = buildHostPortalBinding(client, atomEnv)
    await portalBinding.initialize()

    atomEnv.notifications.clear()
    portal.delegate.siteDidJoin(2)
    assert.equal(atomEnv.notifications.getNotifications().length, 1)
    assert(atomEnv.notifications.getNotifications()[0].message.includes('@site-2'))

    atomEnv.notifications.clear()
    portal.delegate.siteDidLeave(3)
    assert.equal(atomEnv.notifications.getNotifications().length, 1)
    assert(atomEnv.notifications.getNotifications()[0].message.includes('@site-3'))
  })

  test('switching the active editor to a remote editor that had been moved into a non-active pane', async () => {
    const client = new TeletypeClient({pubSubGateway: {}})
    const portal = new FakePortal()
    client.createPortal = () => portal
    const atomEnv = buildAtomEnvironment()
    const portalBinding = buildHostPortalBinding(client, atomEnv)
    await portalBinding.initialize()

    await atomEnv.workspace.open()
    await atomEnv.workspace.open()
    const editorProxy2 = portal.getActiveEditorProxy()

    const leftPane = atomEnv.workspace.getActivePane()
    const rightPane = leftPane.splitRight({moveActiveItem: true})
    assert.equal(leftPane.getItems().length, 1)
    assert.equal(rightPane.getItems().length, 1)
    assert.equal(atomEnv.workspace.getActivePane(), rightPane)

    leftPane.activate()
    await portalBinding.updateTether(FollowState.RETRACTED, editorProxy2)
    assert.equal(leftPane.getItems().length, 1)
    assert.equal(rightPane.getItems().length, 1)
    assert.equal(atomEnv.workspace.getActivePane(), rightPane)
  })

  test('gracefully handles attempt to update tether for destroyed editors', async () => {
    const client = new TeletypeClient({pubSubGateway: {}})
    const portal = new FakePortal()
    client.createPortal = () => portal
    const atomEnv = buildAtomEnvironment()
    const portalBinding = buildHostPortalBinding(client, atomEnv)
    await portalBinding.initialize()

    const editor = await atomEnv.workspace.open()
    editor.getBuffer().setTextInRange('Lorem ipsum dolor', [[0, 0], [0, 0]])
    const editorProxy = portal.getActiveEditorProxy()

    await portalBinding.updateTether(FollowState.RETRACTED, editorProxy, {row: 0, column: 3})
    assert.deepEqual(editor.getCursorBufferPosition(), {row: 0, column: 3})

    editor.destroy()
    await portalBinding.updateTether(FollowState.DISCONNECTED, editorProxy, {row: 0, column: 5})
  })

  test('toggling site position components visibility when switching between shared and non-shared pane items', async () => {
    const client = new TeletypeClient({pubSubGateway: {}})
    const portal = new FakePortal()
    client.createPortal = () => portal
    const atomEnv = buildAtomEnvironment()
    const portalBinding = buildHostPortalBinding(client, atomEnv)

    const localEditor1 = await atomEnv.workspace.open()
    await portalBinding.initialize()
    assert(portalBinding.sitePositionsComponent.element.parentElement)

    const localNonEditor = await atomEnv.workspace.open(new FakePaneItem())
    assert(!portalBinding.sitePositionsComponent.element.parentElement)

    const localEditor2 = await atomEnv.workspace.open()
    assert(portalBinding.sitePositionsComponent.element.parentElement)

    const remoteEditor = new TextEditor()
    remoteEditor.isRemote = true
    await atomEnv.workspace.open(remoteEditor)
    assert(!portalBinding.sitePositionsComponent.element.parentElement)

    await atomEnv.workspace.open(localEditor2)
    assert(portalBinding.sitePositionsComponent.element.parentElement)

    remoteEditor.destroy()
    localEditor1.destroy()
    localEditor2.destroy()
    localNonEditor.destroy()
    assert(!portalBinding.sitePositionsComponent.element.parentElement)
  })

  function buildHostPortalBinding (client, atomEnv) {
    return new HostPortalBinding({
      client,
      notificationManager: atomEnv.notifications,
      workspace: atomEnv.workspace,
      clipboard: new FakeClipboard()
    })
  }
})

class FakePaneItem {
  constructor () {
    this.element = document.createElement('div')
    this.emitter = new Emitter()
  }

  destroy () {
    this.emitter.emit('did-destroy')
  }

  onDidDestroy (callback) {
    return this.emitter.on('did-destroy', callback)
  }
}