bare-http1 3.6.3 → 3.8.0

package/index.js

@@ -27,14 +27,18 @@ exports.request = function request (url, opts, onresponse) {
 
   if (typeof url === 'string') url = new URL(url)
 
-  if (URL.isURL(url)) {
+  if (isURL(url)) {
     opts = opts ? { ...opts } : {}
 
     opts.host = url.hostname
     opts.path = url.pathname + url.search
     opts.port = url.port ? parseInt(url.port, 10) : defaultPort(url)
   } else {
-    opts = url
+    opts = url ? { ...url } : {}
+
+    // For Node.js compatibility
+    opts.host = opts.hostname || opts.host
+    opts.port = typeof opts.port === 'string' ? parseInt(opts.port, 10) : opts.port
   }
 
   return new Request(opts, onresponse)
@@ -52,3 +56,15 @@ function defaultPort (url) {
 
   return null
 }
+
+// https://url.spec.whatwg.org/#api
+function isURL (url) {
+  return (
+    url !== null &&
+    typeof url === 'object' &&
+    typeof url.protocol === 'string' &&
+    typeof url.hostname === 'string' &&
+    typeof url.pathname === 'string' &&
+    typeof url.search === 'string'
+  )
+}

package/lib/agent.js

@@ -1,4 +1,5 @@
 const tcp = require('bare-tcp')
+const HTTPClientConnection = require('./client-connection')
 
 module.exports = class HTTPAgent {
   constructor (opts = {}) {
@@ -11,7 +12,12 @@ module.exports = class HTTPAgent {
       timeout = -1
     } = opts
 
+    this._sockets = new Map()
+    this._freeSockets = new Map()
+
     this._keepAlive = typeof keepAlive === 'number' ? keepAlive : keepAlive ? keepAliveMsecs : -1
+
+    this._opts = { ...opts }
     this._maxSockets = maxSockets
     this._maxTotalSockets = maxTotalSockets
     this._maxFreeSockets = maxFreeSockets
@@ -27,7 +33,87 @@ module.exports = class HTTPAgent {
   }
 
   keepSocketAlive (socket) {
-    return false
+    if (this._keepAlive === -1) return false
+
+    socket.setKeepAlive(true, this._keepAlive)
+    socket.unref()
+
+    return true
+  }
+
+  getName (opts) {
+    return `${opts.host}:${opts.port}`
+  }
+
+  addRequest (req, opts) {
+    opts = { ...opts, ...this._opts }
+
+    const name = this.getName(opts)
+
+    let socket
+
+    if (this._freeSockets.has(name)) {
+      const sockets = this._freeSockets.get(name)
+      socket = sockets.values().next().value
+      sockets.delete(socket)
+      if (sockets.size === 0) this._freeSockets.delete(name)
+
+      this.reuseSocket(socket, req)
+    } else {
+      socket = this.createConnection(opts)
+
+      socket
+        .on('free', () => this._onfree(socket, name))
+        .on('close', () => this._onremove(socket, name))
+    }
+
+    let sockets = this._sockets.get(name)
+    if (sockets === undefined) {
+      sockets = new Set()
+      this._sockets.set(name, sockets)
+    }
+
+    sockets.add(socket)
+
+    req.socket = socket
+
+    const connection = HTTPClientConnection.from(socket, opts)
+
+    connection.req = req
+  }
+
+  destroy () {
+    for (const set of [this._sockets, this._freeSockets]) {
+      for (const [, sockets] of set) {
+        for (const socket of sockets) socket.destroy()
+      }
+    }
+  }
+
+  _onfree (socket, name) {
+    if (this.keepSocketAlive(socket)) {
+      this._onremove(socket, name, false)
+
+      let sockets = this._freeSockets.get(name)
+      if (sockets === undefined) {
+        sockets = new Set()
+        this._freeSockets.set(name, sockets)
+      }
+
+      sockets.add(socket)
+    } else {
+      socket.end()
+    }
+  }
+
+  _onremove (socket, name, all = true) {
+    for (const set of all ? [this._sockets, this._freeSockets] : [this._sockets]) {
+      const sockets = set.get(name)
+      if (sockets === undefined) continue
+
+      sockets.delete(socket)
+      if (sockets.size === 0) set.delete(name)
+    }
   }
 
   static global = new this({ keepAlive: 1000, timeout: 5000 })

package/lib/client-connection.js

@@ -5,6 +5,16 @@ const errors = require('./errors')
 const empty = Buffer.alloc(0)
 
 module.exports = class HTTPClientConnection {
+  static _connections = new WeakMap()
+
+  static for (socket) {
+    return this._connections.get(socket) || null
+  }
+
+  static from (socket, opts) {
+    return this.for(socket) || new this(socket, opts)
+  }
+
   constructor (socket, opts = {}) {
     const {
       IncomingMessage = HTTPIncomingMessage
@@ -21,12 +31,14 @@ module.exports = class HTTPClientConnection {
     this._length = -1
     this._read = 0
     this._buffer = null
+    this._idle = true
 
     this._onerror = this._onerror.bind(this)
     this._onclose = this._onclose.bind(this)
     this._onend = this._onend.bind(this)
     this._ondata = this._ondata.bind(this)
     this._ondrain = this._ondrain.bind(this)
+    this._ontimeout = this._ontimeout.bind(this)
 
     socket
       .on('error', this._onerror)
@@ -34,6 +46,13 @@ module.exports = class HTTPClientConnection {
       .on('end', this._onend)
       .on('data', this._ondata)
       .on('drain', this._ondrain)
+      .on('timeout', this._ontimeout)
+
+    HTTPClientConnection._connections.set(socket, this)
+  }
+
+  get idle () {
+    return this._idle
   }
 
   _onerror (err) {
@@ -49,6 +68,8 @@ module.exports = class HTTPClientConnection {
   }
 
   _ondata (data) {
+    this._idle = false
+
     if (this._state === constants.state.IN_BODY) return this._onbody(data)
 
     if (this._buffer !== null) {
@@ -179,12 +200,7 @@ module.exports = class HTTPClientConnection {
   }
 
   _onupgrade (head) {
-    this.socket
-      .off('error', this._onerror)
-      .off('close', this._onclose)
-      .off('end', this._onend)
-      .off('data', this._ondata)
-      .off('drain', this._ondrain)
+    this._ondetach()
 
     const req = this.req
 
@@ -196,11 +212,13 @@ module.exports = class HTTPClientConnection {
     this.socket.destroy()
   }
 
+  _ontimeout () {
+    if (this.req) this.req.emit('timeout')
+  }
+
   _onfinished () {
     if (this.res) this.res.push(null)
     if (this.req) this.req._continueFinal()
-
-    this.socket.end()
   }
 
   _onreset () {
@@ -208,9 +226,24 @@ module.exports = class HTTPClientConnection {
     this._length = -1
     this._read = 0
     this._buffer = null
+    this._idle = true
+
+    this.socket.emit('free')
   }
 
   _ondrain () {
     if (this.req) this.req._continueWrite()
   }
+
+  _ondetach () {
+    this.socket
+      .off('error', this._onerror)
+      .off('close', this._onclose)
+      .off('end', this._onend)
+      .off('data', this._ondata)
+      .off('drain', this._ondrain)
+      .off('timeout', this._ontimeout)
+
+    HTTPClientConnection._connections.delete(this.socket)
+  }
 }

package/lib/client-request.js

@@ -1,6 +1,5 @@
 const HTTPAgent = require('./agent')
 const HTTPOutgoingMessage = require('./outgoing-message')
-const HTTPClientConnection = require('./client-connection')
 
 module.exports = class HTTPClientRequest extends HTTPOutgoingMessage {
   constructor (opts = {}, onresponse = null) {
@@ -11,25 +10,23 @@ module.exports = class HTTPClientRequest extends HTTPOutgoingMessage {
 
     opts = opts ? { ...opts } : {}
 
-    const agent = opts.agent === false ? new HTTPAgent() : opts.agent || HTTPAgent.global
+    // TODO: Renable the default global agent when tests have been sorted
+    // const agent = opts.agent === false ? new HTTPAgent() : opts.agent || HTTPAgent.global
+
+    const agent = opts.agent || new HTTPAgent()
     const method = opts.method || 'GET'
     const path = opts.path || '/'
     const host = opts.host = opts.host || 'localhost'
     const port = opts.port = opts.port || 80
 
-    const {
-      connection = new HTTPClientConnection(agent.createConnection(opts), opts)
-    } = opts
-
-    super(connection.socket)
+    super()
 
-    connection.req = this
+    agent.addRequest(this, opts)
 
     this.method = method
     this.path = path
     this.headers = { host: host + ':' + port, ...opts.headers }
 
-    this._connection = connection
     this._chunked = method !== 'GET' && method !== 'HEAD'
 
     this._pendingFinal = null

package/lib/constants.js

@@ -6,6 +6,17 @@ module.exports = {
     BEFORE_CHUNK: 4,
     IN_CHUNK: 5
   },
+  method: {
+    GET: 'GET',
+    HEAD: 'HEAD',
+    POST: 'POST',
+    PUT: 'PUT',
+    DELETE: 'DELETE',
+    CONNECT: 'CONNECT',
+    OPTIONS: 'OPTIONS',
+    TRACE: 'TRACE',
+    PATCH: 'PATCH'
+  },
   status: {
     100: 'Continue',
     101: 'Switching Protocols',

package/lib/incoming-message.js

@@ -33,6 +33,14 @@ module.exports = class HTTPIncomingMessage extends Readable {
     return name.toLowerCase() in this.headers
   }
 
+  setTimeout (ms, ontimeout) {
+    if (ontimeout) this.once('timeout', ontimeout)
+
+    this.socket.setTimeout(ms)
+
+    return this
+  }
+
   _predestroy () {
     if (this.upgrade === false && this.socket !== null) this.socket.destroy()
   }

package/lib/outgoing-message.js

@@ -34,6 +34,14 @@ module.exports = class HTTPOutgoingMessage extends Writable {
     this.headersSent = true
   }
 
+  setTimeout (ms, ontimeout) {
+    if (ontimeout) this.once('timeout', ontimeout)
+
+    this.socket.setTimeout(ms)
+
+    return this
+  }
+
   _header () {
     throw errors.NOT_IMPLEMENTED()
   }

package/lib/server-connection.js

@@ -1,3 +1,4 @@
+const tcp = require('bare-tcp')
 const HTTPIncomingMessage = require('./incoming-message')
 const HTTPServerResponse = require('./server-response')
 const constants = require('./constants')
@@ -5,6 +6,12 @@ const constants = require('./constants')
 const empty = Buffer.alloc(0)
 
 module.exports = class HTTPServerConnection {
+  static _connections = new WeakMap()
+
+  static for (socket) {
+    return this._connections.get(socket) || null
+  }
+
   constructor (server, socket, opts = {}) {
     const {
       IncomingMessage = HTTPIncomingMessage,
@@ -24,15 +31,26 @@ module.exports = class HTTPServerConnection {
     this._length = -1
     this._read = 0
     this._buffer = null
+    this._idle = true
 
     this._onerror = this._onerror.bind(this)
     this._ondata = this._ondata.bind(this)
     this._ondrain = this._ondrain.bind(this)
+    this._ontimeout = this._ontimeout.bind(this)
 
     socket
       .on('error', this._onerror)
       .on('data', this._ondata)
       .on('drain', this._ondrain)
+      .on('timeout', this._ontimeout)
+
+    HTTPServerConnection._connections.set(socket, this)
+
+    if (this.server.timeout) socket.setTimeout(this.server.timeout)
+  }
+
+  get idle () {
+    return this._idle
   }
 
   _onerror (err) {
@@ -40,6 +58,8 @@ module.exports = class HTTPServerConnection {
   }
 
   _ondata (data) {
+    this._idle = false
+
     if (this._state === constants.state.IN_BODY) return this._onbody(data)
 
     if (this._buffer !== null) {
@@ -172,10 +192,7 @@ module.exports = class HTTPServerConnection {
   }
 
   _onupgrade (head) {
-    this.socket
-      .off('error', this._onerror)
-      .off('data', this._ondata)
-      .off('drain', this._ondrain)
+    this._ondetach()
 
     const req = this.req
 
@@ -185,6 +202,14 @@ module.exports = class HTTPServerConnection {
     this.server.emit('upgrade', req, this.socket, head || empty)
   }
 
+  _ontimeout () {
+    const reqTimeout = this.req && this.req.emit('timeout')
+    const resTimeout = this.res && this.res.emit('timeout')
+    const serverTimeout = this.server.emit('timeout', this.socket)
+
+    if (!reqTimeout && !resTimeout && !serverTimeout) this.socket.destroy()
+  }
+
   _onfinished () {
     if (this.req) this.req.push(null)
   }
@@ -194,9 +219,24 @@ module.exports = class HTTPServerConnection {
     this._length = -1
     this._read = 0
     this._buffer = null
+    this._idle = true
+
+    if (this.server._state & tcp.constants.state.CLOSING) {
+      this.socket.destroy()
+    }
   }
 
   _ondrain () {
     if (this.res) this.res._continueWrite()
   }
+
+  _ondetach () {
+    this.socket
+      .off('error', this._onerror)
+      .off('data', this._ondata)
+      .off('drain', this._ondrain)
+      .off('timeout', this._ontimeout)
+
+    HTTPServerConnection._connections.delete(this.socket)
+  }
 }

package/lib/server.js

@@ -10,8 +10,34 @@ module.exports = class HTTPServer extends TCPServer {
 
     super({ allowHalfOpen: false })
 
+    this._timeout = 0
+
     this.on('connection', (socket) => new HTTPServerConnection(this, socket, opts))
 
     if (onrequest) this.on('request', onrequest)
   }
+
+  get timeout () {
+    return this._timeout || undefined // For Node.js compatibility
+  }
+
+  setTimeout (ms = 0, ontimeout) {
+    if (ontimeout) this.on('timeout', ontimeout)
+
+    this._timeout = ms
+
+    return this
+  }
+
+  close (onclose) {
+    super.close(onclose)
+
+    for (const socket of this._connections) {
+      const connection = HTTPServerConnection.for(socket)
+
+      if (connection && connection.idle) {
+        socket.destroy()
+      }
+    }
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-http1",
-  "version": "3.6.3",
+  "version": "3.8.0",
   "description": "Native HTTP/1 library for JavaScript",
   "exports": {
     ".": "./index.js",
@@ -27,7 +27,7 @@
   "dependencies": {
     "bare-events": "^2.0.0",
     "bare-stream": "^2.0.0",
-    "bare-tcp": "^1.1.2"
+    "bare-tcp": "^1.8.0"
   },
   "devDependencies": {
     "brittle": "^3.3.0",