[supervisor] improve ssh connected behaviors #10736

mustard-mh · 2022-06-17T16:33:25Z

Description

When we connect to a workspace via SSH, the default folder is ~, this PR change the default directory to $GITPOD_REPO_ROOT, so that user can reach their code folder after conn succeed

After ssh connected, it'll print environment vars in terminal, this PR will remove the log behavior.

After ssh connected, we will print a graceful welcome message for users to tell them useful commands

Related Issue(s)

Fixes #9377

How to test

See if print message as expected after ssh connected

Test if it works

Start a workspace
Connect via SSH copy-paste to see if default folder is correct

Test if not change original behavior

After tests above
Open a terminal in browser vscode
cd into any folder
Click Split button (or command+\ on MacOS)
See if the new split terminal goes with same pwd with previous terminal

Release Notes

Change the default directory of ssh connections
Remove env print after connect via ssh
Add graceful welcome message for users after ssh connected

Documentation

Werft options:

/werft with-preview

mustard-mh · 2022-06-20T03:58:26Z

components/supervisor/pkg/supervisor/supervisor.go

+	msg := []byte(`
+
+
+Welcome to Gitpod - Always ready to code. You use commands below to be more productive.


Any suggestions for this message 🙏? @loujaybee

mustard-mh · 2022-06-20T05:51:42Z

components/supervisor/pkg/supervisor/supervisor.go

+}
+
+func configureSSHMessageOfTheDay() {
+	msg := []byte(`Welcome to Gitpod - Always ready to code. You can use commands below to be more productive.


I can't find a proper char to scroll terminal content to next page without clear history, (tried chars in this page on my computer)

components/supervisor/pkg/supervisor/supervisor.go

akosyakov · 2022-06-20T06:00:42Z

components/supervisor/pkg/supervisor/supervisor.go

+}
+
+func configureSSHMessageOfTheDay() {
+	msg := []byte(`Welcome to Gitpod - Always ready to code. You can use commands below to be more productive.


@loujaybee Please review text. 🙏

iQQBot · 2022-06-20T06:01:33Z

look into now

mustard-mh · 2022-06-20T07:27:54Z

components/supervisor/pkg/supervisor/ssh.go

+		log.Error("cannot configure ssh default dir with empty repo root")
+		return
+	}
+	file, err := os.OpenFile("/home/gitpod/.bashrc", os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0o644)


~/.ssh/rc with -oPermitUserRC not works, don't know why, so we choose .bashrc to do it

loujaybee · 2022-06-20T12:49:47Z

components/supervisor/pkg/supervisor/ssh.go

+}
+
+func configureSSHMessageOfTheDay() {
+	msg := []byte(`Welcome to Gitpod - Always ready to code. You can use commands below to be more productive.


Suggested change

msg := []byte(`Welcome to Gitpod - Always ready to code. You can use commands below to be more productive.

msg := []byte(`Welcome to Gitpod: Always ready to code. Try the following commands to get started:

loujaybee · 2022-06-20T12:50:03Z

components/supervisor/pkg/supervisor/ssh.go

+	msg := []byte(`Welcome to Gitpod - Always ready to code. You can use commands below to be more productive.
+
+	gp tasks list         List all your defined tasks in .gitpod.yml
+	gp tasks attach       Attach to a workspace task


Suggested change

gp tasks attach Attach to a workspace task

gp tasks attach Attach your terminal to a workspace task

components/supervisor/pkg/supervisor/ssh.go

loujaybee · 2022-06-20T13:00:40Z

Thanks for fixing this one @mustard-mh ! :) This should help a few of our Vim users out 😝

iQQBot

code LGTM, This is indeed an obvious change for the user, who won't see a bunch of weird env output anymore

/hold
in case you want to change welcome text

iQQBot · 2022-06-21T09:48:07Z

/werft run

👍 started the job as gitpod-build-hw-ssh-dir.9
(with .werft/ from main)

werft-gitpod-dev-com · 2022-06-21T09:53:53Z

started the job as gitpod-build-hw-ssh-dir.10 because the annotations in the pull request description changed
(with .werft/ from main)

iQQBot · 2022-06-21T10:32:52Z

feel free to unhold

mustard-mh · 2022-06-21T10:36:36Z

/unhold

roboquat added release-note do-not-merge/work-in-progress size/S labels Jun 17, 2022

mustard-mh changed the title ~~[supervisor] change default directory of ssh~~ [supervisor] improve ssh connected behaviors Jun 17, 2022

mustard-mh force-pushed the hw/ssh-dir branch from 6f0bf62 to 1fda547 Compare June 17, 2022 18:07

roboquat added size/M and removed size/S labels Jun 17, 2022

mustard-mh force-pushed the hw/ssh-dir branch 2 times, most recently from 66ccb42 to 2b3f40f Compare June 17, 2022 18:32

mustard-mh commented Jun 20, 2022

View reviewed changes

mustard-mh marked this pull request as ready for review June 20, 2022 03:59

mustard-mh requested a review from a team June 20, 2022 03:59

roboquat removed the do-not-merge/work-in-progress label Jun 20, 2022

github-actions bot added the team: IDE label Jun 20, 2022

mustard-mh force-pushed the hw/ssh-dir branch from 2b3f40f to a2f3419 Compare June 20, 2022 04:11

mustard-mh commented Jun 20, 2022

View reviewed changes

akosyakov reviewed Jun 20, 2022

View reviewed changes

components/supervisor/pkg/supervisor/supervisor.go Outdated Show resolved Hide resolved

akosyakov requested a review from iQQBot June 20, 2022 05:59

akosyakov reviewed Jun 20, 2022

View reviewed changes

mustard-mh force-pushed the hw/ssh-dir branch from a2f3419 to a42b660 Compare June 20, 2022 06:32

[supervisor] remove sshd debug mode

916fe52

mustard-mh force-pushed the hw/ssh-dir branch 2 times, most recently from 9fbb0d1 to 16ee2b4 Compare June 20, 2022 07:25

[supervisor] change default directory of ssh

30d4249

mustard-mh force-pushed the hw/ssh-dir branch from 16ee2b4 to a0003d0 Compare June 20, 2022 07:26

mustard-mh commented Jun 20, 2022

View reviewed changes

loujaybee reviewed Jun 20, 2022

View reviewed changes

components/supervisor/pkg/supervisor/ssh.go Outdated Show resolved Hide resolved

loujaybee reviewed Jun 20, 2022

View reviewed changes

components/supervisor/pkg/supervisor/ssh.go Outdated Show resolved Hide resolved

loujaybee reviewed Jun 20, 2022

View reviewed changes

components/supervisor/pkg/supervisor/ssh.go Show resolved Hide resolved

iQQBot approved these changes Jun 21, 2022

View reviewed changes

roboquat added the do-not-merge/hold label Jun 21, 2022

[supervisor] welcome message for ssh conn

2c423a3

mustard-mh force-pushed the hw/ssh-dir branch from a0003d0 to 2c423a3 Compare June 21, 2022 10:18

roboquat removed the do-not-merge/hold label Jun 21, 2022

roboquat merged commit 47a0941 into main Jun 21, 2022

roboquat deleted the hw/ssh-dir branch June 21, 2022 10:37

roboquat added deployed: IDE IDE change is running in production deployed Change is completely running in production labels Jun 22, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[supervisor] improve ssh connected behaviors #10736

[supervisor] improve ssh connected behaviors #10736

mustard-mh commented Jun 17, 2022 •

edited by iQQBot

mustard-mh Jun 20, 2022

mustard-mh Jun 20, 2022

akosyakov Jun 20, 2022

iQQBot commented Jun 20, 2022

mustard-mh Jun 20, 2022

loujaybee Jun 20, 2022

loujaybee Jun 20, 2022

loujaybee commented Jun 20, 2022 •

edited

iQQBot left a comment

iQQBot commented Jun 21, 2022 •

edited by werft-gitpod-dev-com bot

werft-gitpod-dev-com bot commented Jun 21, 2022

iQQBot commented Jun 21, 2022

mustard-mh commented Jun 21, 2022

		msg := []byte(`


		Welcome to Gitpod - Always ready to code. You use commands below to be more productive.

	msg := []byte(`Welcome to Gitpod - Always ready to code. You can use commands below to be more productive.
	msg := []byte(`Welcome to Gitpod: Always ready to code. Try the following commands to get started:

	gp tasks attach Attach to a workspace task
	gp tasks attach Attach your terminal to a workspace task

[supervisor] improve ssh connected behaviors #10736

[supervisor] improve ssh connected behaviors #10736

Conversation

mustard-mh commented Jun 17, 2022 • edited by iQQBot

Description

Related Issue(s)

How to test

Release Notes

Documentation

Werft options:

mustard-mh Jun 20, 2022

Choose a reason for hiding this comment

mustard-mh Jun 20, 2022

Choose a reason for hiding this comment

akosyakov Jun 20, 2022

Choose a reason for hiding this comment

iQQBot commented Jun 20, 2022

mustard-mh Jun 20, 2022

Choose a reason for hiding this comment

loujaybee Jun 20, 2022

Choose a reason for hiding this comment

loujaybee Jun 20, 2022

Choose a reason for hiding this comment

loujaybee commented Jun 20, 2022 • edited

iQQBot left a comment

Choose a reason for hiding this comment

iQQBot commented Jun 21, 2022 • edited by werft-gitpod-dev-com bot

werft-gitpod-dev-com bot commented Jun 21, 2022

iQQBot commented Jun 21, 2022

mustard-mh commented Jun 21, 2022

mustard-mh commented Jun 17, 2022 •

edited by iQQBot

loujaybee commented Jun 20, 2022 •

edited

iQQBot commented Jun 21, 2022 •

edited by werft-gitpod-dev-com bot