feat: enable forwarded ports using built-in proxy #5673

jsjoeio · 2022-10-19T21:53:12Z

Description

This PR enables the forwarded ports panel in Code and then adds a tunnelFactory to forward them using code-server's built-in proxy (/proxy/port).

One thing to note: it seems ports will not be "un-forwarded" due to a limitation upstream. However, reloading code-server, they are removed. See here:

TODOs

The following things remain:

test with code-server not on localhost
~~killing port should remove from ports panel~~ this behavior exists upstream so leaving as is
don't show port running code-server
use correct link with browser icon
test "open in browser" notification link
test using environment variable like VSCODE_PROXY_URI

Screenshots

Example using VSCODE_PROXY_URI=https://{{port}}.kyle.dev

Example using Caddy to server code-server behind proxy:

This makes the forwarded ports panel enabled by default.

This adds a `tunnelProvider` along with a `tunnelFactory` so that ports are forwarded and use code-server's built-in proxy.

This adds a check in our `resolveExternalUri` patch to skip modifying if the `authority` and the `location.host` match to prevent `localhost:<port>/proxy/<port>` from being modified.

codecov · 2022-10-20T18:29:59Z

Codecov Report

Merging #5673 (b401cbd) into main (430b567) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5673   +/-   ##
=======================================
  Coverage   72.61%   72.61%           
=======================================
  Files          30       30           
  Lines        1680     1680           
  Branches      368      368           
=======================================
  Hits         1220     1220           
  Misses        397      397           
  Partials       63       63

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 430b567...b401cbd. Read the comment docs.

github-actions · 2022-10-20T18:30:02Z

✨ code-server dev build published to npm for PR #5673!

Last publish status: success
Commit: b401cbd

To install in a local project, run:

npm install @coder/code-server-pr@5673

To install globally, run:

npm install -g @coder/code-server-pr@5673

jsjoeio · 2022-10-20T19:03:53Z

npm install --unsafe-perm @coder/code-server-pr@4.7.1-5673-3c17798eb377432f160f3aef7cad61bb2a26a83f

patches/proxy-uri.diff

code-asher

Very exciting 🎉

For some reason I am not seeing the ports panel (tried npm and the CI artifact). 🤔

$ code-server --auth none
[2022-10-21T15:48:23.934Z] info  code-server 4.7.1-5673-3c17798eb377432f160f3aef7cad61bb2a26a83f 3c17798eb377432f160f3aef7cad61bb2a26a83f

patches/proxy-uri.diff

jsjoeio · 2022-10-21T17:16:38Z

For some reason I am not seeing the ports panel (tried npm and the CI artifact). 🤔

Hmm...do you have it hidden by chance? @bpmct and I did test it in a v2 workspace (Linux) and we saw it. I'm not sure what else might cause it to be missing 🤔

bpmct · 2022-10-21T17:20:02Z

For some reason I am not seeing the ports panel (tried npm and the CI artifact). 🤔

Hmm...do you have it hidden by chance? @bpmct and I did test it in a v2 workspace (Linux) and we saw it. I'm not sure what else might cause it to be missing 🤔

here are the steps we did: coder/coder@main...dogfood-code-server-ports

code-asher

Apparently I was having a caching issue. Works for me now!

code-asher · 2022-10-21T21:43:27Z

We might want to edit webClientServer.ts and add a trailing slash since most of the time that will be needed:

proxyEndpointTemplate: process.env.VSCODE_PROXY_URI ?? base + '/proxy/{{port}}/',

jsjoeio · 2022-10-21T21:47:09Z

Good point! I'll do that and then merge

codecae · 2022-11-29T06:14:08Z

FWIW:

I have been experiencing potential issues with this PR on systems in which the code-server is running behind another proxy. Websocket connections are constantly being disconnected and reconnected at a high rate making the UI inaccessible and rendering the application unusable.

I will open another issue for this, but wanted to share in this thread as well.

Having an optional kill switch for this feature might be beneficial for folks like myself who would prefer to opt out so we can stay current with code-server, otherwise!

==> code-server-stderr.log <==


==> code-server-stdout.log <==

