skippy-server 0.76.1

Embedded Skippy staged runtime server
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
use crate::frontend::generation::ParsedChatMessage;
use crate::frontend::generation::PreparedGenerationPrompt;
use crate::frontend::generation::StageOpenAiBackend;
use crate::frontend::generation::chat_message_generation_value;
use crate::frontend::generation::hook_injected_text;
use crate::frontend::generation::mid_generation_window_should_fire;
use crate::frontend::generation::parsed_chat_message_from_json;
use crate::frontend::generation::request_allowed_tool_names;
use crate::frontend::generation::tool_calls_requested;
use crate::frontend::tool_emulation;
use crate::frontend::util::openai_backend_error;
use crate::kv_integration::StagePrefixCachePayload;
use openai_frontend::ChatCompletionRequest;
use openai_frontend::GenerationHookSignals;
use openai_frontend::OpenAiError;
use openai_frontend::OpenAiResult;
use openai_frontend::PrefillHookSignals;
use openai_frontend::apply_chat_hook_outcome;
use openai_frontend::chat_mesh_hooks_enabled;
use serde_json::Value;
use skippy_runtime::ChatTemplateJsonOptions;
use skippy_runtime::ChatTemplateOptions;
use skippy_runtime::GenerationSignalWindow;
use skippy_runtime::MediaInput;
use skippy_runtime::TokenSignal;
use tokio::task;

/// Output of a single chat-template application, before it is folded into a
/// [`PreparedGenerationPrompt`].
struct RenderedChatPrompt {
    prompt: String,
    media: Vec<MediaInput>,
    metadata_json: String,
}

impl StageOpenAiBackend {
    /// Offload [`Self::prepare_chat_prompt`] to a blocking thread.
    ///
    /// Template rendering takes the runtime mutex and runs the template
    /// engine synchronously (FFI). Under a connect burst (e.g. a c256
    /// benchmark wave) running that on tokio workers starves the accept
    /// task: every worker blocks on the mutex or renders while SYNs pile
    /// up behind the listen backlog. Moving it to the blocking pool keeps
    /// the async workers (and therefore the accept loop) responsive. This
    /// mirrors the `spawn_blocking` already used for prompt tokenization.
    pub(super) async fn prepare_chat_prompt_offloaded(
        &self,
        request: &ChatCompletionRequest,
        options: ChatTemplateOptions,
    ) -> OpenAiResult<PreparedGenerationPrompt> {
        let backend = self.clone();
        let request = request.clone();
        task::spawn_blocking(move || backend.prepare_chat_prompt(&request, options))
            .await
            .map_err(|error| {
                OpenAiError::backend(format!("chat prompt preparation task failed: {error}"))
            })?
    }

