@dxos/signal 2.33.9-dev.a78b0c94 → 2.33.9-dev.ceab0857

package/src/signal/peer-map.test.js

@@ -1,58 +0,0 @@
-//
-// Copyright 2021 DXOS.org
-//
-
-import { PeerMap } from './peer-map';
-
-const bf = str => Buffer.from(str);
-
-test('basic operations', () => {
-  const map = new PeerMap(bf('owner1'));
-
-  const onAdd = jest.fn();
-  const onDel = jest.fn();
-
-  map.on('peer-added', onAdd);
-  map.on('peer-deleted', onDel);
-
-  expect(map.peers.length).toBe(0);
-
-  map.add({ id: bf('peer1'), topic: bf('topic1'), rpc: {} });
-  map.add({ id: bf('peer2'), topic: bf('topic1'), rpc: {} });
-  map.add({ id: bf('peer3'), topic: bf('topic2'), rpc: {} });
-  map.add({ id: bf('peer4'), topic: bf('topic3'), rpc: {} });
-  map.add({ id: bf('peer5'), topic: bf('topic3'), rpc: {} });
-
-  expect(map.peers.length).toBe(5);
-  expect(map.topics.length).toBe(3);
-
-  expect(map.delete(bf('topic3'), bf('peer4'))).toBe(true);
-  expect(map.delete(bf('topic3'), bf('peer5'))).toBe(true);
-
-  // Delete false.
-  expect(map.delete(bf('topicx'), bf('peer6'))).toBe(false);
-  expect(map.delete(bf('topic2'), bf('peerx'))).toBe(false);
-
-  expect(map.peers.length).toBe(3);
-  expect(map.topics.length).toBe(2);
-
-  expect(onAdd).toHaveBeenCalledTimes(5);
-  expect(onDel).toHaveBeenCalledTimes(2);
-
-  expect(map.getPeersByTopic(bf('topic2')).length).toBe(1);
-
-  map.updatePeersByOwner(bf('owner2'), [
-    { id: bf('peer6'), topic: bf('topic1') },
-    { id: bf('peer7'), topic: bf('topic2') }
-  ]);
-
-  expect(map.peers.length).toBe(5);
-  expect(map.topics.length).toBe(2);
-
-  map.updatePeersByOwner(bf('owner2'), [
-    { id: bf('peer6'), topic: bf('topic1') }
-  ]);
-
-  expect(map.peers.length).toBe(4);
-  expect(map.topics.length).toBe(2);
-});

package/src/signal/peer-map.ts

