@cypress/debugging-proxy

node-debugging-proxy
===


A simple HTTP proxy that proxies HTTP and HTTPS requests transparently. Useful for debugging that your application works correctly with proxies.

Installation

``
npm i -g @cypress/debugging-proxy

or, if you prefer yarn

yarn global add @cypress/debugging-proxy
`

Usage (as a standalone server)

$3

`
debugging-proxy
`

$3

`
PORT=1234 debugging-proxy
`

$3

`
DEBUG=proxy debugging-proxy
`

$3

`
PROXY_USER=some-username PROXY_PASS=some-password debugging-proxy
`

$3

`
HTTPS_KEY=/path/to/key.key HTTPS_CERT=/path/to/cert.pem debugging-proxy
`

Usage (as a module, in a test)

`js
const debugProxy = require('@cypress/debugging-proxy')

// create an instance
const proxy = new debugProxy({
auth: { // if auth is set, HTTP basic authentication to the proxy will be required using these credentials
username: 'foo',
password: 'bar'
},
keepRequests: false, // if keepRequests is set, the proxy will store a log of requests that can be retrieved using proxy.getRequests()
https: { // if https is set, https.createServer will be called with this key and cert to launch the server
key: fs.readFileSync('my-key.pem'),
cert: fs.readFileSync('my-cert.pem')
}
})

// using your stubbing/spying library of choice...
spy(proxy.proxyRequestToUrl)
spy(proxy.proxySslConnectionToDomain)

// start an httpproxy on localhost:3000
proxy.start(3000).then(() => {
// make some requests using the proxy at localhost:3000, then...
expect(proxy.proxyRequestToUrl).to.be.calledWith('http://google.com')
expect(proxy.proxySslConnectionToDomain).to.be.calledWith('google.com')

expect(proxy.getRequests().find(incomingMessage => incomingMessage.ssl === false)).to.exist

// clean up
proxy.stop().then(() => {
console.log('All done!')
})
})
``