Don't require esModuleInterop downstream

[jeffomatic]

This change updates Node stdlib imports to use the following ES6 import style:

import * as x from 'x';

This allows downstream TypeScript projects (direct or transitive) to use node-agent-base without enabling the esModuleInterop option. Ideally, it would be nice not to force users to enable this option if they don't want it.

To prevent regression, this PR switches off the esModuleInterop option in this package's own tsconfig.json. This means that the test suite also needed to be updated. In particular, the case that modifies https.globalAgent requires a slight tweak, because ES6 module imports mark modules as read-only for the importing scope.

[jeffomatic]

Note that the // @ts-ignore means we don't have to do the require() hack that was necessary for https below.

[Nytelife26]

Looks good, but the package hasn't been updated in months. Seems unlikely you'll get a merge.

[TooTallNate]

I'm potentially open to this change. However, I wonder how are you consuming this module? Are you using the source TypeScript files directly or the compiled version from the dist dir (which would be the default npm way).

[jeffomatic]

I wonder how are you consuming this module? Are you using the source TypeScript files directly or the compiled version from the dist dir (which would be the default npm way).

Sure. We ran into issue when adding proxy-agent to a TypeScript project; folks on the team are hard against enabling esModuleInterop for reasons I won't dive into here. proxy-agent uses node-agent-base as a dependency. The TypeScript compiler dies when reading node-agent-base's index.d.ts, which, as you mention, does appear in dist.

Our current workaround is to use require() to import proxy-agent, which more or less short-circuits the typechecker. The downside is that proxy-agent's exports are no longer typechecked, since require forces an any type.

[Uzlopak]

I ran also today into this issue :/

Would be great if you would fix it.

[Uzlopak]

@TooTallNate

The issue is happening when you have a "normal" typescript project without esModuleInterop set to true. When you import ProxyAgent, it will also use your package. So when the typings are imported, your esModule import will break your project, as it can not determine what this means.

This is your current tarball in npm:
https://registry.npmjs.org/agent-base/-/agent-base-6.0.2.tgz

So it uses the typings in the dist folder, which have esModuleInterop imports.

[Trainmaster]

Without enabling esModuleInterop, this is blocking an upgrade from proxy-agent@3.1.1 to proxy-agent@4.0.2. And this is necessary because agent-base@4.2.1 is in the dependency tree which has the following bug: #25.

"proxy-agent": {
  "version": "3.1.1",
  "resolved": "xxx/proxy-agent-3.1.1.tgz",
  "integrity": "sha1-fgTga/Nq+mJKFUC+JHtHyXC9MBQ=",
  "requires": {
    "agent-base": "^4.2.0",
    "debug": "4",
    "http-proxy-agent": "^2.1.0",
    "https-proxy-agent": "^3.0.0",
    "lru-cache": "^5.1.1",
    "pac-proxy-agent": "^3.0.1",
    "proxy-from-env": "^1.0.0",
    "socks-proxy-agent": "^4.0.1"
  }
},

"socks-proxy-agent": {
  "version": "4.0.2",
  "resolved": "xxx/socks-proxy-agent-4.0.2.tgz",
  "integrity": "sha1-PImR8xRbJ5nnDhG9X7yLGWMRY4Y=",
  "requires": {
    "agent-base": "~4.2.1",
    "socks": "~2.3.2"
  },

[orgads]

@TooTallNate Do you plan to merge this?

[heanzyzabala]

@TooTallNate Any updates on this?

[TooTallNate]

This code in this repository has been moved to the proxy-agents monorepo, so I am closing this pull request. If you feel that this change is still necessary as of the latest release, feel free to open a new pull request over there.