Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

37.9 KB
Raw Blame
//
//  Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
//

// Unit tests for the Tokenizer component that do NOT depend on the C++ RAG
// Analyzer pool. These run under plain `go test` (no -tags integration).
// Pool-dependent tests live in tokenizer_test.go (//go:build integration).

package component

import (
	"context"
	"encoding/json"
	"os"
	"reflect"
	"strconv"
	"strings"
	"sync/atomic"
	"testing"
	"time"

	"ragflow/internal/agent/runtime"
	"ragflow/internal/entity/models"
	"ragflow/internal/ingestion/component/schema"
	"ragflow/internal/tokenizer"
)

// stubEmbedder records every call and returns canned vectors.
// Matches the Embedder contract: len(results) == len(texts).
type stubEmbedder struct {
	calls         atomic.Int32
	dim           int
	maxTokens     int
	delay         time.Duration
	err           error
	callInputs    [][]string
	resultsByCall []embeddingCallResult
	callTokens    []int
}

type embeddingCallResult struct {
	vectors    [][]float64
	tokenCount int
}

func (s *stubEmbedder) MaxTokens() int {
	return s.maxTokens
}

func (s *stubEmbedder) BatchSize() int {
	if v := os.Getenv("TOKENIZER_EMBEDDING_BATCH_SIZE"); v != "" {
		if n, err := strconv.Atoi(v); err == nil && n > 0 {
			return n
		}
	}
	return 16
}

func (s *stubEmbedder) Encode(ctx context.Context, texts []string) ([]EmbeddingResult, error) {
	s.calls.Add(1)
	copied := append([]string(nil), texts...)
	s.callInputs = append(s.callInputs, copied)
	if s.delay > 0 {
		time.Sleep(s.delay)
	}
	if s.err != nil {
		return nil, s.err
	}
	callIdx := int(s.calls.Load()) - 1
	var cfg embeddingCallResult
	if callIdx < len(s.resultsByCall) {
		cfg = s.resultsByCall[callIdx]
	}
	out := make([]EmbeddingResult, len(texts))
	for i := range texts {
		var v []float64
		if i < len(cfg.vectors) {
			v = append([]float64(nil), cfg.vectors[i]...)
		} else {
			v = make([]float64, s.dim)
			v[0] = float64(i + 1)
		}
		tokenCount := len(texts[i])
		if callIdx < len(s.callTokens) {
			tokenCount = s.callTokens[callIdx]
		} else if cfg.tokenCount > 0 {
			tokenCount = cfg.tokenCount
		}
		out[i] = EmbeddingResult{Vector: v, TokenCount: tokenCount}
	}
	return out, nil
}

// newStubEmbedder returns a stub embedder for instance-level resolver injection.
// maxTokens defaults to 2048 so truncateForEmbedding truncates to the first
// 2048 tokens; tests that exercise truncation set maxTokens explicitly.
func newStubEmbedder(dim int) *stubEmbedder {
	return &stubEmbedder{dim: dim, maxTokens: 2048}
}

// withStubEmbedder constructs a TokenizerComponent with an instance-scoped
// stub embedder resolver. The component uses the default search_method
// (["full_text","embedding"]); callers that need a different mode construct
// the component directly via NewTokenizerComponent(NewTokenizerComponentWithResolver).
func withStubEmbedder(t *testing.T, dim int) (*TokenizerComponent, *stubEmbedder) {
	// Non-empty: the per-chunk cache is skipped unless the dataset reports an
	// embd_id, so an empty value here would silently disable the cache.
	embdID := "embd-test"
	return withStubEmbedderEmbdID(t, dim, &embdID)
}

// withStubEmbedderEmbdID builds a TokenizerComponent whose resolver reports the
// value pointed to by embdID at call time. The per-chunk embedding cache keys on
// that id, so mutating *embdID between two embedChunks passes models "the
// dataset's embedding model was rebound" — the two passes must then share no
// cache entry, which is exactly what a stale vector would otherwise cause.
func withStubEmbedderEmbdID(t *testing.T, dim int, embdID *string) (*TokenizerComponent, *stubEmbedder) {
	t.Helper()
	stub := newStubEmbedder(dim)
	comp, err := NewTokenizerComponentWithResolver(nil, func(ctx context.Context, _, _ string) (Embedder, string, error) {
		return stub, *embdID, nil
	})
	if err != nil {
		t.Fatalf("NewTokenizerComponentWithResolver: %v", err)
	}
	return comp.(*TokenizerComponent), stub
}

// TestTokenizerComponent_Registered verifies init() enrollment
// under runtime.CategoryIngestion (Phase 4 / API endpoint depends
// on this contract).
func TestTokenizerComponent_Registered(t *testing.T) {
	factory, cat, md, ok := runtime.DefaultRegistry.Lookup("Tokenizer")
	if !ok {
		t.Fatal("Tokenizer not registered in runtime.DefaultRegistry")
	}
	if cat != runtime.CategoryIngestion {
		t.Errorf("category = %q, want %q", cat, runtime.CategoryIngestion)
	}
	if factory == nil {
		t.Error("factory is nil")
	}
	if len(md.Inputs) == 0 {
		t.Error("metadata.Inputs empty")
	}
	if len(md.Outputs) == 0 {
		t.Error("metadata.Outputs empty")
	}
}

