@fastify/reply-from 7.0.0 → 8.1.0

package/.github/workflows/ci.yml

@@ -1,60 +1,15 @@
 name: CI
-'on':
+
+on:
   push:
     paths-ignore:
-      - docs/**
+      - 'docs/**'
       - '*.md'
   pull_request:
     paths-ignore:
-      - docs/**
+      - 'docs/**'
       - '*.md'
+
 jobs:
   test:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        node-version:
-          - 12
-          - 14
-          - 16
-        os:
-          - macos-latest
-          - ubuntu-latest
-          - windows-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Install Dependencies
-        run: |
-          npm install --ignore-scripts
-      - name: Run Tests
-        run: |
-          npm run test:ci
-      - name: Coveralls Parallel
-        uses: coverallsapp/github-action@1.1.3
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          parallel: true
-          flag-name: run-${{ matrix.node-version }}-${{ matrix.os }}
-  coverage:
-    needs: test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Coveralls Finished
-        uses: coverallsapp/github-action@1.1.3
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          parallel-finished: true
-  automerge:
-    needs: test
-    runs-on: ubuntu-latest
-    permissions:
-      pull-requests: write
-      contents: write
-    steps:
-      - uses: fastify/github-action-merge-dependabot@v3.0.2
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+    uses: fastify/workflows/.github/workflows/plugins-ci.yml@v3

package/README.md

@@ -1,9 +1,7 @@
-# fastify-reply-from
+# @fastify/reply-from
 
 ![CI](https://github.com/fastify/fastify-reply-from/workflows/CI/badge.svg)
-[![NPM version](https://img.shields.io/npm/v/fastify-reply-from.svg?style=flat)](https://www.npmjs.com/package/fastify-reply-from)
-[![Known Vulnerabilities](https://snyk.io/test/github/fastify/fastify-reply-from/badge.svg)](https://snyk.io/test/github/fastify/fastify-reply-from)
-[![Coverage Status](https://coveralls.io/repos/github/fastify/fastify-reply-from/badge.svg?branch=master)](https://coveralls.io/github/fastify/fastify-reply-from?branch=master)
+[![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/)
 
 Fastify plugin to forward the current HTTP request to another server.
@@ -12,11 +10,11 @@ HTTP2 to HTTP is supported too.
 ## Install
 
 ```
-npm i fastify-reply-from
+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>
+## 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>
 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
@@ -41,7 +39,7 @@ const proxy = Fastify({
   logger: true
 })
 
-proxy.register(require('fastify-reply-from'), {
+proxy.register(require('@fastify/reply-from'), {
   base: 'http://localhost:3001/'
 })
 
@@ -77,7 +75,7 @@ for http2 nor undici.  To illustrate:
 
 ```js
 const socketPath = require('querystring').escape('/run/http-daemon.socket')
-proxy.register(require('fastify-reply-from'), {
+proxy.register(require('@fastify/reply-from'), {
   base: 'unix+http://${socketPath}/'
 });
 ```
@@ -91,7 +89,7 @@ requests. Enabling this flag should guarantee
 This flag could controls the settings of the undici client, like so:
 
 ```js
-proxy.register(require('fastify-reply-from'), {
+proxy.register(require('@fastify/reply-from'), {
   base: 'http://localhost:3001/',
   // default settings
   undici: {
@@ -109,7 +107,7 @@ See undici own options for more configurations.
 You can also pass the plugin a custom instance:
 
 ```js
-proxy.register(require('fastify-reply-from'), {
+proxy.register(require('@fastify/reply-from'), {
   base: 'http://localhost:3001/',
   undici: new undici.Pool('http://localhost:3001')
 })
@@ -124,7 +122,7 @@ you can pass in [`agentOptions`](https://nodejs.org/api/http.html#http_new_agent
 [`requestOptions`](https://nodejs.org/api/http.html#http_http_request_options_callback). To illustrate:
 
 ```js
-proxy.register(require('fastify-reply-from'), {
+proxy.register(require('@fastify/reply-from'), {
   base: 'http://localhost:3001/',
   http: {
     agentOptions: { // pass in any options from https://nodejs.org/api/http.html#http_new_agent_options
@@ -139,7 +137,7 @@ proxy.register(require('fastify-reply-from'), {
 
 You can also pass custom HTTP agents. If you pass the agents, then the http.agentOptions will be ignored. To illustrate:
 ```js
-proxy.register(require('fastify-reply-from'), {
+proxy.register(require('@fastify/reply-from'), {
   base: 'http://localhost:3001/',
   http: {
     agents: {
@@ -160,7 +158,7 @@ You can either set `http2` to `true` or set the settings object to connect to a
 The `http2` settings object has the shape of:
 
 ```js
-proxy.register(require('fastify-reply-from'), {
+proxy.register(require('@fastify/reply-from'), {
   base: 'http://localhost:3001/',
   http2: {
     sessionTimeout: 10000, // HTTP/2 session timeout in msecs, defaults to 60000 (1 minute)
@@ -175,6 +173,19 @@ 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.
+
+Default for `disableRequestLogging` will be `false`. To disable the log messages set `disableRequestLogging` to `true`.
+
+```js
+proxy.register(require('@fastify/reply-from'), {
+  base: 'http://localhost:3001/',
+  disableRequestLogging: true // request log messages will be disabled
+})
+```
+
 #### `cacheURLs`
 
 The number of parsed URLs that will be cached. Default: `100`.
@@ -301,7 +312,7 @@ By default: 0 (disabled)
 Override the `'Content-Type'` header of the forwarded request, if we are
 already overriding the [`body`](#body).
 
-### Combining with [fastify-formbody](https://github.com/fastify/fastify-formbody)
+### Combining with [@fastify/formbody](https://github.com/fastify/fastify-formbody)
 
 `formbody` expects the body to be returned as a string and not an object. 
 Use the [`contentTypesToEncode`](#contentTypesToEncode) option to pass in `['application/x-www-form-urlencoded']`

package/index.d.ts

@@ -91,6 +91,7 @@ export interface FastifyReplyFromOptions {
   contentTypesToEncode?: string[];
   retryMethods?: (HTTPMethods | 'TRACE')[];
   maxRetriesOn503?: number;
+  disableRequestLogging?: boolean;
 }
 
 declare const fastifyReplyFrom:

package/index.js

@@ -33,6 +33,7 @@ module.exports = fp(function from (fastify, opts, next) {
     base,
     undici: opts.undici
   })
+  const disableRequestLogging = opts.disableRequestLogging || false
 
   fastify.decorateReply('from', function (source, opts) {
     opts = opts || {}
@@ -120,7 +121,7 @@ module.exports = fp(function from (fastify, opts, next) {
       }
     }
 
-    this.request.log.info({ source }, 'fetching from remote server')
+    !disableRequestLogging && this.request.log.info({ source }, 'fetching from remote server')
 
     const requestHeaders = rewriteRequestHeaders(req, headers)
     const contentLength = requestHeaders['content-length']
@@ -145,7 +146,7 @@ module.exports = fp(function from (fastify, opts, next) {
         }
         return
       }
-      this.request.log.info('response received')
+      !disableRequestLogging && this.request.log.info('response received')
       if (sourceHttp2) {
         copyHeaders(
           rewriteHeaders(stripHttp1ConnectionHeaders(res.headers), req),
@@ -166,7 +167,7 @@ module.exports = fp(function from (fastify, opts, next) {
 
   fastify.addHook('onReady', (done) => {
     if (isFastifyMultipartRegistered(fastify)) {
-      fastify.log.warn('fastify-reply-from might not behave as expected when used with fastify-multipart')
+      fastify.log.warn('@fastify/reply-from might not behave as expected when used with @fastify/multipart')
     }
     done()
   })
@@ -179,7 +180,10 @@ module.exports = fp(function from (fastify, opts, next) {
   })
 
   next()
-}, '>=3')
+}, {
+  fastify: '4.x',
+  name: '@fastify/reply-from'
+})
 
 function getQueryString (search, reqUrl, opts) {
   if (typeof opts.queryString === 'function') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastify/reply-from",
-  "version": "7.0.0",
+  "version": "8.1.0",
   "description": "forward your HTTP request to another server, for fastify",
   "main": "index.js",
   "types": "index.d.ts",
@@ -26,40 +26,37 @@
   "bugs": {
     "url": "https://github.com/fastify/fastify-reply-from/issues"
   },
-  "engines": {
-    "node": ">=12.18"
-  },
   "homepage": "https://github.com/fastify/fastify-reply-from#readme",
   "devDependencies": {
-    "@sinonjs/fake-timers": "^9.0.0",
-    "@types/node": "^17.0.0",
-    "@types/tap": "^15.0.3",
-    "fastify": "^3.17.0",
-    "fastify-formbody": "^5.0.0",
-    "fastify-multipart": "^5.0.0",
+    "@fastify/formbody": "^7.0.1",
+    "@fastify/multipart": "^7.1.0",
+    "@sinonjs/fake-timers": "^9.1.2",
+    "@types/node": "^18.0.0",
+    "@types/tap": "^15.0.7",
+    "fastify": "^4.0.2",
     "form-data": "^4.0.0",
     "got": "^11.8.2",
     "h2url": "^0.2.0",
-    "msgpack5": "^6.0.0",
-    "nock": "^13.1.0",
+    "msgpack5": "^6.0.1",
+    "nock": "^13.2.6",
     "pre-commit": "^1.2.2",
     "proxyquire": "^2.1.3",
-    "simple-get": "^4.0.0",
+    "simple-get": "^4.0.1",
     "snazzy": "^9.0.0",
-    "split2": "^4.0.0",
+    "split2": "^4.1.0",
     "standard": "^17.0.0",
-    "tap": "^16.0.0",
-    "tsd": "^0.20.0",
-    "typescript": "^4.3.2"
+    "tap": "^16.2.0",
+    "tsd": "^0.21.0",
+    "typescript": "^4.7.3"
   },
   "dependencies": {
     "end-of-stream": "^1.4.4",
-    "fastify-plugin": "^3.0.0",
+    "fastify-plugin": "^3.0.1",
     "http-errors": "^2.0.0",
     "pump": "^3.0.0",
-    "semver": "^7.3.5",
-    "tiny-lru": "^8.0.1",
-    "undici": "^5.0.0"
+    "semver": "^7.3.7",
+    "tiny-lru": "^8.0.2",
+    "undici": "^5.5.1"
   },
   "tsd": {
     "directory": "test"

package/test/async-route-handler.js

@@ -29,14 +29,14 @@ instance.get('/', async (request, reply) => {
 
 t.teardown(target.close.bind(target))
 
-target.listen(0, (err) => {
+target.listen({ port: 0 }, (err) => {
   t.error(err)
 
   instance.register(From, {
     base: `http://localhost:${target.address().port}`
   })
 
-  instance.listen(0, (err) => {
+  instance.listen({ port: 0 }, (err) => {
     t.error(err)
 
     get(`http://localhost:${instance.server.address().port}`, (err, res, data) => {

package/test/base-get.js

@@ -27,14 +27,14 @@ instance.get('/', (request, reply) => {
 
 t.teardown(target.close.bind(target))
 
-target.listen(0, (err) => {
+target.listen({ port: 0 }, (err) => {
   t.error(err)
 
   instance.register(From, {
     base: `http://localhost:${target.address().port}`
   })
 
-  instance.listen(0, (err) => {
+  instance.listen({ port: 0 }, (err) => {
     t.error(err)
 
     get(`http://localhost:${instance.server.address().port}`, (err, res, data) => {

package/test/base-path.js

@@ -26,7 +26,7 @@ instance.register(From, {
   undici: false
 })
 
-instance.listen(0, (err) => {
+instance.listen({ port: 0 }, (err) => {
   t.error(err)
 
   get(`http://localhost:${instance.server.address().port}`, (err, res, data) => {

package/test/base-querystring.js

@@ -27,14 +27,14 @@ instance.get('/hello', (request, reply) => {
 
 t.teardown(target.close.bind(target))
 
-target.listen(0, (err) => {
+target.listen({ port: 0 }, (err) => {
   t.error(err)
 
   instance.register(From, {
     base: `http://localhost:${target.address().port}`
   })
 
-  instance.listen(0, (err) => {
+  instance.listen({ port: 0 }, (err) => {
     t.error(err)
 
     get(`http://localhost:${instance.server.address().port}/hello?a=b`, (err, res, data) => {

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

@@ -28,7 +28,7 @@ instance.get('/', (request, reply) => {
 
 t.teardown(target.close.bind(target))
 
-target.listen(0, (err) => {
+target.listen({ port: 0 }, (err) => {
   t.error(err)
 
   instance.register(From, {
@@ -36,7 +36,7 @@ target.listen(0, (err) => {
     http: true
   })
 
-  instance.listen(0, (err) => {
+  instance.listen({ port: 0 }, (err) => {
     t.error(err)
 
     get(`http://localhost:${instance.server.address().port}`, (err, res, data) => {

package/test/custom-undici-instance.js

@@ -21,7 +21,7 @@ const target = http.createServer((req, res) => {
 t.test('use a custom instance of \'undici\'', async t => {
   t.teardown(target.close.bind(target))
 
-  await new Promise((resolve, reject) => target.listen(0, err => err ? reject(err) : resolve()))
+  await new Promise((resolve, reject) => target.listen({ port: 0 }, err => err ? reject(err) : resolve()))
 
   t.test('custom Pool', t => {
     const instance = Fastify()
@@ -35,7 +35,7 @@ t.test('use a custom instance of \'undici\'', async t => {
       reply.from()
     })
 
-    instance.listen(0, (err) => {
+    instance.listen({ port: 0 }, (err) => {
       t.error(err)
 
       get(`http://localhost:${instance.server.address().port}`, (err, res, data) => {
@@ -61,7 +61,7 @@ t.test('use a custom instance of \'undici\'', async t => {
       reply.from()
     })
 
-    instance.listen(0, (err) => {
+    instance.listen({ port: 0 }, (err) => {
       t.error(err)
 
       get(`http://localhost:${instance.server.address().port}`, (err, res, data) => {

package/test/disable-request-logging.js

@@ -0,0 +1,159 @@
+'use strict'
+
+const t = require('tap')
+const Fastify = require('fastify')
+const From = require('..')
+const http = require('http')
+const get = require('simple-get').concat
+const split = require('split2')
+
+const target = http.createServer((req, res) => {
+  t.pass('request proxied')
+  t.equal(req.method, 'GET')
+  t.equal(req.url, '/')
+  t.equal(req.headers.connection, 'keep-alive')
+  res.statusCode = 205
+  res.setHeader('Content-Type', 'text/plain')
+  res.setHeader('x-my-header', 'hello!')
+  res.end('hello world')
+})
+
+t.test('use a custom instance of \'undici\'', async t => {
+  t.teardown(target.close.bind(target))
+
+  await new Promise((resolve, reject) => target.listen({ port: 0 }, err => err ? reject(err) : resolve()))
+
+  t.test('disableRequestLogging is set to true', t => {
+    t.plan(10)
+    const logStream = split(JSON.parse)
+    const instance = Fastify({
+      logger: {
+        level: 'info',
+        stream: logStream
+      }
+    })
+    t.teardown(instance.close.bind(instance))
+    instance.register(From, {
+      base: `http://localhost:${target.address().port}`,
+      disableRequestLogging: true
+    })
+
+    instance.get('/', (request, reply) => {
+      reply.from()
+    })
+
+    logStream.on('data', (log) => {
+      if (
+        log.level === 30 &&
+        (
+          !log.msg.match('response received') ||
+          !log.msg.match('fetching from remote server')
+        )
+      ) {
+        t.pass('request log message does not logged')
+      }
+    })
+
+    instance.listen({ port: 0 }, (err) => {
+      t.error(err)
+
+      get(`http://localhost:${instance.server.address().port}`, (err, res, data) => {
+        t.error(err)
+        t.equal(res.headers['content-type'], 'text/plain')
+        t.equal(res.headers['x-my-header'], 'hello!')
+        t.equal(res.statusCode, 205)
+        t.equal(data.toString(), 'hello world')
+        t.end()
+      })
+    })
+  })
+
+  t.test('disableRequestLogging is set to false', t => {
+    t.plan(8)
+    const logStream = split(JSON.parse)
+    const instance = Fastify({
+      logger: {
+        level: 'info',
+        stream: logStream
+      }
+    })
+    t.teardown(instance.close.bind(instance))
+    instance.register(From, {
+      base: `http://localhost:${target.address().port}`,
+      disableRequestLogging: false
+    })
+
+    instance.get('/', (request, reply) => {
+      reply.from()
+    })
+
+    logStream.on('data', (log) => {
+      if (
+        log.level === 30 &&
+        (
+          log.msg.match('response received') ||
+          log.msg.match('fetching from remote server')
+        )
+      ) {
+        t.pass('request log message does not logged')
+      }
+    })
+
+    instance.listen({ port: 0 }, (err) => {
+      t.error(err)
+
+      get(`http://localhost:${instance.server.address().port}`, (err, res, data) => {
+        t.error(err)
+        t.equal(res.headers['content-type'], 'text/plain')
+        t.equal(res.headers['x-my-header'], 'hello!')
+        t.equal(res.statusCode, 205)
+        t.equal(data.toString(), 'hello world')
+        t.end()
+      })
+    })
+  })
+
+  t.test('disableRequestLogging is not defined', t => {
+    t.plan(8)
+    const logStream = split(JSON.parse)
+    const instance = Fastify({
+      logger: {
+        level: 'info',
+        stream: logStream
+      }
+    })
+    t.teardown(instance.close.bind(instance))
+    instance.register(From, {
+      base: `http://localhost:${target.address().port}`
+    })
+
+    instance.get('/', (request, reply) => {
+      reply.from()
+    })
+
+    logStream.on('data', (log) => {
+      if (
+        log.level === 30 &&
+        (
+          log.msg.match('response received') ||
+          log.msg.match('fetching from remote server')
+        )
+      ) {
+        t.pass('request log message does not logged')
+      }
+    })
+
+    instance.listen({ port: 0 }, (err) => {
+      t.error(err)
+
+      get(`http://localhost:${instance.server.address().port}`, (err, res, data) => {
+        t.error(err)
+        t.equal(res.headers['content-type'], 'text/plain')
+        t.equal(res.headers['x-my-header'], 'hello!')
+        t.equal(res.statusCode, 205)
+        t.equal(data.toString(), 'hello world')
+        t.end()
+      })
+    })
+  })
+})

package/test/fastify-multipart-incompatibility.js

@@ -5,7 +5,7 @@ const path = require('path')
 const t = require('tap')
 const Fastify = require('fastify')
 const From = require('..')
-const Multipart = require('fastify-multipart')
+const Multipart = require('@fastify/multipart')
 const http = require('http')
 const get = require('simple-get').concat
 const FormData = require('form-data')
@@ -56,19 +56,19 @@ instance.post('/', (request, reply) => {
 
 t.teardown(target.close.bind(target))
 
-instance.listen(0, (err) => {
+instance.listen({ port: 0 }, (err) => {
   t.error(err)
 
   logStream.on('data', (log) => {
     if (
       log.level === 40 &&
-      log.msg.match(/fastify-reply-from might not behave as expected when used with fastify-multipart/)
+      log.msg.match(/@fastify\/reply-from might not behave as expected when used with @fastify\/multipart/)
     ) {
       t.pass('incompatibility warn message logged')
     }
   })
 
-  target.listen(0, (err) => {
+  target.listen({ port: 0 }, (err) => {
     t.error(err)
 
     const form = new FormData()

package/test/full-get.js

@@ -28,10 +28,10 @@ instance.get('/', (request, reply) => {
 
 t.teardown(target.close.bind(target))
 
-instance.listen(0, (err) => {
+instance.listen({ port: 0 }, (err) => {
   t.error(err)
 
-  target.listen(0, (err) => {
+  target.listen({ port: 0 }, (err) => {
     t.error(err)
 
     get(`http://localhost:${instance.server.address().port}`, (err, res, data) => {

package/test/full-https-get.js

@@ -35,10 +35,10 @@ instance.get('/', (request, reply) => {
 
 t.teardown(target.close.bind(target))
 
-instance.listen(0, (err) => {
+instance.listen({ port: 0 }, (err) => {
   t.error(err)
 
-  target.listen(0, (err) => {
+  target.listen({ port: 0 }, (err) => {
     t.error(err)
 
     get({

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

@@ -35,10 +35,10 @@ instance.post('/', (request, reply) => {
 
 t.teardown(target.close.bind(target))
 
-instance.listen(0, (err) => {
+instance.listen({ port: 0 }, (err) => {
   t.error(err)
 
-  target.listen(0, (err) => {
+  target.listen({ port: 0 }, (err) => {
     t.error(err)
 
     get.concat({

package/test/full-post-http2.js

@@ -28,14 +28,14 @@ test('http -> http2', async function (t) {
 
   t.teardown(target.close.bind(target))
 
-  await target.listen(0)
+  await target.listen({ port: 0 })
 
   instance.register(From, {
     base: `http://localhost:${target.server.address().port}`,
     http2: true
   })
 
-  await instance.listen(0)
+  await instance.listen({ port: 0 })
 
   const { headers, body, statusCode } = await got(`http://localhost:${instance.server.address().port}`, {
     method: 'POST',