    pub(super) fn prepare_chat_prompt(
        &self,
        request: &ChatCompletionRequest,
        options: ChatTemplateOptions,
    ) -> OpenAiResult<PreparedGenerationPrompt> {
        let marker = {
            let runtime = self
                .runtime
                .lock()
                .map_err(|_| OpenAiError::backend("runtime lock poisoned"))?;
            runtime.media_marker()
        };

        // Native path: render with tools and use the template's own metadata.
        let native = self.render_chat_prompt(request, &options, &marker, None, true)?;

        // If the request carries tools but the template does not support native
        // tool calling, re-render with server-side tool-call emulation: strip
        // tools, inject a text-convention instruction, and rewrite history so
        // the template never sees tool roles. Tool-capable templates keep the
        // native prompt unchanged.
        if tool_calls_requested(request)
            && tool_emulation::should_emulate_tool_calls(&native.metadata_json)
            && let Some(tools) = request.tools.as_ref()
            && let Some(instruction) = tool_emulation::build_emulation_instruction(tools)
        {
            let rewritten =
                tool_emulation::rewrite_history_for_emulation(&request.messages, &instruction);
            let emulated =
                self.render_chat_prompt(request, &options, &marker, Some(&rewritten), false)?;
            let recurrent_cache_prefix_text = if self
                .kv
                .as_ref()
                .is_some_and(|kv| kv.payload == StagePrefixCachePayload::KvRecurrent)
                && emulated.media.is_empty()
                && options.add_assistant
            {
                let mut prefix_options = options.clone();
                prefix_options.add_assistant = false;
                self.render_chat_prompt(request, &prefix_options, &marker, Some(&rewritten), false)
                    .ok()
                    .map(|rendered| rendered.prompt)
            } else {
                None
            };
            return Ok(PreparedGenerationPrompt {
                text: emulated.prompt,
                media: emulated.media,
                chat_parse_metadata: Some(emulated.metadata_json),
                recurrent_cache_prefix_text,
            });
        }

        let recurrent_cache_prefix_text = if self
            .kv
            .as_ref()
            .is_some_and(|kv| kv.payload == StagePrefixCachePayload::KvRecurrent)
            && native.media.is_empty()
            && options.add_assistant
        {
            let mut prefix_options = options.clone();
            prefix_options.add_assistant = false;
            self.render_chat_prompt(request, &prefix_options, &marker, None, true)
                .ok()
                .map(|rendered| rendered.prompt)
        } else {
            None
        };
        Ok(PreparedGenerationPrompt {
            text: native.prompt,
            media: native.media,
            chat_parse_metadata: Some(native.metadata_json),
            recurrent_cache_prefix_text,
        })
    }

    /// Applies the chat template for the given messages. When `messages` is
    /// `None`, the request's own messages are used. When `include_tools` is
    /// false, `tools`/`tool_choice` are omitted (used by the emulation path).
    fn render_chat_prompt(
        &self,
        request: &ChatCompletionRequest,
        options: &ChatTemplateOptions,
        marker: &str,
        messages: Option<&[openai_frontend::ChatMessage]>,
        include_tools: bool,
    ) -> OpenAiResult<RenderedChatPrompt> {
        let source_messages = messages.unwrap_or(&request.messages);
        let mut media = Vec::new();
        let template_messages = source_messages
            .iter()
            .map(|message| chat_message_generation_value(message, marker, &mut media))
            .collect::<OpenAiResult<Vec<_>>>()?;
        let messages_json = serde_json::to_string(&template_messages).map_err(|error| {
            OpenAiError::invalid_request(format!("serialize messages: {error}"))
        })?;
        let tools_json = if include_tools {
            request
                .tools
                .as_ref()
                .map(serde_json::to_string)
                .transpose()
                .map_err(|error| {
                    OpenAiError::invalid_request(format!("serialize tools: {error}"))
                })?
        } else {
            None
        };
        let tool_choice_json = if include_tools {
            request
                .tool_choice
                .as_ref()
                .map(serde_json::to_string)
                .transpose()
                .map_err(|error| {
                    OpenAiError::invalid_request(format!("serialize tool_choice: {error}"))
                })?
        } else {
            None
        };
        // Short-lock reader pattern: clone the immutable reader and run the
        // template FFI on it, so template rendering never waits behind
        // decode's hold of the runtime mutex (and vice versa).
        let reader = self
            .runtime
            .lock()
            .map_err(|_| OpenAiError::backend("runtime lock poisoned"))?
            .model
            .reader();
        let result = reader
            .apply_chat_template_json(
                &messages_json,
                ChatTemplateJsonOptions {
                    add_assistant: options.add_assistant,
                    enable_thinking: options.enable_thinking,
                    reasoning_format: options.reasoning_format,
                    chat_template_kwargs: options.chat_template_kwargs.clone(),
                    tools_json,
                    tool_choice_json,
                    parallel_tool_calls: request.parallel_tool_calls.unwrap_or(true),
                    chat_template: options.chat_template.clone(),
                    use_jinja: options.use_jinja,
                    grammar: options.grammar.clone(),
                    json_schema: options.json_schema.clone(),
                    skip_chat_parsing: options.skip_chat_parsing,
                },
            )
            .map_err(openai_backend_error)?;
        Ok(RenderedChatPrompt {
            prompt: result.prompt,
            media,
            metadata_json: result.metadata_json,
        })
    }