// TestTokenizerComponent_Invoke_EmptyChunks covers the no-op branch:
// empty chunk list -> empty output, no panic, no encoder call.
func TestTokenizerComponent_Invoke_EmptyChunks(t *testing.T) {
	c, stub := withStubEmbedder(t, 4)
	_ = stub

	out, err := c.Invoke(t.Context(), nil, map[string]any{
		"kb_id":         "kb-1",
		"output_format": "chunks",
		"chunks":        []map[string]any{},
	})
	if err != nil {
		t.Fatalf("Invoke: %v", err)
	}
	chunks, ok := schema.ChunkCarrierToMaps(out["chunks"])
	if !ok {
		t.Fatalf("chunks carrier missing or invalid: %v", out["chunks"])
	}
	if len(chunks) != 0 {
		t.Errorf("chunks len = %d, want 0", len(chunks))
	}
	if stub.calls.Load() != 0 {
		t.Errorf("embedder called %d times on empty input, want 0", stub.calls.Load())
	}
	if got := out["embedding_token_consumption"]; got != 0 {
		t.Errorf("embedding_token_consumption = %v, want 0", got)
	}
	if out["output_format"] != "chunks" {
		t.Errorf("output_format = %v, want chunks", out["output_format"])
	}
}

// TestTokenizerComponent_Invoke_NilChunks covers the nil-input
// branch: nil chunks list is treated as zero-length (matches
// python `kwargs.get("chunks")` with None).
func TestTokenizerComponent_Invoke_NilChunks(t *testing.T) {
	c, stub := withStubEmbedder(t, 4)
	_ = stub
	out, err := c.Invoke(t.Context(), nil, map[string]any{
		"output_format": "chunks",
	})
	if err != nil {
		t.Fatalf("Invoke: %v", err)
	}
	chunks, ok := schema.ChunkCarrierToMaps(out["chunks"])
	if !ok {
		t.Fatalf("chunks carrier missing or invalid: %v", out["chunks"])
	}
	if len(chunks) != 0 {
		t.Errorf("chunks len = %d, want 0", len(chunks))
	}
}

func TestTokenizerComponent_Invoke_EmbeddingOnly(t *testing.T) {
	cIntf, err := NewTokenizerComponentWithResolver(map[string]any{
		"search_method": []any{"embedding"},
	}, func(ctx context.Context, _, _ string) (Embedder, string, error) {
		return newStubEmbedder(4), "", nil
	})
	if err != nil {
		t.Fatalf("NewTokenizerComponentWithResolver: %v", err)
	}
	out, err := cIntf.(*TokenizerComponent).Invoke(t.Context(), nil, map[string]any{
		"name":          "doc.pdf",
		"kb_id":         "kb-1",
		"output_format": "chunks",
		"chunks":        []map[string]any{{"text": "alpha bravo"}},
	})
	if err != nil {
		t.Fatalf("Invoke: %v", err)
	}
	got, _ := schema.ChunkCarrierToMaps(out["chunks"])
	if len(got) != 1 {
		t.Fatalf("chunks len = %d, want 1", len(got))
	}
	if got[0]["q_4_vec"] == nil {
		t.Fatalf("q_4_vec missing: %v", got[0])
	}
	if got[0]["content_ltks"] != nil || got[0]["content_sm_ltks"] != nil {
		t.Fatalf("embedding-only mode should not emit full-text tokens: %v", got[0])
	}
	if out["embedding_token_consumption"] == nil {
		t.Fatal("embedding_token_consumption missing")
	}
}

func TestTokenizerComponent_FullTextIncludesMediaContext(t *testing.T) {
	tokenizer.SetEngineType("infinity")
	defer tokenizer.SetEngineType("")

	comp, err := NewTokenizerComponent(map[string]any{
		"search_method": []any{"full_text"},
	})
	if err != nil {
		t.Fatalf("NewTokenizerComponent: %v", err)
	}
	out, err := comp.(*TokenizerComponent).Invoke(t.Context(), nil, map[string]any{
		"name":          "report.pdf",
		"output_format": "chunks",
		"chunks": []map[string]any{
			{
				"text":          "table body",
				"context_above": "above ",
				"context_below": " below",
			},
		},
	})
	if err != nil {
		t.Fatalf("Invoke: %v", err)
	}
	chunks, _ := schema.ChunkCarrierToMaps(out["chunks"])
	if got := chunks[0]["content_ltks"]; got != "above table body below" {
		t.Fatalf("content_ltks = %q, want contextual text", got)
	}
	if got := chunks[0]["content_sm_ltks"]; got != "above table body below" {
		t.Fatalf("content_sm_ltks = %q, want contextual text", got)
	}
}

func TestTokenizerComponent_EmbeddingIncludesMediaContext(t *testing.T) {
	stub := newStubEmbedder(3)
	comp, err := NewTokenizerComponentWithResolver(
		map[string]any{"search_method": []any{"embedding"}},
		func(context.Context, string, string) (Embedder, string, error) {
			return stub, "", nil
		},
	)
	if err != nil {
		t.Fatalf("NewTokenizerComponentWithResolver: %v", err)
	}
	_, err = comp.(*TokenizerComponent).Invoke(t.Context(), nil, map[string]any{
		"output_format": "chunks",
		"chunks": []map[string]any{{
			"text":          "table body",
			"context_above": "above ",
			"context_below": " below",
		}},
		"kb_id": "kb-1",
	})
	if err != nil {
		t.Fatalf("Invoke: %v", err)
	}
	if len(stub.callInputs) != 1 || len(stub.callInputs[0]) != 1 {
		t.Fatalf("embedder calls = %#v, want one content input", stub.callInputs)
	}
	if got := stub.callInputs[0][0]; got != "above table body below" {
		t.Fatalf("embedding input = %q, want contextual text", got)
	}
}

