Add xterm as an IDE

[filiptronicek]

Description

Adds Xterm.js as a web alternative to connecting to your workspace via SSH from your terminal. The code can be found at https://github.com/gitpod-io/xterm-web-ide and the Docker image is at ide/xterm-web.

Warning: this PR was not actually merged. The corrected version is #17005

How to test

1. Open the preview environment
2. In the preferences, select notice there is no Xterm IDE
3. In Configcat, include yourself in the enable-rule for experimentalIdes (non-prod)
4. Wait a couple of minutes (🫖 time)
5. Reload and see the Terminal IDE magically appear
6. Create a workspace and have a blast

Useful commands

Re-pull the IDE:

kubectl rollout restart deployment/ide-service

Current limitations

• Does not work on mobile [fixed]

  iPad demo

  RPReplay_Final1679590301.mp4

Release Notes

NONE

⬆️ we can mention it after we finish the internal dog food

Documentation

Todo

• gp stop closes xterm.js editor and shows the "Workspace Stopping" screen
• gp open works
• gp preview works
• Ensure heartbreating works
• Move Docker image from DockerHub to our GCP registry

Nice-to-haves

• Local echo [source]

Werft options:

• /werft with-preview
• /werft with-large-vm
• /werft with-gce-vm

[codecov]

Codecov Report

Merging #8464 (115b6ce) into main (ebf351e) will decrease coverage by 4.16%.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             main   #8464      +/-   ##
=========================================
- Coverage   12.31%   8.15%   -4.17%     
=========================================
  Files          20      31      +11     
  Lines        1161    2183    +1022     
=========================================
+ Hits          143     178      +35     
- Misses       1014    2002     +988     
+ Partials        4       3       -1     

Flag	Coverage Δ
components-gitpod-cli-app	11.17% <ø> (ø)
components-local-app-app-darwin-amd64	?
components-local-app-app-darwin-arm64	?
components-local-app-app-linux-amd64	?
components-local-app-app-linux-arm64	?
components-local-app-app-windows-386	?
components-local-app-app-windows-amd64	?
components-local-app-app-windows-arm64	?
installer-raw-app	5.63% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
components/local-app/pkg/auth/pkce.go
components/local-app/pkg/auth/auth.go
installer/pkg/components/ws-manager/tlssecret.go	0.00% <0.00%> (ø)
installer/pkg/components/ws-manager/configmap.go	30.05% <0.00%> (ø)
installer/pkg/components/ws-manager/role.go	0.00% <0.00%> (ø)
installer/pkg/common/objects.go	0.00% <0.00%> (ø)
...staller/pkg/components/ws-manager/networkpolicy.go	0.00% <0.00%> (ø)
installer/pkg/common/display.go	0.00% <0.00%> (ø)
...components/ws-manager/unpriviledged-rolebinding.go	0.00% <0.00%> (ø)
installer/pkg/common/storage.go	0.00% <0.00%> (ø)
... and 5 more

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

[akosyakov]

What we are going to do about it?

[felladrin]

I'd love to see it in production. I vote for continuing it, even if it's just developed sporadically.

[stale]

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[werft-gitpod-dev-com]

started the job as gitpod-build-ft-add-xterm-ide.5 because the annotations in the pull request description changed
(with .werft/ from main)

[felladrin]

Impressed with how well it's working! 🎉

I haven't faced any hotkey conflict between the apps and the browser.

[felladrin]

Reminder: Running "gp stop" should lead the user to the "Stopping Workspace" page.

[filiptronicek]

Reminder: Running "gp stop" should lead the user to the "Stopping Workspace" page.

Thanks for noting this, @felladrin! I tried this and it worked for the most part, but there were indeed occurrences where I got an error message which blocked the navigation. Now it should not block the main thread (we switched over from alert() to <dialog>) and just work.

[felladrin]

ℹ️ Something interesting I saw yesterday: https://github.com/cloudcmd/gritty
Leaving it here as it matches what's being done in this PR. An alternative, if needed.

[filiptronicek]

ℹ️ Something interesting I saw yesterday: cloudcmd/gritty

Looks interesting, @felladrin! I think that would be useful for some smaller things, but it seems like implementing stuff like custom link matching wouldn't be possible like this 🤔

[filiptronicek]

Ok one issue that I would love input for:

This looks good

This looks very bad

[felladrin]

Can we add a background ourselves?
Similar to the background on JetBrains IDEs logos.
Something like this, to make it fit both light and dark modes:

---

Adding here, for the record, how it currently looks like on dark mode:

---

Btw, the preview environment is working again!

[felladrin]

Something to add to the docs later: The browser's accessibility functionality of pressing the ESC key to un-focus input fields won't allow sending the keystroke to the terminal. So, for escaping the input mode in terminal apps like VIM, please use ctrl+c.

[stale]

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[mads-hartmann]

The SID-related changes LGTM

[filiptronicek]

/gh run recreate-vm

Comment triggered a workflow run

Started workflow run: 4502888822

• recreate_vm: true

[filiptronicek]

Alright... didn't expect roboquat to merge this automatically... let's make another PR. Sorry folks

[vulkoingim]

Alright... didn't expect roboquat to merge this automatically... let's make another PR. Sorry folks

When you change the base branch for the PR from main the requirements to merge are no longer the same :) If there's an approval (regardless from whom) it gets merged.