feat: add new hooks api

lib/api/api-request.js

@@ -51,9 +51,10 @@ class RequestHandler extends AsyncResource {
     this.callback = callback
     this.res = null
     this.abort = null
+    this.resume = null
     this.body = body
-    this.trailers = {}
     this.context = null
+    this.trailers = {}
     this.onInfo = onInfo || null
     this.highWaterMark = highWaterMark
     this.reason = null
@@ -85,10 +86,12 @@ class RequestHandler extends AsyncResource {
     this.context = context
   }
 
-  onHeaders (statusCode, rawHeaders, resume, statusMessage) {
-    const { callback, opaque, abort, context, responseHeaders, highWaterMark } = this
+  onResponseStart (resume) {
+    this.resume = resume
+  }
 
-    const headers = responseHeaders === 'raw' ? util.parseRawHeaders(rawHeaders) : util.parseHeaders(rawHeaders)
+  onResponseHeaders (headers, statusCode) {
+    const { callback, opaque, abort, highWaterMark } = this
 
     if (statusCode < 200) {
       if (this.onInfo) {
@@ -97,11 +100,10 @@ class RequestHandler extends AsyncResource {
       return
     }
 
-    const parsedHeaders = responseHeaders === 'raw' ? util.parseHeaders(rawHeaders) : headers
-    const contentType = parsedHeaders['content-type']
-    const contentLength = parsedHeaders['content-length']
+    const contentType = headers['content-type']
+    const contentLength = headers['content-length']
     const res = new Readable({
-      resume,
+      resume: this.resume,
       abort,
       contentType,
       contentLength: this.method !== 'HEAD' && contentLength
@@ -124,21 +126,21 @@ class RequestHandler extends AsyncResource {
         trailers: this.trailers,
         opaque,
         body: res,
-        context
+        context: this.context
       })
     }
   }
 
-  onData (chunk) {
+  onResponseData (chunk) {
     return this.res.push(chunk)
   }
 
-  onComplete (trailers) {
-    util.parseHeaders(trailers, this.trailers)
+  onResponseEnd (trailers) {
+    Object.assign(this.trailers, trailers)
     this.res.push(null)
   }
 
-  onError (err) {
+  onResponseError (err) {
     const { res, callback, body, opaque } = this
 
     if (callback) {

lib/core/request.js

@@ -21,6 +21,7 @@ const {
 } = require('./util')
 const { channels } = require('./diagnostics.js')
 const { headerNameLowerCasedRecord } = require('./constants')
+const DecoratorHandler = require('../handler/decorator-handler')
 
 // Verifies that a given path is valid does not contain control chars \x00 to \x20
 const invalidPathRegex = /[^\u0021-\u00ff]/
@@ -187,7 +188,9 @@ class Request {
 
     this.servername = servername || getServerName(this.host) || null
 
-    this[kHandler] = handler
+    this[kHandler] = handler instanceof DecoratorHandler
+      ? handler
+      : new DecoratorHandler(handler)
 
     if (channels.create.hasSubscribers) {
       channels.create.publish({ request: this })

lib/core/util.js

@@ -500,11 +500,11 @@ function assertRequestHandler (handler, method, upgrade) {
     throw new InvalidArgumentError('handler must be an object')
   }
 
-  if (typeof handler.onConnect !== 'function') {
+  if (typeof handler.onConnect !== 'function' && typeof handler.onRequestStart !== 'function') {
     throw new InvalidArgumentError('invalid onConnect method')
   }
 
-  if (typeof handler.onError !== 'function') {
+  if (typeof handler.onError !== 'function' && typeof handler.onResponseError !== 'function') {
     throw new InvalidArgumentError('invalid onError method')
   }
 
@@ -517,15 +517,15 @@ function assertRequestHandler (handler, method, upgrade) {
       throw new InvalidArgumentError('invalid onUpgrade method')
     }
   } else {
-    if (typeof handler.onHeaders !== 'function') {
+    if (typeof handler.onHeaders !== 'function' && typeof handler.onResponseHeaders !== 'function') {
       throw new InvalidArgumentError('invalid onHeaders method')
     }
 
-    if (typeof handler.onData !== 'function') {
+    if (typeof handler.onData !== 'function' && typeof handler.onResponseData !== 'function') {
       throw new InvalidArgumentError('invalid onData method')
     }
 
-    if (typeof handler.onComplete !== 'function') {
+    if (typeof handler.onComplete !== 'function' && typeof handler.onResponseEnd !== 'function') {
       throw new InvalidArgumentError('invalid onComplete method')
     }
   }

lib/dispatcher/dispatcher-base.js

@@ -144,11 +144,12 @@ class DispatcherBase extends Dispatcher {
 
       return this[kDispatch](opts, handler)
     } catch (err) {
-      if (typeof handler.onError !== 'function') {
+      if (typeof handler.onError !== 'function' && typeof handler.onResponseError !== 'function') {
         throw new InvalidArgumentError('invalid onError method')
       }
 
-      handler.onError(err)
+      handler.onError?.(err)
+      handler.onResponseError?.(err)
 
       return false
     }

lib/global.js

@@ -2,7 +2,7 @@
 
 // We include a version number for the Dispatcher API. In case of breaking changes,
 // this version number must be increased to avoid conflicts.
-const globalDispatcher = Symbol.for('undici.globalDispatcher.1')
+const globalDispatcher = Symbol.for('undici.globalDispatcher.2')
 const { InvalidArgumentError } = require('./core/errors')
 const Agent = require('./dispatcher/agent')
 

lib/handler/decorator-handler.js

@@ -1,11 +1,23 @@
 'use strict'
 
 const assert = require('node:assert')
+const util = require('../core/util')
+
+function toRawHeaders (headers) {
+  const rawHeaders = []
+  if (headers != null) {
+    for (const [key, value] of Object.entries(headers)) {
+      rawHeaders.push(Buffer.from(key), Buffer.from(value))
+    }
+  }
+  return rawHeaders
+}
 
 module.exports = class DecoratorHandler {
   #handler
   #onCompleteCalled = false
   #onErrorCalled = false
+  #resume = null
 
   constructor (handler) {
     if (typeof handler !== 'object' || handler === null) {
@@ -14,12 +26,88 @@ module.exports = class DecoratorHandler {
     this.#handler = handler
   }
 
+  // New API
+
+  onRequestStart (abort) {
+    this.#handler.onRequestStart?.(abort)
+    this.#handler.onConnect?.(abort)
+  }
+
+  onResponseStart (resume) {
+    let ret = true
+
+    if (this.#handler.onResponseStart?.(resume) === false) {
+      ret = false
+    }
+
+    this.#resume = resume
+
+    return ret
+  }
+
+  onResponseHeaders (headers, statusCode) {
+    let ret = true
+
+    if (this.#handler.onResponseHeaders?.(headers, statusCode) === false) {
+      ret = false
+    }
+
+    if (this.#handler.onHeaders) {
+      const rawHeaders = toRawHeaders(headers)
+      if (this.#handler.onHeaders(statusCode, rawHeaders, this.#resume) === false) {
+        ret = false
+      }
+    }
+
+    return ret
+  }
+
+  onResponseData (data) {
+    let ret = true
+
+    if (this.#handler.onResponseData?.(data) === false) {
+      ret = false
+    }
+
+    if (this.#handler.onData?.(data) === false) {
+      ret = false
+    }
+
+    return ret
+  }
+
+  onResponseEnd (trailers) {
+    this.#handler.onResponseEnd?.(trailers)
+
+    if (this.#handler.onComplete) {
+      const rawHeaders = toRawHeaders(trailers)
+      this.#handler.onComplete(rawHeaders)
+    }
+  }
+
+  onResponseError (err) {
+    this.#handler.onResponseError?.(err)
+    this.#handler.onError?.(err)
+  }
+
+  // Old API
+
+  onRequestSent (...args) {
+    return this.#handler.onRequestSent?.(...args)
+  }
+
   onConnect (...args) {
+    this.#onErrorCalled = false
+    this.#onCompleteCalled = false
+
+    this.#handler.onRequestStart?.(args[0])
     return this.#handler.onConnect?.(...args)
   }
 
   onError (...args) {
     this.#onErrorCalled = true
+
+    this.#handler.onResponseError?.(args[0])
     return this.#handler.onError?.(...args)
   }
 
@@ -32,7 +120,7 @@ module.exports = class DecoratorHandler {
 
   onResponseStarted (...args) {
     assert(!this.#onCompleteCalled)
-    assert(!this.#onErrorCalled)
+    // assert(!this.#onErrorCalled)
 
     return this.#handler.onResponseStarted?.(...args)
   }
@@ -41,13 +129,34 @@ module.exports = class DecoratorHandler {
     assert(!this.#onCompleteCalled)
     assert(!this.#onErrorCalled)
 
-    return this.#handler.onHeaders?.(...args)
+    let ret
+
+    if (this.#handler.onResponseStart?.(args[2]) === false) {
+      // TODO (fix): Strictly speaking we should not call onRepsonseHeaders
+      // after this...
+      ret = false
+    }
+
+    if (this.#handler.onResponseHeaders) {
+      const headers = util.parseHeaders(args[1])
+      if (this.#handler.onResponseHeaders(headers, args[0]) === false) {
+        ret = false
+      }
+    }
+
+    if (this.#handler.onHeaders) {
+      const ret2 = this.#handler.onHeaders?.(...args)
+      ret ??= ret2
+    }
+
+    return ret
   }
 
   onData (...args) {
     assert(!this.#onCompleteCalled)
     assert(!this.#onErrorCalled)
 
+    this.#handler.onResponseData?.(args[0])
     return this.#handler.onData?.(...args)
   }
 
@@ -56,6 +165,12 @@ module.exports = class DecoratorHandler {
     assert(!this.#onErrorCalled)
 
     this.#onCompleteCalled = true
+
+    if (this.#handler.onResponseEnd) {
+      const headers = util.parseHeaders(args[0])
+      this.#handler.onResponseEnd(headers)
+    }
+
     return this.#handler.onComplete?.(...args)
   }
 

lib/handler/redirect-handler.js

@@ -5,6 +5,7 @@ const { kBodyUsed } = require('../core/symbols')
 const assert = require('node:assert')
 const { InvalidArgumentError } = require('../core/errors')
 const EE = require('node:events')
+const DecoratorHandler = require('./decorator-handler')
 
 const redirectableStatusCodes = [300, 301, 302, 303, 307, 308]
 
@@ -45,7 +46,9 @@ class RedirectHandler {
     this.abort = null
     this.opts = { ...opts, maxRedirections: 0 } // opts must be a copy
     this.maxRedirections = maxRedirections
-    this.handler = handler
+    this.handler = handler instanceof DecoratorHandler
+      ? handler
+      : new DecoratorHandler(handler)
     this.history = []
     this.redirectionLimitReached = false
 

test/client-request.js

@@ -881,43 +881,6 @@ test('request onInfo callback headers parsing', async (t) => {
   t.ok(true, 'pass')
 })
 
-test('request raw responseHeaders', async (t) => {
-  t = tspl(t, { plan: 4 })
-  const infos = []
-
-  const server = net.createServer((socket) => {
-    const lines = [
-      'HTTP/1.1 103 Early Hints',
-      'Link: </style.css>; rel=preload; as=style',
-      '',
-      'HTTP/1.1 200 OK',
-      'Date: Sat, 09 Oct 2010 14:28:02 GMT',
-      'Connection: close',
-      '',
-      'the body'
-    ]
-    socket.end(lines.join('\r\n'))
-  })
-  after(() => server.close())
-
-  await promisify(server.listen.bind(server))(0)
-
-  const client = new Client(`http://localhost:${server.address().port}`)
-  after(() => client.close())
-
-  const { body, headers } = await client.request({
-    path: '/',
-    method: 'GET',
-    responseHeaders: 'raw',
-    onInfo: (x) => { infos.push(x) }
-  })
-  await body.dump()
-  t.strictEqual(infos.length, 1)
-  t.deepStrictEqual(infos[0].headers, ['Link', '</style.css>; rel=preload; as=style'])
-  t.deepStrictEqual(headers, ['Date', 'Sat, 09 Oct 2010 14:28:02 GMT', 'Connection', 'close'])
-  t.ok(true, 'pass')
-})
-
 test('request formData', async (t) => {
   t = tspl(t, { plan: 1 })