fix #4 -- add typescript typings

Author: williamstein

.gitignore

@@ -8,7 +8,7 @@ tes.js
 npm-debug.log
 .nyc_output
 coverage
-tsconfig.tsbuildinfo
 dist
 *.sage-chat
 *.term
+*.tsbuildinfo

.tsconfig-bootstrap.json

@@ -1,6 +1,6 @@
 module.exports = {
   preset: "ts-jest",
   testEnvironment: "node",
-  setupFiles: ["./test/setup.js"],
+  setupFiles: ["./lib/test/setup.js"],
   testMatch: ["**/?(*.)+(spec|test).ts?(x)"],
 };

jest.config.js

@@ -15,7 +15,9 @@ export interface Outgoing extends Outgoing0 {
   method?: any;
   rejectUnauthorized?: boolean;
   path?: string;
-  headers: { [header: string]: string | string[] | undefined };
+  headers: { [header: string]: string | string[] | undefined } & {
+    overwritten?: boolean;
+  };
 }
 
 // If we allow this header and a user sends it with a request,

lib/http-proxy/common.ts

@@ -25,7 +25,7 @@ export interface ProxyTargetDetailed {
 }
 export type ProxyType = "ws" | "web";
 export type ProxyTarget = ProxyTargetUrl | ProxyTargetDetailed;