[2022-11-29T06:28:43.409Z] info  code-server 4.8.0 005fa87699b4b3c791bd97693400dd016a7ee315
[2022-11-29T06:28:43.411Z] info  Using user-data-dir ~/.local/share/code-server
[2022-11-29T06:28:43.435Z] info  Using config file ~/.config/code-server/config.yaml
[2022-11-29T06:28:43.436Z] info  HTTP server listening on http://127.0.0.1:43773/ 
[2022-11-29T06:28:43.436Z] info    - Authentication is disabled 
[2022-11-29T06:28:43.436Z] info    - Not serving HTTPS 
[06:28:44] Extension host agent started.
[06:28:46] [127.0.0.1][a1361db6][ManagementConnection] New connection established.
[06:28:47] [127.0.0.1][b3b52f2c][ExtensionHostConnection] New connection established.
[06:28:47] [127.0.0.1][b3b52f2c][ExtensionHostConnection] <78> Launched Extension Host Process.
[06:28:57] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.

==> code-server-stderr.log <==
[06:28:58] Error: read ECONNRESET
    at TCP.onStreamRead (node:internal/stream_base_commons:217:20) {
  errno: -104,
  code: 'ECONNRESET',
  syscall: 'read'
}

==> code-server-stdout.log <==
[06:28:58] [127.0.0.1][a1361db6][ManagementConnection] The client has disconnected, will wait for reconnection 3h before disposing...
[06:28:58] [127.0.0.1][a1361db6][ManagementConnection] Another client has connected, will shorten the wait for reconnection 5m before disposing...
[06:28:58] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.

==> code-server-stderr.log <==
[06:28:58] Error: read ECONNRESET
    at TCP.onStreamRead (node:internal/stream_base_commons:217:20) {
  errno: -104,
  code: 'ECONNRESET',
  syscall: 'read'
}

==> code-server-stdout.log <==
[06:28:58] [127.0.0.1][a1361db6][ManagementConnection] The client has disconnected, will wait for reconnection 3h before disposing...
[06:28:59] [127.0.0.1][a1361db6][ManagementConnection] Another client has connected, will shorten the wait for reconnection 5m before disposing...
[06:28:59] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:28:59] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:00] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.

==> code-server-stderr.log <==
[06:29:01] Error: read ECONNRESET
    at TCP.onStreamRead (node:internal/stream_base_commons:217:20) {
  errno: -104,
  code: 'ECONNRESET',
  syscall: 'read'
}

==> code-server-stdout.log <==
[06:29:01] [127.0.0.1][a1361db6][ManagementConnection] The client has disconnected, will wait for reconnection 3h before disposing...
[06:29:01] [127.0.0.1][a1361db6][ManagementConnection] Another client has connected, will shorten the wait for reconnection 5m before disposing...
[06:29:01] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:02] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:03] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:04] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:05] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:06] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:07] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:08] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:09] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:10] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:11] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:12] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.

==> code-server-stderr.log <==
[06:29:13] Error: read ECONNRESET
    at TCP.onStreamRead (node:internal/stream_base_commons:217:20) {
  errno: -104,
  code: 'ECONNRESET',
  syscall: 'read'
}

