Merge branch 'master' of ssh://github.com/webtorrent/bittorrent-tracker into add_gitignore

Author: alxhotel

.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: ci
+'on':
+  - push
+  - pull_request
+jobs:
+  test:
+    name: Node ${{ matrix.node }} / ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+        node:
+          - '14'
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+      - run: npm install
+      - run: npm run build --if-present
+      - run: npm test

.npmignore

@@ -1,6 +1,6 @@
-.travis.yml
 CONTRIBUTING.md
 examples/
 img/
 test/
 tools/
+.github/

.travis.yml

@@ -1,7 +1,7 @@
-# bittorrent-tracker [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]
+# bittorrent-tracker [![ci][ci-image]][ci-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]
 
-[travis-image]: https://img.shields.io/travis/webtorrent/bittorrent-tracker/master.svg
-[travis-url]: https://travis-ci.org/webtorrent/bittorrent-tracker
+[ci-image]: https://img.shields.io/github/workflow/status/webtorrent/bittorrent-tracker/ci/master
+[ci-url]: https://github.com/webtorrent/bittorrent-tracker/actions
 [npm-image]: https://img.shields.io/npm/v/bittorrent-tracker.svg
 [npm-url]: https://npmjs.org/package/bittorrent-tracker
 [downloads-image]: https://img.shields.io/npm/dm/bittorrent-tracker.svg

README.md

@@ -3,6 +3,7 @@ const EventEmitter = require('events')
 const once = require('once')
 const parallel = require('run-parallel')
 const Peer = require('simple-peer')
+const queueMicrotask = require('queue-microtask')
 
 const common = require('./lib/common')
 const HTTPTracker = require('./lib/client/http-tracker') // empty object in browser
