[dashboard, server] Add global custom timeout preference #16503

iQQBot · 2023-02-22T07:27:51Z

Description

[dashboard, server] Add global custom timeout preference

Related Issue(s)

How to test

try enabling billing with your account, otherwise custom workspace timeout will disabled.
setting custom timeout in preference
start a workspace, use kubectl describe pod ws-{instanceID} to check your workspace timeout and closed timeout.

annotations `gitpod/customTimeout` is your workspace timeout.

Release Notes

[dashboard, server] Add global custom timeout preference

Documentation

Build Options:

/werft with-github-actions
Experimental feature to run the build with GitHub Actions (and not in Werft).
leeway-no-cache
leeway-target=components:all
/werft no-test
Run Leeway with --dont-test

Publish Options

/werft publish-to-npm
/werft publish-to-jb-marketplace

Installer Options

with-ee-license
with-slow-database
with-dedicated-emulation
with-ws-manager-mk2
workspace-feature-flags
Add desired feature flags to the end of the line above, space separated

Preview Environment Options:

/werft with-local-preview
If enabled this will build install/preview
/werft with-preview
/werft with-large-vm
/werft with-gce-vm
If enabled this will create the environment on GCE infra
/werft with-integration-tests=all
Valid options are all, workspace, webapp, ide, jetbrains, vscode, ssh

werft-gitpod-dev-com · 2023-02-22T07:27:59Z

started the job as gitpod-build-pd-timeout-16089.6 because the annotations in the pull request description changed
(with .werft/ from main)

iQQBot · 2023-02-22T14:35:34Z

@loujaybee Could you help me think of some documents or desc in preference?

iQQBot · 2023-02-22T14:35:41Z

@gtsiolis Could you help review the design here?

should we add a new menu? i.e. not under Preference

iQQBot · 2023-02-22T14:40:16Z

Something need discuss

Currently, we only allow paid users to customize workspace timeout, should we hide these settings when the user don't have any paid plan?
Or we remove all limits, and let all user can customize.
Should we introduce a new API for these workspace timeout settings? i.e. the value should be valid, and need make sure user have permission to set.

cc @svenefftinge

gtsiolis · 2023-02-23T14:26:47Z

Looking at this now! 👀

gtsiolis

Thanks for adding this, @iQQBot! 🔮

Added below some UX comments based on the following design.

To also answer your question about adding a menu in #16503 (comment), I don't think this needs a separate menu in user settings for now. ✔️

Inactivity Timeout

Approving to unblock merging, but holding in case someone from the @gitpod-io/engineering-webapp needs to take a closer look at the code changes. 🏓

/hold

components/dashboard/src/user-settings/Preferences.tsx

gtsiolis · 2023-02-23T16:20:55Z

components/dashboard/src/user-settings/Preferences.tsx

+                    <CheckBox
+                        title="Disabled Close Timeout"
+                        desc={<span></span>}
+                        checked={disabledClosedTimeout}
+                        onChange={(e) => actuallySetDisabledClosedTimeout(e.target.checked)}
+                    />


question: What does this do? It seems to not work. Do we need it?

what do you mean not work?

This feature is used to disable the default close timeout, which means you will no longer have the five minute fast timeout limit when closing your browser or disconnecting from ssh

Ah, it seems to work now. I could not toggle the checkbox when I tried earlier. 🤷

Still, what does this checkbox do? Do we need it?

explain in the previous message, is it make sense?

Thanks @iQQBot! Just highlighting some copy changes from the suggestion above to simplify and improve readability. What do you think?

BEFORE AFTER

💡 tip: Also, using font-semibold instead of bold can improve the rendering here.

❗ issue: This is also missing some validation states where a user enters a blank value or an invalid value but relying on the browser alert sounds ok for this iteration. Could you open a follow-up issue for doing proper form validation in this case?

This 5m close timeout only for gitpod.io. Other installation may have different value, and it set in workspace cluster, so server actually don't know it

And this 30m default inactive timeout is depend user plan, e.g. free user got 30m, paid user got 60m....

So if we want display default value and valid value in server side, we may need some new api for it

