fix(streaming/tools): stop healing-marker stubs from gating off content (#9999)

* fix(streaming/tools): stop healing-marker stubs from gating off content

When the C++ autoparser is in pure-content fallback mode (e.g. qwen3
without --jinja) and the model emits a tool call as JSON, the streaming
worker calls ParseJSONIterative on each new chunk. parseJSONWithStack
heals partial input like `{` into `{"<marker>":1}` where <marker> is a
random integer. removeHealingMarkerFromJSON only stripped the marker
from values, so the synthetic key survived and downstream callers saw
a stub object with a random-looking key.

chat_stream_workers.go's JSON tool-call detector then bumped
lastEmittedCount past the stub even though no real tool call was
emitted, gating off ALL subsequent content chunks. The qwen3 + tools +
streaming case ended up dribbling only the first `{"` to clients and
then nothing, even when the model went on to call the noAction
`answer({"message": "…"})` pseudo-tool.

Three changes, each with its own regression test:

* removeHealingMarkerFromJSON now strips the marker suffix from keys
  too, dropping the entry when the truncated key is empty. Inputs like
  `{` no longer leak `{"<marker>":1}` to callers; partial keys like
  `{ "code` still preserve the model-typed prefix `code`.

* ParseJSONIterative skips empty-after-healing maps so a healed `{`
  doesn't surface as a stub result.

* The streaming JSON detector now breaks (not continues) on entries
  without a usable `name`, and only bumps lastEmittedCount past
  successfully-emitted entries. Defense-in-depth against any future
  partial-parse shape.

The parser tests cover eight partial-JSON-prefix shapes and verify no
marker characters leak into keys, plus the two early shapes (`{`,
`{"`) that should not surface a stub at all.

Fixes #9988

Assisted-by: Claude:opus-4-7 [Read] [Edit] [Bash]
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* test(streaming/tools): cover the autoparser-correctly-working path

Extract the JSON tool-call streaming emit loop into emitJSONToolCallDeltas
and unit-test it against every shape that can hit the streaming worker:

* the bug case — a healing-marker stub at index 0 must NOT bump
  lastEmittedCount, so subsequent content chunks keep flowing;
* the autoparser-correctly-working case — empty jsonResults (because
  the C++ autoparser cleared the raw text and delivers tool calls via
  TokenUsage.ChatDeltas) is a no-op, leaving the deferred end-of-stream
  emitter to ship the autoparser's tool calls;
* a single complete tool call — emit one chunk, advance to 1;
* arguments arriving as a JSON-string vs as a nested object — both
  serialize to the wire as JSON-string arguments;
* multiple parallel tool calls — one chunk each;
* a real tool call followed by a partial stub — emit the real one,
  stop at the stub, resume on a later chunk once the stub completes.

Locks down the no-regression guarantee the user asked for: this PR's
fix is scoped to the pure-content fallback path; when the autoparser
actually classifies tool calls (jinja-recognized chat format with tool
support), the helper is a no-op and nothing changes.

Assisted-by: Claude:opus-4-7 [Read] [Edit] [Bash] [Write]
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

---------

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>
Co-authored-by: Ettore Di Giacinto <mudler@localai.io>
This commit is contained in:
LocalAI [bot]
2026-05-25 23:55:35 +02:00
committed by GitHub
parent 597daa925b
commit f17d99f6e5
5 changed files with 393 additions and 44 deletions

View File

@@ -12,6 +12,77 @@ import (
"github.com/mudler/xlog"
)
// emitJSONToolCallDeltas iterates the JSON tool-call objects produced by the
// streaming tool-call detector and emits SSE chunks for the ones the caller
// hasn't already emitted. It returns the new lastEmittedCount.
//
// Semantics:
// - Skips entries before lastEmittedCount (already emitted).
// - Emits one tool_call chunk per consecutive entry that has a usable
// `name` string.
// - Stops at the first entry without a name (typically the partial-JSON
// tail or a healing-marker stub — see issue #9988) so the caller doesn't
// advance past it. Bumping lastEmittedCount past an unparsed stub
// permanently gates off content emission for the rest of the stream.
// - When jsonResults is empty (the autoparser-working case, where the raw
// text result is cleared and only ChatDeltas carry tool calls), this is
// a no-op and lastEmittedCount is returned unchanged.
//
// The autoparser-correctly-classifying-tool-calls path is unaffected: it
// delivers tool calls via TokenUsage.ChatDeltas, and the deferred
// end-of-stream block (ToolCallsFromChatDeltas → buildDeferredToolCallChunks)
// emits them; this helper sees an empty jsonResults and emits nothing.
func emitJSONToolCallDeltas(
jsonResults []map[string]any,
lastEmittedCount int,
id, model string,
created int,
responses chan<- schema.OpenAIResponse,
) int {
for i := lastEmittedCount; i < len(jsonResults); i++ {
jsonObj := jsonResults[i]
name, ok := jsonObj["name"].(string)
if !ok || name == "" {
break
}
args := "{}"
if argsVal, ok := jsonObj["arguments"]; ok {
if argsStr, ok := argsVal.(string); ok {
args = argsStr
} else {
argsBytes, _ := json.Marshal(argsVal)
args = string(argsBytes)
}
}
responses <- schema.OpenAIResponse{
ID: id,
Created: created,
Model: model,
Choices: []schema.Choice{{
Delta: &schema.Message{
Role: "assistant",
ToolCalls: []schema.ToolCall{
{
Index: i,
ID: id,
Type: "function",
FunctionCall: schema.FunctionCall{
Name: name,
Arguments: args,
},
},
},
},
Index: 0,
FinishReason: nil,
}},
Object: "chat.completion.chunk",
}
lastEmittedCount = i + 1
}
return lastEmittedCount
}
// processStream is the streaming worker for chat completions with no
// tool/function calling involved. It pushes SSE-shaped chunks onto
// `responses` and returns the authoritative cumulative TokenUsage from
@@ -279,49 +350,10 @@ func processStreamWithTools(
// Try JSON tool call parsing for streaming.
// Only emit NEW tool calls (same guard as XML parser above).
jsonResults, jsonErr := functions.ParseJSONIterative(cleanedResult, true)
if jsonErr == nil && len(jsonResults) > lastEmittedCount {
for i := lastEmittedCount; i < len(jsonResults); i++ {
jsonObj := jsonResults[i]
name, ok := jsonObj["name"].(string)
if !ok || name == "" {
continue
}
args := "{}"
if argsVal, ok := jsonObj["arguments"]; ok {
if argsStr, ok := argsVal.(string); ok {
args = argsStr
} else {
argsBytes, _ := json.Marshal(argsVal)
args = string(argsBytes)
}
}
initialMessage := schema.OpenAIResponse{
ID: id,
Created: created,
Model: req.Model,
Choices: []schema.Choice{{
Delta: &schema.Message{
Role: "assistant",
ToolCalls: []schema.ToolCall{
{
Index: i,
ID: id,
Type: "function",
FunctionCall: schema.FunctionCall{
Name: name,
Arguments: args,
},
},
},
},
Index: 0,
FinishReason: nil,
}},
Object: "chat.completion.chunk",
}
responses <- initialMessage
}
lastEmittedCount = len(jsonResults)
if jsonErr == nil {
lastEmittedCount = emitJSONToolCallDeltas(
jsonResults, lastEmittedCount, id, req.Model, created, responses,
)
}
}
return true

View File

@@ -0,0 +1,197 @@
package openai
import (
"github.com/mudler/LocalAI/core/schema"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
)
// drainChannel reads everything currently buffered on a channel without
// blocking on close. The helper test channels are sized for the assertions.
func drainChannel(ch <-chan schema.OpenAIResponse) []schema.OpenAIResponse {
var out []schema.OpenAIResponse
for {
select {
case r, ok := <-ch:
if !ok {
return out
}
out = append(out, r)
default:
return out
}
}
}
// nameOf returns the name of the first tool call carried on the choice's
// delta, or "" if none.
func nameOf(r schema.OpenAIResponse) string {
if len(r.Choices) == 0 || r.Choices[0].Delta == nil {
return ""
}
if len(r.Choices[0].Delta.ToolCalls) == 0 {
return ""
}
return r.Choices[0].Delta.ToolCalls[0].FunctionCall.Name
}
var _ = Describe("emitJSONToolCallDeltas", func() {
const (
id = "test-stream"
model = "test-model"
created = 1700000000
)
// The case that motivated this helper. With the previous version of
// the streaming worker, ParseJSONIterative would hand back a stub
// object like `{"4310046988783340008":1}` after the model had only
// emitted `{`. The worker bumped lastEmittedCount unconditionally,
// which permanently gated off content emission for the rest of the
// stream (qwen3-4b with stream:true + tools dribbled only `{"` to
// the client and then nothing). See issue #9988.
Context("partial stub without a usable name", func() {
It("does NOT bump lastEmittedCount and emits nothing", func() {
responses := make(chan schema.OpenAIResponse, 4)
// What ParseJSONIterative used to return for `{`:
stubResults := []map[string]any{
{"4310046988783340008": float64(1)},
}
next := emitJSONToolCallDeltas(stubResults, 0, id, model, created, responses)
Expect(next).To(Equal(0),
"lastEmittedCount must NOT advance past a stub without a name "+
"— otherwise content emission gets permanently gated off")
Expect(drainChannel(responses)).To(BeEmpty(),
"no tool_call chunk should be emitted for a stub without a name")
})
})
// No-regression #1: the autoparser-correctly-working path. When the
// C++ autoparser classifies tool calls itself, the raw text result is
// cleared and ParseJSONIterative on it returns no results — this
// helper must be a no-op so the deferred end-of-stream code can emit
// the tool calls from TokenUsage.ChatDeltas.
Context("empty jsonResults (autoparser-correctly-working path)", func() {
It("is a no-op and leaves lastEmittedCount unchanged", func() {
responses := make(chan schema.OpenAIResponse, 4)
next := emitJSONToolCallDeltas(nil, 0, id, model, created, responses)
Expect(next).To(Equal(0))
Expect(drainChannel(responses)).To(BeEmpty())
})
It("leaves a non-zero lastEmittedCount unchanged when later called with the same length", func() {
responses := make(chan schema.OpenAIResponse, 4)
results := []map[string]any{
{"name": "search", "arguments": map[string]any{"q": "hi"}},
}
// First call emits the one available tool call.
next := emitJSONToolCallDeltas(results, 0, id, model, created, responses)
Expect(next).To(Equal(1))
Expect(drainChannel(responses)).To(HaveLen(1))
// Subsequent chunks haven't grown the slice — must be a no-op.
next = emitJSONToolCallDeltas(results, next, id, model, created, responses)
Expect(next).To(Equal(1))
Expect(drainChannel(responses)).To(BeEmpty())
})
})
// No-regression #2: the normal completed-JSON path. When the model
// emits a real, complete tool call as JSON in raw content (e.g. qwen3
// without jinja but with tools), we should emit exactly one tool_call
// SSE chunk on the first call and become a no-op on later calls.
Context("single complete tool call", func() {
It("emits one tool_call chunk and bumps lastEmittedCount to 1", func() {
responses := make(chan schema.OpenAIResponse, 4)
results := []map[string]any{
{
"name": "search",
"arguments": map[string]any{
"q": "hello",
},
},
}
next := emitJSONToolCallDeltas(results, 0, id, model, created, responses)
Expect(next).To(Equal(1))
out := drainChannel(responses)
Expect(out).To(HaveLen(1))
Expect(nameOf(out[0])).To(Equal("search"))
Expect(out[0].Choices[0].Delta.ToolCalls[0].FunctionCall.Arguments).
To(ContainSubstring(`"q":"hello"`))
})
It("accepts arguments already serialized as a string", func() {
responses := make(chan schema.OpenAIResponse, 4)
results := []map[string]any{
{
"name": "search",
"arguments": `{"q":"hello"}`,
},
}
emitJSONToolCallDeltas(results, 0, id, model, created, responses)
out := drainChannel(responses)
Expect(out).To(HaveLen(1))
Expect(out[0].Choices[0].Delta.ToolCalls[0].FunctionCall.Arguments).
To(Equal(`{"q":"hello"}`))
})
})
// No-regression #3: multiple tool calls (parallel tool calling).
// Both must be emitted, lastEmittedCount must end at 2.
Context("multiple complete tool calls", func() {
It("emits one chunk per tool call and bumps lastEmittedCount to len(results)", func() {
responses := make(chan schema.OpenAIResponse, 8)
results := []map[string]any{
{"name": "search", "arguments": map[string]any{"q": "a"}},
{"name": "browse", "arguments": map[string]any{"url": "b"}},
}
next := emitJSONToolCallDeltas(results, 0, id, model, created, responses)
Expect(next).To(Equal(2))
out := drainChannel(responses)
Expect(out).To(HaveLen(2))
Expect(nameOf(out[0])).To(Equal("search"))
Expect(nameOf(out[1])).To(Equal("browse"))
})
})
// The streaming-tail case: incremental chunks. First parse returns
// one complete tool call followed by a partial stub; later chunks
// complete the second tool call. We must emit the first immediately
// and the second on the later call — without ever bumping past the
// stub mid-stream.
Context("partial tail behind a real tool call", func() {
It("emits the complete entry, stops at the stub, and resumes once the tail completes", func() {
responses := make(chan schema.OpenAIResponse, 8)
// Chunk 1: one real call + a partial stub for the next.
chunk1 := []map[string]any{
{"name": "search", "arguments": map[string]any{"q": "a"}},
{"4310046988783340008": float64(1)},
}
next := emitJSONToolCallDeltas(chunk1, 0, id, model, created, responses)
Expect(next).To(Equal(1),
"must NOT advance to 2 — the stub at index 1 has no usable name")
out := drainChannel(responses)
Expect(out).To(HaveLen(1))
Expect(nameOf(out[0])).To(Equal("search"))
// Chunk 2: the stub completes into a real call.
chunk2 := []map[string]any{
{"name": "search", "arguments": map[string]any{"q": "a"}},
{"name": "browse", "arguments": map[string]any{"url": "b"}},
}
next = emitJSONToolCallDeltas(chunk2, next, id, model, created, responses)
Expect(next).To(Equal(2))
out = drainChannel(responses)
Expect(out).To(HaveLen(1))
Expect(nameOf(out[0])).To(Equal("browse"))
})
})
})

View File

@@ -577,6 +577,21 @@ func trimPotentialPartialWord(content string, format *XMLToolCallFormat, startTh
func removeHealingMarkerFromJSON(value map[string]any, marker string) map[string]any {
result := make(map[string]any)
for k, v := range value {
// Strip the healing marker from KEYS. parseJSONWithStack appends the
// marker to close a partial key (e.g. `{ "code` heals into
// `{"code<marker>":1}`); we want to preserve the prefix the model
// actually emitted. If the entire key was the marker (i.e. the input
// was just `{` heals into `{"<marker>":1}`), the truncated key is
// empty — drop the entry. Without this, downstream callers see a
// stub object with a random integer-looking key and treat it as a
// complete result, the shape that trips chat_stream_workers.go's
// streaming tool-call detector in issue #9988.
if idx := strings.Index(k, marker); idx != -1 {
k = k[:idx]
if k == "" {
continue
}
}
if str, ok := v.(string); ok {
if idx := strings.Index(str, marker); idx != -1 {
v = str[:idx]

View File

@@ -325,7 +325,17 @@ func ParseJSONIterative(s string, isPartial bool) ([]map[string]any, error) {
if jsonValue != nil {
// Convert to map[string]any if it's an object, or handle arrays
if obj, ok := jsonValue.(map[string]any); ok {
results = append(results, obj)
// Skip stub objects that healed away to nothing. Partial inputs
// like `{`, `{"`, or `{"n` go through parseJSONWithStack and
// come back as `{"<marker>":1}`; after removeHealingMarkerFromJSON
// drops the marker key the map is empty. Returning it as a
// real result trips the streaming tool-call detector
// (chat_stream_workers.go) into thinking a tool call landed,
// gating off content emission for the rest of the stream
// (issue #9988).
if !(isPartialJSON && len(obj) == 0) {
results = append(results, obj)
}
} else if arr, ok := jsonValue.([]any); ok {
// Handle arrays: extract objects from array
for _, item := range arr {

View File

@@ -1782,6 +1782,101 @@ value
// Results may be empty or contain partial data
Expect(len(results)).To(BeNumerically(">=", 0))
})
// Regression: https://github.com/mudler/LocalAI/issues/9988.
// The streaming tool-call detector calls ParseJSONIterative on each
// new content chunk. If the parser returns a stub object whose only
// key is the synthetic healing marker, the caller treats it as
// "tool call detected" and gates content emission — qwen3 with
// streaming + tools used to leak only the first two characters of
// the JSON ("{\"") to clients as a result.
// Regression: https://github.com/mudler/LocalAI/issues/9988.
// parseJSONWithStack inserts a random-integer healing marker into
// keys (and sometimes values) to make a partial input parseable.
// Those marker characters must never reach the caller — keys made
// entirely of the marker must be dropped, and a marker suffix on a
// partial key must be stripped down to the prefix the model
// actually typed. Without this the streaming worker sees garbage
// keys like `"4310046988783340008"` and mistakes the stub for a
// completed tool call, then gates off content emission.
DescribeTable("partial JSON starts must not surface healing markers in keys",
func(input string) {
parser := NewChatMsgParser(input, true)
marker := parser.HealingMarker()
results, err := ParseJSONIterative(input, true)
if err != nil {
return
}
for _, obj := range results {
for k := range obj {
Expect(k).NotTo(ContainSubstring(marker),
"healing marker leaked into key %q for input=%q (full=%+v)", k, input, obj)
Expect(k).NotTo(MatchRegexp(`^[A-Za-z]?\d{6,}$`),
"key %q looks like a synthetic numeric marker for input=%q (full=%+v)",
k, input, obj)
}
}
},
Entry("just an opening brace", `{`),
Entry("brace + quote", `{"`),
Entry("brace + partial key", `{"n`),
Entry("brace + quoted partial key", `{"na`),
Entry("brace + complete key, no value yet", `{"name"`),
Entry("brace + key + colon", `{"name":`),
Entry("brace + key + opening quote of value", `{"name":"`),
Entry("brace + partial value", `{"name":"ans`),
)
DescribeTable("partial JSON that has not yet committed a tool name must not surface a stub object",
// The streaming tool-call detector treats every entry returned
// by ParseJSONIterative as a potential new tool call. For very
// early partial inputs like `{` or `{"` there is nothing the
// caller can act on yet — returning a stub object bumps
// lastEmittedCount and gates off content emission.
// (Partial-key results like `{"n` → `{"n": 1}` are OK at the
// parser level — the streaming caller filters them by
// requiring a usable `name` field. See the streaming
// defense in chat_stream_workers.go.)
func(input string) {
results, err := ParseJSONIterative(input, true)
if err != nil {
return
}
Expect(results).To(BeEmpty(),
"ParseJSONIterative(%q) should return no results — the partial input has no anchor", input)
},
Entry("just an opening brace", `{`),
Entry("brace + quote", `{"`),
)
It("returns a clean tool call once the JSON has a real name (issue #9988)", func() {
results, err := ParseJSONIterative(`{"name":"answer","arguments":{"message":"Hi"}}`, true)
Expect(err).NotTo(HaveOccurred())
Expect(results).To(HaveLen(1))
Expect(results[0]).To(HaveKeyWithValue("name", "answer"))
for k := range results[0] {
Expect(k).NotTo(MatchRegexp(`^[A-Za-z]?\d{6,}$`),
"healing marker leaked as key %q", k)
}
})
It("strips healing-marker keys even when a real name is present (issue #9988)", func() {
// `{"name":"answer"` with no closing brace healed into a stub
// with both `name:"answer"` AND a marker-only key. The marker
// key must not surface.
parser := NewChatMsgParser(`{"name":"answer"`, true)
parser.SetHealingMarker("$marker$")
jsonValue, isPartial, _, err := parser.TryConsumeJSON()
Expect(err).NotTo(HaveOccurred())
Expect(isPartial).To(BeTrue())
obj, ok := jsonValue.(map[string]any)
Expect(ok).To(BeTrue())
Expect(obj).To(HaveKeyWithValue("name", "answer"))
for k := range obj {
Expect(k).NotTo(ContainSubstring("$marker$"),
"healing marker leaked into key %q", k)
}
})
})
Describe("Comprehensive JSON partial parsing tests (matching llama.cpp)", func() {