FEATURE: Add Session API for pipe-based bash sessions in execd by Pangjiping · Pull Request #104 · alibaba/OpenSandbox

Pangjiping · 2026-01-18T04:20:23Z

Summary

This PR adds a dedicated Session API to the execd web layer, exposing three endpoints for creating, running code in, and deleting pipe-based bash sessions. These sessions are independent of the existing code execution flow: the existing Bash language context (e.g. POST /code/context with language: bash) continues to use the Jupyter kernel; the new Session API uses the in-process, pipe-based bash implementation only.

Motivation

Callers need a way to manage stateful bash sessions (create once, run multiple commands with shared env/cwd) without going through Jupyter.
The existing /code and /code/context APIs are built around language runtimes (Jupyter for Bash/Python/etc.). Keeping the new session lifecycle separate avoids mixing concerns and preserves backward compatibility for Bash-as-a-language.

New API

All routes live under the /session group and use the same auth middleware as other execd APIs (e.g. access token header when configured).

Method	Path	Description
`POST`	`/session`	Create a new pipe-based bash session. Returns a `session_id`.
`POST`	`/session/:sessionId/run`	Run code in the given session. Streams output via SSE (same event shape as `/code`).
`DELETE`	`/session/:sessionId`	Delete the session and release resources.

Request / response

Create session
- Body (optional): { "cwd": "/optional/working/dir" }
- Response: { "session_id": "<uuid>" }
Run in session
- Body: { "code": "<shell script>", "cwd": "<optional>", "timeout_ms": <optional, non-negative> }
- Response: SSE stream (e.g. init, stdout, stderr, execution_complete, error), same as /code.
Delete session
- No body.
- Success: 200 with no body.
- 404 if sessionId is not found.

Runtime (codeRunner) changes

Controller
- jupyterClientMap, defaultLanguageSessions, and commandClientMap are now sync.Map for concurrent access; bashSessionClientMap (also sync.Map) was added for pipe-based bash sessions.
- Bash language execution is unchanged: CreateContext and Execute for language: bash still use the Jupyter backend. No behavior change for existing /code and /code/context callers.
Session-only entrypoints (used only by the new API)
- CreateBashSession(req *CreateContextRequest) (string, error) — creates a pipe-based bash session and returns its ID.
- RunInBashSession(ctx, req *ExecuteCodeRequest) error — runs code in an existing session; req.Context must be the session ID.
- DeleteBashSession(sessionID string) error — closes the session and removes it from the map.
Context / cleanup
- DeleteContext / GetContext / ListContext continue to operate only on Jupyter-backed contexts. Pipe-based sessions are not listed or deleted via these; they are managed solely via the new Session API.

Web layer

Models (pkg/web/model/session.go): CreateSessionRequest, CreateSessionResponse, RunInSessionRequest (with validation).
Handlers (in CodeInterpretingController): CreateSession, RunInSession, DeleteSession, each calling the corresponding runtime method above.
Router (pkg/web/router.go): new /session group with the three routes.

Testing

Not run (explain why)
Unit tests
Integration tests
e2e / manual verification

Breaking Changes

None
Yes (describe impact and migration path)

Checklist

Linked Issue or clearly described motivation
Added/updated docs (if needed)
Added/updated tests (if needed)
Security impact considered
Backward compatibility considered

…t of dependency on global locks.

…ession-terminated error

…tion

components/execd/pkg/runtime/bash_session.go

components/execd/pkg/runtime/bash_session_windows.go

jwx0925 · 2026-01-19T01:43:12Z

@codex review

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 4b20500ddb

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

components/execd/pkg/runtime/bash_session_windows.go

components/execd/pkg/runtime/bash_session.go

…ment

…scripts

hittyt

LGTM

…empty

…g newline

…list too long

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: dc145d1587

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

chatgpt-codex-connector · 2026-03-15T13:44:30Z

components/execd/pkg/runtime/bash_session.go

+	ctx, cancel := context.WithTimeout(context.Background(), wait)
+	defer cancel()


Propagate caller cancellation into bash session execution

RunInSession passes a request-scoped context, but bashSession.run discards it and always starts from context.Background(). In practice, if the client disconnects or the server cancels the request, the spawned bash process keeps running until the internal timeout (24h by default when timeout_ms is omitted), which can leave long-running commands consuming resources after the API call is gone.

Useful? React with 👍 / 👎.

chatgpt-codex-connector · 2026-03-15T13:44:30Z

components/execd/pkg/runtime/bash_session.go

+	s.started = false
+	s.env = nil
+	s.cwd = ""


Terminate running bash process when closing a session

Session close currently only flips in-memory flags and clears state, but never signals the active child process. Since both interrupt and delete paths call this close logic, a running command like sleep 600 will continue executing even after the API reports success, which breaks interrupt semantics and can leave orphaned work running in the container.

Useful? React with 👍 / 👎.

chatgpt-codex-connector · 2026-03-15T13:44:30Z

components/execd/pkg/runtime/bash_session.go