    pub(super) fn parse_chat_output(
        &self,
        text: &str,
        request: &ChatCompletionRequest,
        metadata: Option<&str>,
        is_partial: bool,
    ) -> OpenAiResult<Option<ParsedChatMessage>> {
        let Some(metadata) = metadata else {
            return Ok(None);
        };
        if serde_json::from_str::<Value>(metadata)
            .ok()
            .and_then(|value| value.get("skip_chat_parsing").and_then(Value::as_bool))
            .unwrap_or(false)
        {
            return Ok(Some(ParsedChatMessage {
                content: Some(text.to_string()),
                reasoning_content: None,
                tool_calls: None,
            }));
        }

        let model = self
            .runtime
            .lock()
            .map_err(|_| OpenAiError::backend("runtime lock poisoned"))?
            .model
            .reader();
        self.parse_chat_output_with_reader(&model, text, request, metadata, is_partial)
    }

    pub(super) fn parse_chat_output_with_reader(
        &self,
        model: &skippy_runtime::StageModelReader,
        text: &str,
        request: &ChatCompletionRequest,
        metadata: &str,
        is_partial: bool,
    ) -> OpenAiResult<Option<ParsedChatMessage>> {
        // Emulation path: when tools were requested but the prompt was rendered
        // without native tool support, the model emitted TOOL_CALL text lines.
        // Parse those into OpenAI tool_calls instead of using the native parser.
        if tool_calls_requested(request)
            && !tool_emulation::template_supports_native_tool_calls(metadata)
        {
            return Ok(parse_emulated_chat_output(text, request, is_partial));
        }

        let parsed_json = model
            .parse_chat_response_json(text, metadata, is_partial)
            .map_err(openai_backend_error)?;
        Ok(parsed_chat_message_from_json(&parsed_json, request))
    }

    pub(super) fn tokenize(&self, prompt: &str) -> OpenAiResult<Vec<i32>> {
        self.tokenize_with_options(prompt, true)
    }

    pub(super) fn tokenize_continuation(&self, text: &str) -> OpenAiResult<Vec<i32>> {
        self.tokenize_with_options(text, false)
    }

    pub(super) fn tokenize_with_options(
        &self,
        text: &str,
        add_special: bool,
    ) -> OpenAiResult<Vec<i32>> {
        // Hold the inference mutex only long enough to clone the immutable
        // reader; the tokenizer FFI runs on the reader, so decode can hold
        // the runtime lock concurrently without serializing tokenization
        // behind it (see render_chat_prompt for the same pattern).
        let reader = self
            .runtime
            .lock()
            .map_err(|_| OpenAiError::backend("runtime lock poisoned"))?
            .model
            .reader();
        reader
            .tokenize(text, add_special)
            .map_err(openai_backend_error)
    }

    pub(super) fn inject_hook_text_into_session(
        &self,
        session_id: &str,
        text: &str,
    ) -> OpenAiResult<Option<i32>> {
        let token_ids = self.tokenize_continuation(text)?;
        if token_ids.is_empty() {
            return Ok(None);
        }
        if token_ids.len() > 1 {
            let mut runtime = self
                .runtime
                .lock()
                .map_err(|_| OpenAiError::backend("runtime lock poisoned"))?;
            runtime
                .prefill(session_id, &token_ids[..token_ids.len() - 1])
                .map_err(openai_backend_error)?;
        }
        Ok(token_ids.last().copied())
    }

