From c08e3bb06d62a229bf6fb008b5cfccf2a2a6d829 Mon Sep 17 00:00:00 2001 From: Anmol Sethi Date: Thu, 4 Feb 2021 17:29:44 -0500 Subject: [PATCH] Add /absproxy to remove --proxy-path-passthrough See https://github.com/cdr/code-server/issues/2222#issuecomment-765235938 Makes way more sense. --- src/node/cli.ts | 5 ---- src/node/routes/index.ts | 21 ++++++++++++++-- src/node/routes/pathProxy.ts | 46 ++++++++++++++++++++++-------------- test/proxy.test.ts | 16 +++++++------ 4 files changed, 56 insertions(+), 32 deletions(-) diff --git a/src/node/cli.ts b/src/node/cli.ts index c8ca387a..0990797d 100644 --- a/src/node/cli.ts +++ b/src/node/cli.ts @@ -50,7 +50,6 @@ export interface Args extends VsArgs { "show-versions"?: boolean "uninstall-extension"?: string[] "proxy-domain"?: string[] - "proxy-path-passthrough"?: boolean locale?: string _: string[] "reuse-window"?: boolean @@ -173,10 +172,6 @@ const options: Options> = { "uninstall-extension": { type: "string[]", description: "Uninstall a VS Code extension by id." }, "show-versions": { type: "boolean", description: "Show VS Code extension versions." }, "proxy-domain": { type: "string[]", description: "Domain used for proxying ports." }, - "proxy-path-passthrough": { - type: "boolean", - description: "Whether the path proxy should leave the /proxy/ in the request path when proxying.", - }, "ignore-last-opened": { type: "boolean", short: "e", diff --git a/src/node/routes/index.ts b/src/node/routes/index.ts index a3fb8bd4..dd4cc126 100644 --- a/src/node/routes/index.ts +++ b/src/node/routes/index.ts @@ -103,8 +103,25 @@ export const register = async ( app.use("/", domainProxy.router) wsApp.use("/", domainProxy.wsRouter.router) - app.use("/proxy", proxy.router) - wsApp.use("/proxy", proxy.wsRouter.router) + app.all("/proxy/(:port)(/*)?", (req, res) => { + proxy.proxy(req, res) + }) + wsApp.get("/proxy/(:port)(/*)?", (req, res) => { + proxy.wsProxy(req as WebsocketRequest) + }) + // These two routes pass through the path directly. + // So the proxied app must be aware it is running + // under /absproxy// + app.all("/absproxy/(:port)(/*)?", (req, res) => { + proxy.proxy(req, res, { + passthroughPath: true, + }) + }) + wsApp.get("/absproxy/(:port)(/*)?", (req, res) => { + proxy.wsProxy(req as WebsocketRequest, { + passthroughPath: true, + }) + }) app.use(bodyParser.json()) app.use(bodyParser.urlencoded({ extended: true })) diff --git a/src/node/routes/pathProxy.ts b/src/node/routes/pathProxy.ts index 6a6b9d29..31fc5336 100644 --- a/src/node/routes/pathProxy.ts +++ b/src/node/routes/pathProxy.ts @@ -1,14 +1,13 @@ -import { Request, Router } from "express" +import { Request, Response } from "express" +import * as path from "path" import qs from "qs" import { HttpCode, HttpError } from "../../common/http" import { normalize } from "../../common/util" import { authenticated, ensureAuthenticated, redirect } from "../http" -import { proxy } from "../proxy" -import { Router as WsRouter } from "../wsRouter" +import { proxy as _proxy } from "../proxy" +import { WebsocketRequest } from "../wsRouter" -export const router = Router() - -const getProxyTarget = (req: Request, passthroughPath: boolean): string => { +const getProxyTarget = (req: Request, passthroughPath?: boolean): string => { if (passthroughPath) { return `http://0.0.0.0:${req.params.port}/${req.originalUrl}` } @@ -16,7 +15,13 @@ const getProxyTarget = (req: Request, passthroughPath: boolean): string => { return `http://0.0.0.0:${req.params.port}/${req.params[0] || ""}${query ? `?${query}` : ""}` } -router.all("/(:port)(/*)?", (req, res) => { +export function proxy( + req: Request, + res: Response, + opts?: { + passthroughPath?: boolean + }, +): void { if (!authenticated(req)) { // If visiting the root (/:port only) redirect to the login page. if (!req.params[0] || req.params[0] === "/") { @@ -28,22 +33,27 @@ router.all("/(:port)(/*)?", (req, res) => { throw new HttpError("Unauthorized", HttpCode.Unauthorized) } - if (!req.args["proxy-path-passthrough"]) { + if (!opts?.passthroughPath) { // Absolute redirects need to be based on the subpath when rewriting. - ;(req as any).base = `${req.baseUrl}/${req.params.port}` + // See proxy.ts. + ;(req as any).base = req.path.split(path.sep).slice(0, 3).join(path.sep) } - proxy.web(req, res, { + _proxy.web(req, res, { ignorePath: true, - target: getProxyTarget(req, req.args["proxy-path-passthrough"] || false), + target: getProxyTarget(req, opts?.passthroughPath), }) -}) +} -export const wsRouter = WsRouter() - -wsRouter.ws("/(:port)(/*)?", ensureAuthenticated, (req) => { - proxy.ws(req, req.ws, req.head, { +export function wsProxy( + req: WebsocketRequest, + opts?: { + passthroughPath?: boolean + }, +): void { + ensureAuthenticated(req) + _proxy.ws(req, req.ws, req.head, { ignorePath: true, - target: getProxyTarget(req, req.args["proxy-path-passthrough"] || false), + target: getProxyTarget(req, opts?.passthroughPath), }) -}) +} diff --git a/test/proxy.test.ts b/test/proxy.test.ts index 0ef5fd79..84a2c35b 100644 --- a/test/proxy.test.ts +++ b/test/proxy.test.ts @@ -7,6 +7,7 @@ describe("proxy", () => { const nhooyrDevServer = new httpserver.HttpServer() let codeServer: httpserver.HttpServer | undefined let proxyPath: string + let absProxyPath: string let e: express.Express beforeAll(async () => { @@ -14,6 +15,7 @@ describe("proxy", () => { e(req, res) }) proxyPath = `/proxy/${nhooyrDevServer.port()}/wsup` + absProxyPath = proxyPath.replace("/proxy/", "/absproxy/") }) afterAll(async () => { @@ -43,11 +45,11 @@ describe("proxy", () => { }) it("should not rewrite the base path", async () => { - e.get(proxyPath, (req, res) => { + e.get(absProxyPath, (req, res) => { res.json("joe is the best") }) - ;[, , codeServer] = await integration.setup(["--auth=none", "--proxy-path-passthrough=true"], "") - const resp = await codeServer.fetch(proxyPath) + ;[, , codeServer] = await integration.setup(["--auth=none"], "") + const resp = await codeServer.fetch(absProxyPath) expect(resp.status).toBe(200) const json = await resp.json() expect(json).toBe("joe is the best") @@ -69,15 +71,15 @@ describe("proxy", () => { }) it("should not rewrite redirects", async () => { - const finalePath = proxyPath.replace("/wsup", "/finale") - e.post(proxyPath, (req, res) => { + const finalePath = absProxyPath.replace("/wsup", "/finale") + e.post(absProxyPath, (req, res) => { res.redirect(307, finalePath) }) e.post(finalePath, (req, res) => { res.json("redirect success") }) - ;[, , codeServer] = await integration.setup(["--auth=none", "--proxy-path-passthrough=true"], "") - const resp = await codeServer.fetch(proxyPath, { + ;[, , codeServer] = await integration.setup(["--auth=none"], "") + const resp = await codeServer.fetch(absProxyPath, { method: "POST", }) expect(resp.status).toBe(200)