// TestTokenizerComponent_Embedding_ZeroChunksStillEmitsConsumptionZero uses an
// empty chunk list, so tokenizeChunks is a no-op and the C++ pool is not needed.
func TestTokenizerComponent_Embedding_ZeroChunksStillEmitsConsumptionZero(t *testing.T) {
	c, stub := withStubEmbedder(t, 2)
	out, err := c.Invoke(t.Context(), nil, map[string]any{
		"name":          "doc.pdf",
		"kb_id":         "kb-1",
		"output_format": "chunks",
		"chunks":        []map[string]any{},
	})
	if err != nil {
		t.Fatalf("Invoke: %v", err)
	}
	if got := stub.calls.Load(); got != 0 {
		t.Fatalf("embedder calls = %d, want 0", got)
	}
	if got := out["embedding_token_consumption"]; got != 0 {
		t.Fatalf("embedding_token_consumption = %v, want 0", got)
	}
}

// TestTokenizerComponent_InputsOutputs_NonEmpty verifies Phase 4
// API metadata shape.
func TestTokenizerComponent_InputsOutputs_NonEmpty(t *testing.T) {
	c, _ := NewTokenizerComponent(map[string]any{})
	ins := c.(*TokenizerComponent).Inputs()
	outs := c.(*TokenizerComponent).Outputs()
	if len(ins) == 0 {
		t.Error("Inputs() empty")
	}
	if len(outs) == 0 {
		t.Error("Outputs() empty")
	}
	for _, key := range []string{"chunks", "output_format"} {
		if _, ok := outs[key]; !ok {
			t.Errorf("Outputs() missing %q", key)
		}
	}
	for _, key := range []string{"chunks", "name"} {
		if _, ok := ins[key]; !ok {
			t.Errorf("Inputs() missing %q", key)
		}
	}
}

func TestCopyPipelineControlValuesPreservesWikiActiveState(t *testing.T) {
	states := []map[string]any{{"key": "state-1", "payload": `{"plan":[]}`}}
	output := map[string]any{"chunks": []any{}}
	copyPipelineControlValues(output, map[string]any{"wiki_active_map_states": states})
	if !reflect.DeepEqual(output["wiki_active_map_states"], states) {
		t.Fatalf("wiki active states = %#v, want %#v", output["wiki_active_map_states"], states)
	}
}

// TestTokenizerComponent_NewTokenizerComponent_Defaults verifies
// the Python default param values propagate.
func TestTokenizerComponent_NewTokenizerComponent_Defaults(t *testing.T) {
	c, err := NewTokenizerComponent(nil)
	if err != nil {
		t.Fatalf("NewTokenizerComponent(nil): %v", err)
	}
	tc := c.(*TokenizerComponent)
	if tc.param.FilenameEmbdWeight != 0.1 {
		t.Errorf("filename_embd_weight = %v, want 0.1", tc.param.FilenameEmbdWeight)
	}
	if len(tc.param.Fields) != 1 || tc.param.Fields[0] != "text" {
		t.Errorf("fields = %v, want [text]", tc.param.Fields)
	}
	if len(tc.param.SearchMethod) != 2 {
		t.Errorf("search_method len = %d, want 2", len(tc.param.SearchMethod))
	}
}

// TestTokenizerComponent_NewTokenizerComponent_FieldsReplaceDefault
// verifies that a caller-supplied fields value is the full set, not an
// addition to the ["text"] default, and that an empty value keeps it.
func TestTokenizerComponent_NewTokenizerComponent_FieldsReplaceDefault(t *testing.T) {
	cases := []struct {
		name   string
		fields any
		want   []string
	}{
		{name: "string", fields: "summary", want: []string{"summary"}},
		{name: "string slice", fields: []string{"text"}, want: []string{"text"}},
		{name: "any slice", fields: []any{"keywords", "summary"}, want: []string{"keywords", "summary"}},
		{name: "empty string slice", fields: []string{}, want: []string{"text"}},
		{name: "empty any slice", fields: []any{}, want: []string{"text"}},
		{name: "blank string", fields: "", want: []string{"text"}},
		{name: "blank entries dropped", fields: []any{"keywords", ""}, want: []string{"keywords"}},
		{name: "whitespace string", fields: "   ", want: []string{"text"}},
		{name: "whitespace trimmed", fields: []string{" summary ", "  "}, want: []string{"summary"}},
	}
	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {
			c, err := NewTokenizerComponent(map[string]any{"fields": tc.fields})
			if err != nil {
				t.Fatalf("NewTokenizerComponent: %v", err)
			}
			got := c.(*TokenizerComponent).param.Fields
			if !reflect.DeepEqual(got, tc.want) {
				t.Fatalf("fields = %v, want %v", got, tc.want)
			}
		})
	}
}

// TestTokenizerComponent_NewTokenizerComponent_BadParam covers
// the param-validation branch (invalid search_method value).
func TestTokenizerComponent_NewTokenizerComponent_BadParam(t *testing.T) {
	_, err := NewTokenizerComponent(map[string]any{
		"search_method": []any{"unknown"},
	})
	if err == nil {
		t.Fatal("expected param validation error, got nil")
	}
}

func TestValidateTokenizerOutputs_FullTextMissingReturnsError(t *testing.T) {
	err := validateTokenizerOutputs([]schema.ChunkDoc{{Text: "alpha"}}, []string{"full_text"}, []string{"text"}, "")
	if err == nil || !strings.Contains(err.Error(), "missing full_text tokens") {
		t.Fatalf("err = %v, want missing full_text tokens", err)
	}
}

func TestValidateTokenizerOutputs_EmbeddingMissingReturnsError(t *testing.T) {
	err := validateTokenizerOutputs([]schema.ChunkDoc{{Text: "alpha"}}, []string{"embedding"}, []string{"text"}, "kb-1")
	if err == nil || !strings.Contains(err.Error(), "missing embedding vector") {
		t.Fatalf("err = %v, want missing embedding vector", err)
	}
}

