fix: relative url path for ui mode #29924
Conversation
This comment has been minimized.
This comment has been minimized.
|
@pavelfeldman I tried to add a test by implementing a proxy in typescript but struggle with the combination of proxying http and ws as well as the multiple testing layers. Is that something I should invest time in or is continuing without tests ok? In addition I took a look at |
| @@ -117,7 +117,7 @@ async function startTraceViewerServer(traceUrls: string[], options?: OpenTraceVi | |||
| const url = await server.start({ preferredPort: port, host }); | |||
| const { app } = options || {}; | |||
| const searchQuery = params.length ? '?' + params.join('&') : ''; | |||
| const urlPath = `/trace/${app || 'index.html'}${searchQuery}`; | |||
| const urlPath = `./trace/${app || 'index.html'}${searchQuery}`; | |||
There was a problem hiding this comment.
How doe it fix the issue from the description? AFAIU the urlPath will be used as redirect location only for requests to / on the server and that won't match /code.
There was a problem hiding this comment.
In the world of relative URLs and subpath proxying, we don't care if the traceviewer is accessible via /code /trace-viewer or /base-url-of-companies-xy-test-tooling/playwright´. All queries hitting one of these proxy subpaths are forwarded to the proxy viewers /` route.
The traceViewer is none the wiser that it is exposed via a subpath.
However, this indirection is dependent on the fact that the server only returns relative URLs. This allows the browser to construct the new complete URL.
The problematic behavior now occurs only when there are nested proxies.
- Infra Proxy: Reverse proxy exposing
codevia/code/ - App Proxy: Exposing processes running in a code instance via
./proxy/{{port}}
Without this change:
- Browser requests
/code/proxy/8090 - Infra proxy strips part of the request
/code/proxy/8090->/proxy/8090
3 App proxy strips part of the request/proxy/8090->/ - Trace Viewer receives
/and returns 302:/trace/{...} - App proxy adds back its subpath to isolate the different proxied processes from each other
/proxy/8090+/trace/{...}->/proxy/8090/trace/{...}. The absolute nature of the request propagates. - Infra proxy has no domain knowledge and returns absolute URL
/proxy/8090/trace/{...} - Browser receives (via the proxy) 302:
/proxy/8090/trace/{...} - Browser follows redirect but hits a 404 because
/codeis missing.
With this change:
- Browser requests
/code/proxy/8090 - Both proxies strip their proxy paths from the request
/code/proxy/8090->/ - Trace Viewer receives
/and returns 302:./trace/{...} - Proxies build back up the path for the response from
/to/code/proxy/8090 - Browser receives 302:
./trace/{...}coming from/code/proxy/8090 - The Browser combines it with the original request URL (because it is relative).
/code/proxy/8090+./trace/{...}=/code/proxy/8090/trace/{...}
Signed-off-by: Lukas Bockstaller <lukas.bockstaller@everest-erp.com>
Test results for "tests 1"2 flaky27315 passed, 661 skipped Merge workflow run. |
This is a follow up #29564
I did a deep dive on a redirect issue I observed in my infrastructure and originally attributed to some configuration mistakes on my part.
I have code hosted on
example.com/codeand use subdomain proxying. This leads to the uimode being exposed onexample.com/code/proxy/{{port}}.Clicking on the open uimode link shown by vscode redirected with a 302 to
example.com/proxy/{{port}}The absolute redirect url overruled the relative path handling reverse proxies rely on.
This PR turns the absolute into a relative url to avoid this issue.