@@ -1,174 +0,0 @@
-//
-// Copyright 2021 DXOS.org
-//
-
-import { EventEmitter } from 'events';
-import assert from 'node:assert';
-
-/**
- * @typedef Peer
- * @prop {Buffer} id
- * @prop {Buffer} topic
- * @prop {Buffer} owner
- * @prop {NanomessageRPC} [rpc]
- */
-interface Peer {
-  id: Buffer,
-  topic: Buffer,
-  owner: Buffer,
-  rpc: any[]
-}
-
-export class PeerMap extends EventEmitter {
-  private readonly _owner: Buffer;
-  private readonly _peersByTopic: Map<string, Map<string, Peer>>;
-
-  constructor (owner: Buffer) {
-    super();
-
-    this._owner = owner;
-    this._peersByTopic = new Map();
-  }
-
-  get peers () : Peer[] {
-    const result = [];
-    for (const peers of this._peersByTopic.values()) {
-      for (const peer of peers.values()) {
-        result.push(peer);
-      }
-    }
-    return result;
-  }
-
-  get topics (): Array<Buffer> {
-    return Array.from(this._peersByTopic.keys()).map(topic => Buffer.from(topic, 'hex'));
-  }
-
-  /**
-   * Add a new peer
-   */
-  add (opts: {
-    id?: Buffer,
-    topic?: Buffer,
-    owner?: Buffer,
-    rpc?: any,
-  } = {}): Peer {
-    const { id, topic, owner = this._owner, rpc } = opts;
-
-    assert(id && Buffer.isBuffer(id));
-    assert(topic && Buffer.isBuffer(topic));
-
-    const idStr = id.toString('hex');
-    const topicStr = topic.toString('hex');
-
-    let peers;
-    if (this._peersByTopic.has(topicStr)) {
-      peers = this._peersByTopic.get(topicStr);
-    } else {
-      peers = new Map();
-      this._peersByTopic.set(topicStr, peers);
-    }
-
-    const peer = {
-      id,
-      topic,
-      owner,
-      rpc
-    };
-
-    peers?.set(idStr, peer);
-    if (this._owner.equals(owner)) {
-      this.emit('peer-added', peer);
-    }
-
-    return peer;
-  }
-
-  /**
-   * Delete a peer by topic and id
-   */
-  delete (topic: Buffer, id: Buffer): boolean {
-    const peer = this._delete(topic, id);
-
-    if (peer) {
-      if (this._owner.equals(peer.owner)) {
-        this.emit('peer-deleted', peer);
-      }
-
-      return true;
-    }
-
-    return false;
-  }
-
-  getPeersByTopic (topic: Buffer): Peer[] {
-    const topicStr = topic.toString('hex');
-    if (!this._peersByTopic.has(topicStr)) {
-      return [];
-    }
-    const peers = this._peersByTopic.get(topicStr);
-    return Array.from(peers?.values() ?? []);
-  }
-
-  deletePeersByOwner (owner: Buffer) {
-    for (const peer of this.peers) {
-      if (!peer.owner.equals(owner)) {
-        continue;
-      }
-      this._delete(peer.topic, peer.id);
-    }
-  }
-
-  /**
-   * @param {NanomessageRPC} rpc
-   */
-  deletePeersByRPC (rpc: any) {
-    for (const peer of this.peers) {
-      if (peer.rpc !== rpc) {
-        continue;
-      }
-      this._delete(peer.topic, peer.id);
-    }
-  }
-
-  updatePeersByOwner (owner: Buffer, peers: Array<{ id: Buffer, topic: Buffer }>) {
-    this.deletePeersByOwner(owner);
-    peers.forEach(peer => this.add({
-      id: peer.id,
-      topic: peer.topic,
-      owner
-    }));
-  }
-
-  encode (peer: Peer) {
-    return { id: peer.id.toString('hex'), topic: peer.topic.toString('hex'), owner: peer.owner.toString('hex') };
-  }
-
-  decode (peer: {id: string, topic: string, owner: string}) {
-    return { id: Buffer.from(peer.id, 'hex'), topic: Buffer.from(peer.topic, 'hex'), owner: Buffer.from(peer.owner, 'hex') };
-  }
-
-  _delete (topic: Buffer, id: Buffer): Peer | null {
-    const topicStr = topic.toString('hex');
-    const idStr = id.toString('hex');
-
-    if (this._peersByTopic.has(topicStr)) {
-      const peers = this._peersByTopic.get(topicStr);
-      if (!peers) {
-        return null;
-      }
-      const peer = peers.get(idStr);
-      if (peer) {
-        peers.delete(idStr);
-
-        if (peers.size === 0) {
-          this._peersByTopic.delete(topicStr);
-        }
-
-        return peer;
-      }
-    }
-
-    return null;
-  }
-}

package/src/signal/signal-server.js

