[ws-manager] Add custom closed timeout

Co-authored-by: Wouter Verlaek <[email protected]>

Author: 2 people

components/ws-manager-api/core.proto

@@ -171,13 +171,20 @@ message MarkActiveRequest {
 // MarkActiveResponse is the answer to a mark workspace active request
 message MarkActiveResponse {}
 
+enum TimeoutType {
+    WORKSPACE_TIMEOUT = 0;
+    CLOSED_TIMEOUT = 1;
+}
+
 // SetTimeoutRequest configures the timeout of a workspace
 message SetTimeoutRequest {
     // id is the ID of the workspace
     string id = 1;
 
     // duration is the new timeout duration. Must be a valid Go duration (see https://golang.org/pkg/time/#ParseDuration)
     string duration = 2;
+
+    TimeoutType type = 3;
 }
 
 // SetTimeoutResponse is the answer to a set timeout request
@@ -361,6 +368,9 @@ message WorkspaceSpec {
     // ide_image_layers are contains the images needed for the ide to run,
     // including ide-desktop, desktop-plugin and so on
     repeated string ide_image_layers = 10;
+
+    // The timeout for closed ide.
+    string closed_timeout = 11;
 }
 
 // PortSpec describes a networking port exposed on a workspace
@@ -584,6 +594,9 @@ message StartWorkspaceSpec {
     // ide_image_layers are contains the images needed for the ide to run,
     // including ide-desktop, desktop-plugin and so on
     repeated string ide_image_layers = 17;
+
+    // timeout optionally sets a custom closed timeout
+    string closed_timeout = 18;
 }
 
 // WorkspaceFeatureFlag enable non-standard behaviour in workspaces

components/ws-manager-api/go/core.pb.go

@@ -59,6 +59,9 @@ const (
 	// This is handy if you want to prevent a workspace from timing out during lunch break.
 	customTimeoutAnnotation = "gitpod/customTimeout"
 
+	// customClosedTimeoutAnnotation configures the closed timeout of a workspace, i.e. close web ide, disconnect ssh connection
+	customClosedTimeoutAnnotation = "gitpod/customClosedTimeout"
+
 	// firstUserActivityAnnotation marks a workspace woth the timestamp of first user activity in it
 	firstUserActivityAnnotation = "gitpod/firstUserActivity"
 

components/ws-manager-api/typescript/src/core_pb.d.ts

@@ -393,6 +393,13 @@ func (m *Manager) createDefiniteWorkspacePod(startContext *startWorkspaceContext
 		}
 		annotations[customTimeoutAnnotation] = req.Spec.Timeout
 	}
+	if req.Spec.ClosedTimeout != "" {
+		_, err := time.ParseDuration(req.Spec.ClosedTimeout)
+		if err != nil {
+			return nil, xerrors.Errorf("invalid closed timeout \"%s\": %w", req.Spec.ClosedTimeout, err)
+		}
+		annotations[customClosedTimeoutAnnotation] = req.Spec.ClosedTimeout
+	}
 
 	for k, v := range req.Metadata.Annotations {
 		annotations[workspaceAnnotationPrefix+k] = v

components/ws-manager-api/typescript/src/core_pb.js

@@ -134,9 +134,20 @@ func (m *Manager) SetTimeout(ctx context.Context, req *api.SetTimeoutRequest) (r
 		return nil, xerrors.Errorf("invalid duration \"%s\": %w", req.Duration, err)
 	}
 
-	err = m.markWorkspace(ctx, req.Id, addMark(customTimeoutAnnotation, req.Duration))
-	if err != nil {
-		return nil, xerrors.Errorf("cannot set workspace timeout: %w", err)
+	if req.Type == api.TimeoutType_WORKSPACE_TIMEOUT {
+		err = m.markWorkspace(ctx, req.Id, addMark(customTimeoutAnnotation, req.Duration))
+		if err != nil {
+			return nil, xerrors.Errorf("cannot set workspace timeout: %w", err)
+		}
+		err = m.markWorkspace(ctx, req.Id, addMark(customClosedTimeoutAnnotation, "0"))
+		if err != nil {
+			return nil, xerrors.Errorf("cannot set closed timeout: %w", err)
+		}
+	} else if req.Type == api.TimeoutType_CLOSED_TIMEOUT {
+		err = m.markWorkspace(ctx, req.Id, addMark(customClosedTimeoutAnnotation, req.Duration))
+		if err != nil {
+			return nil, xerrors.Errorf("cannot set closed timeout: %w", err)
+		}
 	}
 
 	return &api.SetTimeoutResponse{}, nil