next.js/packages/next/src/server/lib/clone-response.ts
clone-response.ts83 lines2.4 KB
const noop = () => {}

let registry: FinalizationRegistry<WeakRef<ReadableStream>> | undefined

if (globalThis.FinalizationRegistry) {
  registry = new FinalizationRegistry((weakRef: WeakRef<ReadableStream>) => {
    const stream = weakRef.deref()
    if (stream && !stream.locked) {
      stream.cancel('Response object has been garbage collected').then(noop)
    }
  })
}

/**
 * Clones a response by teeing the body so we can return two independent
 * ReadableStreams from it. This avoids the bug in the undici library around
 * response cloning.
 *
 * After cloning, the original response's body will be consumed and closed.
 *
 * @see https://github.com/vercel/next.js/pull/73274
 *
 * @param original - The original response to clone.
 * @returns A tuple containing two independent clones of the original response.
 */
export function cloneResponse(original: Response): [Response, Response] {
  // If the response has no body, then we can just return the original response
  // twice because it's immutable.
  if (!original.body) {
    return [original, original]
  }

  const [body1, body2] = original.body.tee()

  const cloned1 = new Response(body1, {
    status: original.status,
    statusText: original.statusText,
    headers: original.headers,
  })

  Object.defineProperty(cloned1, 'url', {
    value: original.url,
    // How the original response.url behaves
    configurable: true,
    enumerable: true,
    writable: false,
  })

  const cloned2 = new Response(body2, {
    status: original.status,
    statusText: original.statusText,
    headers: original.headers,
  })

  Object.defineProperty(cloned2, 'url', {
    value: original.url,
    // How the original response.url behaves
    configurable: true,
    enumerable: true,
    writable: false,
  })

  // The Fetch Standard allows users to skip consuming the response body by
  // relying on garbage collection to release connection resources.
  // https://github.com/nodejs/undici?tab=readme-ov-file#garbage-collection
  //
  // To cancel the stream you then need to cancel both resulting branches.
  // Teeing a stream will generally lock it for the duration, preventing other
  // readers from locking it.
  // https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream/tee
  if (registry) {
    if (cloned1.body) {
      registry.register(cloned1, new WeakRef(cloned1.body))
    }

    if (cloned2.body) {
      registry.register(cloned2, new WeakRef(cloned2.body))
    }
  }

  return [cloned1, cloned2]
}
Quest for Codev2.0.0
/
SIGN IN