refactor(#1136): replace http-proxy w/ httpxy

[SukkaW]

Description

Another attempt to fix #1136.

Unlike #1159, instead of replacing http-proxy w/ http-proxy-3, the PR chooses httpxy, because:

• httpxy is way more popular and more battle-tested:
  • http-proxy-3 only has about 45K weekly downloads right now
    
  • while httpxy has about 1.1M weekly downloads right now
    
• httpxy has a smaller installation size, hence a smaller footprint:
  • http-proxy-3 has 2 dependencies, its installation size is about 185 KiB (https://pkg-size.dev/http-proxy-3)
    
  • httpxy has 0 dependency (!) and its installation size is only 57 KiB (https://pkg-size.dev/httpxy)
    
• Though http-proxy-3 claims it is used by the Vite, httpxy is actually widely used by the Nuxt.js community, and is actually getting contributions from the Vite.js Team (refactor!: code improvements unjs/httpxy#78)!

Motivation and Context

See #1136

How has this been tested?

Unlike #1159, I actually get all the tests to pass and TypeScript happy! You can check the action log here: SukkaW#1

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.

[SukkaW]

cc @chimurai

Please check my PR as another attempt to fix #1136. Unlike #1159, I get all the tests to pass both on my machine locally and on CI (check SukkaW#1):

Also, I get rid of all TypeScript errors with tsc --build runs perfectly:

[chimurai]

Hi @SukkaW

Thanks for the PR! Didn't know about httpxy

Did a quick check and looks really nice so far. Most of the types are working.

Found a small issue in the typing where req somehow is now type any.

Added an extra check to prevent req: any (#1161)

🔧 Can you rebase with master?
You'll see the same error in:

http-proxy-middleware/test/types.spec.ts

Lines 393 to 401 in 6436ffc

	// responseInterceptor
	proxyServer.on(
	'proxyRes',
	responseInterceptor(async (buffer, proxyRes, req, res) => {
	req.params;
	res.status(200).send('OK');
	return buffer;
	}),
	);

[chimurai]

Why was skipLibCheck: true needed?

[SukkaW]

httpxy's types rely on a default export on node:http (in its .d.ts it uses import http from 'node:http').

But this only works with moduleResolution: node16/nodenext/bundler + module: node16/nodenext/preserve setup, not with moduleResolution: node + module: commonjs setup.

So rather than changing the moduleResolution and module (which will most likely result in a huge breaking change), I just enabled skipLibCheck to avoid that.

[SukkaW]

Did a quick check and looks really nice so far. Most of the types are working.

Found a small issue in the typing where req somehow is now type any.

The httpxy usage of EventEmitter is not typed. I have submitted a PR to the upstream to fix it: unjs/httpxy#96

After httpxy merges that PR and releases a new version, the any we are seeing here should be gone.

[SukkaW]

@chimurai

The types are fixed, and all tests passed on my machine locally:

[SukkaW]

proxyRes comes from the http client instead of the call site (express.js), thus this should not be TReq.

[SukkaW]

Technically, req and res should either be both specified or both nullish.

However, currently, httpxy can't implement this kind of overload due to how NodeJS.EventEmitter types its event arguments via a generic (which ProxyServer is extending from), so the && is replaced with || to make the TypeScript happy down the road.

[SukkaW]

@chimurai Also, I am currently actively working on httpxy's HTTP/2 listener support (unjs/httpxy#38).

Update: almost done unjs/httpxy#102

[SukkaW]

@chimurai Hello, what else is required for the PR to merge? All TypeScript error has been fixed and the lint is now happy.