@@ -76,7 +77,7 @@ class Client extends EventEmitter {
     const webrtcSupport = this._wrtc !== false && (!!this._wrtc || Peer.WEBRTC_SUPPORT)
 
     const nextTickWarn = err => {
-      process.nextTick(() => {
+      queueMicrotask(() => {
         this.emit('warning', err)
       })
     }

client.js

@@ -56,7 +56,7 @@ class WebSocketTracker extends Tracker {
       this._send(params)
     } else {
       // Limit the number of offers that are generated, since it can be slow
-      const numwant = Math.min(opts.numwant, 10)
+      const numwant = Math.min(opts.numwant, 5)
 
       this._generateOffers(numwant, offers => {
         params.numwant = numwant
@@ -278,17 +278,17 @@ class WebSocketTracker extends Tracker {
         if (this._trackerId) params.trackerid = this._trackerId
         this._send(params)
       })
-      peer.signal(data.offer)
       this.client.emit('peer', peer)
+      peer.signal(data.offer)
     }
 
     if (data.answer && data.peer_id) {
       const offerId = common.binaryToHex(data.offer_id)
       peer = this.peers[offerId]
       if (peer) {
         peer.id = common.binaryToHex(data.peer_id)
-        peer.signal(data.answer)
         this.client.emit('peer', peer)
+        peer.signal(data.answer)
 
         clearTimeout(peer.trackerTimeout)
         peer.trackerTimeout = null

lib/client/websocket-tracker.js

@@ -1,7 +1,7 @@
 {
   "name": "bittorrent-tracker",
   "description": "Simple, robust, BitTorrent tracker (client & server) implementation",
-  "version": "9.15.0",
+  "version": "9.17.0",
   "author": {
     "name": "WebTorrent LLC",
     "email": "[email protected]",
@@ -34,6 +34,7 @@
     "lru": "^3.1.0",
     "minimist": "^1.2.5",
     "once": "^1.4.0",
+    "queue-microtask": "^1.2.2",
     "random-iterate": "^1.0.1",
     "randombytes": "^2.1.0",
     "run-parallel": "^1.1.9",

package.json

@@ -23,14 +23,14 @@ const hasOwnProperty = Object.prototype.hasOwnProperty
  * metrics from clients that help the tracker keep overall statistics about the torrent.
  * Responses include a peer list that helps the client participate in the torrent.
  *
- * @param {Object}  opts            options object
- * @param {Number}  opts.interval   tell clients to announce on this interval (ms)
- * @param {Number}  opts.trustProxy trust 'x-forwarded-for' header from reverse proxy
- * @param {boolean} opts.http       start an http server? (default: true)
- * @param {boolean} opts.udp        start a udp server? (default: true)
- * @param {boolean} opts.ws         start a websocket server? (default: true)
- * @param {boolean} opts.stats      enable web-based statistics? (default: true)
- * @param {function} opts.filter    black/whitelist fn for disallowing/allowing torrents
+ * @param {Object}  opts                options object
+ * @param {Number}  opts.interval       tell clients to announce on this interval (ms)
+ * @param {Number}  opts.trustProxy     trust 'x-forwarded-for' header from reverse proxy
+ * @param {boolean|Object} opts.http    start an http server?, or options for http.createServer (default: true)
+ * @param {boolean|Object} opts.udp     start a udp server?, or extra options for dgram.createSocket (default: true)
+ * @param {boolean|Object} opts.ws      start a websocket server?, or extra options for new WebSocketServer (default: true)
+ * @param {boolean} opts.stats          enable web-based statistics? (default: true)
+ * @param {function} opts.filter        black/whitelist fn for disallowing/allowing torrents
  */
 class Server extends EventEmitter {
   constructor (opts = {}) {
@@ -59,7 +59,7 @@ class Server extends EventEmitter {
 
     // start an http tracker unless the user explictly says no
     if (opts.http !== false) {
-      this.http = http.createServer()
+      this.http = http.createServer(isObject(opts.http) ? opts.http : undefined)
       this.http.on('error', err => { this._onError(err) })
       this.http.on('listening', onListening)
 
@@ -75,26 +75,29 @@ class Server extends EventEmitter {
 
     // start a udp tracker unless the user explicitly says no
     if (opts.udp !== false) {
-      const isNode10 = /^v0.10./.test(process.version)
-
-      this.udp4 = this.udp = dgram.createSocket(
-        isNode10 ? 'udp4' : { type: 'udp4', reuseAddr: true }
-      )
+      this.udp4 = this.udp = dgram.createSocket({
+        type: 'udp4',
+        reuseAddr: true,
+        ...(isObject(opts.udp) ? opts.udp : undefined)
+      })
       this.udp4.on('message', (msg, rinfo) => { this.onUdpRequest(msg, rinfo) })
       this.udp4.on('error', err => { this._onError(err) })
       this.udp4.on('listening', onListening)
 
-      this.udp6 = dgram.createSocket(
-        isNode10 ? 'udp6' : { type: 'udp6', reuseAddr: true }
-      )
+      this.udp6 = dgram.createSocket({
+        type: 'udp6',
+        reuseAddr: true,
+        ...(isObject(opts.udp) ? opts.udp : undefined)
+      })
       this.udp6.on('message', (msg, rinfo) => { this.onUdpRequest(msg, rinfo) })
       this.udp6.on('error', err => { this._onError(err) })
       this.udp6.on('listening', onListening)
     }
 
     // start a websocket tracker (for WebTorrent) unless the user explicitly says no
     if (opts.ws !== false) {
-      if (!this.http) {
+      const noServer = isObject(opts.ws) && opts.ws.noServer
+      if (!this.http && !noServer) {
         this.http = http.createServer()
         this.http.on('error', err => { this._onError(err) })
         this.http.on('listening', onListening)
@@ -112,13 +115,19 @@ class Server extends EventEmitter {
         })
       }
       this.ws = new WebSocketServer({
-        server: this.http,
+        server: noServer ? undefined : this.http,
         perMessageDeflate: false,
-        clientTracking: false
+        clientTracking: false,
+        ...(isObject(opts.ws) ? opts.ws : undefined)
       })
+
       this.ws.address = () => {
+        if (noServer) {
+          throw new Error('address() unavailable with { noServer: true }')
+        }
         return this.http.address()
       }
+
       this.ws.on('error', err => { this._onError(err) })
       this.ws.on('connection', (socket, req) => {
         // Note: socket.upgradeReq was removed in [email protected], so re-add it.
@@ -297,10 +306,6 @@ class Server extends EventEmitter {
 
     debug('listen (port: %o hostname: %o)', port, hostname)
 
-    function isObject (obj) {
-      return typeof obj === 'object' && obj !== null
-    }
-
     const httpPort = isObject(port) ? (port.http || 0) : port
     const udpPort = isObject(port) ? (port.udp || 0) : port
 
@@ -801,6 +806,10 @@ function makeUdpPacket (params) {
   return packet
 }
 
+function isObject (obj) {
+  return typeof obj === 'object' && obj !== null
+}
+
 function toNumber (x) {
   x = Number(x)
   return x >= 0 ? x : false