ListResources 的两条循环(get_addable_knowledge_base_list、search_knowledge_base 兜底)与 listAllKBFiles 的 get_knowledge_list 循环都只以 is_end / 空 next_cursor 为终止条件:既不记录用过的游标,也没有跳数上限。厂商只要回 is_end=false 且 next_cursor 不前进,循环就会一直请求同一页,bases / out 随迭代重复增长,直到任务 deadline —— 资源选择器接口不返回,同步任务永远不进终态。 同族的 DingTalk(seenTokens + maxPages)、Confluence(seen + maxPaginationHops)、飞书(seenPageTokens)都已有守卫,本包漏了。 改动: - 抽一条 nextPageCursor:每页取回 next_cursor 后调用,重复游标立即返回错误(不再 重试),页数达到 maxPaginationHops(10000,对齐 Confluence)时 Warn 并报错。 触顶必须留日志:从外部看这种失败和"还在正常同步"一模一样。 - 三条循环按同一写法接入;listAllKBFiles 的守卫错误补上 get_knowledge_list 前缀。 - 假 IMA 服务器支持覆盖某个 action 的分页字段(固定游标 / 每次换新游标 / 有限页数 / 每次换 payload / 请求预算),并给"无防护时会空转"的场景设请求上限,使回归用例失 败而不是挂死。 新增用例:三条循环的重复游标(都在第 2 次请求即报错)、跳数上限(正好 10000 次 请求后报错且日志含 "pagination exceeded 10000 pages")、真实多页仍正常合并。 去掉本次改动后这四条用例全部失败(重复游标场景实测跑到 10006 次请求才被假服务器 的预算拦下)。 Co-authored-by: linus-liu-web <11640009+linus-liu-web@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| connector | ||
| CONNECTOR_IMPLEMENTATION_GUIDE.md | ||
| README.md | ||
| connector.go | ||
| connector_test.go | ||
| errors.go | ||
| filename.go | ||
| filename_test.go | ||
| httpclient.go | ||
| httpclient_test.go | ||
| scheduler.go | ||
| scheduler_test.go | ||
README.md
WeKnora Data Source Sync Framework
Overview
The data source sync framework enables WeKnora to automatically import and synchronize content from external platforms (Feishu, Notion, Confluence, etc.) into knowledge bases. This is the foundational layer upon which all specific connectors are built.
Architecture
Core Components
┌─────────────────────────────────────────────────────────────┐
│ External Data Sources │
│ (Feishu, Notion, Confluence, GitHub, Google Drive...) │
└─────────────┬───────────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────┐
│ Connector Registry & Adapters │
│ Each platform (feishu/, notion/, confluence/, etc) │
│ implements the Connector interface │
└─────────────┬───────────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────┐
│ DataSourceService (Business Logic) │
│ ├─ CreateDataSource / UpdateDataSource │
│ ├─ ManualSync / ListAvailableResources │
│ ├─ ValidateConnection / PauseDataSource │
│ └─ ProcessSync (asynq task handler) │
└─────────────┬───────────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────┐
│ HTTP Handler & API Routes (/api/v1/datasource) │
│ REST endpoints for UI/programmatic access │
└─────────────┬───────────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────┐
│ Database (MySQL / PostgreSQL) │
│ ├─ data_sources (configuration & state) │
│ └─ sync_logs (history & metadata) │
└─────────────────────────────────────────────────────────────┘
Task Flow
Manual Trigger or Scheduled Job (cron)
↓
Scheduler enqueues asynq Task
↓
ProcessSync (task handler) executes
↓
Connector.Fetch* methods pull data
↓
Diff engine identifies changes (new/update/delete)
↓
KnowledgeService creates/updates Knowledge entries
↓
Documents parsed → chunks → vectors → indexed
File Structure
internal/datasource/
├── connector.go # Connector interface & registry
├── errors.go # Error definitions
└── README.md # This file
internal/types/
├── datasource.go # Data models (DataSource, SyncLog, etc)
└── interfaces/datasource.go # Service interfaces
internal/application/
├── repository/datasource_repo.go # Database access layer
└── service/datasource_service.go # Business logic
internal/handler/
└── datasource.go # HTTP request handlers
internal/router/
├── router.go # Route registration
├── task.go # Asynq task registration
└── sync_task.go # Lite mode task registration
migrations/versioned/
└── 000028_datasource_tables.up/down.sql # Database schema
Data Models
DataSource
Represents a configured external data source:
- ID: Unique identifier
- Type: Connector type (feishu, notion, confluence, etc)
- Config: Encrypted credentials and configuration (JSON)
- SyncSchedule: Cron expression (e.g., "0 */6 * * *")
- SyncMode: "incremental" or "full"
- Status: active | paused | error
- ConflictStrategy: overwrite | skip
- SyncDeletions: Whether to sync deletions from source
- LastSyncAt: Timestamp of last successful sync
- LastSyncCursor: State for incremental sync
- LastSyncResult: Summary of last sync
SyncLog
Tracks execution of each sync operation:
- Status: running | success | partial | failed | canceled
- StartedAt/FinishedAt: Execution timestamps
- Items*: Counters (total, created, updated, deleted, skipped, failed)
- ErrorMessage: Error details if failed
- Result: Detailed sync result (JSON)
Connector Interface
All external data sources implement this interface:
type Connector interface {
Type() string
Validate(ctx, config) error
ListResources(ctx, config) ([]Resource, error)
FetchAll(ctx, config, resourceIDs) ([]FetchedItem, error)
FetchIncremental(ctx, config, cursor) ([]FetchedItem, *SyncCursor, error)
}
API Endpoints
Data Source Management
POST /api/v1/datasource # Create
GET /api/v1/datasource # List (by kb_id)
GET /api/v1/datasource/:id # Get
PUT /api/v1/datasource/:id # Update
DELETE /api/v1/datasource/:id # Delete
Operations
POST /api/v1/datasource/:id/validate # Test connection
GET /api/v1/datasource/:id/resources # List available resources
POST /api/v1/datasource/:id/sync # Trigger manual sync
POST /api/v1/datasource/:id/pause # Pause
POST /api/v1/datasource/:id/resume # Resume
Logs
GET /api/v1/datasource/:id/logs # List sync logs
GET /api/v1/datasource/logs/:log_id # Get specific log
Metadata
GET /api/v1/datasource/types # Available connectors
Implementation Guide
Adding a New Connector
-
Create the connector package in
internal/datasource/connector/<type>/// connector/<type>/client.go - API client // connector/<type>/connector.go - Implements Connector interface // connector/<type>/types.go - Type-specific models -
Implement the Connector interface
type YourConnector struct { // fields } func (c *YourConnector) Type() string { return types.ConnectorTypeYourType } func (c *YourConnector) Validate(ctx, config) error { // Test connectivity and credentials } func (c *YourConnector) ListResources(ctx, config) ([]types.Resource, error) { // List available resources (documents, spaces, etc) } func (c *YourConnector) FetchAll(ctx, config, resourceIDs) ([]types.FetchedItem, error) { // Full sync - fetch all items from specified resources } func (c *YourConnector) FetchIncremental(ctx, config, cursor) ([]types.FetchedItem, *types.SyncCursor, error) { // Incremental sync - fetch only changed items since cursor } -
Register the connector in the container (in container.go)
container.Provide(func() datasource.Connector { return yourconnector.NewConnector() }) -
Add metadata in
connector.gotypes.ConnectorTypeYourType: { Type: types.ConnectorTypeYourType, Name: "Your Platform", AuthType: "oauth2", // ... }
Database Schema
data_sources table
- Stores data source configurations
- Indexes: tenant_id, knowledge_base_id, type, status
- Encrypted config field (AES-256-GCM)
sync_logs table
- Stores sync operation history
- Indexes: data_source_id, tenant_id, status, started_at
- Foreign key to data_sources with cascade delete
Key Design Decisions
- Adapter Pattern: Each connector is a separate implementation, easy to add new ones
- Async Task Queue: Syncs are non-blocking, using asynq (or sync mode in Lite)
- Incremental Sync: Supports cursor-based incremental syncs to minimize API calls
- Encryption: API keys/tokens stored encrypted with AES-256-GCM
- Multi-tenant: All operations are tenant-isolated
- Channel Tracking: Knowledge.Channel field tracks data source type for origin tracking
Future Enhancements
- Webhook Support: Real-time push from platforms that support webhooks
- Conflict Resolution: Advanced merge/conflict strategies for overlapping content
- Rate Limiting: Per-connector rate limiting and backoff strategies
- Scheduling: Full cron scheduler with time zone support
- Monitoring: Metrics, alerting, and sync health dashboards
- Filtering: User-defined filters for selective syncing (by title, date, tags, etc)
- Transformation: Content transformation pipelines (e.g., extract tables, summarize)
- Deduplication: Smart deduplication across multiple sources
Testing
The framework is designed to be testable:
- Mock connectors can be created for testing
- No external dependencies required for core logic
- Database operations isolated and mockable
Error Handling
All operations return detailed error information:
- Connection failures are captured and status updated
- Partial failures are logged (some items succeed, some fail)
- Error messages stored in DataSource for user troubleshooting