+func (c *Controller) createBashSession(_ *CreateContextRequest) (string, error) {
+	session := newBashSession(nil)


Apply requested cwd during bash session creation

createBashSession ignores the incoming CreateContextRequest entirely and always initializes the session with default state. As a result, POST /session with a cwd does not actually set the starting working directory, so the first command runs in an unexpected directory until callers manually cd.

Useful? React with 👍 / 👎.

chatgpt-codex-connector · 2026-03-15T13:44:30Z

components/execd/pkg/web/controller/codeinterpreting.go

+	if err := c.bindJSON(&request); err != nil {
+		c.RespondError(


Accept empty request bodies for session creation

CreateSession always decodes JSON and treats decode errors as bad requests, so an empty body returns EOF and 400. Because CreateSessionRequest has no required fields and callers should be able to create a session without options, this makes a no-body POST /session fail unless clients send {} explicitly.

Useful? React with 👍 / 👎.

Pangjiping added 4 commits January 17, 2026 11:27

feat(components/execd): modify bash runtime by pty

07a42aa

feat(components/execd): use concurrent-safe maps to avoid single poin…

d9c20ab

…t of dependency on global locks.

feat(tests): add python integration test for bash execution

31db4ac

feat(tests): add js integration test for bash execution

bb70a0d

Pangjiping requested review from hittyt, jwx0925 and ninan-nn as code owners January 18, 2026 04:20

Pangjiping added the feature New feature or request label Jan 18, 2026

Pangjiping added 3 commits January 18, 2026 14:28

fix(components/execd): reject commands after exit and surface clear s…

1e2ed97

…ession-terminated error

fix(components/execd): preserve bash exit status without killing session

2e9add9

feat(sandboxes/code-interpreter): remove bash jupyter kernel installa…

4b20500

…tion

hittyt reviewed Jan 18, 2026

View reviewed changes

components/execd/pkg/runtime/bash_session.go Outdated Show resolved Hide resolved

components/execd/pkg/runtime/bash_session_windows.go Outdated Show resolved Hide resolved

chatgpt-codex-connector bot reviewed Jan 19, 2026

View reviewed changes

components/execd/pkg/runtime/bash_session_windows.go Outdated Show resolved Hide resolved

components/execd/pkg/runtime/bash_session.go Outdated Show resolved Hide resolved

components/execd/pkg/runtime/bash_session.go Outdated Show resolved Hide resolved

Pangjiping added 4 commits January 19, 2026 10:33

fix(sandboxes/code-interpreter): fix stderr discard error

d8909da

fix(sandboxes/code-interpreter): fix windows bash session start state…

d28a674

…ment

fix(tests): remove bash context management test

2c9af4c

fix(components/execd): keep bash session newlines to support heredoc …

4d5372a

…scripts

Pangjiping force-pushed the feat/run_in_session branch from 7d9e73e to 4d5372a Compare January 29, 2026 12:11

Pangjiping assigned hittyt Jan 29, 2026

fix(components/execd): fix exec issue

ebb9b4b

hittyt self-requested a review February 3, 2026 01:07

hittyt previously approved these changes Feb 3, 2026

View reviewed changes

Pangjiping marked this pull request as draft February 4, 2026 01:37

feat(components/execd): override session's cwd if request.cwd is not …

1e7f2fa

…empty

Pangjiping dismissed hittyt’s stale review via 1e7f2fa February 5, 2026 02:33

Pangjiping added 2 commits February 5, 2026 12:42

fix(components/execd): avoid env dump leak when command lacks trailin…

575ca47

…g newline

chore(execd): emit bash session exit errors

3532fc9

Pangjiping force-pushed the feat/run_in_session branch from d2d9b9d to 62e749e Compare February 27, 2026 02:04

fix(execd): run bash session from temp script file to avoid argument …

7d28368

…list too long

Pangjiping force-pushed the feat/run_in_session branch from 62e749e to 7d28368 Compare February 27, 2026 05:57

Pangjiping added 2 commits March 15, 2026 21:09

Merge remote-tracking branch 'origin/main' into feat/run_in_session

beff38c

feat(execd): support new API for create_session and run_in_session

dc145d1

Pangjiping changed the title ~~FEATURE: optmize bash execution by pty~~ FEATURE: Add Session API for pipe-based bash sessions in execd Mar 15, 2026

Pangjiping marked this pull request as ready for review March 15, 2026 13:39

Pangjiping added the component/execd label Mar 15, 2026

chatgpt-codex-connector bot reviewed Mar 15, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FEATURE: Add Session API for pipe-based bash sessions in execd#104

FEATURE: Add Session API for pipe-based bash sessions in execd#104
Pangjiping wants to merge 18 commits intoalibaba:mainfrom
Pangjiping:feat/run_in_session

Pangjiping commented Jan 18, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

jwx0925 commented Jan 19, 2026

Uh oh!

chatgpt-codex-connector bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hittyt left a comment

Uh oh!

chatgpt-codex-connector bot left a comment

Uh oh!

chatgpt-codex-connector bot Mar 15, 2026

Uh oh!

chatgpt-codex-connector bot Mar 15, 2026

Uh oh!

chatgpt-codex-connector bot Mar 15, 2026

Uh oh!

chatgpt-codex-connector bot Mar 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		ctx, cancel := context.WithTimeout(context.Background(), wait)
		defer cancel()

		func (c Controller) createBashSession(_ CreateContextRequest) (string, error) {
		session := newBashSession(nil)

Conversation

Pangjiping commented Jan 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Motivation

New API

Request / response

Runtime (codeRunner) changes

Web layer

Testing

Breaking Changes

Checklist

Uh oh!

Uh oh!

Uh oh!

jwx0925 commented Jan 19, 2026

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hittyt left a comment

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector bot Mar 15, 2026

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector bot Mar 15, 2026

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector bot Mar 15, 2026

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector bot Mar 15, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Pangjiping commented Jan 18, 2026 •

edited

Loading