Go: file syncer service framework (#16579)

### Summary

./ragflow_main --syncer to start file syncer


config yaml file has following config
```
file_syncer:
  max_concurrent_syncs: 4 # concurrent file sync threads
  sync_interval: 3 # check interval

```

---------

Signed-off-by: Jin Hai <haijin.chn@gmail.com>
This commit is contained in:
Jin Hai
2026-07-03 11:14:02 +08:00
committed by GitHub
parent 62f94cd59b
commit 1aa8abe373
7 changed files with 262 additions and 14 deletions

View File

@@ -31,9 +31,9 @@ const (
type ServerType string
const (
ServerTypeAPI ServerType = "api_server" // API server
ServerTypeIngestion ServerType = "ingestor" // Ingestion server
ServerTypeDataCollector ServerType = "data_collector" // Data collection server
ServerTypeAPI ServerType = "api_server" // API server
ServerTypeIngestion ServerType = "ingestor" // Ingestion server
ServerTypeFileSyncer ServerType = "file_syncer" // File syncer server
)
type BaseMessage struct {

View File

@@ -209,7 +209,6 @@ func (r *Router) Setup(engine *gin.Engine) {
RegisterAgentbotRoutes(agentbotGroup, betaMW, r.botHandler)
}
// Public bot endpoints (authenticated with an SDK beta token, not a session)
apiBetaAuth.GET("/chatbots/:dialog_id/info", r.botHandler.ChatbotInfo)
apiBetaAuth.GET("/documents/:id/preview", r.documentHandler.GetDocumentPreview)
apiBetaAuth.GET("/documents/images/:image_id", r.documentHandler.GetDocumentImage)
apiBetaAuth.GET("/thumbnails", r.documentHandler.GetThumbnail)

View File

@@ -53,6 +53,7 @@ type Config struct {
DefaultSuperUser DefaultSuperUser `mapstructure:"default_super_user"`
Language string `mapstructure:"language"`
TaskExecutor TaskExecutorConfig `mapstructure:"task_executor"`
FileSyncer FileSyncerConfig `mapstructure:"file_syncer"`
}
// AdminConfig admin server configuration
@@ -76,6 +77,11 @@ type TaskExecutorConfig struct {
MessageQueueType string `mapstructure:"message_queue_type"`
}
type FileSyncerConfig struct {
MaxConcurrentSyncs int `mapstructure:"max_concurrent_syncs"`
SyncInterval int `mapstructure:"sync_interval"`
}
// UserDefaultLLMConfig user default LLM configuration
type UserDefaultLLMConfig struct {
DefaultModels DefaultModelsConfig `mapstructure:"default_models"`

143
internal/syncer/syncer.go Normal file
View File

@@ -0,0 +1,143 @@
//
// 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.
//
package syncer
import (
"context"
"fmt"
"ragflow/internal/common"
"ragflow/internal/dao"
"ragflow/internal/entity"
"sync"
"time"
"go.uber.org/zap"
)
// Syncer periodically polls the sync_logs table and dispatches due
// sync/prune tasks to a fixed-size worker pool.
type Syncer struct {
id string
maxConcurrency int
pollInterval time.Duration // how often each worker queries for due tasks
ctx context.Context
cancel context.CancelFunc
workerWg sync.WaitGroup
// ShutdownCh is closed when Stop() completes.
ShutdownCh chan struct{}
}
// NewSyncer creates a syncer with the given concurrency and poll interval.
func NewSyncer(maxConcurrency int, pollInterval time.Duration) *Syncer {
ctx, cancel := context.WithCancel(context.Background())
return &Syncer{
id: common.GenerateUUID(),
maxConcurrency: maxConcurrency,
pollInterval: pollInterval,
ctx: ctx,
cancel: cancel,
ShutdownCh: make(chan struct{}),
}
}
// Start launches maxConcurrency worker goroutines.
func (s *Syncer) Start() error {
common.Info(fmt.Sprintf("Syncer %s starting with %d workers (poll every %v)",
s.id, s.maxConcurrency, s.pollInterval))
for i := 0; i < s.maxConcurrency; i++ {
s.workerWg.Add(1)
go s.workerLoop(i)
}
return nil
}
// Stop cancels all workers and waits for them to finish.
func (s *Syncer) Stop() {
common.Info(fmt.Sprintf("Stopping syncer %s", s.id))
s.cancel()
s.workerWg.Wait()
close(s.ShutdownCh)
common.Info(fmt.Sprintf("Syncer %s stopped", s.id))
}
func (s *Syncer) ID() string {
return s.id
}
// workerLoop periodically polls the DB for due tasks until ctx is cancelled.
func (s *Syncer) workerLoop(workerID int) {
defer s.workerWg.Done()
common.Debug(fmt.Sprintf("Syncer worker %d started", workerID))
ticker := time.NewTicker(s.pollInterval)
defer ticker.Stop()
for {
select {
case <-s.ctx.Done():
common.Debug(fmt.Sprintf("Syncer worker %d exiting (ctx cancelled)", workerID))
return
case <-ticker.C:
s.pollAndExecute(workerID)
}
}
}
// pollAndExecute queries due sync & prune tasks, picks one, and runs it.
func (s *Syncer) pollAndExecute(workerID int) {
common.Info(fmt.Sprintf("Syncer worker %d polling for due tasks", workerID))
}
// executeSyncTask runs a sync task.
func (s *Syncer) executeSyncTask(task *entity.SyncLogs) {
common.Info("Executing sync task",
zap.String("task_id", task.ID),
zap.String("connector_id", task.ConnectorID),
zap.String("kb_id", task.KbID))
// TODO: implement actual data-source-specific sync logic.
// For now, mark done.
s.markTaskDone(task.ID, task.ConnectorID)
}
// executePruneTask runs a prune (delete stale docs) task.
func (s *Syncer) executePruneTask(task *entity.SyncLogs) {
common.Info("Executing prune task",
zap.String("task_id", task.ID),
zap.String("connector_id", task.ConnectorID),
zap.String("kb_id", task.KbID))
// TODO: implement actual prune logic.
s.markTaskDone(task.ID, task.ConnectorID)
}
// markTaskDone updates task and connector status to DONE.
func (s *Syncer) markTaskDone(taskID, connectorID string) {
db := dao.GetDB()
now := time.Now().Local()
db.Model(&entity.SyncLogs{}).Where("id = ?", taskID).Updates(map[string]interface{}{
"status": string(entity.TaskStatusDone),
"update_time": now,
})
db.Model(&entity.Connector{}).Where("id = ?", connectorID).Updates(map[string]interface{}{
"status": string(entity.TaskStatusDone),
"update_time": now,
})
}