Skip to content

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

18.1 KB
Raw Blame
package dataset

import (
	"reflect"
	"sort"
	"strings"
	"testing"

	"ragflow/internal/entity"
	"ragflow/internal/service"
)

// TestValidateParserID_AcceptsRegistryRefs verifies that every
// canonical builtin pipeline id passes validation.
func TestValidateParserID_AcceptsRegistryRefs(t *testing.T) {
	for _, id := range []string{"general", "book", "audio", "qa", "table"} {
		if err := validateParserID(id); err != nil {
			t.Errorf("validateParserID(%q) = %v, want nil", id, err)
		}
	}
}

// TestValidateParserID_AcceptsNaiveAlias verifies the legacy
// parser_id "naive" still validates (alias for general).
func TestValidateParserID_AcceptsNaiveAlias(t *testing.T) {
	if err := validateParserID("naive"); err != nil {
		t.Errorf("validateParserID(naive) = %v, want nil (alias for general)", err)
	}
}

// TestValidateParserID_RejectsUnknown verifies unknown/empty
// values are rejected with an error that lists the valid options.
func TestValidateParserID_RejectsUnknown(t *testing.T) {
	for _, id := range []string{"", "unknown", "NAIVE"} {
		err := validateParserID(id)
		if err == nil {
			t.Errorf("validateParserID(%q) = nil, want error", id)
		}
	}

	err := validateParserID("unknown")
	if err == nil {
		t.Fatal("expected error for unknown parser id")
	}
	msg := err.Error()
	if !strings.Contains(msg, "general") {
		t.Errorf("error message %q should mention general", msg)
	}
}

// --- validateDatasetAvatar ---

func TestValidateDatasetAvatar_Empty(t *testing.T) {
	if err := validateDatasetAvatar(""); err != nil {
		t.Fatalf("expected nil for empty avatar (clear signal), got %v", err)
	}
}

func TestValidateDatasetAvatar_MissingPrefix(t *testing.T) {
	err := validateDatasetAvatar("iVBORw0KGgo=")
	if err == nil {
		t.Fatal("expected error for missing MIME prefix")
	}
}

func TestValidateDatasetAvatar_InvalidPrefix(t *testing.T) {
	err := validateDatasetAvatar("wrong:image/png;base64,iVBORw0KGgo=")
	if err == nil {
		t.Fatal("expected error for invalid prefix")
	}
}

func TestValidateDatasetAvatar_UnsupportedMIME(t *testing.T) {
	err := validateDatasetAvatar("data:image/gif;base64,iVBORw0KGgo=")
	if err == nil {
		t.Fatal("expected error for unsupported MIME")
	}
}

func TestValidateDatasetAvatar_Valid(t *testing.T) {
	err := validateDatasetAvatar("data:image/png;base64,iVBORw0KGgo=")
	if err != nil {
		t.Fatalf("expected nil, got %v", err)
	}
	err = validateDatasetAvatar("data:image/jpeg;base64,/9j/4AAQ==")
	if err != nil {
		t.Fatalf("expected nil, got %v", err)
	}
}

// --- validateDatasetEmbeddingModel ---

func TestValidateDatasetEmbeddingModel_Empty(t *testing.T) {
	err := validateDatasetEmbeddingModel("")
	if err == nil {
		t.Fatal("expected error for empty model")
	}
}

func TestValidateDatasetEmbeddingModel_NameOnlyNoProvider(t *testing.T) {
	// A bare model name without @provider (and not a 32-char hex model ID) is
	// rejected, mirroring the Python contract.
	if err := validateDatasetEmbeddingModel("BAAI/bge-large-zh-v1.5"); err == nil {
		t.Fatal("expected error for name without @provider")
	}
}

func TestValidateDatasetEmbeddingModel_HexModelID(t *testing.T) {
	if err := validateDatasetEmbeddingModel("aabbccdd11223344aabbccdd11223344"); err != nil {
		t.Fatalf("expected nil for 32-char hex model ID, got %v", err)
	}
}

func TestValidateDatasetEmbeddingModel_NameWithProvider(t *testing.T) {
	if err := validateDatasetEmbeddingModel("BAAI/bge-large-zh-v1.5@Builtin"); err != nil {
		t.Fatalf("expected nil, got %v", err)
	}
}

