@fastify/reply-from 10.0.0 → 11.0.0

package/test/undici-agent.test.js

@@ -3,7 +3,7 @@
 const t = require('tap')
 const Fastify = require('fastify')
 const proxyquire = require('proxyquire')
-const http = require('http')
+const http = require('node:http')
 const get = require('simple-get').concat
 const undici = require('undici')
 const { getUndiciOptions } = require('../lib/request')
@@ -31,7 +31,7 @@ target.listen({ port: 0 }, err => {
   const From = proxyquire('..', {
     './lib/request.js': proxyquire('../lib/request.js', {
       undici: proxyquire('undici', {
-        './lib/agent': proxyquire('undici/lib/agent.js', {
+        './lib/dispatcher/agent': proxyquire('undici/lib/dispatcher/agent.js', {
           './pool': class Pool extends undici.Pool {
             constructor (url, options) {
               super(url, options)

package/test/undici-body.test.js

@@ -3,7 +3,7 @@
 const t = require('tap')
 const Fastify = require('fastify')
 const From = require('..')
-const http = require('http')
+const http = require('node:http')
 const get = require('simple-get').concat
 
 const instance = Fastify()

package/test/undici-connect-timeout.test.js

@@ -1,24 +1,22 @@
 'use strict'
 
 const t = require('tap')
-const http = require('http')
-const net = require('net')
+const http = require('node:http')
+const net = require('node:net')
 const Fastify = require('fastify')
 const From = require('..')
 const got = require('got')
 
-t.autoend(false)
-
+t.test('undici connect timeout', async (t) => {
 // never connect
-net.connect = function (options) {
-  return new net.Socket(options)
-}
+  net.connect = function (options) {
+    return new net.Socket(options)
+  }
 
-const target = http.createServer((req, res) => {
-  t.fail('target never called')
-})
+  const target = http.createServer((req, res) => {
+    t.fail('target never called')
+  })
 
-async function main () {
   t.plan(2)
   await target.listen({ port: 0 })
 
@@ -53,6 +51,4 @@ async function main () {
   }
 
   t.fail()
-}
-
-main()
+})

package/test/undici-custom-dispatcher.test.js

@@ -0,0 +1,73 @@
+'use strict'
+
+const { test } = require('tap')
+const undici = require('undici')
+const Fastify = require('fastify')
+const From = require('..')
+
+class CustomDispatcher {
+  constructor (...args) {
+    this._dispatcher = new undici.Pool(...args)
+  }
+
+  request (...args) {
+    return this._dispatcher.request(...args)
+  }
+
+  close (...args) {
+    return this._dispatcher.close(...args)
+  }
+
+  destroy (...args) {
+    return this._dispatcher.destroy(...args)
+  }
+}
+
+test('use a custom instance of \'undici\'', async t => {
+  const target = Fastify({
+    keepAliveTimeout: 1
+  })
+
+  target.get('/', (req, reply) => {
+    t.pass('request proxied')
+
+    reply.headers({
+      'Content-Type': 'text/plain',
+      'x-my-header': 'hello!'
+    })
+
+    reply.statusCode = 205
+    reply.send('hello world')
+  })
+
+  await target.listen({ port: 3001 })
+  t.teardown(async () => {
+    await target.close()
+  })
+
+  const instance = Fastify({
+    keepAliveTimeout: 1
+  })
+
+  instance.register(From, {
+    undici: new CustomDispatcher('http://localhost:3001')
+  })
+
+  instance.get('/', (request, reply) => {
+    reply.from('http://myserver.local')
+  })
+
+  await instance.listen({ port: 0 })
+  t.teardown(async () => {
+    await instance.close()
+  })
+
+  const res = await undici.request(`http://localhost:${instance.server.address().port}`)
+
+  t.equal(res.headers['content-type'], 'text/plain')
+  t.equal(res.headers['x-my-header'], 'hello!')
+  t.equal(res.statusCode, 205)
+
+  const data = await res.body.text()
+  t.equal(data, 'hello world')
+})

package/test/undici-global-agent.test.js

@@ -2,7 +2,7 @@
 
 const { test } = require('tap')
 const Fastify = require('fastify')
-const http = require('http')
+const http = require('node:http')
 const get = require('simple-get').concat
 const undici = require('undici')
 const From = require('..')

package/test/undici-no-destroy.test.js

@@ -0,0 +1,29 @@
+'use strict'
+
+const { test } = require('tap')
+const Fastify = require('fastify')
+const undici = require('undici')
+const From = require('..')
+
+test('destroyAgent false', async (t) => {
+  const mockAgent = new undici.Agent()
+  mockAgent.destroy = () => {
+    t.fail()
+  }
+  const instance = Fastify()
+
+  t.teardown(instance.close.bind(instance))
+
+  instance.get('/', (request, reply) => {
+    reply.from()
+  })
+
+  instance.register(From, {
+    base: 'http://localhost:4242',
+    undici: mockAgent,
+    destroyAgent: false
+  })
+
+  await instance.ready()
+  await instance.close()
+})

package/test/undici-options.test.js

@@ -3,7 +3,7 @@
 const t = require('tap')
 const Fastify = require('fastify')
 const proxyquire = require('proxyquire')
-const http = require('http')
+const http = require('node:http')
 const get = require('simple-get').concat
 const undici = require('undici')
 const { getUndiciOptions } = require('../lib/request')

package/test/undici-proxy-agent.test.js

@@ -0,0 +1,81 @@
+'use strict'
+
+const { test } = require('tap')
+const { createServer } = require('node:http')
+const Fastify = require('fastify')
+const get = require('simple-get').concat
+const { createProxy } = require('proxy')
+const From = require('..')
+
+const configFormat = {
+  string: (value) => value,
+  'url instance': (value) => new URL(value),
+  object: (value) => ({ uri: value })
+}
+
+for (const [description, format] of Object.entries(configFormat)) {
+  test(`use undici ProxyAgent to connect through proxy - configured via ${description}`, async (t) => {
+    t.plan(5)
+    const target = await buildServer()
+    const proxy = await buildProxy()
+    t.teardown(target.close.bind(target))
+    t.teardown(proxy.close.bind(proxy))
+
+    const targetUrl = `http://localhost:${target.address().port}`
+    const proxyUrl = `http://localhost:${proxy.address().port}`
+
+    proxy.on('connect', () => {
+      t.ok(true, 'should connect to proxy')
+    })
+
+    target.on('request', (req, res) => {
+      res.setHeader('content-type', 'application/json')
+      res.end(JSON.stringify({ hello: 'world' }))
+    })
+
+    const instance = Fastify()
+    t.teardown(instance.close.bind(instance))
+
+    instance.register(From, {
+      base: targetUrl,
+      undici: {
+        proxy: format(proxyUrl)
+      }
+    })
+
+    instance.get('/', (request, reply) => {
+      reply.from()
+    })
+
+    const executionFlow = () => new Promise((resolve) => {
+      instance.listen({ port: 0 }, err => {
+        t.error(err)
+
+        get(`http://localhost:${instance.server.address().port}`, (err, res, data) => {
+          t.error(err)
+          t.same(res.statusCode, 200)
+          t.match(JSON.parse(data.toString()), { hello: 'world' })
+          resolve()
+          instance.close()
+          target.close()
+        })
+      })
+    })
+
+    await executionFlow()
+  })
+}
+
+function buildServer () {
+  return new Promise((resolve) => {
+    const server = createServer()
+    server.listen(0, () => resolve(server))
+  })
+}
+
+function buildProxy () {
+  return new Promise((resolve) => {
+    const server = createProxy(createServer())
+    server.listen(0, () => resolve(server))
+  })
+}

package/test/undici-retry.test.js

@@ -7,7 +7,7 @@ const { test } = require('tap')
 
 let retryNum = 1
 
-const target = require('http').createServer(function (req, res) {
+const target = require('node:http').createServer(function (req, res) {
   if (retryNum % 2 !== 0) {
     req.socket.destroy()
   } else {

package/test/undici-timeout-body-partial.test.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const t = require('tap')
-const http = require('http')
+const http = require('node:http')
 const Fastify = require('fastify')
 const From = require('..')
 const got = require('got')
@@ -9,23 +9,21 @@ const FakeTimers = require('@sinonjs/fake-timers')
 
 const clock = FakeTimers.createClock()
 
-t.autoend(false)
-
-const target = http.createServer((req, res) => {
-  t.pass('request proxied')
-  req.on('data', () => undefined)
-  req.on('end', () => {
-    res.writeHead(200)
-    res.flushHeaders()
-    res.write('test')
-    clock.setTimeout(() => {
-      res.end()
-      t.end()
-    }, 1000)
+t.test('undici body timeout', async (t) => {
+  const target = http.createServer((req, res) => {
+    t.pass('request proxied')
+    req.on('data', () => undefined)
+    req.on('end', () => {
+      res.writeHead(200)
+      res.flushHeaders()
+      res.write('test')
+      clock.setTimeout(() => {
+        res.end()
+        t.end()
+      }, 1000)
+    })
   })
-})
 
-async function main () {
   await target.listen({ port: 0 })
 
   const instance = Fastify()
@@ -55,6 +53,4 @@ async function main () {
   }
 
   t.fail()
-}
-
-main()
+})

package/test/undici-timeout-body.test.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const t = require('tap')
-const http = require('http')
+const http = require('node:http')
 const Fastify = require('fastify')
 const From = require('..')
 const got = require('got')
@@ -9,21 +9,19 @@ const FakeTimers = require('@sinonjs/fake-timers')
 
 const clock = FakeTimers.createClock()
 
-t.autoend(false)
-
-const target = http.createServer((req, res) => {
-  t.pass('request proxied')
-  req.on('data', () => undefined)
-  req.on('end', () => {
-    res.flushHeaders()
-    clock.setTimeout(() => {
-      res.end()
-      t.end()
-    }, 1000)
+t.test('undici body timeout', async (t) => {
+  const target = http.createServer((req, res) => {
+    t.pass('request proxied')
+    req.on('data', () => undefined)
+    req.on('end', () => {
+      res.flushHeaders()
+      clock.setTimeout(() => {
+        res.end()
+        t.end()
+      }, 1000)
+    })
   })
-})
 
-async function main () {
   await target.listen({ port: 0 })
 
   const instance = Fastify()
@@ -58,6 +56,4 @@ async function main () {
   }
 
   t.fail()
-}
-
-main()
+})

package/test/undici-timeout.test.js

@@ -8,21 +8,19 @@ const FakeTimers = require('@sinonjs/fake-timers')
 
 const clock = FakeTimers.createClock()
 
-t.autoend(false)
+t.test('undici request timeout', async (t) => {
+  const target = Fastify()
+  t.teardown(target.close.bind(target))
 
-const target = Fastify()
-t.teardown(target.close.bind(target))
+  target.get('/', (request, reply) => {
+    t.pass('request arrives')
 
-target.get('/', (request, reply) => {
-  t.pass('request arrives')
-
-  clock.setTimeout(() => {
-    reply.status(200).send('hello world')
-    t.end()
-  }, 1000)
-})
+    clock.setTimeout(() => {
+      reply.status(200).send('hello world')
+      t.end()
+    }, 1000)
+  })
 
-async function main () {
   await target.listen({ port: 0 })
 
   const instance = Fastify()
@@ -57,6 +55,4 @@ async function main () {
   }
 
   t.fail()
-}
-
-main()
+})

package/test/undici-with-path-in-base.test.js

@@ -3,7 +3,7 @@
 const t = require('tap')
 const Fastify = require('fastify')
 const From = require('..')
-const http = require('http')
+const http = require('node:http')
 const get = require('simple-get').concat
 
 const instance = Fastify()

package/test/undici.test.js

@@ -3,7 +3,7 @@
 const t = require('tap')
 const Fastify = require('fastify')
 const From = require('..')
-const http = require('http')
+const http = require('node:http')
 const get = require('simple-get').concat
 
 const instance = Fastify()

package/test/unix-http-undici-from.test.js

@@ -3,9 +3,9 @@
 const t = require('tap')
 const Fastify = require('fastify')
 const From = require('..')
-const fs = require('fs')
-const querystring = require('querystring')
-const http = require('http')
+const fs = require('node:fs')
+const querystring = require('node:querystring')
+const http = require('node:http')
 const get = require('simple-get').concat
 
 if (process.platform === 'win32') {

package/test/unix-http-undici.test.js

@@ -3,9 +3,9 @@
 const t = require('tap')
 const Fastify = require('fastify')
 const From = require('..')
-const fs = require('fs')
-const querystring = require('querystring')
-const http = require('http')
+const fs = require('node:fs')
+const querystring = require('node:querystring')
+const http = require('node:http')
 const get = require('simple-get').concat
 
 if (process.platform === 'win32') {

package/test/unix-http.test.js

@@ -3,9 +3,9 @@
 const t = require('tap')
 const Fastify = require('fastify')
 const From = require('..')
-const fs = require('fs')
-const querystring = require('querystring')
-const http = require('http')
+const fs = require('node:fs')
+const querystring = require('node:querystring')
+const http = require('node:http')
 const get = require('simple-get').concat
 
 if (process.platform === 'win32') {

package/test/unix-https-undici.test.js

@@ -3,11 +3,11 @@
 const t = require('tap')
 const Fastify = require('fastify')
 const From = require('..')
-const https = require('https')
+const https = require('node:https')
 const get = require('simple-get').concat
-const fs = require('fs')
-const querystring = require('querystring')
-const path = require('path')
+const fs = require('node:fs')
+const querystring = require('node:querystring')
+const path = require('node:path')
 const certs = {
   key: fs.readFileSync(path.join(__dirname, 'fixtures', 'fastify.key')),
   cert: fs.readFileSync(path.join(__dirname, 'fixtures', 'fastify.cert'))

package/test/unix-https.test.js

@@ -3,11 +3,11 @@
 const t = require('tap')
 const Fastify = require('fastify')
 const From = require('..')
-const https = require('https')
+const https = require('node:https')
 const get = require('simple-get').concat
-const fs = require('fs')
-const querystring = require('querystring')
-const path = require('path')
+const fs = require('node:fs')
+const querystring = require('node:querystring')
+const path = require('node:path')
 const certs = {
   key: fs.readFileSync(path.join(__dirname, 'fixtures', 'fastify.key')),
   cert: fs.readFileSync(path.join(__dirname, 'fixtures', 'fastify.cert'))

package/types/index.d.ts

@@ -1,33 +1,35 @@
 /// <reference types="node" />
 
 import {
-  FastifyRequest,
+  FastifyPluginCallback,
   FastifyReply,
+  FastifyRequest,
+  HTTPMethods,
   RawReplyDefaultExpression,
   RawServerBase,
   RequestGenericInterface,
-  HTTPMethods,
-  FastifyPluginCallback,
+  RouteGenericInterface
 } from 'fastify';
 
 import {
+  Agent,
+  AgentOptions,
   IncomingHttpHeaders,
   RequestOptions,
-  AgentOptions,
-  Agent,
 } from "http";
 import {
-  RequestOptions as SecureRequestOptions,
-  AgentOptions as SecureAgentOptions,
-  Agent as SecureAgent
-} from "https";
-import {
-  IncomingHttpHeaders as Http2IncomingHttpHeaders,
-  ClientSessionRequestOptions,
   ClientSessionOptions,
+  ClientSessionRequestOptions,
+  IncomingHttpHeaders as Http2IncomingHttpHeaders,
   SecureClientSessionOptions,
 } from "http2";
-import { Pool } from 'undici'
+import {
+  Agent as SecureAgent,
+  AgentOptions as SecureAgentOptions,
+  RequestOptions as SecureRequestOptions
+} from "https";
+import { Pool } from 'undici';
+import { ProxyAgent } from 'undici';
 
 declare module "fastify" {
   interface FastifyReply {
@@ -39,19 +41,33 @@ declare module "fastify" {
 }
 
 type FastifyReplyFrom = FastifyPluginCallback<fastifyReplyFrom.FastifyReplyFromOptions>
-
 declare namespace fastifyReplyFrom {
-  type QueryStringFunction = (search: string | undefined, reqUrl: string) => string;
+  type QueryStringFunction = (
+    search: string | undefined,
+    reqUrl: string,
+    request: FastifyRequest<RequestGenericInterface, RawServerBase>
+  ) => string;
+
+  export type RetryDetails = {
+    err: Error;
+    req: FastifyRequest<RequestGenericInterface, RawServerBase>;
+    res: FastifyReply<RouteGenericInterface, RawServerBase>;
+    attempt: number;
+    retriesCount: number;
+    getDefaultDelay: () => number | null;
+  }
   export interface FastifyReplyFromHooks {
     queryString?: { [key: string]: unknown } | QueryStringFunction;
     contentType?: string;
+    retryDelay?: (details: RetryDetails) => {} | null;
+    retriesCount?: number;
     onResponse?: (
       request: FastifyRequest<RequestGenericInterface, RawServerBase>,
-      reply: FastifyReply<RawServerBase>,
+      reply: FastifyReply<RouteGenericInterface, RawServerBase>,
       res: RawReplyDefaultExpression<RawServerBase>
     ) => void;
     onError?: (
-      reply: FastifyReply<RawServerBase>,
+      reply: FastifyReply<RouteGenericInterface, RawServerBase>,
       error: { error: Error }
     ) => void;
     body?: unknown;
@@ -67,6 +83,7 @@ declare namespace fastifyReplyFrom {
       request: FastifyRequest<RequestGenericInterface, RawServerBase>,
       base: string
     ) => string;
+    method?: HTTPMethods;
   }
 
   interface Http2Options {
@@ -88,16 +105,17 @@ declare namespace fastifyReplyFrom {
     disableCache?: boolean;
     http?: HttpOptions;
     http2?: Http2Options | boolean;
-    undici?: Pool.Options;
+    undici?: Pool.Options & { proxy?: string  | URL | ProxyAgent.Options };
     contentTypesToEncode?: string[];
     retryMethods?: (HTTPMethods | 'TRACE')[];
     maxRetriesOn503?: number;
     disableRequestLogging?: boolean;
     globalAgent?: boolean;
+    destroyAgent?: boolean;
   }
 
   export const fastifyReplyFrom: FastifyReplyFrom
-  export { fastifyReplyFrom as default }
+  export { fastifyReplyFrom as default };
 }
 
 declare function fastifyReplyFrom(...params: Parameters<FastifyReplyFrom>): ReturnType<FastifyReplyFrom>