func TestValidateTokenizerOutputs_BothModesFailWhenOneMissing(t *testing.T) {
	ck := schema.ChunkDoc{Text: "alpha", ContentLtks: "tok", ContentSmLtks: "sm"}
	err := validateTokenizerOutputs([]schema.ChunkDoc{ck}, []string{"full_text", "embedding"}, []string{"text"}, "kb-1")
	if err == nil || !strings.Contains(err.Error(), "missing embedding vector") {
		t.Fatalf("err = %v, want missing embedding vector", err)
	}
}

func TestValidateTokenizerOutputs_SymbolOnlyContentLtksIsEmptyFails(t *testing.T) {
	// Simulates a chunk whose Text is a symbol/punctuation character that
	// the C++ RAGAnalyzer tokenizer cannot produce tokens for (e.g. "·", ")", "(").
	// After tokenizeChunks runs, ContentLtks and ContentSmLtks remain empty,
	// and validateTokenizerOutputs must detect this as a failure.
	ck := schema.ChunkDoc{
		Text:          ")",
		ContentLtks:   "",
		ContentSmLtks: "",
	}
	err := validateTokenizerOutputs([]schema.ChunkDoc{ck}, []string{"full_text"}, []string{"text"}, "")
	if err == nil || !strings.Contains(err.Error(), "missing full_text tokens") {
		t.Fatalf("err = %v, want missing full_text tokens", err)
	}
}

// TestChunkDocsToMaps_PreservesPDFPositions is the pool-free unit test for
// Tokenizer-(T)1: the tokenizer emits chunks via schema.ChunkDocsToMaps
// (ChunkDoc.ToMap), which must carry the raw `positions` / `_pdf_positions`
// through untouched so the downstream executor stage
// (internal/ingestion/task processChunkPositions → addPDFPositions) can convert
// them into position_int / page_num_int / top_int exactly once. This does NOT
// require the C++ analyzer pool, so it runs under plain `go test`.
func TestChunkDocsToMaps_PreservesPDFPositions(t *testing.T) {
	pos := json.RawMessage(`[[1,10,20,30,40],[2,15,25,35,45]]`)
	chunks := []schema.ChunkDoc{
		{Text: "PDF paragraph", DocType: "text",
			Positions: pos, PDFPositions: pos},
	}
	maps := schema.ChunkDocsToMaps(chunks)

	got, ok := maps[0]["positions"].([][]float64)
	if !ok || len(got) != 2 {
		t.Fatalf("positions not preserved through tokenizer output mapping: %#v", maps[0]["positions"])
	}
	if _, ok := maps[0]["_pdf_positions"].([][]float64); !ok {
		t.Errorf("_pdf_positions not preserved through tokenizer output mapping: %#v", maps[0]["_pdf_positions"])
	}
	// Sanity: page numbers are still raw 1-indexed, i.e. not yet converted
	// to page_num_int (the executor owns that step).
	if int(got[0][0]) != 1 {
		t.Errorf("positions page already converted; want raw 1-indexed page 1, got %v", got[0][0])
	}
}

// TestTruncateForEmbedding_SmallMaxTokens covers Tokenizer Diff-14. For any
// positive maxTokens, truncateForEmbedding keeps the first maxTokens tokens
// (non-empty) and the result is strictly shorter than the input.
//
// The unconfigured case (maxTokens <= 0) is covered separately by
// TestTruncateForEmbedding_UnconfiguredClampsToDefault: rather than mirroring
// Python's `truncate` (which returns "" for max_len <= 0 and would make the
// embeddings API reject the batch), Go clamps the limit to a safe default so
// every path still truncates instead of passing the full text through.
func TestTruncateForEmbedding_SmallMaxTokens(t *testing.T) {
	// Long enough to produce well over 50 tokens, so 5/10/50 are all clearly
	// below the total and truncation is observable.
	long := strings.Repeat("a", 2000)
	if got := truncateForEmbedding(long, 5); got == "" {
		t.Error("truncateForEmbedding(maxTokens=5) returned empty, want first 5 tokens")
	}
	if got := truncateForEmbedding(long, 10); got == "" {
		t.Error("truncateForEmbedding(maxTokens=10) returned empty, want first 10 tokens")
	}
	// Normal path: maxTokens > 10 should truncate (not return empty).
	if got := truncateForEmbedding(long, 50); got == "" {
		t.Error("truncateForEmbedding(maxTokens=50) returned empty, want truncated text")
	}
	if got := truncateForEmbedding(long, 50); len(got) >= len(long) {
		t.Errorf("truncateForEmbedding(maxTokens=50) len = %d, want strictly shorter than %d", len(got), len(long))
	}
}

// TestTruncateForEmbedding_UnconfiguredClampsToDefault is the regression gate
// for the root cause behind embedding truncation: an embedder that reports no
// token limit (maxTokens <= 0) must NOT be passed through verbatim. Before the
// central clamp, the generic model_service branch left maxTokens = 0, which
// silently disabled truncation for the whole generic path. The fix clamps
// maxTokens <= 0 to defaultEmbeddingTokenLimit (8192) inside
// truncateForEmbedding itself, so every caller — Builtin and generic alike —
// keeps truncation active.
//
// For a clearly-over-limit input and maxTokens = 0, the result must be non-empty
// AND strictly shorter than the input: proof that it was truncated to the
// default, not returned verbatim.
func TestTruncateForEmbedding_UnconfiguredClampsToDefault(t *testing.T) {
	// ~10000+ CL100K tokens, comfortably above the 8192 default so truncation
	// is observable.
	long := strings.Repeat("hello world ", 5000)
	got := truncateForEmbedding(long, 0)
	if got == "" {
		t.Fatal("truncateForEmbedding(maxTokens=0) returned empty; clamp must keep truncation active")
	}
	if len(got) >= len(long) {
		t.Errorf("truncateForEmbedding(maxTokens=0) len = %d, want strictly shorter than %d; clamp to default must truncate",
			len(got), len(long))
	}
}

