@fastify/reply-from 7.0.1 → 8.2.0

package/.github/workflows/ci.yml

@@ -1,60 +1,17 @@
 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.1.4
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+    uses: fastify/workflows/.github/workflows/plugins-ci.yml@v3
+    with:
+      license-check: true

package/README.md

@@ -2,8 +2,6 @@
 
 ![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)
 [![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.
@@ -49,12 +47,12 @@ proxy.get('/', (request, reply) => {
   reply.from('/')
 })
 
-target.listen(3001, (err) => {
+target.listen({ port: 3001 }, (err) => {
   if (err) {
     throw err
   }
 
-  proxy.listen(3000, (err) => {
+  proxy.listen({ port: 3000 }, (err) => {
     if (err) {
       throw err
     }
@@ -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`.

package/example.js

@@ -23,12 +23,12 @@ proxy.get('/', (request, reply) => {
   reply.from('/')
 })
 
-target.listen(3001, (err) => {
+target.listen({ port: 3001 }, (err) => {
   if (err) {
     throw err
   }
 
-  proxy.listen(3000, (err) => {
+  proxy.listen({ port: 3000 }, (err) => {
     if (err) {
       throw err
     }

package/index.d.ts

@@ -85,12 +85,13 @@ export interface FastifyReplyFromOptions {
   base?: string;
   cacheURLs?: number;
   disableCache?: boolean;
-  http?: HttpOptions;
+  http?: HttpOptions | boolean;
   http2?: Http2Options | boolean;
   undici?: Pool.Options;
   contentTypesToEncode?: string[];
   retryMethods?: (HTTPMethods | 'TRACE')[];
   maxRetriesOn503?: number;
+  disableRequestLogging?: boolean;
 }
 
 declare const fastifyReplyFrom:

package/index.js

@@ -4,7 +4,6 @@ const fp = require('fastify-plugin')
 const lru = require('tiny-lru')
 const querystring = require('querystring')
 const Stream = require('stream')
-const createError = require('http-errors')
 const buildRequest = require('./lib/request')
 const {
   filterPseudoHeaders,
@@ -13,7 +12,14 @@ const {
   buildURL
 } = require('./lib/utils')
 
-const { TimeoutError } = buildRequest
+const {
+  TimeoutError,
+  ServiceUnavailableError,
+  GatewayTimeoutError,
+  ConnectionResetError,
+  UndiciSocketError,
+  InternalServerError
+} = require('./lib/errors')
 
 module.exports = fp(function from (fastify, opts, next) {
   const contentTypesToEncode = new Set([
@@ -33,6 +39,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 +127,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']
@@ -136,16 +143,20 @@ module.exports = fp(function from (fastify, opts, next) {
         this.request.log.warn(err, 'response errored')
         if (!this.sent) {
           if (err.code === 'ERR_HTTP2_STREAM_CANCEL' || err.code === 'ENOTFOUND') {
-            onError(this, { error: new createError.ServiceUnavailable() })
+            onError(this, { error: ServiceUnavailableError() })
           } else if (err instanceof TimeoutError || err.code === 'UND_ERR_HEADERS_TIMEOUT') {
-            onError(this, { error: new createError.GatewayTimeout() })
+            onError(this, { error: new GatewayTimeoutError() })
+          } else if (err.code === 'ECONNRESET') {
+            onError(this, { error: new ConnectionResetError() })
+          } else if (err.code === 'UND_ERR_SOCKET') {
+            onError(this, { error: new UndiciSocketError() })
           } else {
-            onError(this, { error: createError(500, err) })
+            onError(this, { error: new InternalServerError(err.message) })
           }
         }
         return
       }
-      this.request.log.info('response received')
+      !disableRequestLogging && this.request.log.info('response received')
       if (sourceHttp2) {
         copyHeaders(
           rewriteHeaders(stripHttp1ConnectionHeaders(res.headers), req),
@@ -179,7 +190,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/lib/errors.js

@@ -0,0 +1,13 @@
+'use strict'
+
+const createError = require('@fastify/error')
+
+module.exports.TimeoutError = createError('FST_REPLY_FROM_TIMEOUT', 'Timeout', 504)
+module.exports.HttpRequestTimeoutError = createError('FST_REPLY_FROM_HTTP_REQUEST_TIMEOUT', 'HTTP request timed out', 504, module.exports.TimeoutError)
+module.exports.Http2RequestTimeoutError = createError('FST_REPLY_FROM_HTTP2_REQUEST_TIMEOUT', 'HTTP/2 request timed out', 504, module.exports.TimeoutError)
+module.exports.Http2SessionTimeoutError = createError('FST_REPLY_FROM_HTTP2_SESSION_TIMEOUT', 'HTTP/2 session timed out', 504, module.exports.TimeoutError)
+module.exports.ServiceUnavailableError = createError('FST_REPLY_FROM_SERVICE_UNAVAILABLE', 'Service Unavailable', 503)
+module.exports.GatewayTimeoutError = createError('FST_REPLY_FROM_GATEWAY_TIMEOUT', 'Gateway Timeout', 504)
+module.exports.ConnectionResetError = createError('ECONNRESET', 'Connection Reset', 500)
+module.exports.UndiciSocketError = createError('UND_ERR_SOCKET', 'Undici Socket Error', 500)
+module.exports.InternalServerError = createError('FST_REPLY_FROM_INTERNAL_SERVER_ERROR', '%s', 500)

package/lib/request.js

@@ -9,7 +9,12 @@ const undici = require('undici')
 const { stripHttp1ConnectionHeaders } = require('./utils')
 const http2 = require('http2')
 
-class TimeoutError extends Error {}
+const {
+  TimeoutError,
+  Http2RequestTimeoutError,
+  Http2SessionTimeoutError,
+  HttpRequestTimeoutError
+} = require('./errors')
 
 function shouldUseUndici (opts) {
   if (opts.undici === false || opts.http || opts.http2) {
@@ -102,7 +107,7 @@ function buildRequest (opts) {
       done(null, { statusCode: res.statusCode, headers: res.headers, stream: res })
     })
     req.once('timeout', () => {
-      const err = new TimeoutError('HTTP request timed out')
+      const err = new HttpRequestTimeoutError()
       req.abort()
       done(err)
     })
@@ -183,13 +188,13 @@ function buildRequest (opts) {
       end(req, opts.body, done)
     }
     req.setTimeout(http2Opts.requestTimeout, () => {
-      const err = new TimeoutError('HTTP/2 request timed out')
+      const err = new Http2RequestTimeoutError()
       req.close(http2.constants.NGHTTP2_CANCEL)
       done(err)
     })
     req.once('close', () => {
       if (sessionTimedOut) {
-        const err = new TimeoutError('HTTP/2 session timed out')
+        const err = new Http2SessionTimeoutError()
         done(err)
       }
     })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastify/reply-from",
-  "version": "7.0.1",
+  "version": "8.2.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": {
-    "@fastify/formbody": "^6.0.0",
-    "@fastify/multipart": "^6.0.0",
-    "@sinonjs/fake-timers": "^9.0.0",
-    "@types/node": "^17.0.0",
-    "@types/tap": "^15.0.3",
-    "fastify": "^3.17.0",
+    "@fastify/formbody": "^7.0.1",
+    "@fastify/multipart": "^7.1.0",
+    "@fastify/pre-commit": "^2.0.2",
+    "@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",
-    "pre-commit": "^1.2.2",
+    "msgpack5": "^6.0.1",
+    "nock": "^13.2.6",
     "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.22.0",
+    "typescript": "^4.7.3"
   },
   "dependencies": {
+    "@fastify/error": "^3.0.0",
     "end-of-stream": "^1.4.4",
-    "fastify-plugin": "^3.0.0",
-    "http-errors": "^2.0.0",
+    "fastify-plugin": "^4.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

@@ -56,7 +56,7 @@ 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) => {
@@ -68,7 +68,7 @@ instance.listen(0, (err) => {
     }
   })
 
-  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({