Skip to content

fix(execd): return the command SSE handler after execution completes #1672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vinkiYu wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(execd): return the command SSE handler after execution completes #1672

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions components/execd/pkg/web/controller/command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ import (
"sync"
"time"

"github.com/alibaba/opensandbox/execd/pkg/flag"
"github.com/alibaba/opensandbox/execd/pkg/jupyter/execute"
"github.com/alibaba/opensandbox/execd/pkg/runtime"
"github.com/alibaba/opensandbox/execd/pkg/telemetry"
Expand Down Expand Up @@ -113,12 +112,6 @@ func (c *CodeInterpretingController) RunCommand() {
}

waitForExecutionComplete(ctx, completeCh)

// Keep the SSE connection alive briefly so clients can read all
// buffered events and downstream components (e.g. egress sidecar)
// have time to synchronise state changes that were triggered
// during command execution.
time.Sleep(flag.ApiGracefulShutdownTimeout)
}

// InterruptCommand stops a running shell command session.
Expand Down
29 changes: 29 additions & 0 deletions components/execd/pkg/web/controller/command_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ import (
"net/http/httptest"
"reflect"
"testing"
"time"

"github.com/alibaba/opensandbox/execd/pkg/flag"
"github.com/alibaba/opensandbox/execd/pkg/runtime"
"github.com/alibaba/opensandbox/execd/pkg/web/model"
"github.com/stretchr/testify/require"
Expand Down Expand Up @@ -88,3 +90,30 @@ func TestGetBackgroundCommandOutput_MissingID(t *testing.T) {
require.Equal(t, model.ErrorCodeMissingQuery, resp.Code)
require.Equal(t, "missing command execution id", resp.Message)
}

func TestRunCommandReturnsBeforeGracefulShutdownTimeoutAfterImmediateComplete(t *testing.T) {
previousRunner := codeRunner
previousTimeout := flag.ApiGracefulShutdownTimeout
codeRunner = &fakeCodeRunner{
execute: func(request *runtime.ExecuteCodeRequest) error {
request.Hooks.OnExecuteComplete(5 * time.Millisecond)
return nil
},
}
flag.ApiGracefulShutdownTimeout = 200 * time.Millisecond
t.Cleanup(func() {
codeRunner = previousRunner
flag.ApiGracefulShutdownTimeout = previousTimeout
})

body := []byte(`{"command":"echo hi"}`)
ctx, w := newTestContext(http.MethodPost, "/command", body)
ctrl := NewCodeInterpretingController(ctx)

start := time.Now()
ctrl.RunCommand()
elapsed := time.Since(start)

require.Equal(t, http.StatusOK, w.Code)
require.Less(t, elapsed, flag.ApiGracefulShutdownTimeout/2)
}
Loading