// TestEmbeddingBatchSizeEnvVar covers Tokenizer Omission-3: the batch size
// must be configurable via TOKENIZER_EMBEDDING_BATCH_SIZE env var, matching
// Python's configurable settings.EMBEDDING_BATCH_SIZE. The resolved batch size
// is now provided by models.GetEmbeddingBatchSize (env override -> provider
// capability -> default), surfaced through Embedder.BatchSize().
func TestEmbeddingBatchSizeEnvVar(t *testing.T) {
	if got := models.GetEmbeddingBatchSize(""); got != models.DefaultEmbeddingBatchSize {
		t.Errorf("GetEmbeddingBatchSize() default = %d, want %d", got, models.DefaultEmbeddingBatchSize)
	}
	os.Setenv("TOKENIZER_EMBEDDING_BATCH_SIZE", "32")
	t.Cleanup(func() { os.Unsetenv("TOKENIZER_EMBEDDING_BATCH_SIZE") })
	if got := models.GetEmbeddingBatchSize(""); got != 32 {
		t.Errorf("GetEmbeddingBatchSize() after env = %d, want 32", got)
	}
	// Invalid value falls back to default.
	os.Setenv("TOKENIZER_EMBEDDING_BATCH_SIZE", "bad")
	if got := models.GetEmbeddingBatchSize(""); got != models.DefaultEmbeddingBatchSize {
		t.Errorf("GetEmbeddingBatchSize() invalid env = %d, want %d", got, models.DefaultEmbeddingBatchSize)
	}
}

// TestChunkOrderInt_EmbeddingOnly covers Tokenizer Diff-8: chunk_order_int
// must be set even when search_method does not include "full_text" (i.e.
// embedding-only path). tokenizeChunks previously only set it for the
// full_text branch.
func TestChunkOrderInt_EmbeddingOnly(t *testing.T) {
	stub := newStubEmbedder(3)
	comp, err := NewTokenizerComponentWithResolver(
		map[string]any{"search_method": []string{"embedding"}, "fields": []string{"text"}},
		func(ctx context.Context, _, _ string) (Embedder, string, error) { return stub, "", nil },
	)
	if err != nil {
		t.Fatalf("NewTokenizerComponentWithResolver: %v", err)
	}
	inputs := map[string]any{
		"name":          "doc.pdf",
		"output_format": "json",
		"json": []map[string]any{
			{"text": "first chunk", "doc_type_kwd": "text"},
			{"text": "second chunk", "doc_type_kwd": "text"},
		},
	}
	out, err := comp.Invoke(t.Context(), nil, inputs)
	if err != nil {
		t.Fatalf("Invoke: %v", err)
	}
	chunks, _ := schema.ChunkCarrierToMaps(out["chunks"])
	if len(chunks) != 2 {
		t.Fatalf("want 2 chunks, got %d", len(chunks))
	}
	for i, ck := range chunks {
		coi, ok := ck["chunk_order_int"]
		if !ok {
			t.Errorf("chunk %d: chunk_order_int missing (embedding-only path must set it)", i)
		}
		if coi == nil {
			t.Errorf("chunk %d: chunk_order_int is nil", i)
		}
	}
}

// TestChunksFromTokenizerUpstream_FiltersPhantomChunks covers A5 at the
// pipeline level: a chunk is dropped when canonical "text" is empty.
func TestChunksFromTokenizerUpstream_FiltersPhantomChunks(t *testing.T) {
	items := []map[string]any{
		{"text": "valid chunk", "doc_type_kwd": "text"}, // keep
		{"image": "data:image/png;base64,abc"},          // drop
		{"summary": "a summary"},                        // drop
		{"questions": "q1"},                             // drop
		{"content_with_weight": "weighted"},             // drop: storage field, not canonical text
		{},                                              // drop: empty
	}
	// Use embedding-only mode to avoid CGo tokenizer dependency.
	stub := newStubEmbedder(3)
	comp, err := NewTokenizerComponentWithResolver(
		map[string]any{"search_method": []string{"embedding"}, "fields": []string{"text"}},
		func(ctx context.Context, _, _ string) (Embedder, string, error) { return stub, "", nil },
	)
	if err != nil {
		t.Fatalf("NewTokenizerComponentWithResolver: %v", err)
	}
	out, err := comp.Invoke(t.Context(), nil, map[string]any{
		"name":          "doc.pdf",
		"output_format": "json",
		"json":          items,
	})
	if err != nil {
		t.Fatalf("Invoke: %v", err)
	}
	chunks, _ := schema.ChunkCarrierToMaps(out["chunks"])
	if len(chunks) != 1 {
		t.Fatalf("want 1 chunk (5 phantoms filtered), got %d: %#v", len(chunks), chunks)
	}
	if chunks[0]["text"] != "valid chunk" {
		t.Errorf("chunk 0 text = %q, want %q", chunks[0]["text"], "valid chunk")
	}
}