Just highlighting some copy changes from the suggestion above to simplify and improve readability. What do you think?

I'm not a fan of the "keep workspace running" copy. It feels very ambiguous.

Could we go with:

"Close workspaces on editor disconnect (5 minutes)" (default = selected)

Or similar?

This 5m close timeout only for gitpod.io. Other installation may have different value, and it set in workspace cluster, so server actually don't know it

In Dedicated, this type of policy would likely be controlled through the organisation settings. Can we not safely assume 5 minutes for now as the general default until we have also this configuration at the admin/organisation level? Dedicated will have very little infra level variance, unless exposed through the product.

Epic: Admin control over workspace timeouts #16090

The workspace inactivity timeout copy + behaviour looks good, the editor timeout needs some refinement. I have created an internal RFC to resolve some questions about the naming of the editor timeout copy text and naming. My intention is to get feedback and close that decision in the next 24 hours to unblock this PR.

However, given this PR is solving two distinct product issues:

Introduce global user timeout default #16200

Move the "close timeout" (IDE + editor timeout) to a user preference. #16089

If we are keen to merge it, we should consider either commenting out/disabling the editor timeout part of this PR + raising a separate PR for the editor timeout, whilst we resolve naming + copy decisions. Or wait until that decision and merge both at once.

iQQBot · 2023-02-23T16:32:58Z

Big thanks for @gtsiolis

components/server/ee/src/billing/entitlement-service.ts

components/gitpod-protocol/src/protocol.ts

geropl · 2023-02-24T15:54:30Z

@iQQBot Left a few comments above. Also, the preview env is not working atm 😢

iQQBot · 2023-02-24T16:55:38Z

@geropl Thanks for your review, I already addressed your feedback, and the preview env is works now, you can have a try.

components/dashboard/src/user-settings/Preferences.tsx

loujaybee

Thanks for adapting this @iQQBot ! 🙏 - Would be good if we could leave a message for the disabled setting, and/or simplify the placeholder message. However, both of these could be done in a follow up PR, I'd be happy to ship this as it currently is.

loujaybee · 2023-03-01T16:18:18Z

Could someone from https://github.com/orgs/gitpod-io/teams/engineering-webapp review it? 🙏

Added @gitpod-io/engineering-webapp as a reviewer, but a re-review from @geropl or @easyCZ (as they already have context would also be good!) 🙏

gtsiolis · 2023-03-01T16:51:05Z

Looking at this (again) now! 👀

components/dashboard/src/user-settings/Preferences.tsx

geropl · 2023-03-02T16:09:36Z

components/server/src/workspace/gitpod-server-impl.ts

@@ -494,6 +499,33 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
        return user;
    }

+    public async supportConfigureWorkspaceTimeout(ctx: TraceContext): Promise<boolean> {


The support puts me off a bit: We don't use that word, yet, anywhere. So using it here means adding uncertainty. What about sticking to can or may instead? 🤔

Also, we happen to make (nearly) exactly the same method over here. Maybe it's worth re-using/combining the two? 🤷

the method signature is not same, and it is only in enterprise

the method signature is not same

The signature is effectively identical: If we make maySetTimeout public, it's basically maySetWorkspaceTimeout(ctx: TraceContext), where we get the user on the first or second line.

Anyway, want to push more for the name. 🤗

and it is only in enterprise

I agree that's super confusing, and we should change that very soon: it' the code we use for all distribution modes: there is 0️⃣ difference, we ship that "ee" code to everyone.

9b7d2b5

I made some changes, could you check this commit?

components/server/src/workspace/gitpod-server-impl.ts

geropl · 2023-03-02T16:20:03Z

Two immediate questions when I see this:

What's the current value?
What's the default value?

geropl · 2023-03-02T16:21:45Z

I can't test in the preview env:

How to proceed @iQQBot ? Have you or somebody else tested the current version?

iQQBot · 2023-03-02T16:23:06Z

Could you try again?

components/dashboard/src/user-settings/Preferences.tsx

geropl · 2023-03-03T08:14:35Z

components/server/src/workspace/gitpod-server-impl.ts

@@ -494,6 +499,33 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
        return user;
    }

