@fastify/reply-from 8.1.0 → 8.2.0

package/.github/workflows/ci.yml

@@ -13,3 +13,5 @@ on:
 jobs:
   test:
     uses: fastify/workflows/.github/workflows/plugins-ci.yml@v3
+    with:
+      license-check: true

package/README.md

@@ -47,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
     }

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,7 +85,7 @@ export interface FastifyReplyFromOptions {
   base?: string;
   cacheURLs?: number;
   disableCache?: boolean;
-  http?: HttpOptions;
+  http?: HttpOptions | boolean;
   http2?: Http2Options | boolean;
   undici?: Pool.Options;
   contentTypesToEncode?: string[];

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([
@@ -137,11 +143,15 @@ 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

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": "8.1.0",
+  "version": "8.2.0",
   "description": "forward your HTTP request to another server, for fastify",
   "main": "index.js",
   "types": "index.d.ts",
@@ -30,6 +30,7 @@
   "devDependencies": {
     "@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",
@@ -39,20 +40,19 @@
     "h2url": "^0.2.0",
     "msgpack5": "^6.0.1",
     "nock": "^13.2.6",
-    "pre-commit": "^1.2.2",
     "proxyquire": "^2.1.3",
     "simple-get": "^4.0.1",
     "snazzy": "^9.0.0",
     "split2": "^4.1.0",
     "standard": "^17.0.0",
     "tap": "^16.2.0",
-    "tsd": "^0.21.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.1",
-    "http-errors": "^2.0.0",
+    "fastify-plugin": "^4.0.0",
     "pump": "^3.0.0",
     "semver": "^7.3.7",
     "tiny-lru": "^8.0.2",

package/test/http-invalid-target.js

@@ -26,6 +26,7 @@ test('http invalid target', async (t) => {
     t.match(err.response.headers['content-type'], /application\/json/)
     t.same(JSON.parse(err.response.body), {
       statusCode: 503,
+      code: 'FST_REPLY_FROM_SERVICE_UNAVAILABLE',
       error: 'Service Unavailable',
       message: 'Service Unavailable'
     })

package/test/http-timeout.js

@@ -43,6 +43,7 @@ async function main () {
     t.match(err.response.headers['content-type'], /application\/json/)
     t.same(JSON.parse(err.response.body), {
       statusCode: 504,
+      code: 'FST_REPLY_FROM_GATEWAY_TIMEOUT',
       error: 'Gateway Timeout',
       message: 'Gateway Timeout'
     })

package/test/http2-invalid-target.js

@@ -27,6 +27,7 @@ test('http2 invalid target', async (t) => {
     t.match(err.response.headers['content-type'], /application\/json/)
     t.same(JSON.parse(err.response.body), {
       statusCode: 503,
+      code: 'FST_REPLY_FROM_SERVICE_UNAVAILABLE',
       error: 'Service Unavailable',
       message: 'Service Unavailable'
     })

package/test/http2-target-crash.js

@@ -44,6 +44,7 @@ test('http -> http2 crash', async (t) => {
     t.match(err.response.headers['content-type'], /application\/json/)
     t.same(JSON.parse(err.response.body), {
       statusCode: 503,
+      code: 'FST_REPLY_FROM_SERVICE_UNAVAILABLE',
       error: 'Service Unavailable',
       message: 'Service Unavailable'
     })

package/test/http2-target-multi-crash.js

@@ -37,6 +37,7 @@ test('http -> http2 crash multiple times', async (t) => {
     t.match(err.response.headers['content-type'], /application\/json/)
     t.same(JSON.parse(err.response.body), {
       statusCode: 503,
+      code: 'FST_REPLY_FROM_SERVICE_UNAVAILABLE',
       error: 'Service Unavailable',
       message: 'Service Unavailable'
     })

package/test/http2-timeout.js

@@ -38,6 +38,7 @@ test('http2 request timeout', async (t) => {
     t.match(err.response.headers['content-type'], /application\/json/)
     t.same(JSON.parse(err.response.body), {
       statusCode: 504,
+      code: 'FST_REPLY_FROM_GATEWAY_TIMEOUT',
       error: 'Gateway Timeout',
       message: 'Gateway Timeout'
     })
@@ -81,6 +82,7 @@ test('http2 session timeout', async (t) => {
     t.match(err.response.headers['content-type'], /application\/json/)
     t.same(JSON.parse(err.response.body), {
       statusCode: 504,
+      code: 'FST_REPLY_FROM_GATEWAY_TIMEOUT',
       error: 'Gateway Timeout',
       message: 'Gateway Timeout'
     })

package/test/on-error.js

@@ -34,8 +34,13 @@ async function main () {
     reply.from(`http://localhost:${target.server.address().port}/`,
       {
         onError: (reply, { error }) => {
-          t.equal(error.status, 504)
-          reply.code(error.status).send(error)
+          t.same(error, {
+            statusCode: 504,
+            name: 'FastifyError',
+            code: 'FST_REPLY_FROM_GATEWAY_TIMEOUT',
+            message: 'Gateway Timeout'
+          })
+          reply.code(error.statusCode).send(error)
         }
       })
   })
@@ -49,6 +54,7 @@ async function main () {
     t.match(err.response.headers['content-type'], /application\/json/)
     t.same(JSON.parse(err.response.body), {
       statusCode: 504,
+      code: 'FST_REPLY_FROM_GATEWAY_TIMEOUT',
       error: 'Gateway Timeout',
       message: 'Gateway Timeout'
     })

package/test/undici-timeout.js

@@ -48,6 +48,7 @@ async function main () {
     t.match(err.response.headers['content-type'], /application\/json/)
     t.same(JSON.parse(err.response.body), {
       statusCode: 504,
+      code: 'FST_REPLY_FROM_GATEWAY_TIMEOUT',
       error: 'Gateway Timeout',
       message: 'Gateway Timeout'
     })

package/test/unexpected-error.js

@@ -37,6 +37,7 @@ test('unexpected error renders 500', async (t) => {
     t.match(err.response.headers['content-type'], /application\/json/)
     t.same(JSON.parse(err.response.body), {
       statusCode: 500,
+      code: 'FST_REPLY_FROM_INTERNAL_SERVER_ERROR',
       error: 'Internal Server Error',
       message: 'foo'
     })