# fast-proxy

> Forward your HTTP request to another server.

Latest version **2.2.0** (published 2023-07-21) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install fast-proxy
pnpm add fast-proxy
yarn add fast-proxy
bun add fast-proxy
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.2.0 |
| Published | 2023-07-21 |
| First published | 2019-05-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 21.4 KB |
| Known vulnerabilities | 0 (+12 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 162 |
| Author | Rolando Santamaria Maso |
| Maintainers | matteo.collina, jkyberneees |
| Keywords | http, forward, proxy, gateway |

## Links

- npm: https://www.npmjs.com/package/fast-proxy
- Repository: https://github.com/fastify/fast-proxy
- Issues: https://github.com/fastify/fast-proxy/issues
- npm.io page: https://npm.io/package/fast-proxy

## Dependencies (6)

- [pump](https://npm.io/package/pump.md) ^3.0.0
- [semver](https://npm.io/package/semver.md) ^7.3.5
- [undici](https://npm.io/package/undici.md) ^5.4.0
- [tiny-lru](https://npm.io/package/tiny-lru.md) ^11.0.0
- [end-of-stream](https://npm.io/package/end-of-stream.md) ^1.4.4
- [fast-querystring](https://npm.io/package/fast-querystring.md) ^1.0.0

## Recent versions

- 2.2.0 (latest) — 2023-07-21
- 2.1.0 — 2021-09-19
- 2.0.0 — 2021-02-28
- 1.8.0 — 2020-12-09
- 1.7.0 — 2020-07-19
- 1.6.3 — 2020-07-04
- 1.6.2 — 2020-04-17
- 1.6.1 — 2020-04-11
- 1.6.0 — 2020-04-09
- 1.5.0 — 2020-03-03
- 1.4.1 — 2020-02-13
- 1.4.0 — 2020-02-11
- 1.3.0 — 2019-11-14
- 1.2.0 — 2019-10-03
- 1.1.3 — 2019-08-27
- … 7 more at https://npm.io/package/fast-proxy/versions

## README

# fast-proxy
![CI](https://github.com/fastify/fast-proxy/workflows/CI/badge.svg)
[![NPM version](https://img.shields.io/npm/v/fast-proxy.svg?style=flat)](https://www.npmjs.com/package/fast-proxy)  

Node.js framework agnostic library that enables you to forward an http request to another HTTP server. 
Supported protocols: HTTP, HTTPS, HTTP2

> This library was initially forked from `fastify-reply-from`: https://github.com/fastify/fastify-reply-from

`fast-proxy` powers: https://www.npmjs.com/package/fast-gateway 🚀 
## Install
```
npm i fast-proxy
```

## Usage
The following examples describe how to use `fast-proxy` with `restana`:

Gateway:
```js
const { proxy, close } = require('fast-proxy')({
  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'

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_.

#### queryString
Set the query string parser and stringifier. By default `fast-proxy` uses the
[fast-querystring](https://npmjs.com/package/fast-querystring) module. Configuration can be changed like so:

```js
{
  base: 'http://localhost:3001/',
  queryString: {
    parse: (value) => qs.parse(value),
    stringify: (value) => qs.stringify(value),
  }
}
```

#### http2
Set to `true` if target server is `http2` enabled.

#### undici
Set to `true` to use [undici](https://github.com/mcollina/undici)
instead of `require('http')`. Enabling this flag should guarantee
20-50% more throughput.

This flag could controls the settings of the undici client, like so:

```js
...
  base: 'http://localhost:3001/',
  undici: {
    connections: 100,
    pipelining: 10
  }
...
```
> See undici demo at: `demos/gateway-undici.js`

#### 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')
  }
...
```
> If using `undici` or `http2` this settings are ignored!

#### 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`.  

> `http2` options are limited to `timeout` only, while `undici` supports none.

##### 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

## Contributions 
Special thanks to `fastify-reply-from` developers for creating a production ready library from where we could initially fork.

## License
MIT

---
_Source: https://npm.io/package/fast-proxy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._