fixup

Author: ronag

lib/handler/cache-handler.js

@@ -10,7 +10,7 @@ const {
 function noop () {}
 
 /**
- * Writes a response to a CacheStore and then passes it on to the next handler
+ * @implements {import('../../types/dispatcher.d.ts').default.DispatchHandler}
  */
 class CacheHandler {
   /**
@@ -24,7 +24,7 @@ class CacheHandler {
   #store
 
   /**
-   * @type {import('../../types/dispatcher.d.ts').default.DispatchHandlers}
+   * @type {import('../../types/dispatcher.d.ts').default.DispatchHandler}
    */
   #handler
 
@@ -36,7 +36,7 @@ class CacheHandler {
   /**
    * @param {import('../../types/cache-interceptor.d.ts').default.CacheHandlerOptions} opts
    * @param {import('../../types/cache-interceptor.d.ts').default.CacheKey} cacheKey
-   * @param {import('../../types/dispatcher.d.ts').default.DispatchHandlers} handler
+   * @param {import('../../types/dispatcher.d.ts').default.DispatchHandler} handler
    */
   constructor (opts, cacheKey, handler) {
     const { store } = opts
@@ -154,15 +154,10 @@ class CacheHandler {
     this.#handler.onResponseEnd?.(controller, trailers)
   }
 
-  /**
-   * @see {DispatchHandlers.onError}
-   *
-   * @param {Error} err
-   */
   onResponseError (controller, err) {
     this.#writeStream?.destroy(err)
     this.#writeStream = undefined
-    this.#handler?.onResponseError(controller, err)
+    this.#handler.onResponseError?.(controller, err)
   }
 }
 

lib/handler/cache-revalidation-handler.js

@@ -13,7 +13,7 @@ const assert = require('node:assert')
  *
  * @see https://www.rfc-editor.org/rfc/rfc9111.html#name-validation
  *
- * @typedef {import('../../types/dispatcher.d.ts').default.DispatchHandlers} DispatchHandlers
+ * @implements {import('../../types/dispatcher.d.ts').default.DispatchHandler}
  */
 class CacheRevalidationHandler {
   #successful = false
@@ -22,15 +22,15 @@ class CacheRevalidationHandler {
    */
   #callback
   /**
-   * @type {(import('../../types/dispatcher.d.ts').default.DispatchHandlers)}
+   * @type {(import('../../types/dispatcher.d.ts').default.DispatchHandler)}
    */
   #handler
 
   #context
 
   /**
    * @param {(boolean, any) => void} callback Function to call if the cached value is valid
-   * @param {import('../../types/dispatcher.d.ts').default.DispatchHandlers} handler
+   * @param {import('../../types/dispatcher.d.ts').default.DispatchHandler} handler
    */
   constructor (callback, handler) {
     if (typeof callback !== 'function') {

lib/interceptor/cache.js

@@ -7,9 +7,10 @@ const CacheHandler = require('../handler/cache-handler')
 const MemoryCacheStore = require('../cache/memory-cache-store')
 const CacheRevalidationHandler = require('../handler/cache-revalidation-handler')
 const { assertCacheStore, assertCacheMethods, makeCacheKey, parseCacheControlHeader } = require('../util/cache.js')
+const { AbortError } = require('../core/errors.js')
 
 /**
- * @param {import('../../types/dispatcher.d.ts').default.DispatchHandlers} handler
+ * @param {import('../../types/dispatcher.d.ts').default.DispatchHandler} handler
  */
 function sendGatewayTimeout (handler) {
   let aborted = false
@@ -171,7 +172,7 @@ module.exports = (opts = {}) => {
             return stream.errored
           },
           abort (reason) {
-            stream.destroy(reason)
+            stream.destroy(reason ?? new AbortError())
           }
         }
 

types/dispatcher.d.ts

@@ -15,7 +15,7 @@ export default Dispatcher
 /** Dispatcher is the core API used to dispatch requests. */
 declare class Dispatcher extends EventEmitter {
   /** Dispatches a request. This API is expected to evolve through semver-major versions and is less stable than the preceding higher level APIs. It is primarily intended for library developers who implement higher level APIs on top of this. */
-  dispatch (options: Dispatcher.DispatchOptions, handler: Dispatcher.DispatchHandlers): boolean
+  dispatch (options: Dispatcher.DispatchOptions, handler: Dispatcher.DispatchHandler): boolean
   /** Starts two-way communications with the requested resource. */
   connect<TOpaque = null>(options: Dispatcher.ConnectOptions<TOpaque>): Promise<Dispatcher.ConnectData<TOpaque>>
   connect<TOpaque = null>(options: Dispatcher.ConnectOptions<TOpaque>, callback: (err: Error | null, data: Dispatcher.ConnectData<TOpaque>) => void): void
@@ -213,22 +213,46 @@ declare namespace Dispatcher {
     context: object;
   }
   export type StreamFactory<TOpaque = null> = (data: StreamFactoryData<TOpaque>) => Writable
-  export interface DispatchHandlers {
+
+  export interface DispatchController {
+    get aborted () : boolean
+    get paused () : boolean
+    get reason () : Error | null
+    abort (reason: Error): void
+    pause(): void
+    resume(): void
+  }
+
+  export interface DispatchHandler {
+    onRequestStart?(controller: DispatchController, context: any)
+    onResponseStart?(controller: DispatchController, statusCode: number, statusMessage?: string, headers: IncomingHttpHeaders)
+    onResponseData?(controller: DispatchController, chunk: Buffer)
+    onResponseEnd?(controller: DispatchController, trailers: IncomingHttpHeaders)
+    onResponseError?(controller: DispatchController, error: Error)
+
     /** Invoked before request is dispatched on socket. May be invoked multiple times when a request is retried when the request at the head of the pipeline fails. */
+    /** @deprecated */
     onConnect?(abort: (err?: Error) => void): void;
     /** Invoked when an error has occurred. */
+    /** @deprecated */
     onError?(err: Error): void;
     /** Invoked when request is upgraded either due to a `Upgrade` header or `CONNECT` method. */
+    /** @deprecated */
     onUpgrade?(statusCode: number, headers: Buffer[] | string[] | null, socket: Duplex): void;
     /** Invoked when response is received, before headers have been read. **/
+    /** @deprecated */
     onResponseStarted?(): void;
     /** Invoked when statusCode and headers have been received. May be invoked multiple times due to 1xx informational headers. */
+    /** @deprecated */
     onHeaders?(statusCode: number, headers: Buffer[], resume: () => void, statusText: string): boolean;
     /** Invoked when response payload data is received. */
+    /** @deprecated */
     onData?(chunk: Buffer): boolean;
     /** Invoked when response payload and trailers have been received and the request has completed. */
+    /** @deprecated */
     onComplete?(trailers: string[] | null): void;
     /** Invoked when a body chunk is sent to the server. May be invoked multiple times for chunked requests */
+    /** @deprecated */
     onBodySent?(chunkSize: number, totalBytesSent: number): void;
   }
   export type PipelineHandler<TOpaque = null> = (data: PipelineHandlerData<TOpaque>) => Readable