func TestValidateDatasetEmbeddingModel_EmptyPart(t *testing.T) {
	err := validateDatasetEmbeddingModel("model@")
	if err == nil {
		t.Fatal("expected error for empty provider")
	}
	err = validateDatasetEmbeddingModel("@provider")
	if err == nil {
		t.Fatal("expected error for empty model name")
	}
}

// --- normalizeDatasetPipelineID ---

func TestNormalizeDatasetPipelineID_Empty(t *testing.T) {
	result, err := normalizeDatasetPipelineID("")
	if err != nil {
		t.Fatalf("expected nil, got %v", err)
	}
	if result != nil {
		t.Fatalf("expected nil result for empty input")
	}
}

func TestNormalizeDatasetPipelineID_Spaces(t *testing.T) {
	result, err := normalizeDatasetPipelineID("  ")
	if err != nil {
		t.Fatalf("expected nil, got %v", err)
	}
	if result != nil {
		t.Fatalf("expected nil result for whitespace-only input")
	}
}

func TestNormalizeDatasetPipelineID_WrongLength(t *testing.T) {
	_, err := normalizeDatasetPipelineID("abc123")
	if err == nil {
		t.Fatal("expected error for wrong length")
	}
}

func TestNormalizeDatasetPipelineID_InvalidChars(t *testing.T) {
	_, err := normalizeDatasetPipelineID("abcdef01-23456789abcdef0123456789")
	if err == nil {
		t.Fatal("expected error for non-hex chars")
	}
}

func TestNormalizeDatasetPipelineID_Valid(t *testing.T) {
	result, err := normalizeDatasetPipelineID("ABCDEF0123456789ABCDEF0123456789")
	if err != nil {
		t.Fatalf("expected nil, got %v", err)
	}
	if result == nil {
		t.Fatal("expected non-nil result")
	}
	if *result != "abcdef0123456789abcdef0123456789" {
		t.Errorf("expected lowercased, got %q", *result)
	}
}

// --- validateDatasetParserConfigSize ---

func TestValidateDatasetParserConfigSize_Empty(t *testing.T) {
	if err := validateDatasetParserConfigSize(map[string]interface{}{}); err != nil {
		t.Fatalf("expected nil for empty, got %v", err)
	}
}

func TestValidateDatasetParserConfigSize_UnderLimit(t *testing.T) {
	cfg := map[string]interface{}{
		"Parser:abc": map[string]interface{}{
			"chunk_size": float64(512),
		},
	}
	if err := validateDatasetParserConfigSize(cfg); err != nil {
		t.Fatalf("expected nil, got %v", err)
	}
}

func TestValidateDatasetParserConfigSize_OverLimit(t *testing.T) {
	// Build a config that exceeds 65535 bytes.
	bigVal := strings.Repeat("x", 66000)
	cfg := map[string]interface{}{
		"Parser:abc": map[string]interface{}{
			"big_field": bigVal,
		},
	}
	err := validateDatasetParserConfigSize(cfg)
	if err == nil {
		t.Fatal("expected error for oversized parser_config")
	}
	if !strings.Contains(err.Error(), "exceeds size limit") {
		t.Errorf("unexpected error: %v", err)
	}
}

// --- DropUnscopedParserConfigKeys ---

func TestDropUnscopedParserConfigKeys_NilAndEmpty(t *testing.T) {
	if got := DropUnscopedParserConfigKeys(nil); got != nil {
		t.Fatalf("expected nil for nil map, got %#v", got)
	}
	if got := DropUnscopedParserConfigKeys(map[string]any{}); got != nil {
		t.Fatalf("expected nil for empty map, got %#v", got)
	}
}

func TestDropUnscopedParserConfigKeys_DropsFlatKeys(t *testing.T) {
	cfg := map[string]any{
		"File":                         map[string]any{},
		"Extractor":                    map[string]any{},
		"extractor_0":                  map[string]any{},
		"compiler_0":                   map[string]any{},
		"chunk_token_num":              float64(128),
		"delimiter":                    "\n",
		"metadata":                     map[string]any{},
		"parent_child":                 map[string]any{},
		"Parser:abc":                   map[string]any{"chunk_size": float64(512)},
		"Extractor:AutoExtractDefault": map[string]any{"metadata": map[string]any{}},
	}
	dropped := DropUnscopedParserConfigKeys(cfg)
	sort.Strings(dropped)
	want := []string{"Extractor", "File", "chunk_token_num", "compiler_0", "delimiter", "extractor_0", "metadata", "parent_child"}
	if !reflect.DeepEqual(dropped, want) {
		t.Fatalf("dropped = %#v, want %#v", dropped, want)
	}
	// Component-scoped keys survive.
	if _, ok := cfg["Parser:abc"]; !ok {
		t.Error("component-scoped Parser:abc was dropped")
	}
	if _, ok := cfg["Extractor:AutoExtractDefault"]; !ok {
		t.Error("component-scoped Extractor:AutoExtractDefault was dropped")
	}
	// A flat-looking key nested inside a component node is NOT a top-level flat
	// key and must be preserved.
	if inner, ok := cfg["Extractor:AutoExtractDefault"].(map[string]any); !ok || inner["metadata"] == nil {
		t.Error("nested metadata inside a component node was dropped")
	}
	if len(cfg) != 2 {
		t.Fatalf("expected 2 surviving keys, got %d: %#v", len(cfg), cfg)
	}
}

