v1.0.0

Author: jkyberneees

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -0,0 +1,64 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+.vscode/
+
+.idea
+
+.DS_Store

.npmrc

@@ -0,0 +1 @@
+package-lock=false

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Rolando Santamaria Maso
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,139 @@
+# fast-proxy-lite
+Node.js framework agnostic library that enables you to forward an http request to another HTTP server. 
+Supported proxy protocols: HTTP, HTTPS
+
+> This library was initially forked from `fast-proxy`: https://github.com/fastify/fast-proxy
+
+`fast-proxy-lite` powers: https://www.npmjs.com/package/fast-gateway 🚀 
+## Install
+```
+npm i fast-proxy-lite
+```
+
+## Usage
+The following examples describe how to use `fast-proxy-lite` with `restana`:
+
+Gateway:
+```js
+const { proxy, close } = require('fast-proxy-lite')({
+  base: 'http://127.0.0.1:3000'
+  // options
+})
+const gateway = require('restana')()
+
+gateway.all('/service/*', function (req, res) {
+  proxy(req, res, req.url, {})
+})
+
+gateway.start(8080)
+```
+
+Remote service:
+```js
+const service = require('restana')()
+service.get('/service/hi', (req, res) => res.send('Hello World!'))
+
+service.start(3000)
+```
+
+Using imports:
+```ts
+import fastProxy from 'fast-proxy-lite'
+
+const { proxy, close } = fastProxy({
+  base: 'http://127.0.0.1:3000'
+})
+```
+
+## Benchmarks
+Please see: https://github.com/jkyberneees/nodejs-proxy-benchmarks
+
+## API
+
+### Options
+#### `base`
+Set the base URL for all the forwarded requests. Will be required if `http2` is set to `true`
+Note that _path will be discarded_.
+
+#### cacheURLs
+The number of parsed URLs that will be cached. Default: 100.
+> Use value = `0` to disable the caching mechanism
+
+#### requests.http and requests.https
+Allows to optionally overwrite the internal `http` and `https` client agents implementation. Defaults: [`http`](https://nodejs.org/api/http.html#http_http) and [`https`](https://nodejs.org/api/https.html#https_https).
+
+For example, this could be used to add support for following redirects, like so:
+
+```js
+...
+  requests: {
+    http: require('follow-redirects/http'),
+    https: require('follow-redirects/https')
+  }
+...
+```
+
+#### keepAliveMsecs
+Defaults to 1 minute, passed down to [`http.Agent`][http-agent] and
+[`https.Agent`][https-agent] instances.
+
+#### maxSockets
+Defaults to 2048 sockets, passed down to [`http.Agent`][http-agent] and
+[`https.Agent`][https-agent] instances.
+
+#### rejectUnauthorized
+Defaults to `true`, passed down to [`https.Agent`][https-agent] instances.
+This needs to be set to `false` to reply from https servers with
+self-signed certificates.
+
+#### Extended configurations
+Other supported configurations in https://nodejs.org/api/http.html#http_new_agent_options can also be part of the `opts` object.
+
+### close
+Optional _"on `close` resource release"_ strategy. You can link this to your application shutdown hook as an example.
+
+### proxy(originReq, originRes, source, [opts])
+Enables you to forward an http request to another HTTP server.
+```js
+proxy(
+  originReq,                          // http.IncomingMessage 
+  originRes,                          // http.ServerResponse
+  req.url,                            // String -> remote URL + path or path if base was set
+  {}                                  // Options described below
+)
+```
+#### opts
+
+##### base
+Optionally indicates the base URL for the current request proxy. When used, the global `base` config is overwriten.  
+> This configuration value is ignored when using HTTP2.
+
+##### onResponse(req, res, stream)
+Called when an http response is received from the source.
+The default behavior is `pump(stream, res)`, which will be disabled if the
+option is specified.
+
+##### rewriteRequestHeaders(req, headers)
+Called to rewrite the headers of the request, before them being sent to the downstream server. 
+It must return the new headers object.
+
+##### rewriteHeaders(headers)
+Called to rewrite the headers of the response, before them being copied
+over to the outer response.
+It must return the new headers object.
+
+##### request
+Extended options supported by `http[s].request` method (https://nodejs.org/api/http.html#http_http_request_options_callback)
+The following options are dynamically assigned: `method, port, path, hostname, headers, agent`.  
+
+##### queryString
+Replaces the original querystring of the request with what is specified.
+This will get passed to
+[`querystring.stringify`](https://nodejs.org/api/querystring.html#querystring_querystring_stringify_obj_sep_eq_options).
+
+## Related topics
+- http-agent: https://nodejs.org/api/http.html#http_new_agent_options
+- https-agent: https://nodejs.org/api/https.html#https_class_https_agent
+
+## License
+MIT

demos/gateway-typescript.ts

@@ -0,0 +1,13 @@
+'use strict'
+
+import fastProxy from '..'
+import restana from 'restana'
+
+const { proxy } = fastProxy({
+  base: 'http://127.0.0.1:3000'
+})
+
+const service = restana()
+service.all('/service/*', (req, res) => proxy(req, res, req.url, {}))
+
+service.start(8080)

demos/gateway.js

@@ -0,0 +1,10 @@
+'use strict'
+
+const { proxy } = require('../index')({
+  base: 'http://127.0.0.1:3000'
+})
+
+const service = require('restana')()
+service.all('/service/*', (req, res) => proxy(req, res, req.url, {}))
+
+service.start(8080)

demos/service.js

@@ -0,0 +1,12 @@
+'use strict'
+
+const bodyParser = require('body-parser')
+
+const service = require('restana')()
+service.use(bodyParser.json())
+
+service.get('/service/get', (req, res) => res.send('Hello World!'))
+
+service.post('/service/post', (req, res) => res.send(req.body))
+
+service.start(3000)

index.d.ts

@@ -0,0 +1,34 @@
+import * as Http from 'http';
+import * as Https from 'https';
+import { Stream } from 'pump';
+
+interface Options {
+  base?: string;
+  cacheURLs?: number;
+  requests?: {
+    http?: Http.Agent,
+    https?: Https.Agent
+  };
+  keepAliveMsecs?: number;
+  maxSockets?: number;
+  rejectUnauthorized?: boolean;
+}
+
+declare function fastProxy(options?: Options): {
+  proxy(
+    originReq: Http.IncomingMessage,
+    originRes: Http.ServerResponse,
+    source: string,
+    opts?: {
+      base?: string;
+      onResponse?(req: Http.IncomingMessage, res: Http.ServerResponse, stream: Stream): void;
+      rewriteRequestHeaders?(req: Http.IncomingMessage, headers: Http.IncomingHttpHeaders): Http.IncomingHttpHeaders;
+      rewriteHeaders?(headers: Http.OutgoingHttpHeaders): Http.OutgoingHttpHeaders;
+      request?: Http.RequestOptions;
+      queryString?: string;
+    }
+  ): void;
+  close(): void;
+}
+
+export default fastProxy