func TestTokenizerComponent_KeepsContextOnlyMediaChunk(t *testing.T) {
	tokenizer.SetEngineType("infinity")
	defer tokenizer.SetEngineType("")

	comp, err := NewTokenizerComponent(map[string]any{
		"search_method": []any{"full_text"},
	})
	if err != nil {
		t.Fatalf("NewTokenizerComponent: %v", err)
	}
	out, err := comp.(*TokenizerComponent).Invoke(t.Context(), nil, map[string]any{
		"name":          "report.pdf",
		"output_format": "chunks",
		"chunks": []map[string]any{{
			"image":         "data:image/png;base64,placeholder",
			"context_above": "figure description",
		}},
	})
	if err != nil {
		t.Fatalf("Invoke: %v", err)
	}
	chunks, _ := schema.ChunkCarrierToMaps(out["chunks"])
	if len(chunks) != 1 {
		t.Fatalf("chunks = %#v, want context-bearing media chunk retained", chunks)
	}
	if got := chunks[0]["content_ltks"]; got != "figure description" {
		t.Fatalf("content_ltks = %q, want media context", got)
	}
}

// TestChunkOrderInt_AllPathsUnconditional is the A6 regression gate: every
// surviving chunk must carry chunk_order_int, equal to its index in the
// (post-filter) reading sequence — on every output_format and every
// search_method combination. Go sets it unconditionally (deviation from
// Python's chunks+full_text-only rule) so every retrieval path can sort by
// reading order.
func TestChunkOrderInt_AllPathsUnconditional(t *testing.T) {
	// identity tokenizer: Tokenize returns input unchanged — no CGo pool.
	tokenizer.SetEngineType("infinity")
	defer tokenizer.SetEngineType("")

	stub := newStubEmbedder(8)
	textChunks := []map[string]any{{"text": "a"}, {"text": "b"}, {"text": "c"}}
	jsonChunks := []map[string]any{
		{"text": "a", "doc_type_kwd": "text"},
		{"text": "b", "doc_type_kwd": "text"},
		{"text": "c", "doc_type_kwd": "text"},
	}
	cases := []struct {
		name         string
		searchMethod []string
		inputs       map[string]any
		wantChunks   int
	}{
		{"chunks/full_text", []string{"full_text"},
			map[string]any{"output_format": "chunks", "chunks": textChunks}, 3},
		{"chunks/embedding", []string{"embedding"},
			map[string]any{"output_format": "chunks", "chunks": textChunks}, 3},
		{"chunks/full_text+embedding", []string{"full_text", "embedding"},
			map[string]any{"output_format": "chunks", "chunks": textChunks}, 3},
		{"json/full_text", []string{"full_text"},
			map[string]any{"output_format": "json", "json": jsonChunks}, 3},
		{"markdown/full_text", []string{"full_text"},
			map[string]any{"output_format": "markdown", "markdown": "# H\n\nbody one\n\nbody two"}, 1},
		{"text/full_text", []string{"full_text"},
			map[string]any{"output_format": "text", "text": "body text"}, 1},
		{"html/full_text", []string{"full_text"},
			map[string]any{"output_format": "html", "html": "<p>body text</p>"}, 1},
	}
	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {
			comp, err := NewTokenizerComponentWithResolver(
				map[string]any{"search_method": tc.searchMethod, "fields": []string{"text"}},
				func(ctx context.Context, _, _ string) (Embedder, string, error) { return stub, "", nil },
			)
			if err != nil {
				t.Fatalf("NewTokenizerComponentWithResolver: %v", err)
			}
			out, err := comp.Invoke(t.Context(), nil, tc.inputs)
			if err != nil {
				t.Fatalf("Invoke: %v", err)
			}
			chunks, _ := schema.ChunkCarrierToMaps(out["chunks"])
			if len(chunks) != tc.wantChunks {
				t.Fatalf("want %d chunks, got %d: %#v", tc.wantChunks, len(chunks), chunks)
			}
			for i, ck := range chunks {
				coi, ok := ck["chunk_order_int"]
				if !ok {
					t.Errorf("chunk %d: chunk_order_int missing", i)
					continue
				}
				got, ok := coi.(float64)
				if !ok {
					t.Errorf("chunk %d: chunk_order_int type %T, want number", i, coi)
					continue
				}
				if int(got) != i {
					t.Errorf("chunk %d: chunk_order_int = %v, want %d", i, got, i)
				}
			}
		})
	}
}

// TestChunkOrderInt_A5FilterKeepsSequenceContiguous is the A5+A6 joint gate:
// when an upstream text-empty chunk is dropped by the A5 gate, the surviving
// text chunks still receive contiguous 0-based chunk_order_int values (Go
// indexes the post-filter slice, so no gap is left by the dropped chunk).
func TestChunkOrderInt_A5FilterKeepsSequenceContiguous(t *testing.T) {
	tokenizer.SetEngineType("infinity")
	defer tokenizer.SetEngineType("")

	stub := newStubEmbedder(8)
	comp, err := NewTokenizerComponentWithResolver(
		map[string]any{"search_method": []string{"full_text", "embedding"}, "fields": []string{"text"}},
		func(ctx context.Context, _, _ string) (Embedder, string, error) { return stub, "", nil },
	)
	if err != nil {
		t.Fatalf("NewTokenizerComponentWithResolver: %v", err)
	}
	// Middle chunk has empty text and no content_with_weight -> dropped by A5.
	items := []map[string]any{
		{"text": "first"},
		{"questions": "orphan question"}, // dropped: no retrievable content
		{"text": "second"},
	}
	out, err := comp.Invoke(t.Context(), nil, map[string]any{
		"name":          "doc.pdf",
		"output_format": "chunks",
		"chunks":        items,
	})
	if err != nil {
		t.Fatalf("Invoke: %v", err)
	}
	chunks, _ := schema.ChunkCarrierToMaps(out["chunks"])
	if len(chunks) != 2 {
		t.Fatalf("want 2 surviving chunks, got %d: %#v", len(chunks), chunks)
	}
	for i, ck := range chunks {
		coi, ok := ck["chunk_order_int"]
		if !ok {
			t.Errorf("chunk %d: chunk_order_int missing", i)
			continue
		}
		got, ok := coi.(float64)
		if !ok {
			t.Errorf("chunk %d: chunk_order_int type %T, want number", i, coi)
			continue
		}
		if int(got) != i {
			t.Errorf("chunk %d: chunk_order_int = %v, want %d (contiguous after A5 drop)", i, got, i)
		}
	}
}

