hpagent

.

A ready to use http and https agent for working with proxies that keeps connections alive!

Install

npm install hpagent

Usage

Based on your infrastructure, you should use the http agent or the https agent. The following table will help you picking the right one.

Type	Proxy	Server
HttpProxyAgent	HTTP	HTTP
HttpProxyAgent	HTTPS	HTTP
HttpsProxyAgent	HTTP	HTTPS
HttpsProxyAgent	HTTPS	HTTPS

1const { HttpProxyAgent, HttpsProxyAgent } = require('hpagent')

Once you have understood the right agent for your use case, you can instance it. It takes the same parameter of the Node.js core's http(s) agent and an additional proxy option, which is the url of your proxy.

1const http = require('http')
2const { HttpProxyAgent } = require('hpagent')
3
4const agent = new HttpProxyAgent({
5  keepAlive: true,
6  keepAliveMsecs: 1000,
7  maxSockets: 256,
8  maxFreeSockets: 256,
9  proxy: 'http://localhost:8080'
10})
11
12http.get('http://localhost:9200', { agent })
13    .on('response', console.log)
14    .end()

If your proxy requires basic authentication, you can configure it in the proxy url:

1const http = require('http')
2const { HttpProxyAgent } = require('hpagent')
3
4const agent = new HttpProxyAgent({
5  keepAlive: true,
6  keepAliveMsecs: 1000,
7  maxSockets: 256,
8  maxFreeSockets: 256,
9  proxy: 'http://user:pwd@localhost:8080'
10})
11
12http.get('http://localhost:9200', { agent })
13    .on('response', console.log)
14    .end()

You can also pass custom options intended only for the proxy CONNECT request with the proxyConnectOptions option, such as headers or tls.connect() options:

1const fs = require('fs')
2const http = require('http')
3const { HttpProxyAgent } = require('hpagent')
4
5const agent = new HttpProxyAgent({
6  keepAlive: true,
7  keepAliveMsecs: 1000,
8  maxSockets: 256,
9  maxFreeSockets: 256,
10  proxy: 'https://localhost:8080',
11  proxyConnectOptions: {
12    headers: {
13      'Proxy-Authorization': 'Basic YWxhZGRpbjpvcGVuc2VzYW1l',
14    },
15    ca: [ fs.readFileSync('custom-proxy-cert.pem') ]
16  }
17})
18
19http.get('http://localhost:9200', { agent })
20    .on('response', console.log)
21    .end()

Integrations

Following you can find the list of userland http libraries that are tested with this agent.

got

1got('http://localhost:9200', {
2  agent: {
3    http: new HttpProxyAgent({
4      keepAlive: true,
5      keepAliveMsecs: 1000,
6      maxSockets: 256,
7      maxFreeSockets: 256,
8      scheduling: 'lifo',
9      proxy: 'http://localhost:8080'
10    })
11  }
12})

needle

1needle('get', 'http://localhost:9200', {
2  agent: new HttpProxyAgent({
3    keepAlive: true,
4    keepAliveMsecs: 1000,
5    maxSockets: 256,
6    maxFreeSockets: 256,
7    scheduling: 'lifo',
8    proxy: 'http://localhost:8080'
9  })
10})

node-fetch

1fetch('http://localhost:9200', {
2  agent: new HttpProxyAgent({
3    keepAlive: true,
4    keepAliveMsecs: 1000,
5    maxSockets: 256,
6    maxFreeSockets: 256,
7    scheduling: 'lifo',
8    proxy: 'http://localhost:8080'
9  })
10})

simple-get

1sget.concat({
2  url: `http://${server.address().address}:${server.address().port}`,
3  agent: new HttpProxyAgent({
4    keepAlive: true,
5    keepAliveMsecs: 1000,
6    maxSockets: 256,
7    maxFreeSockets: 256,
8    scheduling: 'lifo',
9    proxy: `https://${proxy.address().address}:${proxy.address().port}`
10  })
11}, function (err, response, data) {
12  // handle the response
13})

License

This software is licensed under the MIT.