func TestValidateParserConfig_DropsFlatKeys(t *testing.T) {
	flat := map[string]any{"chunk_token_num": float64(128), "delimiter": "\n"}
	dropped, err := ValidateParserConfig(flat)
	if err != nil {
		t.Fatalf("expected nil after dropping flat keys, got %v", err)
	}
	if len(dropped) != 2 {
		t.Fatalf("expected 2 dropped keys, got %#v", dropped)
	}
	if len(flat) != 0 {
		t.Fatalf("expected flat keys to be dropped, got %#v", flat)
	}
	// Component-scoped keys pass and are preserved.
	scoped := map[string]any{
		"GeneralChunker:SixApplesFall": map[string]any{"chunk_token_size": float64(512)},
		"Extractor:AutoExtractDefault": map[string]any{"metadata": map[string]any{}},
	}
	dropped, err = ValidateParserConfig(scoped)
	if err != nil {
		t.Fatalf("expected nil for component-scoped keys, got %v", err)
	}
	if len(dropped) != 0 {
		t.Fatalf("expected no dropped keys for component-scoped config, got %#v", dropped)
	}
	if len(scoped) != 2 {
		t.Fatalf("expected component-scoped keys preserved, got %#v", scoped)
	}
}

func TestValidateDocumentParserConfig_DropsFlatKeys(t *testing.T) {
	for _, flat := range []map[string]any{
		{"parser_specific": "value"},
		{"delimiter": float64(1)},
		{"children_delimiter": "|"},
		{"metadata": map[string]any{}},
		{"parent_child": map[string]any{}},
		{"File": map[string]any{}},
	} {
		cfg := make(map[string]any, len(flat))
		for k, v := range flat {
			cfg[k] = v
		}
		dropped, err := ValidateDocumentParserConfig(cfg)
		if err != nil {
			t.Fatalf("expected nil after dropping flat key %#v, got %v", flat, err)
		}
		if len(dropped) != 1 {
			t.Fatalf("expected exactly 1 dropped key for %#v, got %#v", flat, dropped)
		}
		if len(cfg) != 0 {
			t.Fatalf("expected flat key dropped, got %#v", cfg)
		}
	}
}

// TestValidateParserConfig_ReturnsDroppedKeys asserts that ValidateParserConfig
// returns the names of the flat (unscoped) keys it dropped so the caller can log
// the silent drop. This is the single drop point shared by every entry path.
func TestValidateParserConfig_ReturnsDroppedKeys(t *testing.T) {
	cfg := map[string]any{
		"chunk_token_num": float64(128),
		"delimiter":       "\n",
		"Parser:abc":      map[string]any{"chunk_size": float64(512)},
	}
	dropped, err := ValidateParserConfig(cfg)
	if err != nil {
		t.Fatalf("expected nil error, got %v", err)
	}
	sort.Strings(dropped)
	want := []string{"chunk_token_num", "delimiter"}
	if !reflect.DeepEqual(dropped, want) {
		t.Fatalf("dropped = %#v, want %#v", dropped, want)
	}
	if _, ok := cfg["Parser:abc"]; !ok {
		t.Error("component-scoped Parser:abc was dropped")
	}
	if len(cfg) != 1 {
		t.Fatalf("expected 1 surviving key, got %d: %#v", len(cfg), cfg)
	}
}

