Add http.Agent option

[rkretzschmar]

- Summary

If you want to use this Netlify JS client behind a corporate proxy, you need to be able to pass a proxy agent, like for example the https-proxy-agent, to the underlying node-fetch. So I basically implemented what was suggested here.

With this, it should also be possible to handle other use cases and situations by using or even creating custom http.Agent implementations.

- Test plan

• added three ava tests, those and the existing tests still pass
• successfully tested a Netlify site deployment by implementing this:

const NetlifyAPI = require("netlify");
const HttpsProxyAgent = require("https-proxy-agent");

const proxyUri = "http://username:password@corporate-proxy-hostname:port";
const agent = new HttpsProxyAgent(proxyUri);
const client = new NetlifyAPI("myAccessToken", { agent });

async function deployeSite(siteId, buildDir, opts) {
  return await client.deploy(siteId, buildDir, opts);
}

deployeSite("mySiteId", "dist/my-project-build", {
  draft: true,
}).then((deploy) => console.log(deploy));

- Description for the changelog

• add option named agent of type http.Agent to NetlifyClient opts, so that something like https-proxy-agent can be passed to the underlying node-fetch.

- A picture of a cute animal (not mandatory but encouraged)

[ehmicky]

Thanks @rkretzschmar, this looks great!

Only one thing: would it be possible to add a test using a real http.Agent instance instead of a mock plain object? Even just using the default Node.js Agent. Thanks!

[rkretzschmar]

Hi @ehmicky,

thanks for the feedback. I haven't add another test, but replaced the mock agent with the Node.js http.Agent as suggested and passed some arbitrary options to it's constructor.

Hope that's what you was asking for?

Best,
Rene

[ehmicky]

Awesome!
I'll release this shortly :)

[ehmicky]

Released in 4.1.0 🎉

[rkretzschmar]

Thank you very much @ehmicky !