Implement gp tasks stop --force-success (#20067)

* Implement `gp tasks stop --force-success` * Fix potential race
gitpod-io · Jul 26, 2024 · a4c1a31 · a4c1a31
1 parent 519b678
commit a4c1a31
Show file tree

Hide file tree

Showing 8 changed files with 338 additions and 224 deletions.
diff --git a/components/gitpod-cli/cmd/tasks-stop.go b/components/gitpod-cli/cmd/tasks-stop.go
@@ -18,7 +18,8 @@ import (
 )
 
 var stopTaskCmdOpts struct {
-	All bool
+	All          bool
+	ForceSuccess bool
 }
 
 // stopTaskCmd represents the stop task command
@@ -113,7 +114,7 @@ var stopTaskCmd = &cobra.Command{
 		}
 
 		for _, terminalAlias := range terminalAliases {
-			_, err = client.Terminal.Shutdown(ctx, &api.ShutdownTerminalRequest{Alias: terminalAlias})
+			_, err = client.Terminal.Shutdown(ctx, &api.ShutdownTerminalRequest{Alias: terminalAlias, ForceSuccess: stopTaskCmdOpts.ForceSuccess})
 			if err != nil {
 				return xerrors.Errorf("cannot stop task: %w", err)
 			}
@@ -126,4 +127,5 @@ func init() {
 	tasksCmd.AddCommand(stopTaskCmd)
 
 	stopTaskCmd.Flags().BoolVarP(&stopTaskCmdOpts.All, "all", "a", false, "stop all tasks")
+	stopTaskCmd.Flags().BoolVarP(&stopTaskCmdOpts.ForceSuccess, "force-success", "f", false, "force the task to exit with status code 0")
 }
diff --git a/components/supervisor-api/go/terminal.pb.go b/components/supervisor-api/go/terminal.pb.go
diff --git a/components/supervisor-api/go/terminal.pb.gw.go b/components/supervisor-api/go/terminal.pb.gw.go
diff --git a/...onents/supervisor-api/java/src/main/java/io/gitpod/supervisor/api/TerminalOuterClass.java b/...onents/supervisor-api/java/src/main/java/io/gitpod/supervisor/api/TerminalOuterClass.java
diff --git a/components/supervisor-api/terminal.proto b/components/supervisor-api/terminal.proto
@@ -88,6 +88,7 @@ message OpenTerminalResponse {
 
 message ShutdownTerminalRequest {
     string alias = 1;
+    bool force_success = 2;
 }
 message ShutdownTerminalResponse {}
 

diff --git a/components/supervisor/pkg/supervisor/tasks.go b/components/supervisor/pkg/supervisor/tasks.go
@@ -330,7 +330,11 @@ func (tm *tasksManager) Run(ctx context.Context, wg *sync.WaitGroup, successChan
 			taskLog.Info("task terminal has been closed. Waiting for watch() to finish...")
 			taskWatchWg.Wait()
 			taskLog.Info("watch() has finished, setting task state to closed")
-			if state != nil {
+
+			if term.ForceSuccess {
+				// Simulate state.Success()
+				t.successChan <- taskSuccessful
+			} else if state != nil {
 				if state.Success() {
 					t.successChan <- taskSuccessful
 				} else {

diff --git a/components/supervisor/pkg/terminal/service.go b/components/supervisor/pkg/terminal/service.go
@@ -133,7 +133,7 @@ func (srv *MuxTerminalService) OpenWithOptions(ctx context.Context, req *api.Ope
 
 // Close closes a terminal for the given alias.
 func (srv *MuxTerminalService) Shutdown(ctx context.Context, req *api.ShutdownTerminalRequest) (*api.ShutdownTerminalResponse, error) {
-	err := srv.Mux.CloseTerminal(ctx, req.Alias)
+	err := srv.Mux.CloseTerminal(ctx, req.Alias, req.ForceSuccess)
 	if err == ErrNotFound {
 		return nil, status.Error(codes.NotFound, err.Error())
 	}