Add gp timeout show command

[andrew-farries]

Description

Add a gp timeout show command to the gp CLI to go along with the recently added gp timeout extend command (see #10619).

• Need to hold until PR [server] Return raw duration from getWorkspaceTimeout #10896 deployed
• Maybe want to follow up @filiptronicek 's suggestion Add gp timeout show command #10782 (comment)

Related Issue(s)

How to test

1. Create a workspace in preview environment
2. Run gp timeout show
3. Output should be (value depends on user's plan):

60m

4. Extend the workspace timeout with gp timeout extend.
5. Rerun gp timeout show. Output should be:

180m

6. Open another workspace, and extend its timeout gp timeout extend
7. Back to first one, gp timeout show should back to original one

Release Notes

Add command `gp timeout show` to show the timeout of current workspace

Documentation

We'll need to add something to https://github.com/gitpod-io/website/pull/2218 either before or after it's merged.

Werft options:

• /werft with-preview

[akosyakov]

@andrew-farries Don't forget about docs update. At least file an issue.

[andrew-farries]

@mustard-mh Should we add the docs for this to your existing docs PR (https://github.com/gitpod-io/website/pull/2218) or would you rather I create a new one?

[mustard-mh]

@mustard-mh Should we add the docs for this to your existing docs PR (https://github.com/gitpod-io/website/pull/2218) or would you rather I create a new one?

@andrew-farries You can do it after previous one https://github.com/gitpod-io/website/pull/2218 merged, I can ping you after that

[mustard-mh]

I tested with it. As we can see in image below,

default value is long
after extend 180m
extend another workspace, this workspace will reset to default long

If we can't format every output time to 180m, maybe we can turn 180m to extended?

PS. As a user I prefer 180m formated duration🙂

If we will keep it, it's good for me too, but we should explain more in doc

gitpod/components/gitpod-protocol/src/gitpod-service.ts

Lines 340 to 349 in 7bf63df

	export const WORKSPACE_TIMEOUT_DEFAULT_SHORT = "short";
	export const WORKSPACE_TIMEOUT_DEFAULT_LONG = "long";
	export const WORKSPACE_TIMEOUT_EXTENDED = "extended";
	export const WORKSPACE_TIMEOUT_EXTENDED_ALT = "180m"; // for backwards compatibility since the IDE uses this
	export const WorkspaceTimeoutValues = [
	WORKSPACE_TIMEOUT_DEFAULT_SHORT,
	WORKSPACE_TIMEOUT_DEFAULT_LONG,
	WORKSPACE_TIMEOUT_EXTENDED,
	WORKSPACE_TIMEOUT_EXTENDED_ALT,
	] as const;

[mustard-mh]

#10782 (review) What do you think/prefer? @loujaybee

[mustard-mh]

If we want to turn all output into 180m formatted, maybe we need a map/func in protocol, since we have multiple similar code like this below. Or just hard code here too

gitpod/components/server/src/user/user-service.ts

Lines 173 to 183 in 402894b

	public workspaceTimeoutToDuration(timeout: WorkspaceTimeoutDuration): string {
	switch (timeout) {
	case WORKSPACE_TIMEOUT_DEFAULT_SHORT:
	return "30m";
	case WORKSPACE_TIMEOUT_DEFAULT_LONG:
	return "60m";
	case WORKSPACE_TIMEOUT_EXTENDED:
	case WORKSPACE_TIMEOUT_EXTENDED_ALT:
	return "180m";
	}
	}

gitpod/components/server/src/user/user-service.ts

Lines 185 to 196 in 402894b

	public durationToWorkspaceTimeout(duration: string): WorkspaceTimeoutDuration {
	switch (duration) {
	case "30m":
	return WORKSPACE_TIMEOUT_DEFAULT_SHORT;
	case "60m":
	return WORKSPACE_TIMEOUT_DEFAULT_LONG;
	case "180m":
	return WORKSPACE_TIMEOUT_EXTENDED_ALT;
	default:
	return WORKSPACE_TIMEOUT_DEFAULT_SHORT;
	}
	}

[mustard-mh]

Notice that if we need changes from server, this PR will be approved before next WebApp deploy, or it will block IDE deployment 🙏

[andrew-farries]

We can get the raw time duration from server, without conversion to short or extended. This behaves as expected:

gitpod /workspace/dotfiles (main) $ gp timeout show
60m
gitpod /workspace/dotfiles (main) $ gp timeout extend
gitpod /workspace/dotfiles (main) $ gp timeout show
180m

[filiptronicek]

Thanks a lot @andrew-farries for the new command 🧡! I tested it and ti works as advertised.

Maybe we could add to the minutes just a "status" which would indicate whether the timeout is the default one or the extended one? Something like

$ gp timeout show
60m (Default)
$ gp timeout extend
$ gp timeout show
180m (Extended)

[mustard-mh]

Thanks a lot @andrew-farries for the new command 🧡! I tested it and ti works as advertised.

Maybe we could add to the minutes just a "status" which would indicate whether the timeout is the default one or the extended one? Something like

$ gp timeout show
60m (Default)
$ gp timeout extend
$ gp timeout show
180m (Extended)

@filiptronicek Remember that 60m is not default for all users, value of default is depend on Plan of user/team.

cc @andrew-farries

Image

[andrew-farries]

Remember that 60m is not default for all users, value of default is depend on Plan of user/team.

I suggest we leave the output as is for now, ie without (Default) or (Extended).

[andrew-farries]

/hold

[filiptronicek]

Remember that 60m is not default for all users, value of default is depend on Plan of user/team.

@mustard-mh I agree, thanks for bringing this up. I wanted to say, that as a user, I would personally like to check gp timeout show just to see how many minutes my timeout is and whether I have successfully for example extended it for this repo. For checking the subscription, there could be something like gp billing (not sure if suggested before).

I suggest we leave the output as is for now, ie without (Default) or (Extended).

@andrew-farries I see where you're coming from, it could perhaps be in some way programmatically consumed afterwards as well, but I would prefer to see a bit more context about my timeout, if we have it available. We could also ship it as is and afterwards provide a flag or similar to provide such information.

[mustard-mh]

If a user cannot extend timeout, output will be like this @filiptronicek

Only Unleashed plan can extend timeout 🙈

Image

[mustard-mh]

Tested and code LGTM

/hold

• ‼️ Need to deploy WebApp first, so this PR should unhold before next WebApp deploy
• Maybe want to follow up @filiptronicek 's suggestion Add gp timeout show command #10782 (comment)

I'll add them to PR description too

[mustard-mh]

@mustard-mh Should we add the docs for this to your existing docs PR (gitpod-io/website#2218) or would you rather I create a new one?

@andrew-farries You can do it after previous one gitpod-io/website#2218 merged, I can ping you after that

@andrew-farries Previous doc PR has been merged, you can start it or ask @filiptronicek to help with it 👍

[andrew-farries]

Docs PR is here: https://github.com/gitpod-io/website/pull/2292

[mustard-mh]

Thank you @andrew-farries , could you split this PR into two PRs, to unblock deployment? server will approve first, and then gp-cli.

See more context in internal chat

[andrew-farries]

could you split this PR into two PRs, to unblock deployment? server will approve first, and then gp-cli.

I've done this. This PR now contains just the gp change and #10896 has the server change.

[geropl]

Thx, works as expected! 👍

nit: I think the long in the beginning might be a hint towards a conversion bug in server. But as it's a display issue only: 👍

[jeanp413]

Some feedback, not really important, but I would expect some more user friendly output other than just a number, same with extend a message telling me what was the side effect of running this command

[mustard-mh]

Thank you, LGTM

[mustard-mh]

/unhold

Some feedback, not really important, but I would expect some more user friendly output other than just a number, same with extend a message telling me what was the side effect of running this command

I see where you're coming from, it could perhaps be in some way programmatically consumed afterwards as well, but I would prefer to see a bit more context about my timeout, if we have it available. We could also ship it as is and afterwards provide a flag or similar to provide such information.

You can do it in another PR if you want, to print more friendly 🙂 cc @jeanp413 @filiptronicek

i.e. extend success don't print anything🙈, we can show current ws timeout