// TestTokenizerComponent_ImportantKwd_CommaOnly is the no-tag parity test for
// A2: important_kwd must be split on the ENGLISH COMMA ONLY, matching the DSL
// tokenizer (rag/flow/tokenizer/tokenizer.py:153 `keywords.split(",")`). It
// runs without the C++ analyzer pool by switching the tokenizer engine to
// "infinity" (identity: Tokenize returns its input unchanged), so it executes
// in the default `go test ./...` CI tier and gives real regression protection.
func TestTokenizerComponent_ImportantKwd_CommaOnly(t *testing.T) {
	// Switch to identity tokenizer so tokenizeChunks needs no CGo pool, then
	// restore the default engine type afterwards.
	tokenizer.SetEngineType("infinity")
	defer tokenizer.SetEngineType("")

	c, err := NewTokenizerComponent(map[string]any{
		"search_method": []any{"full_text"},
	})
	if err != nil {
		t.Fatalf("NewTokenizerComponent: %v", err)
	}
	out, err := c.Invoke(t.Context(), nil, map[string]any{
		"output_format": "chunks",
		"chunks": []map[string]any{
			{"text": "doc body", "keywords": "kw1,kw2;kw3,kw4"},
		},
	})
	if err != nil {
		t.Fatalf("Invoke: %v", err)
	}
	got, ok := schema.ChunkCarrierToMaps(out["chunks"])
	if !ok || len(got) != 1 {
		t.Fatalf("chunks = %v, want 1 chunk", out["chunks"])
	}
	kwd, ok := got[0]["important_kwd"].([]string)
	if !ok {
		t.Fatalf("important_kwd should be []string, got %T", got[0]["important_kwd"])
	}
	// Only the English comma splits; CJK comma and semicolon stay attached.
	want := []string{"kw1", "kw2;kw3,kw4"}
	if len(kwd) != len(want) {
		t.Fatalf("important_kwd = %v, want %v", kwd, want)
	}
	for i := range want {
		if kwd[i] != want[i] {
			t.Errorf("important_kwd = %v, want %v (only comma splits)", kwd, want)
		}
	}
	// important_tks still tokenizes the full keyword string (identity mode
	// returns it unchanged).
	if tks, ok := got[0]["important_tks"].(string); !ok || tks != "kw1,kw2;kw3,kw4" {
		t.Errorf("important_tks = %v, want full keyword string", got[0]["important_tks"])
	}
}

// TestTokenizerComponent_ImportantKwd_PreservesEmptyElements locks F3: the
// component path splits on the ENGLISH COMMA ONLY via strings.Split and
// PRESERVES empty elements, matching Python's "a,,b".split(",") ==
// ["a","","b"]. This is the contract asserted by the comment at
// tokenizer.go:688-689, and it is the intentional counterpart to the executor
// fallback (cleanupConsumedChunkFields -> utility.SplitKeywords) which DROPS
// empty parts. Runs without the C++ analyzer pool via the identity engine.
func TestTokenizerComponent_ImportantKwd_PreservesEmptyElements(t *testing.T) {
	tokenizer.SetEngineType("infinity")
	defer tokenizer.SetEngineType("")

	c, err := NewTokenizerComponent(map[string]any{
		"search_method": []any{"full_text"},
	})
	if err != nil {
		t.Fatalf("NewTokenizerComponent: %v", err)
	}

	// Middle empty element must be preserved (["a","","b"]), not dropped.
	out, err := c.Invoke(t.Context(), nil, map[string]any{
		"output_format": "chunks",
		"chunks": []map[string]any{
			{"text": "doc body", "keywords": "a,,b"},
		},
	})
	if err != nil {
		t.Fatalf("Invoke: %v", err)
	}
	got, ok := schema.ChunkCarrierToMaps(out["chunks"])
	if !ok || len(got) != 1 {
		t.Fatalf("chunks = %v, want 1 chunk", out["chunks"])
	}
	kwd, ok := got[0]["important_kwd"].([]string)
	if !ok {
		t.Fatalf("important_kwd should be []string, got %T", got[0]["important_kwd"])
	}
	want := []string{"a", "", "b"}
	if len(kwd) != len(want) {
		t.Fatalf("important_kwd = %v, want %v (empty elements preserved)", kwd, want)
	}
	for i := range want {
		if kwd[i] != want[i] {
			t.Errorf("important_kwd[%d] = %q, want %q (empty elements preserved)", i, kwd[i], want[i])
		}
	}

	// Empty keyword string must not error. The component guards on a
	// non-empty keywords field (tokenizer.go:682), so important_kwd is left
	// unset (nil) rather than materialized as an empty array. Downstream
	// indexing treats a missing important_kwd as "no keywords", which is safe.
	outEmpty, err := c.Invoke(t.Context(), nil, map[string]any{
		"output_format": "chunks",
		"chunks": []map[string]any{
			{"text": "doc body", "keywords": ""},
		},
	})
	if err != nil {
		t.Fatalf("Invoke(empty keywords): %v", err)
	}
	gotEmpty, ok := schema.ChunkCarrierToMaps(outEmpty["chunks"])
	if !ok || len(gotEmpty) != 1 {
		t.Fatalf("empty chunks = %v, want 1 chunk", outEmpty["chunks"])
	}
	if kwd, exists := gotEmpty[0]["important_kwd"]; exists && kwd != nil {
		t.Errorf("empty keywords should leave important_kwd unset, got %v", kwd)
	}
}

