Files
yawan f7fc992f57
Anydoc / anydoc parser engine (push) Canceled after 0s
App / Format, vet, test, and build (push) Canceled after 0s
CLI / test (macos-latest / go 1.26) (push) Canceled after 0s
CLI / test (ubuntu-latest / go 1.26) (push) Canceled after 0s
CLI / test (windows-latest / go 1.26) (push) Canceled after 0s
Build and Push Docker Image / build-ui (push) Canceled after 0s
Build and Push Docker Image / build-docreader (push) Canceled after 0s
Build and Push Docker Image / build-sandbox (push) Canceled after 0s
Build and Push Docker Image / build-app (amd64, linux/amd64, ubuntu-latest) (push) Canceled after 0s
Build and Push Docker Image / build-app (arm64, linux/arm64, ubuntu-24.04-arm) (push) Canceled after 0s
DocReader / Python tests and Go client tests (push) Canceled after 0s
Build & Publish (dsh-weknora) / Typecheck, test, pack (push) Canceled after 0s
Build & Publish (dsh-weknora) / End-to-end inside dsh (pinned) (push) Canceled after 0s
Build & Publish (dsh-weknora) / End-to-end inside dsh (latest, advisory) (push) Canceled after 0s
Frontend / Test, type-check, and build (push) Canceled after 0s
Go Lint Cache / warm lint cache (.) (push) Canceled after 0s
Go Lint Cache / warm lint cache (cli) (push) Canceled after 0s
Go Lint Cache / warm lint cache (client) (push) Canceled after 0s
Build & Publish (mcp-server) / Test (Python 3.10) (push) Canceled after 0s
Build & Publish (mcp-server) / Test (Python 3.11) (push) Canceled after 0s
Build & Publish (mcp-server) / Test (Python 3.12) (push) Canceled after 0s
Build & Publish (mcp-server) / Test (Python 3.13) (push) Canceled after 0s
Build and Push Docker Image / merge (push) Canceled after 0s
Build & Publish (dsh-weknora) / Publish to npm (push) Canceled after 0s
Build & Publish (mcp-server) / Build sdist + wheel (push) Canceled after 0s
Build & Publish (mcp-server) / Publish to PyPI (push) Canceled after 0s
WeKnora deployment source with the reviewed wiki identity, summary and recovery fixes
2026-09-22 16:19:06 +08:00

27 KiB
Raw Permalink Blame History

数据源导入(Data Source)

团队的知识往往长在飞书、Notion、语雀里,手动导一次很快就过期。数据源要解决的是持续同步:绑定一次账号,之后按计划自动把新增和修改同步进知识库,删除的文档也会同步下架。

用法:数据源是挂在知识库上的,不在全局设置里——打开目标知识库 → 编辑设置 → 「数据源」页签(仅编辑模式下出现)→ 新建连接 → 填凭据并授权 → 选要同步的空间/目录 → 设定同步周期。首次同步是全量,之后按修改时间增量拉取。

它不是一次性导入工具,而是一套完整的"连接器 + 调度器 + 增量同步 + 知识入库"流水线:

  • 连接器框架与实现:internal/datasource/(connector.go、scheduler.go、httpclient.go、errors.go、connector/ 各实现)
  • HTTP 接口层:internal/handler/datasource.go、internal/handler/datasource_credentials.go
  • 业务服务层:internal/application/service/datasource_service.go
  • 数据模型:internal/types/datasource.go

核心抽象:Connector 接口

所有连接器必须实现 internal/datasource/connector.go 中的 Connector 接口:

type Connector interface {
    // Type 返回连接器类型标识(如 "feishu"、"notion")
    Type() string
    // Validate 通过实际调用外部 API 验证配置与凭据有效性
    Validate(ctx context.Context, config *types.DataSourceConfig) error
    // ListResources 列出可同步的资源(文档、空间、文件夹等)。
    // parentID 支持层级资源的懒加载:""=顶层;非空=该资源的直接子节点
    ListResources(ctx context.Context, config *types.DataSourceConfig, parentID string) ([]types.Resource, error)
    // ResolveResourceAncestors 解析已选资源的祖先链,用于懒加载选择器回显深层选中项
    ResolveResourceAncestors(ctx context.Context, config *types.DataSourceConfig, resourceIDs []string) ([]string, error)
    // FetchAll 全量同步指定资源
    FetchAll(ctx context.Context, config *types.DataSourceConfig, resourceIDs []string) ([]types.FetchedItem, error)
    // FetchIncremental 基于游标增量同步,返回变更项与下一次同步的新游标
    FetchIncremental(ctx context.Context, config *types.DataSourceConfig, cursor *types.SyncCursor) ([]types.FetchedItem, *types.SyncCursor, error)
}