@@ -1,106 +0,0 @@
-//
-// Copyright 2021 DXOS.org
-//
-
-import Server from 'simple-websocket/server';
-
-const { SocketSignalServer, errors: { ERR_PEER_NOT_FOUND } } = require('socket-signal'); // eslint-disable-line @typescript-eslint/no-var-requires
-
-export class SignalServer extends SocketSignalServer {
-  constructor (server, broker, opts = {}) {
-    const { path, ...signalOpts } = opts;
-
-    super(signalOpts);
-
-    const { keyPair, peerMap } = broker.shared;
-
-    this._broker = broker;
-    this._keyPair = keyPair;
-    this._peerMap = peerMap;
-
-    this._server = new Server({ server, path });
-    this._server.setMaxListeners(Infinity);
-
-    this.on('error', err => this._broker.logger.warn('signal-server', err));
-    this.on('rpc-error', err => this._broker.logger.warn('rpc-signal-server', err));
-  }
-
-  _onSocket (socket) {
-    this.addSocket(socket).catch(err => process.nextTick(() => this.emit('error', err)));
-  }
-
-  async _open () {
-    this._server.on('connection', this._onSocket.bind(this));
-  }
-
-  async _close () {
-    this._server.removeListener('connection', this._onSocket.bind(this));
-    await super._close();
-    return new Promise(resolve => this._server.close(() => resolve()));
-  }
-
-  async _onDisconnect (rpc) {
-    const peer = this._peerMap.peers.find(p => p.rpc === rpc);
-    if (peer) {
-      this._peerMap.peers
-        .filter(p => p.rpc === rpc)
-        .forEach(p => this._peerMap.delete(p.topic, p.id));
-
-      this._broker.logger.info('peer-disconnected', { id: peer.id.toString('hex') });
-    }
-  }
-
-  async _onJoin (rpc, data) {
-    this._peerMap.add({
-      id: data.id,
-      topic: data.topic,
-      owner: this._keyPair.publicKey,
-      rpc
-    });
-    this._broker.logger.info('peer-join', { topic: data.topic.toString('hex'), id: data.id.toString('hex') });
-    return this._peerMap.getPeersByTopic(data.topic).map(p => p.id);
-  }
-
-  async _onLeave (rpc, data) {
-    this._broker.logger.info('peer-leave', { topic: data.topic.toString('hex'), id: data.id.toString('hex') });
-    this._peerMap.delete(data.topic, data.id);
-  }
-
-  async _onOffer (rpc, data) {
-    const remotePeer = this._peerMap.peers.find(p => p.topic.equals(data.topic) && p.id.equals(data.remoteId));
-    if (!remotePeer) {
-      throw new ERR_PEER_NOT_FOUND(data.remoteId.toString('hex'));
-    }
-
-    if (remotePeer.owner.equals(this._keyPair.publicKey)) {
-      const rpc = remotePeer.rpc;
-      if (!rpc) {
-        throw new Error('rpc not found');
-      }
-      return rpc.call('offer', data);
-    }
-
-    return this._broker.call('discovery.offer', data, { nodeID: remotePeer.owner.toString('hex'), retries: 0 });
-  }
-
-  async _onSignal (rpc, data) {
-    const remotePeer = this._peerMap.peers.find(p => p.topic.equals(data.topic) && p.id.equals(data.remoteId));
-    if (!remotePeer) {
-      throw new ERR_PEER_NOT_FOUND(data.remoteId.toString('hex'));
-    }
-
-    if (remotePeer.owner.equals(this._keyPair.publicKey)) {
-      const rpc = remotePeer.rpc;
-      if (!rpc) {
-        throw new Error('rpc not found');
-      }
-      return rpc.emit('signal', data);
-    }
-
-    return this._broker.call('discovery.signal', data, { nodeID: remotePeer.owner.toString('hex'), retries: 0 });
-  }
-
-  async _onLookup (rpc, data) {
-    return this._peerMap.getPeersByTopic(data.topic).map(p => p.id);
-  }
-}

package/src/signal.test.js

@@ -1,78 +0,0 @@
-//
-// Copyright 2021 DXOS.org
-//
-
-import swarm from '@geut/discovery-swarm-webrtc';
-import wrtc from '@koush/wrtc';
-import crypto from 'crypto';
-import debug from 'debug';
-import pEvent from 'p-event';
-
-import { createBroker } from './broker';
-
-const log = debug('dxos:test:signal');
-
-jest.setTimeout(100 * 1000);
-
-const checkDiscoveryUpdate = (brokers, check) => Promise.all(brokers.map((broker) => pEvent(broker.localBus, '$broker.discovery-update', () => check(broker))));
-
-// TODO(telackey): This test does not work for me.
-test.skip('join/leave/connection webrtc peer', async () => {
-  const topic = crypto.randomBytes(32);
-
-  const brokers = [...Array(10).keys()].map(i => createBroker(topic, { port: 5000 + i, logger: false, hyperswarm: { bootstrap: false } }));
-
-  log('> starting brokers');
-  await Promise.all(brokers.map(b => b.start()));
-
-  const clients = [...Array(3).keys()].map(i => swarm({
-    bootstrap: [`ws://127.0.0.1:${5000 + i}`],
-    simplePeer: {
-      wrtc
-    }
-  }));
-
-  const peerIds = clients.map(c => c.id);
-  const waitForJoin = checkDiscoveryUpdate(brokers, broker => {
-    const { peerMap } = broker.shared;
-
-    return peerIds.reduce((prev, peerId) => prev && peerMap.peers.find(p => p.topic.equals(topic) && p.id.equals(peerId)), true);
-  });
-
-  const waitForPeerConnections = new Promise(resolve => {
-    let connections = 0;
-    const done = (conn, { initiator }) => {
-      if (initiator) {
-        connections++;
-      }
-      if (connections >= 2) {
-        clients.forEach(client => client.off('connection', done));
-        resolve();
-      }
-    };
-    clients.forEach(client => client.on('connection', done));
-  });
-
-  log('> waiting for joining');
-  clients.forEach(client => client.join(topic));
-  await waitForJoin;
-
-  log('> waiting for webrtc connections');
-  await waitForPeerConnections;
-
-  log('> waiting for leaving');
-  const waitForLeave = checkDiscoveryUpdate(brokers, broker => {
-    const { peerMap } = broker.shared;
-    return peerMap.getPeersByTopic(topic).length === 0;
-  });
-
-  clients.forEach(client => client.leave(topic));
-  await waitForLeave;
-  log('> all left');
-
-  log('> stopping signals');
-  await Promise.all(clients.map(client => client.signal.close()));
-  log('> stopping brokers');
-  await Promise.all(brokers.map(b => b.stop()));
-  log('> stopped');
-});

