-
Notifications
You must be signed in to change notification settings - Fork 11.1k
fix(openai): support streaming image relay and image edit for images API #4608
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.
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
Merged
Calcium-Ion
merged 22 commits into
QuantumNous:main
from
gaoren002:pr/openai-image-stream-keepalive-20260504130050
Jun 8, 2026
Merged
Changes from all commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
9d13ce8
fix(openai): support streaming image relay
9cc9542
fix(openai): keep image edit multipart body reusable
47ba6ee
test(openai): cover image stream usage details
71a66dc
test(openai): cover image edit fallback stream field
26b87a1
Merge branch 'QuantumNous:main' into pr/openai-image-stream-keepalive…
gaoren002 4ee48d7
Merge branch 'QuantumNous:main' into pr/openai-image-stream-keepalive…
gaoren002 e79107a
fix(openai): wrap image json fallback as stream
9a9609d
fix(relay): support OpenAI image streaming
0fb42be
fix(openai): record image stream upstream error events
2817964
fix(openai): harden image stream relay
377faa7
Merge branch 'QuantumNous:main' into pr/openai-image-stream-keepalive…
gaoren002 2abb10a
Merge branch 'QuantumNous:main' into pr/openai-image-stream-keepalive…
gaoren002 5d8d6c2
fix(openai): return image JSON errors
d7bdad7
Merge branch 'QuantumNous:main' into pr/openai-image-stream-keepalive…
gaoren002 fedad96
Merge branch 'QuantumNous:main' into pr/openai-image-stream-keepalive…
gaoren002 26f81a2
Merge branch 'QuantumNous:main' into pr/openai-image-stream-keepalive…
gaoren002 cb8bc18
Merge branch 'QuantumNous:main' into pr/openai-image-stream-keepalive…
gaoren002 01dd22d
fix(relay): reset stream status per scanner run
d8a0088
fix(relay): drop upstream credit passthrough
518f804
fix(openai): keep image errors minimal
5284fe7
fix(openai): keep image error status from response
Calcium-Ion 8097a54
Merge branch 'QuantumNous:main' into pr/openai-image-stream-keepalive…
gaoren002 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| package dto | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| // TestImageRequestStreamJSON verifies that image requests preserve stream=true. | ||
| func TestImageRequestStreamJSON(t *testing.T) { | ||
| var req ImageRequest | ||
| require.NoError(t, req.UnmarshalJSON([]byte(`{"model":"gpt-image-1","prompt":"draw a cat","stream":true}`))) | ||
|
|
||
| require.True(t, req.Stream) | ||
| require.True(t, req.IsStream(nil)) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| package openai | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "io" | ||
| "mime/multipart" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "testing" | ||
|
|
||
| "github.com/QuantumNous/new-api/common" | ||
| "github.com/QuantumNous/new-api/dto" | ||
| relaycommon "github.com/QuantumNous/new-api/relay/common" | ||
| relayconstant "github.com/QuantumNous/new-api/relay/constant" | ||
| "github.com/gin-gonic/gin" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| // TestConvertImageEditRequestKeepsValidMultipartStreamFields verifies multipart replay. | ||
| func TestConvertImageEditRequestKeepsValidMultipartStreamFields(t *testing.T) { | ||
| gin.SetMode(gin.TestMode) | ||
|
|
||
| var body bytes.Buffer | ||
| writer := multipart.NewWriter(&body) | ||
| require.NoError(t, writer.WriteField("model", "gpt-image-1")) | ||
| require.NoError(t, writer.WriteField("prompt", "edit this image")) | ||
| require.NoError(t, writer.WriteField("stream", "true")) | ||
| require.NoError(t, writer.WriteField("partial_images", "3")) | ||
| part, err := writer.CreateFormFile("image", "input.png") | ||
| require.NoError(t, err) | ||
| _, err = part.Write([]byte("fake image")) | ||
| require.NoError(t, err) | ||
| require.NoError(t, writer.Close()) | ||
|
|
||
| recorder := httptest.NewRecorder() | ||
| c, _ := gin.CreateTestContext(recorder) | ||
| c.Request = httptest.NewRequest(http.MethodPost, "/v1/images/edits", &body) | ||
| c.Request.Header.Set("Content-Type", writer.FormDataContentType()) | ||
| require.NoError(t, c.Request.ParseMultipartForm(32<<20)) | ||
|
|
||
| info := &relaycommon.RelayInfo{ | ||
| RelayMode: relayconstant.RelayModeImagesEdits, | ||
| } | ||
| request := dto.ImageRequest{ | ||
| Model: "gpt-image-1", | ||
| Prompt: "edit this image", | ||
| Stream: true, | ||
| } | ||
|
|
||
| converted, err := (&Adaptor{}).ConvertImageRequest(c, info, request) | ||
| require.NoError(t, err) | ||
|
|
||
| convertedBody, ok := converted.(*bytes.Buffer) | ||
| require.True(t, ok) | ||
|
|
||
| contentType := c.Request.Header.Get("Content-Type") | ||
| replayedRequest := httptest.NewRequest(http.MethodPost, "/v1/images/edits", bytes.NewReader(convertedBody.Bytes())) | ||
| replayedRequest.Header.Set("Content-Type", contentType) | ||
| require.NoError(t, replayedRequest.ParseMultipartForm(32<<20)) | ||
|
|
||
| require.Equal(t, "gpt-image-1", replayedRequest.PostForm.Get("model")) | ||
| require.Equal(t, "edit this image", replayedRequest.PostForm.Get("prompt")) | ||
| require.Equal(t, "true", replayedRequest.PostForm.Get("stream")) | ||
| require.Equal(t, "3", replayedRequest.PostForm.Get("partial_images")) | ||
| require.Len(t, replayedRequest.MultipartForm.File["image"], 1) | ||
|
|
||
| file, err := replayedRequest.MultipartForm.File["image"][0].Open() | ||
| require.NoError(t, err) | ||
| defer file.Close() | ||
| fileBytes, err := io.ReadAll(file) | ||
| require.NoError(t, err) | ||
| require.Equal(t, []byte("fake image"), fileBytes) | ||
| } | ||
|
|
||
| // TestConvertImageEditRequestParsesReusableMultipartWhenFormIsMissing verifies fallback parsing. | ||
| func TestConvertImageEditRequestParsesReusableMultipartWhenFormIsMissing(t *testing.T) { | ||
| gin.SetMode(gin.TestMode) | ||
|
|
||
| var body bytes.Buffer | ||
| writer := multipart.NewWriter(&body) | ||
| require.NoError(t, writer.WriteField("model", "gpt-image-1")) | ||
| require.NoError(t, writer.WriteField("prompt", "edit without pre-parsed form")) | ||
| require.NoError(t, writer.WriteField("stream", "true")) | ||
| part, err := writer.CreateFormFile("image", "input.png") | ||
| require.NoError(t, err) | ||
| _, err = part.Write([]byte("fake image")) | ||
| require.NoError(t, err) | ||
| require.NoError(t, writer.Close()) | ||
|
|
||
| recorder := httptest.NewRecorder() | ||
| c, _ := gin.CreateTestContext(recorder) | ||
| c.Request = httptest.NewRequest(http.MethodPost, "/v1/images/edits", &body) | ||
| c.Request.Header.Set("Content-Type", writer.FormDataContentType()) | ||
|
|
||
| storage, err := common.GetBodyStorage(c) | ||
| require.NoError(t, err) | ||
| c.Request.Body = io.NopCloser(storage) | ||
| c.Request.MultipartForm = nil | ||
| c.Request.PostForm = nil | ||
|
|
||
| info := &relaycommon.RelayInfo{ | ||
| RelayMode: relayconstant.RelayModeImagesEdits, | ||
| } | ||
| request := dto.ImageRequest{ | ||
| Model: "gpt-image-1", | ||
| Prompt: "edit without pre-parsed form", | ||
| Stream: true, | ||
| } | ||
|
|
||
| converted, err := (&Adaptor{}).ConvertImageRequest(c, info, request) | ||
| require.NoError(t, err) | ||
|
|
||
| convertedBody, ok := converted.(*bytes.Buffer) | ||
| require.True(t, ok) | ||
| replayedRequest := httptest.NewRequest(http.MethodPost, "/v1/images/edits", bytes.NewReader(convertedBody.Bytes())) | ||
| replayedRequest.Header.Set("Content-Type", c.Request.Header.Get("Content-Type")) | ||
| require.NoError(t, replayedRequest.ParseMultipartForm(32<<20)) | ||
| require.Equal(t, "edit without pre-parsed form", replayedRequest.PostForm.Get("prompt")) | ||
| require.Equal(t, "true", replayedRequest.PostForm.Get("stream")) | ||
| require.Len(t, replayedRequest.MultipartForm.File["image"], 1) | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.