-export type ProxyTargetUrl = URL | string;
+export type ProxyTargetUrl = URL | string | { port: number; host: string };
 
 export interface ServerOptions {
   // NOTE: `options.target and `options.forward` cannot be both missing when the
@@ -145,10 +145,7 @@ export class ProxyServer extends EventEmitter {
         }
 
         if (!requestOptions.target && !requestOptions.forward) {
-          this.emit(
-            "error",
-            new Error("Must set target or forward"),
-          );
+          this.emit("error", new Error("Must set target or forward"));
           return;
         }
 

lib/http-proxy/index.ts

@@ -17,7 +17,7 @@ export { numOpenSockets } from "./http-proxy/passes/ws-incoming";
  * @api public
  */
 
-function createProxyServer(options: ServerOptions): ProxyServer {
+function createProxyServer(options: ServerOptions = {}): ProxyServer {
   return new ProxyServer(options);
 }
 

lib/index.ts

@@ -66,7 +66,7 @@ describe("A simple round-robin load balancer that supports websockets", () => {
     );
 
     proxyPort = await getPort();
-    servers.proxy = httpProxy.createProxyServer();
+    servers.proxy = httpProxy.createProxyServer({});
     let i = 0;
     function nextProxy() {
       i = (i + 1) % addresses.length;

test/README.md renamed to lib/test/README.md

@@ -46,7 +46,7 @@ describe("A simple round-robin load balancing strategy.", () => {
   let proxyPort;
   it("creates the round robin proxy server", async () => {
     proxyPort = await getPort();
-    const proxy = httpProxy.createServer();
+    const proxy = httpProxy.createServer({});
     let i = 0;
     servers.proxy = http
       .createServer((req, res) => {

test/balancer/simple-balancer-with-websockets.test.ts renamed to lib/test/balancer/simple-balancer-with-websockets.test.ts

@@ -66,7 +66,7 @@ describe("Load test against the basic proxy", () => {
   });
 
   const COUNT = 200;
-  const MAX_TIME = 1000;
+  const MAX_TIME = 3000;
   it(`Does a serial load test of HTTP server with ${COUNT} requests`, async () => {
     const t = Date.now();
     for (let i = 0; i < COUNT; i++) {

test/balancer/simple-balancer.test.ts renamed to lib/test/balancer/simple-balancer.test.ts

@@ -2,7 +2,17 @@
 pnpm test ./http-proxy-common.test.ts
 */
 
-import { setupOutgoing, setupSocket } from "../../dist/lib/http-proxy/common";
+import {
+  setupOutgoing as setupOutgoing0,
+  setupSocket,
+} from "../../http-proxy/common";
+
+// wrap setupOutgoing so types aren't checked, since a lot of the tests here
+// involve partial objects that typescript doesn't view as correct, e.g., {url:'foo...'}
+// for a Request.
+function setupOutgoing(...args) {
+  setupOutgoing0(args[0], args[1], args[2], args[3]);
+}
 
 describe("#setupOutgoing", () => {
   it("should setup the correct headers", () => {
@@ -471,7 +481,7 @@ describe("#setupSocket", () => {
           socketConfig.keepalive = bol;
         },
       };
-    setupSocket(stubSocket);
+    setupSocket(stubSocket as any);
     expect(socketConfig.timeout).toEqual(0);
     expect(socketConfig.nodelay).toEqual(true);
     expect(socketConfig.keepalive).toEqual(true);

test/fixtures/agent2-cert.pem renamed to lib/test/fixtures/agent2-cert.pem

@@ -6,7 +6,7 @@ import {
   deleteLength,
   timeout,
   XHeaders,
-} from "../../dist/lib/http-proxy/passes/web-incoming";
+} from "../../http-proxy/passes/web-incoming";
 import * as httpProxy from "../..";
 import * as http from "http";
 import concat from "concat-stream";
@@ -18,17 +18,17 @@ describe("#deleteLength", () => {
     const stubRequest = {
       method: "DELETE",
       headers: {},
-    };
-    deleteLength(stubRequest, {}, {});
+    } as any;
+    deleteLength(stubRequest);
     expect(stubRequest.headers["content-length"]).toEqual("0");
   });
 
   it("should change `content-length` for OPTIONS requests", () => {
     const stubRequest = {
       method: "OPTIONS",
       headers: {},
-    };
-    deleteLength(stubRequest, {}, {});
+    } as any;
+    deleteLength(stubRequest);
     expect(stubRequest.headers["content-length"]).toEqual("0");
   });
 
@@ -38,8 +38,8 @@ describe("#deleteLength", () => {
       headers: {
         "transfer-encoding": "chunked",
       },
-    };
-    deleteLength(stubRequest, {}, {});
+    } as any;
+    deleteLength(stubRequest);
     expect(stubRequest.headers["content-length"]).toEqual("0");
     expect(stubRequest.headers).not.toHaveProperty("transfer-encoding");
   });
@@ -55,7 +55,7 @@ describe("#timeout", () => {
         },
       },
     };
-
+    // @ts-ignore
     timeout(stubRequest, {}, { timeout: 5000 });
     expect(done).toEqual(5000);
   });
@@ -73,6 +73,7 @@ describe("#XHeaders", () => {
   };
 
   it("set the correct x-forwarded-* headers", () => {
+    // @ts-ignore
     XHeaders(stubRequest, {}, { xfwd: true });
     expect(stubRequest.headers["x-forwarded-for"]).toEqual("192.168.1.2");
     expect(stubRequest.headers["x-forwarded-port"]).toEqual("8080");

test/fixtures/agent2-key.pem renamed to lib/test/fixtures/agent2-key.pem

@@ -1,14 +1,25 @@
 import {
   removeChunked,
-  setRedirectHostRewrite,
-  setConnection,
+  setRedirectHostRewrite as setRedirectHostRewrite0,
+  setConnection as setConnection0,
   writeStatusCode,
-  writeHeaders,
-} from "../../dist/lib/http-proxy/passes/web-outgoing";
+  writeHeaders as writeHeaders0,
+} from "../../http-proxy/passes/web-outgoing";
 import * as url from "url";
 
 const state: any = { headers: {} };
 
+// disable typescript
+function writeHeaders(...args) {
+  return writeHeaders0(args[0], args[1], args[2], args[3]);
+}
+function setConnection(...args) {
+  return setConnection0(args[0], args[1], args[2]);
+}
+function setRedirectHostRewrite(...args) {
+  return setRedirectHostRewrite0(args[0], args[1], args[2], args[3]);
+}
+
 // NOTE: here url.parse("http://backend.com") uses the deprecated url.parse
 // function, and we're testing that we still support it.
 for (const target of ["http://backend.com", url.parse("http://backend.com")]) {
@@ -273,6 +284,7 @@ describe("#writeStatusCode", () => {
       },
     };
 
+    // @ts-ignore
     writeStatusCode({}, res, { statusCode: 200 });
   });
 });
@@ -477,6 +489,7 @@ describe("#removeChunked", () => {
     },
   };
 
+  // @ts-ignore
   removeChunked({ httpVersion: "1.0" }, {}, proxyRes);
 
   expect(proxyRes.headers["transfer-encoding"]).toEqual(undefined);

test/get-port.ts renamed to lib/test/get-port.ts

@@ -2,7 +2,15 @@
 pnpm test ./http-proxy-passes-ws-incoming.test.ts
 */
 
-import { checkMethodAndHeader, XHeaders } from "../../dist/lib/http-proxy/passes/ws-incoming";
+import {
+  checkMethodAndHeader as checkMethodAndHeader0,
+  XHeaders,
+} from "../../http-proxy/passes/ws-incoming";
+
+// disable typescript for this function
+function checkMethodAndHeader(...args) {
+  return checkMethodAndHeader0(args[0], args[1]);
+}
 
 describe("#checkMethodAndHeader", () => {
   it("should drop non-GET connections", () => {
@@ -80,6 +88,7 @@ describe("#checkMethodAndHeader", () => {
 
 describe("#XHeaders", () => {
   it("return if no forward request", () => {
+    // @ts-ignore
     let returnValue = XHeaders({}, {}, {});
     expect(returnValue).toBe(undefined);
   });
@@ -94,6 +103,7 @@ describe("#XHeaders", () => {
         host: "192.168.1.2:8080",
       },
     };
+    // @ts-ignore
     XHeaders(stubRequest, {}, { xfwd: true });
     expect(stubRequest.headers["x-forwarded-for"]).toBe("192.168.1.2");
     expect(stubRequest.headers["x-forwarded-port"]).toBe("8080");
@@ -113,6 +123,7 @@ describe("#XHeaders", () => {
         host: "192.168.1.3:8181",
       },
     };
+    // @ts-ignore
     XHeaders(stubRequest, {}, { xfwd: true });
     expect(stubRequest.headers["x-forwarded-for"]).toBe("192.168.1.3");
     expect(stubRequest.headers["x-forwarded-port"]).toBe("8181");

test/http/basic-proxy.test.ts renamed to lib/test/http/basic-proxy.test.ts

@@ -41,7 +41,7 @@ describe("Load testing proxying a WebSocket", () => {
       .listen(ports.proxy);
   });
 
-  const LATENCY = 250;
+  const LATENCY = 1000;
   const COUNT = 250;
 
   it(`Serial test ${COUNT} times plain websocket server`, async () => {

test/http/custom-proxy-error.test.ts renamed to lib/test/http/custom-proxy-error.test.ts

@@ -70,7 +70,7 @@ describe("Example of proxying over HTTP and WebSockets", () => {
     client.close();
   });
 
-  const LATENCY = 250;
+  const LATENCY = 1000;
   const COUNT = 250;
   it(`Serial test ${COUNT} times proxy server`, async () => {
     const t = Date.now();

test/http/error-handling.test.ts renamed to lib/test/http/error-handling.test.ts

@@ -1,6 +1,6 @@
 {
   "name": "http-proxy-3",
-  "version": "1.20.4",
+  "version": "1.20.5",
   "repository": {
     "type": "git",
     "url": "https://github.com/sagemathinc/http-proxy-3.git"
@@ -13,7 +13,7 @@
     "jcrugzz <[email protected]>"
   ],
   "main": "dist/lib/index.js",
-  "files": ["dist"],
+  "files": ["dist/lib/http-proxy", "dist/lib/index.js", "dist/lib/index.d.ts"],
   "dependencies": {
     "debug": "^4.4.0",
     "follow-redirects": "^1.15.9"
@@ -48,7 +48,8 @@
     "test-all": "pnpm audit && TEST_EXTERNAL_REVERSE_PROXY=yes pnpm test --runInBand",
     "test-versions": ". \"$NVM_DIR/nvm.sh\" && nvm use 18 && pnpm test && nvm use 20 && pnpm test && nvm use 22 && pnpm test && nvm use 24 && pnpm test && nvm use 20",
     "clean": "rm -rf dist node_modules",
-    "build": "pnpm exec tsc --build .tsconfig-bootstrap.json && pnpm exec tsc --build",
+    "build": "pnpm exec tsc --build",
+    "make": "pnpm clean && pnpm install && pnpm build && pnpm test",
     "tsc": "pnpm exec tsc --watch  --pretty --preserveWatchOutput",
     "prepublishOnly": "pnpm test-versions && pnpm test-all && rm -f dist/*.tsbuildinfo dist/.tsconfig-bootstrap* && rm -rf dist/test"
   },

test/http/forward-and-target-proxy.test.ts renamed to lib/test/http/forward-and-target-proxy.test.ts

@@ -4,6 +4,7 @@
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "strictNullChecks": true,
+    "declaration": true,
     "downlevelIteration": true,
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
@@ -16,13 +17,13 @@
     "target": "es2020",
     "module": "commonjs",
     "rootDir": "./",
-    "outDir": "dist"
+    "outDir": "./dist"
   },
   "watchOptions": {
     "fallbackPolling": "dynamicPriority",
     "synchronousWatchDirectory": true,
     "watchDirectory": "useFsEvents",
     "watchFile": "useFsEvents"
   },
-  "exclude": ["node_modules", "dist", "test-todo", "examples"]
+  "exclude": ["node_modules", "dist", "benchmark"]
 }