Files
ragflow/internal/ingestion/task/pipeline_e2e_test.go
Jack b59d6e8ba1 refactor(ingestion/task): extract index-doc mapping into task/indexdoc package (#17749)
## Summary
Extract the pipeline-output → search-engine index document mapping
helpers out of the `task` package into a dedicated, dependency-light
leaf package `internal/ingestion/task/indexdoc`.

These functions are pure transforms (they only depend on
`common`/`utility`) and are not task-orchestration concerns:
- `NormalizeChunks`, `DeepCopyChunks` (was unexported `deepCopyChunks`),
`toChunkMaps` → `indexdoc/normalize.go`
- `ProcessChunksForPipeline`, `RenameTextToContentWithWeight`,
`GetEmbeddingTokenConsumption`, `cleanupConsumedChunkFields`,
`mergeChunkMetadata`, `processChunkPositions`,
`AggregateTableDocMetadata`, `resolveTableColumnConfig` →
`indexdoc/process.go`
- `AddPositions` → `indexdoc/position.go`
- `EmbeddingTokenConsumptionKey` constant → `indexdoc/constants.go`
(task/constants.go keeps only `GRAPH_RAPTOR_FAKE_DOC_ID`)

Call sites in `pipeline_executor.go` and `golden_compare.go` now
reference the `indexdoc` package; package-task tests qualify the moved
symbols.

## Why
The `task` package had grown into a "orchestration + pure mapping +
debug" mix. Splitting the pure mapping helpers into a leaf package
sharpens package boundaries, removes a misleading top-level
`ingestion/chunk` candidate (there are already `parser/chunk` and
`service/chunk`), and lets the golden tool / future reuse pull in the
mapping logic without dragging in `task`'s `dao`/`engine`/`service`
dependency graph (Go subpackage import does not pull in the parent).

## Test plan
- `build.sh --test ./internal/ingestion/task/...` — **green** (task
4.7s, indexdoc 0.007s), matching the pre-change baseline.
- `gofmt` clean; `build.sh` builds both `ragflow-cli` and
`ragflow_server` successfully.
- Integration/E2E tiers are delegated to CI (need real MySQL/MinIO/ES
services).

Note: `pipeline_e2e_test.go` has a **pre-existing** compile error
(`server.ElasticsearchConfig` / `server.InfinityConfig` are now defined
under `internal/server/config/`, not re-exported by `internal/server`).
This is unrelated to this change — the diff to that file is only the
added `indexdoc` import and the qualified `EmbeddingTokenConsumptionKey`
reference.
2026-08-04 10:05:27 +08:00

337 lines
10 KiB
Go

//
// 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.
//
//go:build e2e
package task
import (
"context"
"fmt"
"net"
"testing"
"time"
"ragflow/internal/common"
"ragflow/internal/dao"
"ragflow/internal/engine"
"ragflow/internal/engine/elasticsearch"
"ragflow/internal/engine/infinity"
indexdoc "ragflow/internal/ingestion/task/indexdoc"
"ragflow/internal/ingestion/testutil"
"ragflow/internal/server"
"ragflow/internal/service"
)
// =============================================================================
// Test helper: setupTestDocEngine - Creates either Elasticsearch or Infinity engine
// =============================================================================
func setupTestDocEngine(t *testing.T, engineType engine.EngineType, tenantID, datasetID string) (engine.DocEngine, func()) {
t.Helper()
var (
docEngine engine.DocEngine
err error
)
switch engineType {
case engine.EngineElasticsearch:
t.Logf("Setting up Elasticsearch engine...")
esHost := common.GetEnv(common.EnvESHost)
if esHost == "" {
esHost = "localhost:1200"
}
if !startsWithHTTP(esHost) {
esHost = "http://" + esHost
}
esUser := common.GetEnv(common.EnvESUsername)
if esUser == "" {
esUser = "elastic"
}
esPassword := common.GetEnv(common.EnvESPassword)
if esPassword == "" {
esPassword = "infini_rag_flow"
}
cfg := &server.ElasticsearchConfig{
Hosts: esHost,
Username: esUser,
Password: esPassword,
}
docEngine, err = elasticsearch.NewEngine(cfg)
if err != nil {
t.Skipf("Could not create Elasticsearch engine: %v (skipping ES subtest)", err)
return nil, func() {}
}
case engine.EngineInfinity:
t.Logf("Setting up Infinity engine...")
infURI := common.GetEnv(common.EnvInfinityURI)
if infURI == "" {
infURI = "localhost:23817"
}
// First check if Infinity is reachable quickly without waiting 120s!
if !isPortOpen("localhost", 23817) {
t.Skipf("Infinity not running at %s (skipping Infinity subtest)", infURI)
return nil, func() {}
}
cfg := &server.InfinityConfig{
URI: infURI,
DBName: "ragflow_e2e_test",
PostgresPort: 5432,
}
docEngine, err = infinity.NewEngine(cfg)
if err != nil {
t.Skipf("Could not create Infinity engine: %v (skipping Infinity subtest)", err)
return nil, func() {}
}
default:
t.Fatalf("Unsupported engine type: %v", engineType)
}
// Create unique base name for the test
baseName := fmt.Sprintf("ragflow_%s", tenantID)
// Cleanup first (if exists)
ctx := context.Background()
_ = docEngine.DropChunkStore(ctx, baseName, datasetID)
// Create chunk store (note: vec dimension = 2 because our test chunks have q_2_vec)
if err := docEngine.CreateChunkStore(ctx, baseName, datasetID, 2, "naive"); err != nil {
// If create failed, maybe it exists; try dropping and recreating
_ = docEngine.DropChunkStore(ctx, baseName, datasetID)
if err := docEngine.CreateChunkStore(ctx, baseName, datasetID, 2, "naive"); err != nil {
_ = docEngine.Close()
t.Fatalf("Could not create chunk store: %v", err)
}
}
// Return cleanup function
cleanup := func() {
_ = docEngine.DropChunkStore(ctx, baseName, datasetID)
_ = docEngine.Close()
}
return docEngine, cleanup
}
func startsWithHTTP(s string) bool {
return len(s) >= 4 && (s[:4] == "http" || s[:5] == "https")
}
func toLowerSnakeCase(s string) string {
result := make([]rune, 0, len(s))
for _, r := range s {
if r >= 'A' && r <= 'Z' {
result = append(result, r-'A'+'a')
} else if (r >= 'a' && r <= 'z') || (r >= '0' && r <= '9') {
result = append(result, r)
} else {
result = append(result, '_')
}
}
return string(result)
}
func isPortOpen(host string, port int) bool {
addr := fmt.Sprintf("%s:%d", host, port)
conn, err := net.DialTimeout("tcp", addr, 1*time.Second)
if err != nil {
return false
}
defer conn.Close()
return true
}
// =============================================================================
// Main E2E Test with Subtests for Elasticsearch and Infinity
// =============================================================================
func TestPipelineE2E_PipelineExecutor(t *testing.T) {
testCases := []struct {
name string
engineType engine.EngineType
}{
{
name: "Elasticsearch",
engineType: engine.EngineElasticsearch,
},
{
name: "Infinity",
engineType: engine.EngineInfinity,
},
}
ctx := t.Context()
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
t.Logf("Running Pipeline E2E test with engine: %s", tc.name)
// Setup test database
db := testutil.SetupTestDB(t)
cleanupDB := testutil.ReplaceDBForTest(t, db)
defer cleanupDB()
// Seed test data (lowercase for ES index compatibility, no hyphens for Infinity)
lowerName := toLowerSnakeCase(tc.name)
tenantID, kbID, _, taskID := testutil.SeedTestData(t, db,
testutil.WithTenantID(fmt.Sprintf("tenant_e2e_%s", lowerName)),
testutil.WithKBID(fmt.Sprintf("kb_e2e_%s", lowerName)),
testutil.WithDocID(fmt.Sprintf("doc_e2e_%s", lowerName)),
testutil.WithTaskID(fmt.Sprintf("task_e2e_%s", lowerName)),
testutil.WithPipelineID(fmt.Sprintf("pipeline_e2e_%s", lowerName)),
testutil.WithDocName(fmt.Sprintf("e2e_test_%s.pdf", lowerName)),
)
// Setup DocEngine for this test
docEngine, cleanupEngine := setupTestDocEngine(t, tc.engineType, tenantID, kbID)
defer cleanupEngine()
// Load task context
ingestionTask, err := dao.NewIngestionTaskDAO().GetByID(ctx, db, taskID)
if err != nil {
t.Fatalf("GetByID failed: %v", err)
}
taskCtx, err := LoadFromIngestionTask(ctx, ingestionTask)
if err != nil {
t.Fatalf("LoadFromIngestionTask failed: %v", err)
}
taskCtx.Ctx = context.Background()
// Track what was called
var (
loadDSLCalled bool
runPipelineCalled bool
insertChunksCalled bool
)
var capturedChunks [][]map[string]any
// Build a PipelineExecutor with mocked dependencies.
svc := mustNewPipelineExecutor(t, taskCtx, taskCtx.PipelineID, 0)
// Mock loadDSLFunc
svc.WithLoadDSLFunc(func(ctx context.Context, canvasID string) (string, string, error) {
loadDSLCalled = true
return `{"nodes":[{"id":"test","type":"parser"}],"edges":[]}`, canvasID, nil
})
// Mock runPipelineFunc - returns test chunks (with vectors to skip embedding)
svc.WithRunPipelineFunc(func(ctx context.Context, dsl string) (map[string]any, string, error) {
runPipelineCalled = true
return map[string]any{
"chunks": []map[string]any{
{
"text": fmt.Sprintf("Hello world from E2E test with %s", tc.name),
"id": fmt.Sprintf("chunk_e2e_%s_1", lowerName),
"q_2_vec": []float64{0.1, 0.2}, // Pre-vectorized to skip embedding
},
{
"text": fmt.Sprintf("Second chunk from E2E test with %s", tc.name),
"id": fmt.Sprintf("chunk_e2e_%s_2", lowerName),
"q_2_vec": []float64{0.3, 0.4}, // Pre-vectorized to skip embedding
},
},
indexdoc.EmbeddingTokenConsumptionKey: 100,
}, dsl, nil
})
// Use the injected DocEngine for insertChunks!
svc.WithInsertFunc(func(ctx context.Context, chunks []map[string]any, baseName string, datasetID string) ([]string, error) {
insertChunksCalled = true
t.Logf("DocEngine InsertChunks called! baseName=%s datasetID=%s len(chunks)=%d", baseName, datasetID, len(chunks))
ids, err := docEngine.InsertChunks(ctx, chunks, baseName, datasetID)
if err != nil {
t.Logf("WARNING: InsertChunks err=%v", err)
}
capturedChunks = append(capturedChunks, chunks)
return ids, err
})
// Execute the pipeline!
t.Logf("Calling PipelineExecutor.Execute()...")
_, err = svc.Execute(taskCtx.Ctx)
if err != nil {
t.Fatalf("PipelineExecutor.Execute failed: %v", err)
}
t.Logf("PipelineExecutor.Execute() complete!")
// Verify all the expected calls happened
if !loadDSLCalled {
t.Fatal("Expected loadDSLFunc to be called")
}
if !runPipelineCalled {
t.Fatal("Expected runPipelineFunc to be called")
}
if !insertChunksCalled {
t.Fatal("Expected insertChunks to be called")
}
// Verify chunks were captured
totalChunks := 0
for _, batch := range capturedChunks {
totalChunks += len(batch)
}
if totalChunks != 2 {
t.Fatalf("Expected total 2 chunks, got %d", totalChunks)
}
// Now verify we can read the chunks back!
baseName := fmt.Sprintf("ragflow_%s", tenantID)
t.Logf("Reading chunks back from %s: baseName=%s datasetID=%s", tc.name, baseName, kbID)
// Refresh (wait for ES to index or Infinity to commit)
time.Sleep(300 * time.Millisecond)
for _, batch := range capturedChunks {
for _, chunk := range batch {
chunkID, ok := chunk["id"].(string)
if ok && chunkID != "" {
t.Logf("Trying to get chunk: %s", chunkID)
readBack, err := docEngine.GetChunk(context.Background(), baseName, chunkID, []string{kbID})
if err != nil {
t.Logf("WARNING: Failed to get chunk %q: %v", chunkID, err)
} else if readBack == nil {
t.Logf("WARNING: chunk %q not found (may not have been indexed yet)", chunkID)
} else {
t.Logf("SUCCESS: Read back chunk %q!", chunkID)
}
}
}
}
// Verify final task status can be marked completed
ingestSvc := service.NewIngestionTaskService()
if err = ingestSvc.MarkCompleted(ctx, taskID); err != nil {
t.Fatalf("MarkCompleted failed: %v", err)
}
finalTask, err := dao.NewIngestionTaskDAO().GetByID(ctx, db, taskID)
if err != nil {
t.Fatalf("GetByID failed: %v", err)
}
if finalTask.Status != common.COMPLETED {
t.Errorf("Final task status = %q, want %q", finalTask.Status, common.COMPLETED)
}
t.Logf("SUCCESS: Pipeline E2E test passed with %s engine!", tc.name)
})
}
}