==> code-server-stdout.log <==
[06:29:13] [127.0.0.1][a1361db6][ManagementConnection] The client has disconnected, will wait for reconnection 3h before disposing...
[06:29:14] [127.0.0.1][a1361db6][ManagementConnection] Another client has connected, will shorten the wait for reconnection 5m before disposing...
[06:29:14] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:15] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:16] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:17] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:18] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:19] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.
[06:29:20] [127.0.0.1][a1361db6][ManagementConnection] The client has reconnected.```

jsjoeio · 2022-11-30T17:39:09Z

Having an optional kill switch for this feature might be beneficial for folks like myself who would prefer to opt out so we can stay current with code-server, otherwise!

I didn't consider that when I merged this - great point! I'll keep an eye out for that issue.

jsjoeio changed the title ~~jsjoeio/tunnel~~ feat: enable forwarded ports using built-in proxy Oct 19, 2022

jsjoeio self-assigned this Oct 19, 2022

jsjoeio added 4 commits October 20, 2022 11:01

feat: enable ports panel in proxy-uri patch

1b5d431

This makes the forwarded ports panel enabled by default.

feat: add tunnelProvider in proxy-uri patch

de5a47a

This adds a `tunnelProvider` along with a `tunnelFactory` so that ports are forwarded and use code-server's built-in proxy.

fixup!: update import

231eb89

fix: skip uri modification if authority host match

b98bebb

This adds a check in our `resolveExternalUri` patch to skip modifying if the `authority` and the `location.host` match to prevent `localhost:<port>/proxy/<port>` from being modified.

jsjoeio force-pushed the jsjoeio/tunnel branch from 433ff31 to b98bebb Compare October 20, 2022 18:04

fixup!: refresh patch

f134aaa

jsjoeio marked this pull request as ready for review October 20, 2022 18:17

jsjoeio requested a review from a team as a code owner October 20, 2022 18:17

jsjoeio temporarily deployed to npm October 20, 2022 18:29 Inactive

jsjoeio temporarily deployed to npm October 20, 2022 18:50 Inactive

jsjoeio commented Oct 20, 2022

View reviewed changes

patches/proxy-uri.diff Show resolved Hide resolved

patches/proxy-uri.diff Outdated Show resolved Hide resolved

patches/proxy-uri.diff Show resolved Hide resolved

code-asher reviewed Oct 21, 2022

View reviewed changes

patches/proxy-uri.diff Outdated Show resolved Hide resolved

patches/proxy-uri.diff Outdated Show resolved Hide resolved

jsjoeio added 2 commits October 21, 2022 10:14

fixup!: move authority check up

5207d37

fixup!: remove comment

cbd59a8

jsjoeio requested a review from code-asher October 21, 2022 17:16

jsjoeio temporarily deployed to npm October 21, 2022 17:25 Inactive

code-asher approved these changes Oct 21, 2022

View reviewed changes

fixup!: add trailing slash

e4113f4

jsjoeio enabled auto-merge (squash) October 21, 2022 21:48

fixup!: refresh

0b95898

jsjoeio temporarily deployed to npm October 21, 2022 23:36 Inactive

jsjoeio temporarily deployed to npm October 24, 2022 17:34 Inactive

Merge branch 'main' into jsjoeio/tunnel

b249a66

jsjoeio temporarily deployed to npm October 24, 2022 17:47 Inactive

fixup!: add trailing slash in test

b401cbd

jsjoeio temporarily deployed to npm October 24, 2022 18:00 Inactive

jsjoeio merged commit 031e903 into main Oct 24, 2022

jsjoeio deleted the jsjoeio/tunnel branch October 24, 2022 18:11

jsjoeio mentioned this pull request Oct 24, 2022

[Feat]: Leverage "proxy-domain" in the "Ports" panel #5458

Closed

bpmct mentioned this pull request Oct 26, 2022

Auto set VSCODE_PROXY_URI in workspaces to use code-server ports coder/coder#4776

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: enable forwarded ports using built-in proxy #5673

feat: enable forwarded ports using built-in proxy #5673

jsjoeio commented Oct 19, 2022 •

edited

Loading

codecov bot commented Oct 20, 2022 •

edited

Loading

github-actions bot commented Oct 20, 2022 •

edited

Loading

jsjoeio commented Oct 20, 2022

code-asher left a comment •

edited

Loading

jsjoeio commented Oct 21, 2022

bpmct commented Oct 21, 2022

code-asher left a comment

code-asher commented Oct 21, 2022 •

edited

Loading

jsjoeio commented Oct 21, 2022

codecae commented Nov 29, 2022 •

edited

Loading

jsjoeio commented Nov 30, 2022

feat: enable forwarded ports using built-in proxy #5673

feat: enable forwarded ports using built-in proxy #5673

Conversation

jsjoeio commented Oct 19, 2022 • edited Loading

Description

TODOs

Screenshots

codecov bot commented Oct 20, 2022 • edited Loading

Codecov Report

github-actions bot commented Oct 20, 2022 • edited Loading

jsjoeio commented Oct 20, 2022

code-asher left a comment • edited Loading

Choose a reason for hiding this comment

jsjoeio commented Oct 21, 2022

bpmct commented Oct 21, 2022

code-asher left a comment

Choose a reason for hiding this comment

code-asher commented Oct 21, 2022 • edited Loading

jsjoeio commented Oct 21, 2022

codecae commented Nov 29, 2022 • edited Loading

jsjoeio commented Nov 30, 2022

jsjoeio commented Oct 19, 2022 •

edited

Loading

codecov bot commented Oct 20, 2022 •

edited

Loading

github-actions bot commented Oct 20, 2022 •

edited

Loading

code-asher left a comment •

edited

Loading

code-asher commented Oct 21, 2022 •

edited

Loading

codecae commented Nov 29, 2022 •

edited

Loading