Add /absproxy to remove --proxy-path-passthrough
See https://github.com/cdr/code-server/issues/2222#issuecomment-765235938 Makes way more sense.
This commit is contained in:
parent
4bace1ae4a
commit
c08e3bb06d
@ -50,7 +50,6 @@ export interface Args extends VsArgs {
|
|||||||
"show-versions"?: boolean
|
"show-versions"?: boolean
|
||||||
"uninstall-extension"?: string[]
|
"uninstall-extension"?: string[]
|
||||||
"proxy-domain"?: string[]
|
"proxy-domain"?: string[]
|
||||||
"proxy-path-passthrough"?: boolean
|
|
||||||
locale?: string
|
locale?: string
|
||||||
_: string[]
|
_: string[]
|
||||||
"reuse-window"?: boolean
|
"reuse-window"?: boolean
|
||||||
@ -173,10 +172,6 @@ const options: Options<Required<Args>> = {
|
|||||||
"uninstall-extension": { type: "string[]", description: "Uninstall a VS Code extension by id." },
|
"uninstall-extension": { type: "string[]", description: "Uninstall a VS Code extension by id." },
|
||||||
"show-versions": { type: "boolean", description: "Show VS Code extension versions." },
|
"show-versions": { type: "boolean", description: "Show VS Code extension versions." },
|
||||||
"proxy-domain": { type: "string[]", description: "Domain used for proxying ports." },
|
"proxy-domain": { type: "string[]", description: "Domain used for proxying ports." },
|
||||||
"proxy-path-passthrough": {
|
|
||||||
type: "boolean",
|
|
||||||
description: "Whether the path proxy should leave the /proxy/<port> in the request path when proxying.",
|
|
||||||
},
|
|
||||||
"ignore-last-opened": {
|
"ignore-last-opened": {
|
||||||
type: "boolean",
|
type: "boolean",
|
||||||
short: "e",
|
short: "e",
|
||||||
|
@ -103,8 +103,25 @@ export const register = async (
|
|||||||
app.use("/", domainProxy.router)
|
app.use("/", domainProxy.router)
|
||||||
wsApp.use("/", domainProxy.wsRouter.router)
|
wsApp.use("/", domainProxy.wsRouter.router)
|
||||||
|
|
||||||
app.use("/proxy", proxy.router)
|
app.all("/proxy/(:port)(/*)?", (req, res) => {
|
||||||
wsApp.use("/proxy", proxy.wsRouter.router)
|
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/<someport>/
|
||||||
|
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.json())
|
||||||
app.use(bodyParser.urlencoded({ extended: true }))
|
app.use(bodyParser.urlencoded({ extended: true }))
|
||||||
|
@ -1,14 +1,13 @@
|
|||||||
import { Request, Router } from "express"
|
import { Request, Response } from "express"
|
||||||
|
import * as path from "path"
|
||||||
import qs from "qs"
|
import qs from "qs"
|
||||||
import { HttpCode, HttpError } from "../../common/http"
|
import { HttpCode, HttpError } from "../../common/http"
|
||||||
import { normalize } from "../../common/util"
|
import { normalize } from "../../common/util"
|
||||||
import { authenticated, ensureAuthenticated, redirect } from "../http"
|
import { authenticated, ensureAuthenticated, redirect } from "../http"
|
||||||
import { proxy } from "../proxy"
|
import { proxy as _proxy } from "../proxy"
|
||||||
import { Router as WsRouter } from "../wsRouter"
|
import { WebsocketRequest } from "../wsRouter"
|
||||||
|
|
||||||
export const router = Router()
|
const getProxyTarget = (req: Request, passthroughPath?: boolean): string => {
|
||||||
|
|
||||||
const getProxyTarget = (req: Request, passthroughPath: boolean): string => {
|
|
||||||
if (passthroughPath) {
|
if (passthroughPath) {
|
||||||
return `http://0.0.0.0:${req.params.port}/${req.originalUrl}`
|
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}` : ""}`
|
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 (!authenticated(req)) {
|
||||||
// If visiting the root (/:port only) redirect to the login page.
|
// If visiting the root (/:port only) redirect to the login page.
|
||||||
if (!req.params[0] || req.params[0] === "/") {
|
if (!req.params[0] || req.params[0] === "/") {
|
||||||
@ -28,22 +33,27 @@ router.all("/(:port)(/*)?", (req, res) => {
|
|||||||
throw new HttpError("Unauthorized", HttpCode.Unauthorized)
|
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.
|
// 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,
|
ignorePath: true,
|
||||||
target: getProxyTarget(req, req.args["proxy-path-passthrough"] || false),
|
target: getProxyTarget(req, opts?.passthroughPath),
|
||||||
})
|
})
|
||||||
})
|
}
|
||||||
|
|
||||||
export const wsRouter = WsRouter()
|
export function wsProxy(
|
||||||
|
req: WebsocketRequest,
|
||||||
wsRouter.ws("/(:port)(/*)?", ensureAuthenticated, (req) => {
|
opts?: {
|
||||||
proxy.ws(req, req.ws, req.head, {
|
passthroughPath?: boolean
|
||||||
|
},
|
||||||
|
): void {
|
||||||
|
ensureAuthenticated(req)
|
||||||
|
_proxy.ws(req, req.ws, req.head, {
|
||||||
ignorePath: true,
|
ignorePath: true,
|
||||||
target: getProxyTarget(req, req.args["proxy-path-passthrough"] || false),
|
target: getProxyTarget(req, opts?.passthroughPath),
|
||||||
})
|
})
|
||||||
})
|
}
|
||||||
|
@ -7,6 +7,7 @@ describe("proxy", () => {
|
|||||||
const nhooyrDevServer = new httpserver.HttpServer()
|
const nhooyrDevServer = new httpserver.HttpServer()
|
||||||
let codeServer: httpserver.HttpServer | undefined
|
let codeServer: httpserver.HttpServer | undefined
|
||||||
let proxyPath: string
|
let proxyPath: string
|
||||||
|
let absProxyPath: string
|
||||||
let e: express.Express
|
let e: express.Express
|
||||||
|
|
||||||
beforeAll(async () => {
|
beforeAll(async () => {
|
||||||
@ -14,6 +15,7 @@ describe("proxy", () => {
|
|||||||
e(req, res)
|
e(req, res)
|
||||||
})
|
})
|
||||||
proxyPath = `/proxy/${nhooyrDevServer.port()}/wsup`
|
proxyPath = `/proxy/${nhooyrDevServer.port()}/wsup`
|
||||||
|
absProxyPath = proxyPath.replace("/proxy/", "/absproxy/")
|
||||||
})
|
})
|
||||||
|
|
||||||
afterAll(async () => {
|
afterAll(async () => {
|
||||||
@ -43,11 +45,11 @@ describe("proxy", () => {
|
|||||||
})
|
})
|
||||||
|
|
||||||
it("should not rewrite the base path", async () => {
|
it("should not rewrite the base path", async () => {
|
||||||
e.get(proxyPath, (req, res) => {
|
e.get(absProxyPath, (req, res) => {
|
||||||
res.json("joe is the best")
|
res.json("joe is the best")
|
||||||
})
|
})
|
||||||
;[, , codeServer] = await integration.setup(["--auth=none", "--proxy-path-passthrough=true"], "")
|
;[, , codeServer] = await integration.setup(["--auth=none"], "")
|
||||||
const resp = await codeServer.fetch(proxyPath)
|
const resp = await codeServer.fetch(absProxyPath)
|
||||||
expect(resp.status).toBe(200)
|
expect(resp.status).toBe(200)
|
||||||
const json = await resp.json()
|
const json = await resp.json()
|
||||||
expect(json).toBe("joe is the best")
|
expect(json).toBe("joe is the best")
|
||||||
@ -69,15 +71,15 @@ describe("proxy", () => {
|
|||||||
})
|
})
|
||||||
|
|
||||||
it("should not rewrite redirects", async () => {
|
it("should not rewrite redirects", async () => {
|
||||||
const finalePath = proxyPath.replace("/wsup", "/finale")
|
const finalePath = absProxyPath.replace("/wsup", "/finale")
|
||||||
e.post(proxyPath, (req, res) => {
|
e.post(absProxyPath, (req, res) => {
|
||||||
res.redirect(307, finalePath)
|
res.redirect(307, finalePath)
|
||||||
})
|
})
|
||||||
e.post(finalePath, (req, res) => {
|
e.post(finalePath, (req, res) => {
|
||||||
res.json("redirect success")
|
res.json("redirect success")
|
||||||
})
|
})
|
||||||
;[, , codeServer] = await integration.setup(["--auth=none", "--proxy-path-passthrough=true"], "")
|
;[, , codeServer] = await integration.setup(["--auth=none"], "")
|
||||||
const resp = await codeServer.fetch(proxyPath, {
|
const resp = await codeServer.fetch(absProxyPath, {
|
||||||
method: "POST",
|
method: "POST",
|
||||||
})
|
})
|
||||||
expect(resp.status).toBe(200)
|
expect(resp.status).toBe(200)
|
||||||
|
Reference in New Issue
Block a user