+    public async maySetTimeout(ctx: TraceContext): Promise<boolean> {


🧡 Thanks @iQQBot !

geropl

Code LGTM, but cannot test due to (unrelated) preview problems 👍

iQQBot · 2023-03-03T08:29:02Z

/unhold

roboquat added release-note-none do-not-merge/work-in-progress labels Feb 22, 2023

roboquat added the size/M label Feb 22, 2023

iQQBot force-pushed the pd/timeout-16089 branch from 314b33a to ebf57a4 Compare February 22, 2023 08:05

iQQBot marked this pull request as ready for review February 22, 2023 14:40

iQQBot requested a review from a team February 22, 2023 14:40

iQQBot requested a review from gtsiolis as a code owner February 22, 2023 14:40

roboquat removed the do-not-merge/work-in-progress label Feb 22, 2023

github-actions bot added the team: webapp Issue belongs to the WebApp team label Feb 22, 2023

roboquat added release-note and removed release-note-none labels Feb 22, 2023

gtsiolis approved these changes Feb 23, 2023

View reviewed changes

roboquat added the do-not-merge/hold label Feb 23, 2023

filiptronicek added component: dashboard component: server labels Feb 23, 2023

iQQBot force-pushed the pd/timeout-16089 branch 2 times, most recently from 5737f15 to 655c2b9 Compare February 24, 2023 15:10

geropl reviewed Feb 24, 2023

View reviewed changes

components/server/ee/src/billing/entitlement-service.ts Outdated Show resolved Hide resolved

geropl reviewed Feb 24, 2023

View reviewed changes

components/gitpod-protocol/src/protocol.ts Outdated Show resolved Hide resolved

iQQBot force-pushed the pd/timeout-16089 branch 2 times, most recently from 59edcca to c6b20e1 Compare February 24, 2023 16:28

loujaybee reviewed Feb 27, 2023

View reviewed changes

components/dashboard/src/user-settings/Preferences.tsx Outdated Show resolved Hide resolved

loujaybee approved these changes Mar 1, 2023

View reviewed changes

iQQBot force-pushed the pd/timeout-16089 branch from 02fa0e2 to c0c7935 Compare March 1, 2023 15:03

loujaybee requested a review from a team March 1, 2023 16:17

gtsiolis reviewed Mar 1, 2023

View reviewed changes

iQQBot force-pushed the pd/timeout-16089 branch 2 times, most recently from 908770a to f242605 Compare March 2, 2023 15:59

geropl reviewed Mar 2, 2023

View reviewed changes

components/server/src/workspace/gitpod-server-impl.ts Outdated Show resolved Hide resolved

selfcontained reviewed Mar 3, 2023

View reviewed changes

components/dashboard/src/user-settings/Preferences.tsx Outdated Show resolved Hide resolved

selfcontained reviewed Mar 3, 2023

View reviewed changes

components/dashboard/src/user-settings/Preferences.tsx Outdated Show resolved Hide resolved

iQQBot added 2 commits March 3, 2023 04:15

[dashboard] use new api to configure workspace timeout setting

9ee6e9d

[dashboard, server] use maySetTimeout

93c093d

iQQBot force-pushed the pd/timeout-16089 branch from 9b7d2b5 to 93c093d Compare March 3, 2023 04:15

geropl reviewed Mar 3, 2023

View reviewed changes

geropl approved these changes Mar 3, 2023

View reviewed changes

roboquat removed the do-not-merge/hold label Mar 3, 2023

roboquat merged commit 5ee2a66 into main Mar 3, 2023

roboquat deleted the pd/timeout-16089 branch March 3, 2023 08:30

This was referenced Mar 3, 2023

Update timeouts layout in user preferences #16653

Merged

Move the "close timeout" (IDE + editor timeout) to a user preference. #16089

Closed

roboquat added deployed: webapp Meta team change is running in production deployed Change is completely running in production labels Mar 6, 2023

gtsiolis mentioned this pull request Mar 21, 2023

Timeouts banner link to billing redirects to workspaces when the personal account is active in the org selector or you have no other organizations #16946

Closed

gtsiolis mentioned this pull request Mar 29, 2023

Adding Toasts #17030

Merged

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[dashboard, server] Add global custom timeout preference #16503

[dashboard, server] Add global custom timeout preference #16503

iQQBot commented Feb 22, 2023 •

edited

Loading

werft-gitpod-dev-com bot commented Feb 22, 2023

iQQBot commented Feb 22, 2023

iQQBot commented Feb 22, 2023 •

edited

Loading

iQQBot commented Feb 22, 2023

gtsiolis commented Feb 23, 2023 •

edited by werft-gitpod-dev-com bot

Loading

gtsiolis left a comment

gtsiolis Feb 23, 2023

iQQBot Feb 23, 2023

iQQBot Feb 23, 2023

gtsiolis Feb 23, 2023

iQQBot Feb 23, 2023

gtsiolis Feb 24, 2023 •

edited

Loading

iQQBot Feb 24, 2023

loujaybee Feb 28, 2023 •

edited

Loading

loujaybee Feb 28, 2023 •

edited

Loading

loujaybee Mar 1, 2023

iQQBot commented Feb 23, 2023

geropl commented Feb 24, 2023

iQQBot commented Feb 24, 2023

loujaybee left a comment

loujaybee commented Mar 1, 2023 •

edited by werft-gitpod-dev-com bot

Loading

gtsiolis commented Mar 1, 2023 •

edited by werft-gitpod-dev-com bot

Loading

geropl Mar 2, 2023 •

edited

Loading

iQQBot Mar 2, 2023

geropl Mar 2, 2023 •

edited

Loading

iQQBot Mar 2, 2023

geropl commented Mar 2, 2023

geropl commented Mar 2, 2023

iQQBot commented Mar 2, 2023 •

edited

Loading

geropl Mar 3, 2023

geropl left a comment

iQQBot commented Mar 3, 2023

[dashboard, server] Add global custom timeout preference #16503

[dashboard, server] Add global custom timeout preference #16503

Conversation

iQQBot commented Feb 22, 2023 • edited Loading

Description

Related Issue(s)

How to test

Release Notes

Documentation

Build Options:

Preview Environment Options:

werft-gitpod-dev-com bot commented Feb 22, 2023

iQQBot commented Feb 22, 2023

iQQBot commented Feb 22, 2023 • edited Loading

iQQBot commented Feb 22, 2023

gtsiolis commented Feb 23, 2023 • edited by werft-gitpod-dev-com bot Loading

gtsiolis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gtsiolis Feb 24, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

loujaybee Feb 28, 2023 • edited Loading

Choose a reason for hiding this comment

loujaybee Feb 28, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iQQBot commented Feb 23, 2023

geropl commented Feb 24, 2023

iQQBot commented Feb 24, 2023

loujaybee left a comment

Choose a reason for hiding this comment

loujaybee commented Mar 1, 2023 • edited by werft-gitpod-dev-com bot Loading

gtsiolis commented Mar 1, 2023 • edited by werft-gitpod-dev-com bot Loading

geropl Mar 2, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

geropl Mar 2, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

geropl commented Mar 2, 2023

geropl commented Mar 2, 2023

iQQBot commented Mar 2, 2023 • edited Loading

Choose a reason for hiding this comment

geropl left a comment

Choose a reason for hiding this comment

iQQBot commented Mar 3, 2023

iQQBot commented Feb 22, 2023 •

edited

Loading

iQQBot commented Feb 22, 2023 •

edited

Loading

gtsiolis commented Feb 23, 2023 •

edited by werft-gitpod-dev-com bot

Loading

gtsiolis Feb 24, 2023 •

edited

Loading

loujaybee Feb 28, 2023 •

edited

Loading

loujaybee Feb 28, 2023 •

edited

Loading

loujaybee commented Mar 1, 2023 •

edited by werft-gitpod-dev-com bot

Loading

gtsiolis commented Mar 1, 2023 •

edited by werft-gitpod-dev-com bot

Loading

geropl Mar 2, 2023 •

edited

Loading

geropl Mar 2, 2023 •

edited

Loading

iQQBot commented Mar 2, 2023 •

edited

Loading