// TestValidateDocumentParserConfig_ReturnsDroppedKeys mirrors the dataset
// variant for the document path: the function drops the flat keys and reports
// them, preserving component-scoped nodes.
func TestValidateDocumentParserConfig_ReturnsDroppedKeys(t *testing.T) {
	cfg := map[string]any{
		"metadata":                     map[string]any{},
		"parent_child":                 map[string]any{},
		"File":                         map[string]any{},
		"Extractor:AutoExtractDefault": map[string]any{"metadata": map[string]any{}},
	}
	dropped, err := ValidateDocumentParserConfig(cfg)
	if err != nil {
		t.Fatalf("expected nil error, got %v", err)
	}
	sort.Strings(dropped)
	want := []string{"File", "metadata", "parent_child"}
	if !reflect.DeepEqual(dropped, want) {
		t.Fatalf("dropped = %#v, want %#v", dropped, want)
	}
	if _, ok := cfg["Extractor:AutoExtractDefault"]; !ok {
		t.Error("component-scoped Extractor was dropped")
	}
	if len(cfg) != 1 {
		t.Fatalf("expected 1 surviving key, got %d: %#v", len(cfg), cfg)
	}
}

// --- normalizeDatasetID ---

func TestNormalizeDatasetID_Invalid(t *testing.T) {
	_, err := normalizeDatasetID("not-a-uuid")
	if err == nil {
		t.Fatal("expected error for invalid UUID")
	}
	_, err = normalizeDatasetID("")
	if err == nil {
		t.Fatal("expected error for empty string")
	}
}

func TestNormalizeDatasetID_Valid(t *testing.T) {
	raw := "550e8400-e29b-41d4-a716-446655440000"
	result, err := normalizeDatasetID(raw)
	if err != nil {
		t.Fatalf("expected nil, got %v", err)
	}
	expected := "550e8400e29b41d4a716446655440000"
	if result != expected {
		t.Errorf("expected %q, got %q", expected, result)
	}
}

func TestNormalizeDatasetID_StripsHyphens(t *testing.T) {
	// UUID with hyphens already removed.
	raw := "550e8400e29b41d4a716446655440000"
	result, err := normalizeDatasetID(raw)
	if err != nil {
		t.Fatalf("expected nil, got %v", err)
	}
	if result != raw {
		t.Errorf("expected %q, got %q", raw, result)
	}
}

// --- normalizeMetadataConfigFields ---

func TestNormalizeMetadataConfigFields_EmptyKey(t *testing.T) {
	fields := []service.MetadataConfigField{
		{Key: "", Type: "string"},
	}
	_, err := normalizeMetadataConfigFields(fields, "metadata")
	if err == nil {
		t.Fatal("expected error for empty key")
	}
}

func TestNormalizeMetadataConfigFields_KeyTooLong(t *testing.T) {
	longKey := strings.Repeat("k", 256)
	fields := []service.MetadataConfigField{
		{Key: longKey, Type: "string"},
	}
	_, err := normalizeMetadataConfigFields(fields, "metadata")
	if err == nil {
		t.Fatal("expected error for too-long key")
	}
}

func TestNormalizeMetadataConfigFields_InvalidType(t *testing.T) {
	fields := []service.MetadataConfigField{
		{Key: "my_field", Type: "boolean"},
	}
	_, err := normalizeMetadataConfigFields(fields, "metadata")
	if err == nil {
		t.Fatal("expected error for invalid type")
	}
}

func TestNormalizeMetadataConfigFields_DescriptionTooLong(t *testing.T) {
	longDesc := strings.Repeat("d", 65536)
	fields := []service.MetadataConfigField{
		{Key: "my_field", Type: "string", Description: &longDesc},
	}
	_, err := normalizeMetadataConfigFields(fields, "metadata")
	if err == nil {
		t.Fatal("expected error for too-long description")
	}
}

func TestNormalizeMetadataConfigFields_Valid(t *testing.T) {
	desc := "A description"
	fields := []service.MetadataConfigField{
		{Key: "field1", Type: "string", Description: &desc},
		{Key: "field2", Type: "list"},
	}
	result, err := normalizeMetadataConfigFields(fields, "metadata")
	if err != nil {
		t.Fatalf("expected nil, got %v", err)
	}
	if len(result) != 2 {
		t.Fatalf("expected 2 fields, got %d", len(result))
	}
	if result[0]["key"] != "field1" {
		t.Errorf("expected key=field1, got %v", result[0]["key"])
	}
	if result[0]["type"] != "string" {
		t.Errorf("expected type=string, got %v", result[0]["type"])
	}
	if result[0]["description"] != &desc {
		t.Errorf("expected description preserved")
	}
	if result[1]["key"] != "field2" {
		t.Errorf("expected key=field2, got %v", result[1]["key"])
	}
	if result[1]["type"] != "list" {
		t.Errorf("expected type=list, got %v", result[1]["type"])
	}
}