package/src/system-information.ts

@@ -1,110 +0,0 @@
-/**
- * Copy from https://github.com/dxos/console/tree/master/packages/console-server
- */
-
-//
-// Copyright 2021 DXOS.org
-//
-
-import { spawnSync } from 'child_process';
-import fs from 'fs';
-import pick from 'lodash.pick';
-import moment from 'moment';
-import os from 'os';
-import si from 'systeminformation';
-
-const num = new Intl.NumberFormat('en', { maximumSignificantDigits: 3 });
-
-const size = (n: number, unit: 'K' | 'M' | 'G' | 'T') => {
-  const units = {
-    K: 3,
-    M: 6,
-    G: 9,
-    T: 12
-  };
-
-  const power = units[unit] || 0;
-
-  return num.format(Math.round(n / (10 ** power))) + (unit ? ` ${unit}` : '');
-};
-
-const getVersionInfo = () => {
-  // TODO(telackey): Get from config (or figure out a better way to do this).
-  const versionFile = '/opt/kube/VERSION';
-  if (fs.existsSync(versionFile)) {
-    return fs.readFileSync(versionFile, { encoding: 'utf8' }).replace(/^\s+|\s+$/g, '');
-  }
-  return undefined;
-};
-
-/**
- * Get system inforamtion.
- * https://www.npmjs.com/package/systeminformation
- */
-const getSystemInfo = async () => {
-  const ifaces = os.networkInterfaces();
-  const addresses = Object.entries(ifaces).reduce((result, [, values]) => {
-    (values ?? []).forEach(({ family, address }) => {
-      address = address.toLowerCase();
-      // TODO(telackey): Include link-local IPv6?
-      if (!address.startsWith('127.') && !address.startsWith('fe80::') && !address.startsWith('::1')) {
-        result.push(address);
-      }
-    });
-    return result;
-  }, [] as string[]);
-
-  const cpu = await si.cpu();
-  const memory = await si.mem();
-  const device = await si.system();
-  const hostname = os.hostname();
-
-  return {
-    cpu: pick(cpu, 'brand', 'cores', 'manufacturer', 'vendor', 'speed'),
-
-    memory: {
-      total: size(memory.total, 'M'),
-      free: size(memory.free, 'M'),
-      used: size(memory.used, 'M'),
-      swaptotal: size(memory.swaptotal, 'M')
-    },
-
-    device: pick(device, 'model', 'serial', 'version'),
-
-    network: {
-      hostname,
-      addresses
-    },
-
-    os: {
-      arch: os.arch(),
-      platform: os.platform(),
-      version: os.version ? os.version() : undefined // Node > 13.
-    },
-
-    time: {
-      now: moment(),
-      up: moment().subtract(os.uptime(), 'seconds')
-    },
-
-    nodejs: {
-      version: process.version
-    },
-
-    version: getVersionInfo()
-  };
-};
-
-/**
- * Get system inforamtion.
- * https://www.npmjs.com/package/systeminformation
- */
-const getServiceInfo = async () => {
-  const command = 'dx';
-  const args = ['service', '--json'];
-
-  const child = spawnSync(command, args, { encoding: 'utf8' });
-  return JSON.parse(child.stdout);
-};
-
-module.exports = { getServiceInfo, getSystemInfo };

