@worker-tools/middleware/src/flushed.ts

A suite of standalone HTTP server middlewares for Worker Runtimes.

export { pipe as combine } from 'ts-functional-pipe';
import { ResolvablePromise } from '@worker-tools/resolvable-promise'
import type { Awaitable } from "./utils/common-types.js";
import type { Context } from "./index.js";

class FlushCallbackStream<T> extends TransformStream<T, T> { 
  constructor(flushCallback: () => void) { 
    super({ flush() { flushCallback() } }) 
  } 
}

export interface FlushedContext {
  /** 
   * A promise that resolves when the entire response body has been written to the wire, 
   * or if the stream has been closed for any other reason.
   * Most likely useful when combined with streaming responses.
   */
  flushed: Promise<Response>
}

export const flushed = () => async <X extends Context>(ax: Awaitable<X>): Promise<X & FlushedContext> => {
  const x = await ax;
  const flush = new ResolvablePromise<Response>()
  const flushed = Promise.resolve(flush)
  x.effects.push(res => {
    const ref: { res?: Response } = {}
    const cb = () => flush.resolve(ref.res!)
    const { status, statusText, headers, body } = res;
    ref.res = new Response(body != null
      ? body.pipeThrough(new FlushCallbackStream(cb)) 
      : (x.handled.then(cb), null), { status, statusText, headers }) 
    return ref.res;
  })
  return Object.assign(x, { flushed })
}