[Feat]: Allow turning rewrites off or give better rewrites control over asExternalUri
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- typescript, vscode
- Ambito
- networking, web-dev
Direzione di ricerca
Parti da mainThreadWindow.ts:65 di VS Code e traccia il modo in cui i risultati di asExternalUri vengono riscritti da code-server, inclusi i percorsi --proxy-domain e CS_DISABLE_PROXY. Confronta questo comportamento con l’uso di openExternal() in Dart Code e con le strutture localhost segnalate. Il lavoro è completato quando viene fornito un modo supportato per disabilitare la riscrittura o configurare un modello di origine senza interrompere le connessioni del workbench.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
What is your suggestion?
Allow controlling how asExternalUri() rewrites work beyond current --proxy-domain capabilities or allow turning them off completely.
Why do you want this feature?
Extensions like Dart Code use asExternalUri to open a WebView in the editor with their DevTools. In Dart Code's case, it refuses to function unless it's served off http://localhost:port root, and also requires connection to its WebSocket server on another port.
I use manual SSH port forwarding for these ports and it used to work about a year ago, but now code-server rewrites these URLs with its own port forwarding, which doesn't work with the extension and I found no way to fix it.
Are there any workarounds to get this functionality today?
- I tried configuring
<port>.example.comport forwarding, but it doesn't work with the extension - I can't set
--proxy-domain http://localhost:{{port}}because it results inhttps://httplocalhost%3AportURLs - With
--proxy-domain localhost:{{port}}VS Code fails to connect to workbench (The workbench failed to connect to the server (Error: Failed to construct 'URL': Invalid URL)) - Setting
CS_DISABLE_PROXY=1 && code-serverand deleting all the existing port forwards doesn't turn the rewrites off - Setting
remote.forwardOnOpenandremote.autoForwardPortstofalsedoesn't turn the rewrites off. - Maybe I'm doing something wrong, but setting
VSCODE_PROXY_URI=http://localhost:{{port}}environment variable doesn't produce any result
With CS_DISABLE_PROXY=1 environment variable, remote.forwardOnOpen and remote.autoForwardPorts set to false, when I set a breakpoint on mainThreadWindow.ts:65, I get the following structure:
{
authority: "example.com",
fragment: "",
path: "/proxy/9100/",
query: "",
scheme: "https",
}
Some implementation details not very related to the problem, but useful to know: When debugging, I get the aforementioned structure twice, first for the DevTools URL, and the similar one for the debug service URL. While the debug service URL is actually a websocket connection, Dart Code uses http protocol to get the asExternalUri() and then replaces it with ws, since the method doesn't support ws port forwarding.
After the extension receives the mapped url, a webview opens at https://example.com/DEBUGGER_URL, dropping the /proxy/9100 part, which I saw mentioned in the docs, though I don't understand how it works. The webview contains only Not Found error.
When using subdomain port forwarding, devtools just fail to load because of some bug in them.
When I copy the URL to my browser and manually change https://example.com to http://localhost:<port> (in both URI itself and its URI parameter that contains the endpoint for the debug service), the DevTools load and successfully connect to the websocket port I SSH forwarded earlier.
When opening VS Code with port forwarding over http://localhost:8080, I get the following structures from asExternalUri:
{
"external": "http://127.0.0.1:9100/DEBUGGER_URL",
"path": "/network",
"scheme": "http",
"authority": "127.0.0.1:9100",
}
Which is exactly what I need. But the resulting webview still points to localhost:8080, so the URL gets patched on some stage, but I can't find any lines in Dart Code which would cause that. Unless I'm missing something, my suspicion is that code-server replaces the result somewhere on returning the result to the extension or displaying the webview, but I don't know how to debug the remote side of the extension and need help with that.
The extension also has "Launch DevTools in browser" option, which tries to open https://example.com/proxy/<port>/ when opening VS Code from example.com, and http://localhost:8080/proxy/<port>/ when opened from localhost. If I studied the extension's code correctly, it uses openExternal() method.
Thus my suggested solution is to either allow to specify any sort of origin template in --proxy-domain, like http://localhost:{{port}}, or at least allow rewrites to be turned off so the localhost URIs remain untouched.
Are you interested in submitting a PR for this?
I could try, but I'm not familiar with code-server's code base yet.
- Lingua principale
- TypeScript
- Stelle
- 79.4k
- Fork
- 6.9k
- Merge medio
- 2g 13h
- PR unite (30g)
- 39
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di coder/code-server
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
coder/code-server#8017 · 2 commenti ·
-
Bump proxy-addr to 2.0.8 Apertasecurity
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
coder/code-server#8013 · 4 commenti ·
-
enhancement
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
coder/code-server#7976 · 2 commenti ·
-
enhancement
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
coder/code-server#7962 · 3 commenti ·
-
bug needs-investigation
Difficoltà 4/5 3-5 giorni Idoneità per principianti 55/100
coder/code-server#7955 · 1 commento ·
Tutte le issue di coder/code-server
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
vercel-labs/just-bash#464 ·
-
looksLikeSlug() is ASCII-only, so non-Latin entity slugs (e.g. Korean) skip exact match and collapse Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
TanStack/tanstack.com#1293 ·