可选扩展:StreamingConnector(流式可恢复同步)

针对大规模同步(如上千篇文档的飞书 Wiki),connector.go 还定义了可选的 StreamingConnector 接口。实现了它的连接器不再一次性把所有条目攒在内存里,而是"边抓取、边入库、边落盘游标":

type StreamHandler interface {
    // Emit 逐条入库一个抓取项;返回错误则中止整个流
    Emit(ctx context.Context, item types.FetchedItem) error
    // Checkpoint 同步持久化游标快照(必须是完整可恢复的快照,而非增量)
    Checkpoint(ctx context.Context, cursor *types.SyncCursor) error
}

type StreamingConnector interface {
    Connector
    FetchStream(ctx context.Context, config *types.DataSourceConfig,
        cursor *types.SyncCursor, h StreamHandler) (*types.SyncCursor, error)
}

价值(见源码注释,对应 issue Tencent/WeKnora#2136):同步任务超时(Asynq 任务超时为 2 小时)后可以从最后一个 checkpoint 续传,而不是从头重来;同时内存占用被限制在"单个条目"级别。目前只有 Feishu/Lark 连接器实现了 StreamingConnector。

ConnectorRegistry:注册与查找

ConnectorRegistry 是简单的 map[string]Connector 注册表。实际注册发生在 internal/container/container.go 的 initConnectorRegistry():

registry.Register(feishuConnector.NewConnector(feishuConnector.RegionFeishu))  // feishu
registry.Register(feishuConnector.NewConnector(feishuConnector.RegionLark))    // lark(国际版,同一实现不同 Region)
registry.Register(notionConnector.NewConnector())                              // notion
registry.Register(yuqueConnector.NewConnector())                               // yuque
registry.Register(rssConnector.NewConnector())                                 // rss

注意:connector.go 中的 ConnectorMetadataRegistry 为前端展示定义了更多连接器元数据(Confluence、GitHub、Google Drive、OneDrive、DingTalk、Web Crawler、Slack、IMAP 等),但当前代码库中实际注册可用的连接器只有 5 个类型:feishu、lark、notion、yuque、rss(其中 feishu/lark 共用同一份实现)。未注册类型在创建数据源时会被 connectorRegistry.Get() 以 ErrConnectorNotFound 拒绝。

数据模型(internal/types/datasource.go)

结构 说明
DataSource 数据源配置实体(表 data_sources)。关键字段:Type(连接器类型)、Config(JSONB,含加密凭据)、SyncSchedule(cron 表达式)、SyncMode(incremental/full)、Status(active/paused/error/deleted)、ConflictStrategy、SyncDeletions、LastSyncCursor(增量游标 JSONB)、LastSyncAt、LastSyncResult、SyncLogRetentionDays
SyncLog 单次同步执行记录(表 sync_logs)。状态:running/success/partial/failed/canceled;计数:ItemsTotal/Created/Updated/Deleted/Skipped/Failed;Result 保存 SyncResult JSON
DataSourceConfig 解密后的配置结构:Type + Credentials map[string]interface{} + ResourceIDs []string(选中的资源)+ Settings map[string]interface{}(非机密配置)
Resource 外部系统的可选资源:ExternalID、Name、Type、URL、ParentID、HasChildren、ModifiedAt、Metadata
FetchedItem 单个抓取到的文档:ExternalID、Title、Content []byte、ContentType、FileName、URL、UpdatedAt、Metadata、IsDeleted、SourceResourceID
SyncCursor 增量游标:LastSyncTime + ConnectorCursor map[string]interface{}(连接器自定义结构)
SyncResult 同步结果汇总 + Errors []SyncItemError(失败样本,上限 100 条,见 maxSyncResultErrors)
SyncItemError 面向用户的失败样本:稳定的 i18n Code + 插值 Params + 兜底 Message;原始 API 状态码/响应体只留在服务端日志
DataSourceSyncPayload Asynq 任务载荷:DataSourceID、TenantID、SyncLogID、ForceFull、Trigger(manual/schedule)

凭据加密存储

凭据安全是该模块的重点设计,实现分散在三处:

1. 写入时加密 —— DataSourceConfig.ToJSON()(internal/types/datasource.go):

// 当配置了 SYSTEM_AES_KEY 时,Credentials 中的每个字符串值在序列化前
// 都会做 AES-256-GCM 加密。这是凭据进入 DB 的唯一写路径(GORM 的 JSON
// 类型本身是字节透传),因此在这里加密即可保证 DataSource.Config 落库全程密文。
if key := utils.GetAESKey(); key != nil && len(out.Credentials) > 0 {
    ...
    if enc, err := utils.EncryptAESGCM(s, key); err == nil { encCreds[k] = enc }
}

2. 读取时解密 —— DataSource.ParseConfig():透明处理三种情况——空串原样返回;无 enc:v1: 前缀的历史明文原样返回(免迁移);密文用 SYSTEM_AES_KEY 解密。解密失败(密钥丢失/轮转)时不让行加载失败,而是把该字段置空,UI 显示"凭据未配置",用户重填即可,不会丢失数据源其他配置。

3. 独立的凭据子资源 —— internal/handler/datasource_credentials.go:凭据不走普通的 PUT /datasource/:id,而是独立的 /credentials 子资源,且是整体原子替换(不允许按字段 PATCH,因为"配了一半的连接器认证"没有意义):

  • PUT /api/v1/datasource/:id/credentials — 整体替换凭据 map,替换后立即调用连接器 Validate 做在线校验(错 token 立刻反馈,而不是等到下次调度同步)
  • DELETE /api/v1/datasource/:id/credentials/credentials — 整体清空
  • 响应中永远不回传密文/明文,只返回 {"credentials": {"configured": true/false}};列表/详情接口经 dto.NewDataSourceResponse 序列化时也从构造上剥离 Credentials

普通更新接口 UpdateDataSource(datasource_service.go)会强制保留库中已存凭据,即使请求体里带了 credentials 也被忽略并打警告日志。另外 StripNonSecretCredentials 会把误放进 credentials 的非机密字段清出去(目前只有 RSS 的 feed_urls,它属于 Settings)。

数据源生命周期与 REST API

路由注册在 internal/router/router.go 的 RegisterDataSourceRoutes(读操作 Viewer+,写操作 Admin+):

方法与路径 权限 说明
GET /api/v1/datasource/types Viewer 可用连接器元数据列表(ListAvailableConnectors,按 Priority 排序)
POST /api/v1/datasource/validate-credentials Admin 用裸凭据测试连通性(不落库),供创建向导的"测试连接"按钮
POST /api/v1/datasource Admin 创建数据源(校验 KB 归属租户 → 校验连接器类型 → 在线 Validate → 落库 → 注册 cron)
GET /api/v1/datasource?kb_id= Viewer 按知识库列出数据源(附带最近一次 SyncLog)
GET /api/v1/datasource/:id Viewer 详情
PUT /api/v1/datasource/:id Admin 更新(凭据字段被忽略;配置实际变化且已有凭据时才触发在线校验;同步更新 cron)
DELETE /api/v1/datasource/:id Admin 软删除 + 移除 cron + 取消 pending/running 的 SyncLog
PUT /api/v1/datasource/:id/credentials Admin 原子替换凭据(见上节)
DELETE /api/v1/datasource/:id/credentials/:field Admin 清空凭据(field 只接受 credentials)
POST /api/v1/datasource/:id/validate Admin 对已存数据源做连接测试;失败置 status=error,成功清除 error 状态
GET /api/v1/datasource/:id/resources?parent_id= Viewer 列出外部系统可选资源(parent_id 支持懒加载展开)
POST /api/v1/datasource/:id/resource-ancestors Viewer 解析选中资源的祖先链(编辑时回显深层勾选)
POST /api/v1/datasource/:id/sync Admin 手动触发同步(创建 SyncLog + 入队 Asynq 任务)
POST /api/v1/datasource/:id/pause / resume Admin 暂停/恢复(同时移除/重挂 cron)
GET /api/v1/datasource/:id/logs、GET /api/v1/datasource/logs/:log_id Viewer 同步历史

所有 :id 路径都先经 getOwnedDataSource → getOwnedKnowledgeBase 做租户隔离校验(数据源归属的 KB 必须属于当前租户,且通过 API Key 的 KB 授权检查)。

生命周期状态流转:

flowchart LR
    A["创建<br/>POST /datasource"] --> B["授权<br/>PUT /:id/credentials<br/>(AES-256-GCM 加密落库 + 在线 Validate)"]
    B --> C["选择资源<br/>GET /:id/resources<br/>(ResourceIDs 写入 Config)"]
    C --> D["active<br/>(cron 调度 / 手动同步)"]
    D -- "同步失败" --> E["error"]
    E -- "validate 通过 / 同步成功" --> D
    D -- "POST /:id/pause" --> F["paused"]
    F -- "POST /:id/resume" --> D
    F -- "手动同步仍允许" --> D
    D -- "DELETE /:id" --> G["软删除<br/>(移除 cron + 取消未完成 SyncLog)"]

同步调度(internal/datasource/scheduler.go)

Scheduler 基于 robfig/cron(cron.WithSeconds(),支持秒级 6 段表达式)为每个配置了 SyncSchedule 的 active 数据源维护一个 cron entry;服务启动时 Start() 从 DB 加载全部 active 数据源批量注册。

由于 robfig/cron 按绝对墙钟时间触发(例如 0 0 * * * * 总在整点触发),多实例部署时所有实例会同时触发。去重靠两层机制:

  1. DB 层防重叠:syncLogRepo.HasRunningSync —— 上一次同步还在 running 就跳过本次(防止同步耗时超过 cron 间隔时叠加执行)。
  2. Redis 层跨实例去重:确定性的 asynq.TaskID = "dssync:<dsID>:<yyyyMMddHHmm>"(按分钟截断)。同一分钟内所有实例产生相同 TaskID,Redis 保证只有一个入队成功,其余得到 asynq.ErrTaskIDConflict,对应 SyncLog 标记为 canceled("deduplicated: another instance enqueued first")。

入队参数:队列 types.QueueSync、MaxRetry(5)、Timeout(2*time.Hour)。任务类型为 types.TypeDataSourceSync("datasource:sync"),由 internal/router/task.go 中 mux.HandleFunc(types.TypeDataSourceSync, params.DataSourceService.ProcessSync) 消费。

同步执行与知识入库(datasource_service.go)

ProcessSync 是 Asynq 任务处理器,完整流程见下方时序图。要点:

  • 防御性取消:数据源或知识库已被删除时,把 SyncLog 置为 canceled 并返回 nil(不再重试)。
  • 两条抓取路径:连接器实现了 StreamingConnector 走 processSyncStreaming(流式);否则按 ForceFull || SyncMode==full 走 FetchAll,或带上 ParseSyncCursor() 的游标走 FetchIncremental(批量)。
  • 流式路径的游标策略(streamStartCursor):用户触发的全量同步在首次尝试时丢弃游标全量抓取;Asynq 重试(attempt > 0)以及所有增量同步都从最后一个 checkpoint 续传。
  • 入库核心 applyFetchedItem → ingestItem:
    • IsDeleted=true 的条目只累加 result.Deleted 计数——刻意不真正删除知识库条目(防止连接器误判或重新配置导致意外数据丢失,用户需在 KB UI 中显式删除);
    • 有 Content 字节 → 包装成 multipart.FileHeader 走 KnowledgeService.CreateKnowledgeFromFile(完整文档解析流水线);只有 URL → 走 CreateKnowledgeFromURL 由 WeKnora 下载解析;
    • 更新 = 先删后建:按 metadata external_id 查到既有知识条目就先 DeleteKnowledge 再重建,计为 Updated;
    • 重复文件(DuplicateKnowledgeError)计为 Skipped,不算失败;
    • 每个条目自动带上 metadata:external_id、source_resource_id、datasource_id 以及连接器附加的 metadata。
  • 自动打标:resolveAutoTagIDs 按数据源名称在目标 KB 中 FindOrCreate 一个标签,所有同步条目自动挂上,便于在 KB 中识别来源;打标失败不阻断同步。
  • 结果状态:全部条目失败 → failed(allFetchedItemsFailedError);RSS 部分 feed 失败(PartialFetchError)或流式路径存在失败文档 → partial;其余 → success。失败样本以 SyncItemError 形式最多保留 100 条。
  • 抓取失败时若连接器返回了新游标(如 RSS),仍会持久化游标,避免瞬时故障后被迫全量重抓。
sequenceDiagram
    autonumber
    participant U as "用户 / Cron Scheduler"
    participant H as "DataSourceHandler"
    participant S as "DataSourceService"
    participant Q as "Asynq (QueueSync)"
    participant C as "Connector (如 Feishu)"
    participant EXT as "外部系统 API"
    participant K as "KnowledgeService"
    participant DB as "PostgreSQL"

    U->>H: POST /datasource/:id/sync (或 cron 触发)
    H->>S: ManualSync(dsID)
    S->>DB: 创建 SyncLog(status=running)
    S->>Q: Enqueue(datasource:sync, MaxRetry=5, Timeout=2h)
    Q-->>S: ProcessSync(payload)
    S->>DB: 加载 DataSource / SyncLog / 校验 KB 存在
    S->>S: ParseConfig() 解密凭据
    alt "StreamingConnector(Feishu/Lark)"
        S->>C: FetchStream(config, cursor, handler)
        loop "遍历 Wiki 节点"
            C->>EXT: ListWikiNodesRecursive / ExportAndDownload
            EXT-->>C: 文档内容 (.docx/.xlsx/原文件)
            C->>S: handler.Emit(item)
            S->>K: CreateKnowledgeFromFile (先删后建=更新)
            C->>S: handler.Checkpoint(cursor) 每 50 节点或 30s
            S->>DB: 持久化 LastSyncCursor + SyncLog 进度
        end
        C-->>S: 最终 cursor
    else "批量连接器(Notion/Yuque/RSS)"
        S->>C: FetchAll 或 FetchIncremental(cursor)
        C->>EXT: 列表 + 拉取变更内容
        EXT-->>C: 文档 / Markdown
        C-->>S: []FetchedItem + nextCursor
        loop "每个条目"
            S->>K: applyFetchedItem → ingestItem
        end
    end
    S->>DB: 更新 SyncLog(success/partial/failed) + DataSource(LastSyncAt/Cursor/Result)
    S->>DB: 记录审计日志 (recordKBActivity)

连接器实现详解

连接器能力对比

Feishu / Lark Notion Yuque(语雀) RSS / Atom
源码目录 internal/datasource/connector/feishu/ connector/notion/ connector/yuque/ connector/rss/
类型标识 feishu / lark notion yuque rss
认证方式 企业自建应用 app_id + app_secret(tenant_access_token) Internal Integration Token(api_key) 个人/团队 Token(api_token,X-Auth-Token 头) 无认证或自定义请求头(auth_headers)
凭据字段 app_id、app_secret、base_url(可选覆盖) api_key(base_url 走 Settings) api_token、base_url(私有化部署可选) auth_headers(可选,属凭据);feed_urls 属 Settings
资源模型 Wiki 空间 → 节点树(懒加载,spaceID:nodeToken 复合 ID) 页面/数据库全量树(一次返回带 parent 关系) 知识库(book/repo)扁平列表 每个 feed URL 一个资源(扁平)
内容格式 导出 API → .docx/.xlsx 文件;drive 文件原样下载 Block → Markdown;数据库转 Markdown 表格;附件下载 body Markdown 原文(.md) Readability 全文抽取 → HTML→Markdown
增量机制 按节点 obj_edit_time 比对(cursor: SpaceNodeTimes) 按页面/记录 last_edited_time 比对(cursor: PageEditTimes) 按文档 content_updated_at 比对(cursor: BookDocTimes) feed 信号指纹 + 内容 SHA-256 指纹双层比对
删除检测 支持(游标中有、当前树没有 → IsDeleted;部分列举失败时跳过删除检测) 支持(区分"源端已删"与"用户取消勾选",后者不报删除) 支持 不支持(feed 天然滚动淘汰旧条目)
流式可恢复同步 是(StreamingConnector,每 50 节点或 30 秒 checkpoint) 否 否 否
限流应对 429 读 Retry-After + 指数退避(2s/4s/8s,最多 3 次重试);5xx 重试 — 每次 GetDocDetail 间隔 300ms(个人 token 约 100 req/5min) —
部分失败 单文档失败生成带错误 metadata 的占位条目,继续同步 单页失败记日志跳过 单文档失败生成占位条目 单 feed 失败 → PartialFetchError;全部失败才算 fail

Feishu / Lark(connector/feishu/)

飞书与 Lark(国际版 open.larksuite.com)是部署在两朵隔离云上的同一产品,Wiki/docx/drive API 完全一致,因此共用同一份连接器代码,由 region.go 中的 Region 结构选择云端(RegionFeishu / RegionLark,分别对应类型 feishu / lark、API 域名 open.feishu.cn / open.larksuite.com)。base_url 凭据字段可显式覆盖(兼容历史上把 feishu 连接器指向 larksuite 的存量数据源)。

  • 认证(client.go):POST /open-apis/auth/v3/tenant_access_token/internal 换取 tenant_access_token,带互斥锁缓存与过期刷新。
  • 资源列举(ListResources):三级懒加载——parentID=="" 列 Wiki 空间;parentID==spaceID 列空间顶层节点;parentID=="spaceID:nodeToken" 列该节点子节点。早期版本会预先递归整棵树,大 Wiki 会超时(issue #1672),现在递归只发生在同步时。ResolveResourceAncestors 通过 GetWikiNode 的 parent_node_token 逐级上溯,O(depth) 回显深层勾选。
  • 内容抓取(fetchNodeContent)按 obj_type 分派:
    • docx/doc → 异步导出 API(POST /drive/v1/export_tasks)导出 .docx;
    • sheet/bitable → 导出 .xlsx;
    • file → drive 原文件下载(PDF/Word/图片等);
    • mindnote/slides → 跳过(无内容读取 API),并通过 fetchTally 统计输出 discovered/fetched/failed/skipped_unsupported by_type 摘要日志,解释"发现 13 篇为何只同步了 3 篇"(issue #2136)。
  • 增量逻辑:游标 feishuCursor.SpaceNodeTimes(resourceID → nodeToken → editTime)。变更判定用 obj_edit_time(文档内容编辑时间),而不是 node_edit_time(只反映改标题/挪位置)。抓取失败的节点不推进游标(保留旧 editTime,下次必然 prev != current 而重试),避免瞬时导出失败导致文档被永久跳过。
  • FetchStream:统一全量/增量路径(cursor==nil 即全量),每处理 feishuStreamCheckpointInterval = 50 个节点、或距上次 checkpoint 超过 feishuStreamCheckpointMaxInterval = 30s 就落盘一次游标——后者兜底"少量文档但每篇导出都极慢(被限流)"导致 2 小时超时前从未 checkpoint 的场景。
  • 错误分类(feishuFailure):把原始错误归类为稳定 i18n code(feishu_auth_or_permission / feishu_rate_limited / feishu_timeout / feishu_server_unavailable / feishu_api_error(+code) / sync_failed),前端本地化展示;原始 status/body/log_id 只留在服务端日志。

Notion(connector/notion/)

  • 认证:Internal Integration Token(凭据字段 api_key),API 版本 NotionAPIVersion = "2026-03-11",默认 https://api.notion.com(Settings.base_url 可覆盖)。
  • 资源列举:Search API 一次拉取全部可见页面与数据库,返回带 ParentID 的完整树(因此 parentID != "" 的懒加载请求直接返回空;ResolveResourceAncestors 亦无事可做)。resolveParentID 处理 2025-09-03+ API 的 data_source 对象:其 parent 指向数据库容器,真实工作区位置要看 database_parent。
  • 抓取:fetchPage 递归处理页面——GetBlockChildrenAll 拉块 → BlocksToMarkdown(markdown.go)转 Markdown;file_upload 型文件块先 ResolveBlock 换临时下载 URL;附件(PDF 等,图片除外——图片已以 ![](url) 内联在 Markdown 中)作为独立条目下载入库;child_page / child_database 块递归下钻。数据库两种形态:整库渲染成一张 Markdown 表格(buildDatabaseItem,含每条记录的块内容附录),数据库记录单独出现时按"属性列表 + 块内容"渲染(buildRecordItem)。属性提取 propertyToString 通用地跟随 type 链,覆盖全部 22 种属性类型;属性名按字母序排序保证增量比对的确定性。
  • 增量逻辑:首次同步(游标为空)直接委托 FetchAll 并用返回条目的 UpdatedAt 构建游标;后续同步 discoverAllResources 用 Search API + BFS 圈定选中根下的全部后代,逐页比对 last_edited_time。数据库走 fetchDatabaseIncremental:任一记录变更就整表重建。
  • 删除与取消勾选的区分:源端消失的页面报 IsDeleted;仍可见但因用户取消勾选祖先而不再可达的页面进入 excluded 集合,不会被误报为删除。computeExcludedSet 同时保证"用户从未见过的新页面"不被排除——选中的父节点仍会自动带上新子页面。

Yuque 语雀(connector/yuque/)

  • 认证:个人 Token(语雀设置 → Token)或团队 Token,凭据字段 api_token(请求头 X-Auth-Token)+ 可选 base_url(企业私有化域名,缺 scheme 自动补 https://)。
  • 资源列举:GET /api/v2/user 判断 token 身份——type=="Group" 为团队 token,直接列团队 repo;否则列个人 repo + 已加入 group 的 repo(用户未加入任何 group 时语雀返回 404,按空处理)。输出扁平的 book 资源列表,按 ExternalID 稳定排序。
  • 抓取(walk,全量/增量共用):ListBookDocs 列文档 → 过滤 type != "Doc"(跳过 Sheet/Thread/Board/Table)与 status != "1"(跳过草稿)→ 每次 GetDocDetail 之间 sleep 300ms 规避限流 → format 为 markdown/lake 时取 body Markdown 原文入库(其他格式如 html 防御性跳过并记 skip_reason)。
  • 增量逻辑:游标 yuqueCursor.BookDocTimes(bookID → docID → content_updated_at),一致则跳过。删除检测:游标里有、当前列表没有 → IsDeleted。

RSS / Atom(connector/rss/)

  • 配置:feed_urls(换行/逗号分隔,多条去重)存放在 Settings(非机密,UI 可直接编辑);auth_headers(Name: Value 每行一条,仅附加在 feed 请求上、绝不发给第三方文章页)存放在 Credentials 并加密。HasConfiguredCredentials 对 RSS 特判:只有 auth_headers 才算已配置凭据。
  • 抓取:gofeed 解析 RSS/Atom/JSON feed;条目有链接时抓原文页过 readability 抽取器,成功则以全文为准,失败回退 feed 自带内容(content:encoded/description);HTML 经 html-to-markdown/v2 转 Markdown。条目 ID 取 GUID > Link > Title 第一个非空值。
  • 增量逻辑:双层指纹——先比 feed 侧信号指纹(feedSignalFingerprint,未变则连原文页都不抓);再比抓取后内容的 SHA-256 指纹。不支持删除同步(feed 会自然淘汰旧条目)。
  • 部分失败:单个 feed 抓取/解析失败时沿用旧游标(copyFeedCursor)并继续其余 feed,最终以 datasource.PartialFetchError 上报(SyncLog 记 partial);全部 feed 都失败才整体报错。

安全限制(internal/datasource/httpclient.go 与 errors.go)

httpclient.go 提供两个所有连接器共用的 SSRF 防护入口:

// ValidateConnectorBaseURL 对连接器 base_url 做 SSRF 策略校验(空值放行,由调用方套默认值)
func ValidateConnectorBaseURL(rawURL string) error {
    ...
    if err := utils.ValidateURLForSSRF(url); err != nil { ... }
}

// NewConnectorHTTPClient 返回带重定向与拨号期 SSRF 防护的 HTTP 客户端
func NewConnectorHTTPClient(timeout time.Duration) *http.Client {
    cfg := utils.DefaultSSRFSafeHTTPClientConfig()
    cfg.Timeout = timeout
    return utils.NewSSRFSafeHTTPClient(cfg)
}

底层 internal/utils/security.go 会拒绝私网地址、回环地址、link-local 等目标,并且在每次重定向和实际拨号时重新校验(而非只校验初始 URL),防止恶意 feed 或自定义 base_url 把 WeKnora 引向内网服务。各连接器的 parseXXXConfig 都会对 base_url 调用 ValidateConnectorBaseURL。

errors.go 定义了模块级哨兵错误(ErrConnectorNotFound、ErrDataSourceInvalid、ErrInvalidCredentials、ErrSyncFailed 等)与 PartialFetchError(部分资源成功、部分失败;调用方应处理已得条目、持久化游标、把 Details 以 partial 状态呈现给用户)。

参考

  • 连接器开发指南(随代码维护):internal/datasource/CONNECTOR_IMPLEMENTATION_GUIDE.md
  • 模块说明(随代码维护):internal/datasource/README.md