'use strict' const multiaddr = require('multiaddr') const errCode = require('err-code') const TimeoutController = require('timeout-abort-controller') const anySignal = require('any-signal') const debug = require('debug') const log = debug('libp2p:dialer') log.error = debug('libp2p:dialer:error') const { DialRequest } = require('./dial-request') const { codes } = require('../errors') const { DIAL_TIMEOUT, MAX_PARALLEL_DIALS, MAX_PER_PEER_DIALS } = require('../constants') class Dialer { /** * @constructor * @param {object} options * @param {TransportManager} options.transportManager * @param {Peerstore} peerStore * @param {number} options.concurrency Number of max concurrent dials. Defaults to `MAX_PARALLEL_DIALS` * @param {number} options.timeout How long a dial attempt is allowed to take. Defaults to `DIAL_TIMEOUT` */ constructor ({ transportManager, peerStore, concurrency = MAX_PARALLEL_DIALS, timeout = DIAL_TIMEOUT, perPeerLimit = MAX_PER_PEER_DIALS }) { this.transportManager = transportManager this.peerStore = peerStore this.concurrency = concurrency this.timeout = timeout this.perPeerLimit = perPeerLimit this.tokens = [...new Array(concurrency)].map((_, index) => index) this._pendingDials = new Set() } /** * Clears any pending dials */ destroy () { for (const dial of this._pendingDials.values()) { try { dial.controller.abort() } catch (err) { log.error(err) } } this._pendingDials.clear() } /** * Connects to the first success of a given list of `Multiaddr`. `addrs` should * include the id of the peer being dialed, it will be used for encryption verification. * * @param {Array|Multiaddr} addrs * @param {object} [options] * @param {AbortSignal} [options.signal] An AbortController signal * @returns {Promise} */ async connectToMultiaddr (addrs, options = {}) { if (!Array.isArray(addrs)) addrs = [multiaddr(addrs)] const dialAction = (addr, options) => { if (options.signal.aborted) throw errCode(new Error('already aborted'), 'ERR_ALREADY_ABORTED') return this.transportManager.dial(addr, options) } const dialRequest = new DialRequest({ addrs, dialAction, dialer: this }) // Combine the timeout signal and options.signal, if provided const timeoutController = new TimeoutController(this.timeout) const signals = [timeoutController.signal] options.signal && signals.push(options.signal) const signal = anySignal(signals) const dial = { dialRequest, controller: timeoutController } this._pendingDials.add(dial) try { const dialResult = await dialRequest.run({ ...options, signal }) log('dial succeeded to %s', dialResult.remoteAddr) return dialResult } catch (err) { // Error is a timeout if (timeoutController.signal.aborted) { err.code = codes.ERR_TIMEOUT } log.error(err) throw err } finally { timeoutController.clear() this._pendingDials.delete(dial) } } /** * Connects to a given `PeerInfo` or `PeerId` by dialing all of its known addresses. * The dial to the first address that is successfully able to upgrade a connection * will be used. * * @param {PeerId} peerId The remote peer id to dial * @param {object} [options] * @param {AbortSignal} [options.signal] An AbortController signal * @returns {Promise} */ connectToPeer (peerId, options = {}) { const addrs = this.peerStore.multiaddrsForPeer(peerId) // TODO: ensure the peer id is on the multiaddr return this.connectToMultiaddr(addrs, options) } getTokens (num) { const total = Math.min(num, this.perPeerLimit, this.tokens.length) const tokens = this.tokens.splice(0, total) log('%d tokens request, returning %d, %d remaining', num, total, this.tokens.length) return tokens } releaseToken (token) { // Guard against duplicate releases if (this.tokens.indexOf(token) > -1) return log('token %d released', token) this.tokens.push(token) } } module.exports = Dialer