fix: wrap socket in proxy before passing to vscode

[jsjoeio]

Summary

This PR fixes a regression introduced in 4.0.1. Previously in 3.12.0, using the --cert flag allowed you to use code-server locally over HTTPS. The regression broke that functionality causing the ExtensionHost to repeatedly reconnect and fail. We fixed this by wrapping the socket in our SocketProxyProvider before passing back to VS Code. This is because TLSSockets cannot be passed to child processes.

Changes

• modify e2e tests to accept args
• add new e2e test to extension.test.ts with --cert flag
• use req.ws instead of req.socket
• wrap req.ws in SocketProxyProvider and pass in handleUpgrade

Context

We didn't have a test for this feature so the regression was introduced in 4.0.1. We've now added a new e2e test which uses the --cert flag and attempts to use an extension. This will only work if the ExtensionHost is working properly. Therefore, this will prevent new regressions.

After adding the new e2e test, we tested it against the 3.12.0 build and it worked as expected:

extension-proof.mp4

Here is that same test passing against code-server using a local dev build with the regression fixed:

4.0.2-proof.mp4

We also took extensive notes and whiteboarded the flow here to help us arrive at the solution.

Fixes #4693

[github-actions]

✨ Coder.com for PR #4840 deployed! It will be updated on every commit.

• Host: https://codercom-3wmukifre-codercom.vercel.app/docs/code-server
• Last deploy status: success
• Commit: 6049dd3
• Workflow status: https://github.com/coder/code-server/actions/runs/1849469762

[codecov]

Codecov Report

Merging #4840 (6049dd3) into main (b26cce5) will increase coverage by 0.01%.
The diff coverage is 50.00%.

@@            Coverage Diff             @@
##             main    #4840      +/-   ##
==========================================
+ Coverage   69.72%   69.73%   +0.01%     
==========================================
  Files          29       29              
  Lines        1645     1649       +4     
  Branches      363      363              
==========================================
+ Hits         1147     1150       +3     
- Misses        424      425       +1     
  Partials       74       74              

Impacted Files	Coverage Δ
src/node/routes/vscode.ts	80.30% <50.00%> (-0.35%)	⬇️

---

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 b26cce5...6049dd3. Read the comment docs.

[code-asher]

🎉 🎉 🎉

[jsjoeio]

Re-run e2e tests after merging: #4857

[jsjoeio]

// TODO@jsjoeio add note why we do this for testing cert stuff
ignoreHTTPSErrors: true,

Need to add back in

[jsjoeio]

I believe the e2e tests are failing because we need to update VS Code (waiting on another PR)

[ericzhucode]

Hi team,
I have used the latest version of code-server and coder/vscode to build but it seems reconnection issue still exists
(including this fixup commit)
This is what I got in dev tools

May I know what's the situation on your side and does this matter?(since it's only info level but not error or warning)
Thank you!

[jsjoeio]

@ericzhucode what is the output when you run code-server --version?

[ericzhucode]

@ericzhucode what is the output when you run code-server --version?

Sorry I forgot to update this comment. After cherry-pick this commit and build code server again, it's working perfectly now and no disconnection occurred.
Thank you for your effort!

[jsjoeio]

@ericzhucode hooray!!! Really happy it's working. Thank you for confirming! 🎉