package/src/testing.ts

@@ -1,27 +0,0 @@
-//
-// Copyright 2021 DXOS.org
-//
-
-import Moleculer from 'moleculer';
-
-import { PublicKey } from '@dxos/protocols';
-
-import { createBroker } from './broker';
-
-export type TestBroker = Moleculer.ServiceBroker;
-
-/**
- * Creates a test instance of the signal server with swarming disabled and starts it.
- *
- * @param port Port to start the signal server on, random by default.
- */
-export const createTestBroker = async (port?: string | number): Promise<TestBroker> => {
-  const broker = createBroker(PublicKey.random().asBuffer(), {
-    port,
-    logger: false,
-    logLevel: 'fatal',
-    hyperswarm: { bootstrap: false }
-  });
-  await broker.start();
-  return broker;
-};

package/src/transporter/bootstrap-node.js

@@ -1,112 +0,0 @@
-//
-// Copyright 2021 DXOS.org
-//
-
-import dht from '@hyperswarm/dht';
-import crypto from 'crypto';
-import internalIp from 'internal-ip';
-import pEvent from 'p-event';
-import publicIp from 'public-ip';
-
-class BootstrapNode {
-  constructor (options = {}) {
-    const { port = 4000 } = options;
-
-    this._id = null;
-    this._broker = null;
-    this._port = port;
-    this._stop = false;
-    this._address = null;
-  }
-
-  async getAddress () {
-    if (this._address) {
-      return this._address;
-    }
-
-    if (!this._dht) {
-      throw new Error('dht not found');
-    }
-
-    const address = this._dht.socket.address();
-
-    address.address = await this._getBootstrapIp();
-
-    this._address = address;
-    return this._address;
-  }
-
-  async start (broker) {
-    this._broker = broker;
-
-    this._id = crypto.createHash('sha256')
-      .update(this._broker.nodeID + 'bootstrap')
-      .digest();
-
-    this._dht = dht({ ephemeral: true, adaptive: true, id: this._id });
-
-    // Runs the bootstrap UDP node in a specific port.
-    this._dht.listen(this._port);
-
-    await pEvent(this._dht, 'ready');
-
-    this._dht.on('announce', (target, peer) => {
-      this._broker.logger.debug('BOOTSTRAP_NODE: received announce', target, peer);
-    });
-
-    this._dht.on('unannounce', (target, peer) => {
-      this._broker.logger.debug('BOOTSTRAP_NODE: received unannounce', target, peer);
-    });
-
-    this._dht.on('lookup', (target, peer) => {
-      this._broker.logger.debug('BOOTSTRAP_NODE: received lookup', target, peer);
-    });
-
-    this._dht.once('close', async () => {
-      if (this._stop) {
-        return;
-      }
-
-      this._broker.logger.warn('BOOTSTRAP_NODE: closed, reconnecting...');
-      try {
-        await this._createBootstrapNode();
-      } catch (err) {
-        this._broker.logger.error('BOOTSTRAP_NODE: error during reconnection', err);
-      }
-    });
-
-    const address = await this.getAddress();
-    this._broker.logger.info('BOOTSTRAP_NODE: running on', {
-      id: this._dht.id.toString('hex'),
-      ...address
-    });
-  }
-
-  stop () {
-    if (this._stop || this._dht.destroyed) {
-      return;
-    }
-
-    this._stop = true;
-    if (this._dht) {
-      this._dht.destroy();
-      return pEvent(this._dht, 'close');
-    }
-  }
-
-  _getBootstrapIp () {
-    if (!this._dht) {
-      throw new Error('dht not found');
-    }
-
-    return publicIp.v4().catch(() => {
-      this._broker.logger.error('BOOTSTRAP_NODE: error trying to get external ip');
-      return internalIp.v4();
-    }).catch(err => {
-      this._broker.logger.error('BOOTSTRAP_NODE: error trying to get interal ip');
-      throw err;
-    });
-  }
-}
-
-module.exports = { BootstrapNode };