func TestNormalizeMetadataConfigFields_TrimsKey(t *testing.T) {
	fields := []service.MetadataConfigField{
		{Key: "  my_field  ", Type: "number"},
	}
	result, err := normalizeMetadataConfigFields(fields, "metadata")
	if err != nil {
		t.Fatalf("expected nil, got %v", err)
	}
	if result[0]["key"] != "my_field" {
		t.Errorf("expected trimmed key 'my_field', got %v", result[0]["key"])
	}
}

func TestPreserveDatasetParserConfigState_FallsBackWhenIncomingNotMap(t *testing.T) {
	existing := entity.JSONMap{
		"Extractor:AutoExtractDefault": map[string]any{
			"metadata": map[string]any{
				"enabled":           true,
				"metadata":          []any{map[string]any{"key": "existing_field", "type": "string"}},
				"built_in_metadata": []any{},
			},
		},
	}
	cases := map[string]interface{}{
		"null":  nil,
		"array": []any{},
	}
	for name, incomingMetadata := range cases {
		t.Run(name, func(t *testing.T) {
			incoming := map[string]interface{}{
				"Extractor:AutoExtractDefault": map[string]any{
					"metadata": incomingMetadata,
				},
			}
			got := preserveDatasetParserConfigState(entity.JSONMap{
				"Extractor:AutoExtractDefault": map[string]any{},
			}, existing, incoming)
			meta, ok := got["metadata"].(map[string]any)
			if !ok {
				t.Fatalf("expected existing modular metadata preserved, got %#v", got["metadata"])
			}
			fields, ok := meta["metadata"].([]any)
			if !ok || len(fields) != 1 || fields[0].(map[string]any)["key"] != "existing_field" {
				t.Fatalf("expected existing_field preserved, got %#v", meta["metadata"])
			}
		})
	}
}

func TestPreserveDatasetParserConfigState_IgnoresStaleExtractor(t *testing.T) {
	existing := entity.JSONMap{
		"Extractor:AutoExtractDefault": map[string]any{
			"metadata": map[string]any{
				"enabled":           true,
				"metadata":          []any{map[string]any{"key": "current_field", "type": "string"}},
				"built_in_metadata": []any{},
			},
		},
	}
	incoming := map[string]interface{}{
		"Extractor:Old": map[string]any{
			"metadata": map[string]any{
				"enabled":           true,
				"metadata":          []any{map[string]any{"key": "stale_field", "type": "string"}},
				"built_in_metadata": []any{},
			},
		},
	}
	got := preserveDatasetParserConfigState(entity.JSONMap{
		"Extractor:AutoExtractDefault": map[string]any{},
	}, existing, incoming)
	meta, ok := got["metadata"].(map[string]any)
	if !ok {
		t.Fatalf("expected current modular metadata, got %#v", got["metadata"])
	}
	fields, ok := meta["metadata"].([]any)
	if !ok || len(fields) != 1 || fields[0].(map[string]any)["key"] != "current_field" {
		t.Fatalf("expected current_field to win over stale Extractor, got %#v", meta["metadata"])
	}
}

func TestPreserveDatasetParserConfigState_UsesValidIncomingMap(t *testing.T) {
	existing := entity.JSONMap{
		"Extractor:AutoExtractDefault": map[string]any{
			"metadata": map[string]any{
				"enabled":           false,
				"metadata":          []any{},
				"built_in_metadata": []any{},
			},
		},
	}
	incoming := map[string]interface{}{
		"Extractor:AutoExtractDefault": map[string]any{
			"metadata": map[string]any{
				"enabled":           true,
				"metadata":          []any{map[string]any{"key": "incoming_field", "type": "string"}},
				"built_in_metadata": []any{},
			},
		},
	}
	got := preserveDatasetParserConfigState(entity.JSONMap{
		"Extractor:AutoExtractDefault": map[string]any{},
	}, existing, incoming)
	meta, ok := got["metadata"].(map[string]any)
	if !ok {
		t.Fatalf("expected modular metadata map, got %#v", got["metadata"])
	}
	fields, ok := meta["metadata"].([]any)
	if !ok || len(fields) != 1 || fields[0].(map[string]any)["key"] != "incoming_field" {
		t.Fatalf("expected incoming_field to be used, got %#v", meta["metadata"])
	}
}