    #[allow(clippy::too_many_arguments)]
    pub(super) fn maybe_run_generation_hooks(
        &self,
        session_id: &str,
        hook_request: &mut Option<ChatCompletionRequest>,
        hook_runtime: Option<&tokio::runtime::Handle>,
        decoded_tokens: usize,
        post_prefill_hook_checked: &mut bool,
        last_mid_generation_hook_at: &mut Option<usize>,
        token_signal: Option<TokenSignal>,
        signal_window: Option<GenerationSignalWindow>,
    ) -> OpenAiResult<Option<i32>> {
        let Some(hooks) = self.hook_policy.as_ref() else {
            return Ok(None);
        };
        let Some(handle) = hook_runtime else {
            return Ok(None);
        };
        let Some(request) = hook_request.as_mut() else {
            return Ok(None);
        };
        if !chat_mesh_hooks_enabled(request) {
            return Ok(None);
        }

        if !*post_prefill_hook_checked {
            *post_prefill_hook_checked = true;
            if let Some(signal) = token_signal {
                let signals = PrefillHookSignals {
                    first_token_entropy: f64::from(signal.entropy),
                    first_token_margin: f64::from(signal.margin),
                };
                let outcome = handle.block_on(hooks.after_prefill(request, signals))?;
                apply_chat_hook_outcome(request, &outcome);
                if let Some(text) = hook_injected_text(&outcome) {
                    return self.inject_hook_text_into_session(session_id, &text);
                }
            }
        }

        let Some(window) = signal_window else {
            return Ok(None);
        };
        if !mid_generation_window_should_fire(decoded_tokens, last_mid_generation_hook_at, &window)
        {
            return Ok(None);
        }

        let signals = GenerationHookSignals {
            n_decoded: i64::try_from(decoded_tokens).unwrap_or(i64::MAX),
            window_tokens: window.token_count,
            mean_entropy: f64::from(window.mean_entropy),
            max_entropy: f64::from(window.max_entropy),
            mean_margin: f64::from(window.mean_margin),
            min_margin: f64::from(window.min_margin),
            high_entropy_count: window.high_entropy_count,
            repetition_count: window.repetition_count,
        };
        let outcome = handle.block_on(hooks.mid_generation(request, signals))?;
        *last_mid_generation_hook_at = Some(decoded_tokens);
        apply_chat_hook_outcome(request, &outcome);
        if let Some(text) = hook_injected_text(&outcome) {
            return self.inject_hook_text_into_session(session_id, &text);
        }
        Ok(None)
    }

    pub(super) fn generation_hooks_active(
        &self,
        hook_request: &Option<ChatCompletionRequest>,
        hook_runtime: Option<&tokio::runtime::Handle>,
    ) -> bool {
        self.hook_policy.is_some()
            && hook_runtime.is_some()
            && hook_request.as_ref().is_some_and(chat_mesh_hooks_enabled)
    }
}

/// Parses generated text produced under tool-call emulation into a
/// [`ParsedChatMessage`]. During streaming (`is_partial`) the trailing
/// incomplete line is held back and tool calls are withheld, so a half-formed
/// `TOOL_CALL` marker is never streamed as content and calls are emitted once,
/// on finalization.
///
/// Unlike the native path, emulated tool calls are therefore *not* streamed
/// incrementally. The emulated parser only recognises a call once its JSON
/// object closes (`tool_emulation::parse_emulated_tool_calls`), so it has no
/// representation of a partially generated argument object to stream from;
/// streaming it needs a partial-JSON scanner, not a change to this gate.
pub(super) fn parse_emulated_chat_output(
    text: &str,
    request: &ChatCompletionRequest,
    is_partial: bool,
) -> Option<ParsedChatMessage> {
    let allowed = request_allowed_tool_names(request);
    let partial_scan = is_partial.then(|| tool_emulation::partial_emulation_text(text));
    let scan_text = partial_scan.as_deref().unwrap_or(text);
    let parse = tool_emulation::parse_emulated_tool_calls(scan_text, &allowed);
    let tool_calls = if is_partial || parse.tool_calls.is_empty() {
        None
    } else {
        let mut calls = parse.tool_calls;
        if request.parallel_tool_calls == Some(false) {
            calls.truncate(1);
        }
        openai_frontend::ensure_tool_call_ids(&mut calls);
        Some(Value::Array(calls))
    };
    Some(ParsedChatMessage {
        content: parse.content,
        reasoning_content: None,
        tool_calls,
    })
}