Skip to content

Open-source LLM knowledge platform: turn raw documents into a queryable RAG, an autonomous reasoning agent, and a self-maintaining Wiki.

5.2 KB
Raw Blame
package api

import (
	"encoding/json"
	"fmt"
	"os"
	"path/filepath"
	"strings"
	"sync"
	"time"
)

// streamRawDumpDir returns the directory for per-stream raw packet dumps.
// Enabled when WEKNORA_LLM_STREAM_RAW_DUMP_DIR is set, or when
// WEKNORA_LLM_STREAM_RAW_DUMP=1 (defaults to ~/.weknora/investigate/llm-stream).
func streamRawDumpDir() string {
	if dir := strings.TrimSpace(os.Getenv("WEKNORA_LLM_STREAM_RAW_DUMP_DIR")); dir != "" {
		return dir
	}
	v := strings.TrimSpace(os.Getenv("WEKNORA_LLM_STREAM_RAW_DUMP"))
	if v == "1" || strings.EqualFold(v, "true") || strings.EqualFold(v, "yes") {
		home, err := os.UserHomeDir()
		if err != nil {
			return ""
		}
		return filepath.Join(home, ".weknora", "investigate", "llm-stream")
	}
	return ""
}

// StreamPacketDumper writes one stream session to a dedicated JSONL file:
// line 1 = request wrapper; following lines = raw provider chunk JSON.
type StreamPacketDumper struct {
	mu    sync.Mutex
	file  *os.File
	path  string
	model string
	seq   int
}

// NewStreamPacketDumper opens a dump file for one stream, or returns nil when
// raw dumping is disabled.
func NewStreamPacketDumper(modelName string, request any) *StreamPacketDumper {
	dir := streamRawDumpDir()
	if dir == "" {
		return nil
	}
	if err := os.MkdirAll(dir, 0o755); err != nil {
		return nil
	}

	safeModel := strings.Map(func(r rune) rune {
		switch {
		case r >= 'a' && r <= 'z', r >= 'A' && r <= 'Z', r >= '0' && r <= '9', r == '-', r == '_':
			return r
		default:
			return '_'
		}
	}, modelName)
	if safeModel == "" {
		safeModel = "model"
	}

	name := fmt.Sprintf("llm_stream_%s_%s.jsonl", safeModel, time.Now().Format("20060102T150405.000000000"))
	// Defense-in-depth against path traversal: the model name is externally
	// controlled, so force the file to live directly under dir and verify the
	// cleaned path cannot escape it.
	name = filepath.Base(filepath.Clean("/" + name))
	dir = filepath.Clean(dir)
	path := filepath.Join(dir, name)
	if rel, err := filepath.Rel(dir, path); err != nil || rel != name {
		return nil
	}

	f, err := os.OpenFile(path, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0o644)
	if err != nil {
		return nil
	}

	d := &StreamPacketDumper{file: f, path: path, model: modelName}
	_ = d.writeRequest(request)
	return d
}

func (d *StreamPacketDumper) writeRequest(request any) error {
	line, err := json.Marshal(map[string]any{
		"type":      "request",
		"model":     d.model,
		"timestamp": time.Now().UTC().Format(time.RFC3339Nano),
		"data":      request,
	})
	if err != nil {
		return err
	}
	return d.writeLine(line)
}

func (d *StreamPacketDumper) writeLine(line []byte) error {
	d.mu.Lock()
	defer d.mu.Unlock()
	if _, err := d.file.Write(line); err != nil {
		return err
	}
	_, err := d.file.Write([]byte{'\n'})
	return err
}

// WritePacketRaw appends one provider chunk as a single JSONL line (valid JSON written as-is).
func (d *StreamPacketDumper) WritePacketRaw(raw []byte) {
	if d == nil || d.file == nil || len(raw) == 0 {
		return
	}
	raw = bytesTrimSpace(raw)
	if len(raw) == 0 {
		return
	}

	d.mu.Lock()
	defer d.mu.Unlock()

	d.seq++

	if json.Valid(raw) {
		_, _ = d.file.Write(raw)
		_, _ = d.file.Write([]byte{'\n'})
		return
	}

	line, _ := json.Marshal(map[string]any{
		"type":      "packet",
		"seq":       d.seq,
		"timestamp": time.Now().UTC().Format(time.RFC3339Nano),
		"data_raw":  string(raw),
	})
	_, _ = d.file.Write(line)
	_, _ = d.file.Write([]byte{'\n'})
}

// WriteError appends a terminal error record (stream read failure, API error, etc.).
func (d *StreamPacketDumper) WriteError(message string) {
	if d == nil || d.file == nil || strings.TrimSpace(message) == "" {
		return
	}
	line, err := json.Marshal(map[string]any{
		"type":      "error",
		"model":     d.model,
		"timestamp": time.Now().UTC().Format(time.RFC3339Nano),
		"message":   message,
	})
	if err != nil {
		return
	}
	_ = d.writeLine(line)
}

// WriteHTTPError appends a non-2xx HTTP response before any SSE packets.
func (d *StreamPacketDumper) WriteHTTPError(statusCode int, body []byte) {
	if d == nil || d.file == nil {
		return
	}
	entry := map[string]any{
		"type":        "http_error",
		"model":       d.model,
		"timestamp":   time.Now().UTC().Format(time.RFC3339Nano),
		"status_code": statusCode,
	}
	if len(body) > 0 {
		trimmed := bytesTrimSpace(body)
		if json.Valid(trimmed) {
			var parsed any
			if json.Unmarshal(trimmed, &parsed) == nil {
				entry["body"] = parsed
			} else {
				entry["body_raw"] = string(trimmed)
			}
		} else {
			entry["body_raw"] = string(trimmed)
		}
	}
	line, err := json.Marshal(entry)
	if err != nil {
		return
	}
	_ = d.writeLine(line)
}

// WritePacket marshals v as one JSON object per line (SDK stream Recv path).
func (d *StreamPacketDumper) WritePacket(v any) {
	if d == nil || v == nil {
		return
	}
	line, err := json.Marshal(v)
	if err != nil {
		return
	}
	d.WritePacketRaw(line)
}

// Path returns the dump file location.
func (d *StreamPacketDumper) Path() string {
	if d == nil {
		return ""
	}
	return d.path
}

// Close flushes and closes the dump file.
func (d *StreamPacketDumper) Close() {
	if d == nil || d.file == nil {
		return
	}
	_ = d.file.Close()
	d.file = nil
}

func bytesTrimSpace(b []byte) []byte {
	return []byte(strings.TrimSpace(string(b)))
}