@fastify/reply-from 11.0.2 → 12.0.1

package/README.md

@@ -1,8 +1,8 @@
 # @fastify/reply-from
 
-[![CI](https://github.com/fastify/fastify-reply-from/workflows/CI/badge.svg)](https://github.com/fastify/fastify-reply-from/actions/workflows/ci.yml)
+[![CI](https://github.com/fastify/fastify-reply-from/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/fastify/fastify-reply-from/actions/workflows/ci.yml)
 [![NPM version](https://img.shields.io/npm/v/@fastify/reply-from.svg?style=flat)](https://www.npmjs.com/package/@fastify/reply-from)
-[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
+[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)
 
 Fastify plugin to forward the current HTTP request to another server.
 HTTP2 to HTTP is supported too.
@@ -14,7 +14,7 @@ npm i @fastify/reply-from
 ```
 
 ## Compatibility with @fastify/multipart
-`@fastify/reply-from` and [`@fastify/multipart`](https://github.com/fastify/fastify-multipart) should not be registered as sibling plugins nor should they be registered in plugins which have a parent-child relationship.`<br>` The two plugins are incompatible, in the sense that the behavior of `@fastify/reply-from` might not be the expected one when the above-mentioned conditions are not respected.`<br>` This is due to the fact that `@fastify/multipart` consumes the multipart content by parsing it, hence this content is not forwarded to the target service by `@fastify/reply-from`.`<br>`
+`@fastify/reply-from` and [`@fastify/multipart`](https://github.com/fastify/fastify-multipart) should not be registered as sibling plugins nor should they be registered in plugins that have a parent-child relationship.`<br>` The two plugins are incompatible, in the sense that the behavior of `@fastify/reply-from` might not be the expected one when the above-mentioned conditions are not respected.`<br>` This is due to the fact that `@fastify/multipart` consumes the multipart content by parsing it, hence this content is not forwarded to the target service by `@fastify/reply-from`.`<br>`
 However, the two plugins may be used within the same fastify instance, at the condition that they belong to disjoint branches of the fastify plugins hierarchy tree.
 
 ## Usage
@@ -83,10 +83,10 @@ proxy.register(require('@fastify/reply-from'), {
 #### `undici`
 
 By default, [undici](https://github.com/nodejs/undici) will be used to perform the HTTP/1.1
-requests. Enabling this flag should guarantee
+requests. Enabling this option should guarantee
 20-50% more throughput.
 
-This flag could controls the settings of the undici client, like so:
+This option controls the settings of the undici client, like so:
 
 ```js
 proxy.register(require('@fastify/reply-from'), {
@@ -167,7 +167,7 @@ proxy.register(require('@fastify/reply-from'), {
 
 #### `http2`
 
-You can either set `http2` to `true` or set the settings object to connect to a HTTP/2 server.
+You can either set `http2` to `true` or set the settings object to connect to an HTTP/2 server.
 The `http2` settings object has the shape of:
 
 ```js
@@ -188,7 +188,7 @@ proxy.register(require('@fastify/reply-from'), {
 
 #### `disableRequestLogging`
 
-By default package will issue log messages when a request is received. By setting this option to true, these log messages will be disabled.
+By default, the package will issue log messages when a request is received. By setting this option to true, these log messages will be disabled.
 
 Default for `disableRequestLogging` will be `false`. To disable the log messages set `disableRequestLogging` to `true`.
 
@@ -206,7 +206,7 @@ The number of parsed URLs that will be cached. Default: `100`.
 #### `disableCache`
 
 This option will disable the URL caching.
-This cache is dedicated to reduce the amount of URL object generation.
+This cache is dedicated to reducing the amount of URL object generation.
 Generating URLs is a main bottleneck of this module, please disable this cache with caution.
 
 #### `contentTypesToEncode`
@@ -231,7 +231,7 @@ This plugin will always retry on 503 errors, _unless_ `retryMethods` does not co
 
 #### `globalAgent`
 
-Enables the possibility to explictly opt-in for global agents.
+Enables the possibility to explicitly opt-in for global agents.
 
 Usage for undici global agent:
 
@@ -274,7 +274,7 @@ By Default: `false`
 
 This plugin will always retry on `GET` requests that returns 503 errors, _unless_ `retryMethods` does not contain `GET`.
 
-This option set the limit on how many times the plugin should retry the request, specifically for 503 errors.
+This option sets the limit on how many times the plugin should retry the request, specifically for 503 errors.
 
 By Default: 10
 
@@ -293,7 +293,7 @@ If a `handler` is passed to the `retryDelay` object the onus is on the client to
 - `res` is the raw response returned by the underlying agent (if available) __Note__: this object is not a Fastify response, but instead the low-level response from the agent. This property may be null if no response was obtained at all, like from a connection reset or timeout.
 - `attempt` in the object callback refers to the current retriesAttempt number. You are given the freedom to use this in concert with the retryCount property set to handle retries
 - `getDefaultRetry` refers to the default retry handler. If this callback returns not null and you wish to handle those case of errors simply invoke it as done below.
-- `retriesCount` refers to the retriesCount property a client passes to reply-from. Note if the client does not explicitly set this value it will default to 0. The objective value here is to avoid hard-coding and seeing the retriesCount set. It is your perogative to ensure that you ensure the value here is as you wish (and not `0` if not intended to be as a result of a lack of not setting it).
+- `retriesCount` refers to the retriesCount property a client passes to reply-from. Note if the client does not explicitly set this value it will default to 0. The objective value here is to avoid hard-coding and seeing the retriesCount set. It is your prerogative to ensure that you ensure the value here is as you wish (and not `0` if not intended to be as a result of a lack of not setting it).
 
 Given example
 
@@ -339,14 +339,14 @@ const customRetryLogic = ({req, res, err, getDefaultRetry}: RetryDetails) => {
 The plugin decorates the
 [`Reply`](https://fastify.dev/docs/latest/Reference/Reply)
 instance with a `from` method, which will reply to the original request
-__from the desired source__. The options allows to override any part of
+__from the desired source__. The options allows overrides of any part of
 the request or response being sent or received to/from the source.
 
 **Note: If `base` is specified in plugin options, the `source` here should not override the host/origin.**
 
 #### `onResponse(request, reply, response)`
 
-Called when a HTTP response is received from the source. Passed the original source `request`, the in-progress reply to the source as `reply`, and the ongoing `response` from the upstream server.
+Called when an HTTP response is received from the source. Passed the original source `request`, the in-progress reply to the source as `reply`, and the ongoing `response` from the upstream server.
 
 The default behavior is `reply.send(response.stream)`, which will be disabled if the
 option is specified.
@@ -367,10 +367,10 @@ the `content-length` header.
 
 #### `onError(reply, error)`
 
-Called when a HTTP response is received with error from the source.
+Called when an HTTP response is received with error from the source.
 The default behavior is `reply.send(error)`, which will be disabled if the
 option is specified.
-It must reply the error.
+It must reply with the error.
 
 #### `rewriteHeaders(headers, request)`
 
@@ -387,7 +387,7 @@ It must return the new headers object.
 
 #### `getUpstream(request, base)`
 
-Called to get upstream destination, before the request is being sent. Useful when you want to decide which target server to call based on the request data.
+Called to get upstream destination, before the request is sent. Useful when you want to decide which target server to call based on the request data.
 Helpful for a gradual rollout of new services.
 Parameters are the Fastify request and the base string from the plugin options.
 It must return the upstream destination.

package/eslint.config.js

@@ -0,0 +1,6 @@
+'use strict'
+
+module.exports = require('neostandard')({
+  ignores: require('neostandard').resolveIgnoresFromGitignore(),
+  ts: true
+})

package/examples/example.js

@@ -6,7 +6,7 @@ const target = Fastify({
   logger: true
 })
 
-target.get('/', (request, reply) => {
+target.get('/', (_request, reply) => {
   reply.send('hello world')
 })
 
@@ -19,7 +19,7 @@ proxy.register(require('..'), {
   base: 'http://localhost:3001/'
 })
 
-proxy.get('/', (request, reply) => {
+proxy.get('/', (_request, reply) => {
   reply.from('/')
 })
 

package/index.js

@@ -149,7 +149,7 @@ const fastifyReplyFrom = fp(function from (fastify, opts, next) {
         // Magic number, so why not 42? We might want to make this configurable.
         let retryAfter = 42 * Math.random() * (retries + 1)
 
-        if (res && res.headers['retry-after']) {
+        if (res?.headers['retry-after']) {
           retryAfter = res.headers['retry-after']
         }
         if (res && res.statusCode === 503 && req.method === 'GET') {
@@ -164,9 +164,7 @@ const fastifyReplyFrom = fp(function from (fastify, opts, next) {
     }
 
     if (retryDelay) {
-      requestImpl = createRequestRetry(request, this, (req, res, err, retries) => {
-        return retryDelay({ err, req, res, attempt: retries, getDefaultDelay, retriesCount })
-      })
+      requestImpl = createRequestRetry(request, this, (req, res, err, retries) => retryDelay({ err, req, res, attempt: retries, getDefaultDelay, retriesCount }))
     } else {
       requestImpl = createRequestRetry(request, this, getDefaultDelay)
     }
@@ -223,7 +221,7 @@ const fastifyReplyFrom = fp(function from (fastify, opts, next) {
     done()
   })
 
-  fastify.onClose((fastify, next) => {
+  fastify.onClose((_fastify, next) => {
     close()
     // let the event loop do a full run so that it can
     // actually destroy those sockets
@@ -257,15 +255,15 @@ function getQueryString (search, reqUrl, opts, request) {
   return ''
 }
 
-function headersNoOp (headers, originalReq) {
+function headersNoOp (headers, _originalReq) {
   return headers
 }
 
-function requestHeadersNoOp (originalReq, headers) {
+function requestHeadersNoOp (_originalReq, headers) {
   return headers
 }
 
-function upstreamNoOp (req, base) {
+function upstreamNoOp (_req, base) {
   return base
 }
 

package/lib/request.js

@@ -75,7 +75,7 @@ function buildRequest (opts) {
   if (isHttp2) {
     return { request: handleHttp2Req, close, retryOnError: 'ECONNRESET' }
   } else if (hasUndiciOptions) {
-    if (opts.base && opts.base.startsWith('unix+')) {
+    if (opts.base?.startsWith('unix+')) {
       const undiciOpts = getUndiciOptions(opts.undici)
       undiciOpts.socketPath = decodeURIComponent(new URL(opts.base).host)
       const protocol = opts.base.startsWith('unix+https') ? 'https' : 'http'
@@ -102,8 +102,8 @@ function buildRequest (opts) {
     }
 
     if (hasUndiciOptions) {
-      undiciAgent && undiciAgent.destroy()
-      undiciInstance && undiciInstance.destroy()
+      undiciAgent?.destroy()
+      undiciInstance?.destroy()
     } else if (!isHttp2) {
       agents['http:'].destroy()
       agents['https:'].destroy()
@@ -304,7 +304,7 @@ function getAgentOptions (opts) {
     keepAliveMsecs: 60 * 1000, // 1 minute
     maxSockets: 2048,
     maxFreeSockets: 2048,
-    ...(opts.http && opts.http.agentOptions)
+    ...(opts.http?.agentOptions)
   }
 }
 

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@fastify/reply-from",
-  "version": "11.0.2",
+  "version": "12.0.1",
   "description": "forward your HTTP request to another server, for fastify",
   "main": "index.js",
   "type": "commonjs",
   "types": "types/index.d.ts",
   "scripts": {
-    "lint": "standard | snazzy",
-    "lint:fix": "standard --fix | snazzy",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
     "test": "npm run test:unit && npm run test:typescript",
     "test:unit": "tap",
     "test:typescript": "tsd"
@@ -23,31 +23,58 @@
     "proxy"
   ],
   "author": "Matteo Collina <hello@matteocollina.com>",
+  "contributors": [
+    {
+      "name": "James Sumners",
+      "url": "https://james.sumners.info"
+    },
+    {
+      "name": "Manuel Spigolon",
+      "email": "behemoth89@gmail.com"
+    },
+    {
+      "name": "Aras Abbasi",
+      "email": "aras.abbasi@gmail.com"
+    },
+    {
+      "name": "Frazer Smith",
+      "email": "frazer.dev@icloud.com",
+      "url": "https://github.com/fdawgs"
+    }
+  ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/fastify/fastify-reply-from/issues"
   },
   "homepage": "https://github.com/fastify/fastify-reply-from#readme",
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/fastify"
+    },
+    {
+      "type": "opencollective",
+      "url": "https://opencollective.com/fastify"
+    }
+  ],
   "devDependencies": {
     "@fastify/formbody": "^8.0.0",
     "@fastify/multipart": "^9.0.0",
     "@fastify/pre-commit": "^2.1.0",
-    "@sinonjs/fake-timers": "^13.0.1",
+    "@sinonjs/fake-timers": "^14.0.0",
     "@types/node": "^22.0.0",
-    "@types/tap": "^15.0.11",
+    "@types/tap": "^18.0.0",
+    "eslint": "^9.17.0",
     "fastify": "^5.0.0",
     "form-data": "^4.0.0",
     "got": "^11.8.6",
     "h2url": "^0.2.0",
-    "msgpack5": "^6.0.2",
+    "neostandard": "^0.12.0",
     "nock": "^13.5.4",
     "proxy": "^2.1.1",
     "proxyquire": "^2.1.3",
-    "semver": "^7.6.0",
     "simple-get": "^4.0.1",
-    "snazzy": "^9.0.0",
     "split2": "^4.2.0",
-    "standard": "^17.1.0",
     "tap": "^18.7.2",
     "tsd": "^0.31.0"
   },
@@ -58,7 +85,7 @@
     "fast-querystring": "^1.1.2",
     "fastify-plugin": "^5.0.1",
     "toad-cache": "^3.7.0",
-    "undici": "^6.11.1"
+    "undici": "^7.0.0"
   },
   "pre-commit": [
     "lint",

package/test/async-route-handler.test.js

@@ -21,7 +21,7 @@ const target = http.createServer((req, res) => {
   res.end('hello world')
 })
 
-instance.get('/', async (request, reply) => {
+instance.get('/', async (_request, reply) => {
   const p = reply.from()
   t.equal(p, reply)
   return p

package/test/base-get.test.js

@@ -21,7 +21,7 @@ const target = http.createServer((req, res) => {
   res.end('hello world')
 })
 
-instance.get('/', (request, reply) => {
+instance.get('/', (_request, reply) => {
   reply.from()
 })
 

package/test/base-path.test.js

@@ -10,7 +10,7 @@ const instance = Fastify()
 
 nock('http://httpbin.org')
   .get('/ip')
-  .reply(200, function (uri, requestBody) {
+  .reply(200, function () {
     t.equal(this.req.headers.host, 'httpbin.org')
     return { origin: '127.0.0.1' }
   })
@@ -18,7 +18,7 @@ nock('http://httpbin.org')
 t.plan(6)
 t.teardown(instance.close.bind(instance))
 
-instance.get('/', (request, reply) => {
+instance.get('/', (_request, reply) => {
   reply.from('http://httpbin.org/ip')
 })
 

package/test/base-querystring.test.js

@@ -21,7 +21,7 @@ const target = http.createServer((req, res) => {
   res.end('hello world')
 })
 
-instance.get('/hello', (request, reply) => {
+instance.get('/hello', (_request, reply) => {
   reply.from()
 })
 

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

@@ -22,7 +22,7 @@ const target = http.createServer((req, res) => {
   res.end('hello world')
 })
 
-instance.get('/', (request, reply) => {
+instance.get('/', (_request, reply) => {
   reply.from('/hello')
 })
 

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

@@ -31,7 +31,7 @@ t.test('use a custom instance of \'undici\'', async t => {
       undici: new undici.Pool(`http://localhost:${target.address().port}`)
     })
 
-    instance.get('/', (request, reply) => {
+    instance.get('/', (_request, reply) => {
       reply.from()
     })
 
@@ -57,7 +57,7 @@ t.test('use a custom instance of \'undici\'', async t => {
       undici: new undici.Client(`http://localhost:${target.address().port}`)
     })
 
-    instance.get('/', (request, reply) => {
+    instance.get('/', (_request, reply) => {
       reply.from()
     })
 

package/test/disable-request-logging.test.js

@@ -38,7 +38,7 @@ t.test('use a custom instance of \'undici\'', async t => {
       disableRequestLogging: true
     })
 
-    instance.get('/', (request, reply) => {
+    instance.get('/', (_request, reply) => {
       reply.from()
     })
 
@@ -82,7 +82,7 @@ t.test('use a custom instance of \'undici\'', async t => {
       disableRequestLogging: false
     })
 
-    instance.get('/', (request, reply) => {
+    instance.get('/', (_request, reply) => {
       reply.from()
     })
 
@@ -125,7 +125,7 @@ t.test('use a custom instance of \'undici\'', async t => {
       base: `http://localhost:${target.address().port}`
     })
 
-    instance.get('/', (request, reply) => {
+    instance.get('/', (_request, reply) => {
       reply.from()
     })
 

package/test/fastify-multipart-incompatibility.test.js

@@ -50,7 +50,7 @@ const target = http.createServer((req, res) => {
   })
 })
 
-instance.post('/', (request, reply) => {
+instance.post('/', (_request, reply) => {
   reply.from(`http://localhost:${target.address().port}`)
 })
 
@@ -82,7 +82,7 @@ instance.listen({ port: 0 }, (err) => {
         ...form.getHeaders()
       },
       body: form
-    }, (err, res, data) => {
+    }, (err, _res, data) => {
       t.error(err)
       t.same(JSON.parse(data), { something: 'else' })
     })

package/test/fix-GHSA-v2v2-hph8-q5xp.test.js

@@ -1,47 +1,63 @@
 'use strict'
 
-const t = require('tap')
+const { describe, after, it } = require('node:test')
 const fastify = require('fastify')
-const get = require('simple-get').concat
-const From = require('..')
-
-const upstream = fastify()
-t.teardown(upstream.close.bind(upstream))
-t.plan(4)
-
-upstream.post('/test', async (request, reply) => {
-  if (typeof request.body === 'object') {
-    return 'not ok'
-  }
-  return 'ok'
-})
+const fastifyProxyFrom = require('..')
+const { isIPv6 } = require('node:net')
+
+describe('GHSA-v2v2-hph8-q5xp', function () {
+  it('should not parse the body if it is an object', async function (t) {
+    t.plan(1)
+
+    const upstream = fastify()
+
+    upstream.post('/test', async (request) => {
+      if (typeof request.body === 'object') {
+        return 'not ok'
+      }
+      return 'ok'
+    })
 
-upstream.listen({ port: 0 }, function (err) {
-  t.error(err)
+    await upstream.listen({ port: 0 })
 
-  const app = fastify()
-  app.register(From)
-  t.teardown(app.close.bind(app))
+    let upstreamAdress = upstream.server.address().address
 
-  app.post('/test', (request, reply) => {
-    if (request.body.method === 'invalid_method') {
-      return reply.code(400).send({ message: 'payload contains invalid method' })
+    if (isIPv6(upstreamAdress)) {
+      upstreamAdress = `[${upstreamAdress}]`
     }
-    reply.from(`http://127.0.0.1:${upstream.server.address().port}/test`)
-  })
 
-  app.listen({ port: 0 }, function (err) {
-    t.error(err)
-
-    get({
-      url: `http://127.0.0.1:${app.server.address().port}/test`,
-      headers: { 'content-type': 'application/json ; charset=utf-8' },
-      // eslint-disable-next-line no-useless-escape
-      body: '"{\\\"method\\\":\\\"invalid_method\\\"}"',
-      method: 'POST'
-    }, (err, res, data) => {
-      t.error(err)
-      t.equal(data.toString(), 'ok')
+    const app = fastify()
+    app.register(fastifyProxyFrom)
+
+    app.post('/test', (request, reply) => {
+      if (request.body.method === 'invalid_method') {
+        return reply.code(400).send({ message: 'payload contains invalid method' })
+      }
+      reply.from(`http://${upstreamAdress}:${upstream.server.address().port}/test`)
     })
+
+    await app.listen({ port: 0 })
+
+    after(() => {
+      upstream.close()
+      app.close()
+    })
+
+    let appAddress = app.server.address().address
+
+    if (isIPv6(appAddress)) {
+      appAddress = `[${appAddress}]`
+    }
+
+    const response = await fetch(
+      `http://${appAddress}:${app.server.address().port}/test`,
+      {
+        headers: { 'content-type': 'application/json ; charset=utf-8' },
+        // eslint-disable-next-line no-useless-escape
+        body: '"{\\\"method\\\":\\\"invalid_method\\\"}"',
+        method: 'POST'
+      })
+
+    t.assert.strictEqual(await response.text(), 'ok')
   })
 })

package/test/full-delete-http2.test.js

@@ -14,14 +14,14 @@ test('http -> http2', async function (t) {
     http2: true
   })
 
-  target.delete('/', (request, reply) => {
+  target.delete('/', (_request, reply) => {
     t.pass('request proxied')
     reply.code(200).header('x-my-header', 'hello!').send({
       hello: 'world'
     })
   })
 
-  instance.delete('/', (request, reply) => {
+  instance.delete('/', (_request, reply) => {
     reply.from()
   })
 

package/test/full-get-test.test.js

@@ -22,7 +22,7 @@ const target = http.createServer((req, res) => {
   res.end('hello world')
 })
 
-instance.get('/', (request, reply) => {
+instance.get('/', (_request, reply) => {
   reply.from(`http://localhost:${target.address().port}/hello`)
 })
 

package/test/full-https-get.test.js

@@ -29,7 +29,7 @@ const target = https.createServer(certs, (req, res) => {
   res.end('hello world')
 })
 
-instance.get('/', (request, reply) => {
+instance.get('/', (_request, reply) => {
   reply.from(`https://localhost:${target.address().port}`)
 })
 

package/test/full-post-extended-content-type.test.js

@@ -29,7 +29,7 @@ const target = http.createServer((req, res) => {
   })
 })
 
-instance.post('/', (request, reply) => {
+instance.post('/', (_request, reply) => {
   reply.from(`http://localhost:${target.address().port}`)
 })
 

package/test/full-post-http2.test.js

@@ -22,7 +22,7 @@ test('http -> http2', async function (t) {
     })
   })
 
-  instance.post('/', (request, reply) => {
+  instance.post('/', (_request, reply) => {
     reply.from()
   })
 

package/test/full-post-stream-core.test.js

@@ -14,7 +14,7 @@ instance.register(From, {
 t.plan(8)
 t.teardown(instance.close.bind(instance))
 
-instance.addContentTypeParser('application/octet-stream', function (req, payload, done) {
+instance.addContentTypeParser('application/octet-stream', function (_req, payload, done) {
   done(null, payload)
 })
 
@@ -37,7 +37,7 @@ const target = http.createServer((req, res) => {
   })
 })
 
-instance.post('/', (request, reply) => {
+instance.post('/', (_request, reply) => {
   reply.from(`http://localhost:${target.address().port}`)
 })
 
@@ -58,7 +58,7 @@ instance.listen({ port: 0 }, (err) => {
       body: JSON.stringify({
         hello: 'world'
       })
-    }, (err, res, data) => {
+    }, (err, _res, data) => {
       t.error(err)
       t.same(JSON.parse(data), { something: 'else' })
     })

package/test/full-post-stream.test.js

@@ -12,7 +12,7 @@ instance.register(From)
 t.plan(8)
 t.teardown(instance.close.bind(instance))
 
-instance.addContentTypeParser('application/octet-stream', function (req, payload, done) {
+instance.addContentTypeParser('application/octet-stream', function (_req, payload, done) {
   done(null, payload)
 })
 
@@ -35,7 +35,7 @@ const target = http.createServer((req, res) => {
   })
 })
 
-instance.post('/', (request, reply) => {
+instance.post('/', (_request, reply) => {
   reply.from(`http://localhost:${target.address().port}`)
 })
 
@@ -56,7 +56,7 @@ instance.listen({ port: 0 }, (err) => {
       body: JSON.stringify({
         hello: 'world'
       })
-    }, (err, res, data) => {
+    }, (err, _res, data) => {
       t.error(err)
       t.same(JSON.parse(data), { something: 'else' })
     })