fix(client): accumulate multiline SSE data (#2122)
* fix(client): accumulate multiline SSE data * fix(client): skip empty SSE data frames and clear lint findings Accumulating data lines turned a bare "data:" frame into an empty JSON payload that aborted the stream; the old parser skipped it. Skip frames whose joined payload is empty. Also use strings.TrimPrefix in appendSSEDataLine and check Fprint results / drop unused params in the new streaming tests. --------- Co-authored-by: wizardchen <wizardchen@tencent.com> Co-authored-by: lyingbug <xiayula2014@gmail.com>main
parent
0bf105499b
commit
a7fc9e13da
|
|
@ -137,9 +137,11 @@ func (c *Client) processAgentSSEStream(reader io.Reader, callback AgentEventCall
|
|||
|
||||
// Empty line indicates the end of an event
|
||||
if line == "" {
|
||||
if dataBuffer != "" {
|
||||
// A bare `data:` frame carries no payload; skip it rather than
|
||||
// failing the stream on an empty JSON document.
|
||||
if data := completeSSEData(dataBuffer); data != "" {
|
||||
var streamResponse AgentStreamResponse
|
||||
if err := json.Unmarshal([]byte(dataBuffer), &streamResponse); err != nil {
|
||||
if err := json.Unmarshal([]byte(data), &streamResponse); err != nil {
|
||||
return fmt.Errorf("failed to parse SSE data: %w", err)
|
||||
}
|
||||
|
||||
|
|
@ -153,8 +155,8 @@ func (c *Client) processAgentSSEStream(reader io.Reader, callback AgentEventCall
|
|||
if streamResponse.ResponseType == AgentResponseTypeError && streamResponse.Done {
|
||||
return NewSSEStreamError(streamResponse.Content)
|
||||
}
|
||||
dataBuffer = ""
|
||||
}
|
||||
dataBuffer = ""
|
||||
continue
|
||||
}
|
||||
|
||||
|
|
@ -167,7 +169,7 @@ func (c *Client) processAgentSSEStream(reader io.Reader, callback AgentEventCall
|
|||
|
||||
// Process lines with data: prefix
|
||||
if strings.HasPrefix(line, "data:") {
|
||||
dataBuffer = strings.TrimSpace(line[5:]) // Remove "data:" prefix
|
||||
dataBuffer = appendSSEDataLine(dataBuffer, line)
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -324,10 +324,12 @@ func (c *Client) KnowledgeQAStream(
|
|||
|
||||
// Empty line indicates the end of an event
|
||||
if line == "" {
|
||||
if dataBuffer != "" {
|
||||
debugLogger.Debug("sse_data_processing", "data", dataBuffer, "event_type", eventType)
|
||||
// A bare `data:` frame carries no payload; skip it rather than
|
||||
// failing the stream on an empty JSON document.
|
||||
if data := completeSSEData(dataBuffer); data != "" {
|
||||
debugLogger.Debug("sse_data_processing", "data", data, "event_type", eventType)
|
||||
var streamResponse StreamResponse
|
||||
if err := json.Unmarshal([]byte(dataBuffer), &streamResponse); err != nil {
|
||||
if err := json.Unmarshal([]byte(data), &streamResponse); err != nil {
|
||||
debugLogger.Debug("sse_parse_failed", "error", err)
|
||||
return fmt.Errorf("failed to parse SSE data: %w", err)
|
||||
}
|
||||
|
|
@ -342,9 +344,9 @@ func (c *Client) KnowledgeQAStream(
|
|||
if streamResponse.ResponseType == ResponseTypeError && streamResponse.Done {
|
||||
return NewSSEStreamError(streamResponse.Content)
|
||||
}
|
||||
dataBuffer = ""
|
||||
eventType = ""
|
||||
}
|
||||
dataBuffer = ""
|
||||
eventType = ""
|
||||
continue
|
||||
}
|
||||
|
||||
|
|
@ -356,7 +358,7 @@ func (c *Client) KnowledgeQAStream(
|
|||
|
||||
// Process lines with data: prefix
|
||||
if strings.HasPrefix(line, "data:") {
|
||||
dataBuffer = line[5:] // Remove "data:" prefix
|
||||
dataBuffer = appendSSEDataLine(dataBuffer, line)
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -410,9 +412,9 @@ func (c *Client) ContinueStream(
|
|||
|
||||
// Empty line indicates the end of an event
|
||||
if line == "" {
|
||||
if dataBuffer != "" && eventType == "message" {
|
||||
if data := completeSSEData(dataBuffer); data != "" && eventType == "message" {
|
||||
var streamResponse StreamResponse
|
||||
if err := json.Unmarshal([]byte(dataBuffer), &streamResponse); err != nil {
|
||||
if err := json.Unmarshal([]byte(data), &streamResponse); err != nil {
|
||||
return fmt.Errorf("failed to parse SSE data: %w", err)
|
||||
}
|
||||
|
||||
|
|
@ -422,9 +424,9 @@ func (c *Client) ContinueStream(
|
|||
if streamResponse.ResponseType == ResponseTypeError && streamResponse.Done {
|
||||
return NewSSEStreamError(streamResponse.Content)
|
||||
}
|
||||
dataBuffer = ""
|
||||
eventType = ""
|
||||
}
|
||||
dataBuffer = ""
|
||||
eventType = ""
|
||||
continue
|
||||
}
|
||||
|
||||
|
|
@ -435,7 +437,7 @@ func (c *Client) ContinueStream(
|
|||
|
||||
// Process lines with data: prefix
|
||||
if strings.HasPrefix(line, "data:") {
|
||||
dataBuffer = line[5:] // Remove "data:" prefix
|
||||
dataBuffer = appendSSEDataLine(dataBuffer, line)
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,11 @@
|
|||
package client
|
||||
|
||||
import "strings"
|
||||
|
||||
func appendSSEDataLine(buffer, line string) string {
|
||||
return buffer + strings.TrimPrefix(line[5:], " ") + "\n"
|
||||
}
|
||||
|
||||
func completeSSEData(buffer string) string {
|
||||
return strings.TrimSuffix(buffer, "\n")
|
||||
}
|
||||
|
|
@ -37,6 +37,144 @@ func knowledgeSSEEvent(t *testing.T, w io.Writer, resp StreamResponse, eventType
|
|||
fmt.Fprintf(w, "data:%s\n\n", b)
|
||||
}
|
||||
|
||||
func TestProcessAgentSSEStream_MultilineDataFrame(t *testing.T) {
|
||||
frame := "data: {\"response_type\":\"answer\",\n" +
|
||||
"data: \"content\":\"hello\",\"done\":false}\n\n"
|
||||
|
||||
c := &Client{}
|
||||
var got *AgentStreamResponse
|
||||
err := c.processAgentSSEStream(strings.NewReader(frame), func(resp *AgentStreamResponse) error {
|
||||
got = resp
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("multiline SSE data frame failed: %v", err)
|
||||
}
|
||||
if got == nil {
|
||||
t.Fatal("callback was not invoked")
|
||||
}
|
||||
if got.ResponseType != AgentResponseTypeAnswer || got.Content != "hello" {
|
||||
t.Fatalf("response = %#v, want answer content hello", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestKnowledgeQAStream_MultilineDataFrame(t *testing.T) {
|
||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/event-stream")
|
||||
_, _ = fmt.Fprint(w, "data:{\"response_type\":\"answer\",\n")
|
||||
_, _ = fmt.Fprint(w, "data:\"content\":\"hello\",\"done\":false}\n\n")
|
||||
}))
|
||||
defer srv.Close()
|
||||
|
||||
c := NewClient(srv.URL)
|
||||
var got *StreamResponse
|
||||
err := c.KnowledgeQAStream(context.Background(), "sess", &KnowledgeQARequest{Query: "q"},
|
||||
func(e *StreamResponse) error {
|
||||
got = e
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("multiline knowledge SSE data frame failed: %v", err)
|
||||
}
|
||||
if got == nil {
|
||||
t.Fatal("callback was not invoked")
|
||||
}
|
||||
if got.ResponseType != ResponseTypeAnswer || got.Content != "hello" {
|
||||
t.Fatalf("response = %#v, want answer content hello", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestContinueStream_MultilineDataFrame(t *testing.T) {
|
||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/event-stream")
|
||||
_, _ = fmt.Fprint(w, "event:message\n")
|
||||
_, _ = fmt.Fprint(w, "data:{\"response_type\":\"answer\",\n")
|
||||
_, _ = fmt.Fprint(w, "data:\"content\":\"hello\",\"done\":false}\n\n")
|
||||
}))
|
||||
defer srv.Close()
|
||||
|
||||
c := NewClient(srv.URL)
|
||||
var got *StreamResponse
|
||||
err := c.ContinueStream(context.Background(), "sess", "msg", func(e *StreamResponse) error {
|
||||
got = e
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("multiline continue SSE data frame failed: %v", err)
|
||||
}
|
||||
if got == nil {
|
||||
t.Fatal("callback was not invoked")
|
||||
}
|
||||
if got.ResponseType != ResponseTypeAnswer || got.Content != "hello" {
|
||||
t.Fatalf("response = %#v, want answer content hello", got)
|
||||
}
|
||||
}
|
||||
|
||||
// emptyDataFrameStream wraps a bare `data:` frame between two real events;
|
||||
// the empty frame must be skipped, not parsed as JSON.
|
||||
const emptyDataFrameStream = "data:{\"response_type\":\"answer\",\"content\":\"a\"}\n\n" +
|
||||
"data:\n\n" +
|
||||
"data:{\"response_type\":\"answer\",\"content\":\"b\"}\n\n"
|
||||
|
||||
func TestProcessAgentSSEStream_SkipsEmptyDataFrame(t *testing.T) {
|
||||
c := &Client{}
|
||||
var got []string
|
||||
err := c.processAgentSSEStream(strings.NewReader(emptyDataFrameStream), func(resp *AgentStreamResponse) error {
|
||||
got = append(got, resp.Content)
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("empty SSE data frame aborted the stream: %v", err)
|
||||
}
|
||||
if strings.Join(got, ",") != "a,b" {
|
||||
t.Fatalf("contents = %v, want [a b]", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestKnowledgeQAStream_SkipsEmptyDataFrame(t *testing.T) {
|
||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/event-stream")
|
||||
_, _ = fmt.Fprint(w, emptyDataFrameStream)
|
||||
}))
|
||||
defer srv.Close()
|
||||
|
||||
c := NewClient(srv.URL)
|
||||
var got []string
|
||||
err := c.KnowledgeQAStream(context.Background(), "sess", &KnowledgeQARequest{Query: "q"},
|
||||
func(e *StreamResponse) error {
|
||||
got = append(got, e.Content)
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("empty SSE data frame aborted the stream: %v", err)
|
||||
}
|
||||
if strings.Join(got, ",") != "a,b" {
|
||||
t.Fatalf("contents = %v, want [a b]", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestContinueStream_SkipsEmptyDataFrame(t *testing.T) {
|
||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/event-stream")
|
||||
_, _ = fmt.Fprint(w, "event:message\n"+
|
||||
strings.ReplaceAll(emptyDataFrameStream, "\n\n", "\n\nevent:message\n"))
|
||||
}))
|
||||
defer srv.Close()
|
||||
|
||||
c := NewClient(srv.URL)
|
||||
var got []string
|
||||
err := c.ContinueStream(context.Background(), "sess", "msg", func(e *StreamResponse) error {
|
||||
got = append(got, e.Content)
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("empty SSE data frame aborted the stream: %v", err)
|
||||
}
|
||||
if strings.Join(got, ",") != "a,b" {
|
||||
t.Fatalf("contents = %v, want [a b]", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestProcessAgentSSEStream_DataLineLimits locks in the 4 MiB bufio.Scanner
|
||||
// cap raised from the 64 KiB default: a `references` event bundling chunk
|
||||
// contents reaches hundreds of KiB and previously errored "token too long".
|
||||
|
|
|
|||
Loading…
Reference in New Issue