// TestSanitizeKeywordTerm verifies the ES keyword-field guard used by the Go
// tokenizer path. It mirrors the Python regression tests in
// tests/test_main.py::TestSanitizeKeywordTerm.
func TestSanitizeKeywordTerm(t *testing.T) {
	tests := []struct {
		name     string
		term     string
		want     string
		wantByte int
	}{
		{
			name: "small term unchanged",
			term: "hello",
			want: "hello",
		},
		{
			name: "trims whitespace",
			term: "  world  ",
			want: "world",
		},
		{
			name: "empty string",
			term: "",
			want: "",
		},
		{
			name:     "oversized single word truncated to byte limit",
			term:     strings.Repeat("x", 40000),
			want:     strings.Repeat("x", esKeywordMaxTermBytes),
			wantByte: esKeywordMaxTermBytes,
		},
		{
			name:     "multi-byte characters truncated at rune boundary",
			term:     strings.Repeat("中", 20000),
			want:     strings.Repeat("中", esKeywordMaxTermBytes/3),
			wantByte: esKeywordMaxTermBytes,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got := sanitizeKeywordTerm(tt.term)
			if got != tt.want {
				t.Errorf("sanitizeKeywordTerm(%q) = %q, want %q", tt.term, got, tt.want)
			}
			if tt.wantByte > 0 && len(got) != tt.wantByte {
				t.Errorf("len(sanitizeKeywordTerm(%q)) = %d, want %d", tt.term, len(got), tt.wantByte)
			}
		})
	}
}

// TestTokenizerComponent_ImportantKwd_Bounded verifies that oversized keywords
// are truncated to the ES keyword-field limit at the component level, while
// normal comma-splitting behavior is preserved.
func TestTokenizerComponent_ImportantKwd_Bounded(t *testing.T) {
	tokenizer.SetEngineType("infinity")
	defer tokenizer.SetEngineType("")

	c, err := NewTokenizerComponent(map[string]any{
		"search_method": []any{"full_text"},
	})
	if err != nil {
		t.Fatalf("NewTokenizerComponent: %v", err)
	}

	oversized := strings.Repeat("x", 40000)
	out, err := c.Invoke(t.Context(), nil, map[string]any{
		"output_format": "chunks",
		"chunks": []map[string]any{
			{"text": "doc body", "keywords": "normal," + oversized + ",中文字"},
		},
	})
	if err != nil {
		t.Fatalf("Invoke: %v", err)
	}
	got, ok := schema.ChunkCarrierToMaps(out["chunks"])
	if !ok || len(got) != 1 {
		t.Fatalf("chunks = %v, want 1 chunk", out["chunks"])
	}
	kwd, ok := got[0]["important_kwd"].([]string)
	if !ok {
		t.Fatalf("important_kwd should be []string, got %T", got[0]["important_kwd"])
	}
	if len(kwd) != 3 {
		t.Fatalf("important_kwd = %v, want 3 entries", kwd)
	}
	if kwd[0] != "normal" {
		t.Errorf("important_kwd[0] = %q, want \"normal\"", kwd[0])
	}
	if len(kwd[1]) != esKeywordMaxTermBytes {
		t.Errorf("important_kwd[1] byte length = %d, want %d", len(kwd[1]), esKeywordMaxTermBytes)
	}
	if kwd[2] != "中文字" {
		t.Errorf("important_kwd[2] = %q, want \"中文字\"", kwd[2])
	}
}

// TestTextPayloadToChunks_B1B2 pins the text-payload adapter used for
// markdown/text/html payloads (tokenizer.go:578). This is the Go-correct
// counterpart to a Python-DSL bug where turning full_text off dropped the
// entire document (B1), and where an empty payload failed to emit the chunks
// key at all (B2). The Go helper always returns a slice: non-empty payload ->
// one chunk carrying the raw text; nil/empty/whitespace payload -> a non-nil
// EMPTY slice so the downstream "chunks" key is present as [].
//
// No-tag unit test: textPayloadToChunks is a pure function, no CGo pool needed.
func TestTextPayloadToChunks_B1B2(t *testing.T) {
	// B1: a real payload yields exactly one chunk with the text preserved.
	payload := "plain payload body"
	got := textPayloadToChunks(&payload)
	if len(got) != 1 {
		t.Fatalf("non-empty payload: len(chunks) = %d, want 1", len(got))
	}
	if got[0].Text != payload {
		t.Errorf("chunk text = %q, want %q", got[0].Text, payload)
	}

	// B2: empty/whitespace/nil payloads must still return a non-nil EMPTY
	// slice (so the chunks key is present as [] downstream), never nil.
	for _, tc := range []struct {
		name string
		in   *string
	}{
		{"empty string", ptr("")},
		{"whitespace only", ptr("   \n\t  ")},
		{"nil pointer", nil},
	} {
		t.Run(tc.name, func(t *testing.T) {
			out := textPayloadToChunks(tc.in)
			if out == nil {
				t.Fatalf("textPayloadToChunks(%s) = nil, want non-nil empty slice", tc.name)
			}
			if len(out) != 0 {
				t.Errorf("textPayloadToChunks(%s) len = %d, want 0", tc.name, len(out))
			}
		})
	}
}

func ptr(s string) *string { return &s }