Moderne OnlyThis recipe is proprietary to Moderne and runs on the Moderne platform or CLI — it isn’t part of the open-source catalog. Available with a Moderne subscription.Contact Sales

Replace hpagent with https-proxy-agent

Recipe IDorg.openrewrite.node.migrate.hpagent.replace-hpagent

Artifact@openrewrite/recipes-nodejs

Replaces hpagent's HttpProxyAgent and HttpsProxyAgent with https-proxy-agent's HttpsProxyAgent, whose constructor takes the proxy URL as its first argument rather than as a proxy option: new HttpsProxyAgent({proxy: url, keepAlive: true}) becomes new HttpsProxyAgent(url, {keepAlive: true}). Both hpagent classes tunnel with CONNECT, and https-proxy-agent upgrades the tunnel to TLS only for an https: target, so one class serves both. proxyRequestOptions members move up into the options object, where https-proxy-agent applies them to the connection to the proxy. hpagent accepted a missing proxy until a request needed it, but https-proxy-agent reads it in the constructor, so in JavaScript a proxy that may be missing, such as process.env.HTTP_PROXY, guards the construction: proxy ? new HttpsProxyAgent(proxy) : undefined.

A construction that can't take the two-argument form — options that aren't an object literal, a spread that can't be checked, or a TLS option for the destination handshake (ca, rejectUnauthorized, cert, ...), which https-proxy-agent would apply to the proxy hop — calls a createProxyAgent adapter written into the same file instead. It takes hpagent's options object as it was, gives the proxy hop what hpagent gave it, and puts every other option on the agent's per-request options, which is where hpagent's https.Agent kept them for the destination. hpagent's option types become the adapter's own ProxyAgentOptions, ConstructorParameters<typeof HttpProxyAgent>[0] included, and ProxyAgentRequestOptions a ProxyRequestOptions of its own; instanceof checks and type references move to the new class. A default import becomes a namespace import, since https-proxy-agent has no default export; a block's const {...} = require('hpagent'), and ({...} = require('hpagent')) into a let, move like a top-level one; jest.mock/vi.mock and spyOn follow the module in a file whose hpagent bindings all moved; and a declare module 'hpagent' is deleted. FindHpagentManualMigrations reports every usage left behind.

Single recipeOpenRewritehttps-proxy-agenthpagentModerne Proprietary License

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

1 parameters

1 optional

Parameter	Example	Type	Required
migrateSpreadOptions	—	String	Optional
Rewrite options that spread another object, as in {...shared, proxy: url}, to the two-argument form, passing the spread through to the new options object, instead of calling the adapter. Left off by default: the spread may itself carry a proxyRequestOptions, which has to be flattened, or a TLS option for the destination handshake, which https-proxy-agent would apply to the proxy connection instead. A spread that resolves to a literal of plain agent options in the same file takes the two-argument form either way, since there it can be checked rather than assumed.

Usage

Run this recipe

In order to run JavaScript recipes, you will need to use the Moderne CLI. For JavaScript specific configuration instructions, please see our configuring JavaScript guide.

Once the CLI is installed, you can install this JavaScript recipe package by running the following command:

Install the recipe package

mod config recipes npm install @openrewrite/recipes-nodejs

Then, you can run the recipe via:

Run the recipe

mod run . --recipe org.openrewrite.node.migrate.hpagent.replace-hpagent