feat(fuyao): 快照单页 limit=6000 一次拉完全市场

实测服务端单页 6000 不截断(全市场 ~5600 只), 一轮轮询从 11 请求降到
1 请求, 大幅降低 4001 限频压力; 分页循环保留作未来扩容/服务端截断兜底。
插件开发文档重写并补充单页上限实测结论与页间隔自限速要求。

docs/plugin-development.md

@@ -1,9 +1,13 @@
 # 数据源插件开发指南
 
-数据源插件是可选的行情数据来源(stock-sdk、akshare 等),作为独立模块放在
-`backend/app/plugins/` 下。用户**手动安装依赖**后才可用(开发模式);不安装完全不影响主功能。
+数据源插件是可选的行情数据来源(fuyao、stock-sdk、akshare 等),作为独立模块放在
+`backend/app/plugins/` 下。services 层(kline_sync / quote_service / financial_sync)
+全部通过统一路由点分流:插件声明了某数据集就走插件,未声明自动回退 TickFlow。
+因此**一个合格的插件只需要正确实现契约,不需要改动任何 service / API 代码**;
+反过来,插件也必须遵守内部数据契约(单位、代码格式、复权口径),框架不会替你转换。
 
-> ⚠️ **Docker 默认不打包 stock-sdk**(合规考虑:它抓取第三方财经网站接口,存在版权与反爬风险)。如需在 Docker 中启用,构建时传 `--build-arg INCLUDE_STOCKSDK=1`,使用风险自负。下方"手动安装依赖"适用于开发模式及自定义 Docker 构建。
+> 无代码接入(纯 HTTP YAML 配置)请看 [custom-data-source.md](./custom-data-source.md),
+> 两种方式遵循同一套内部数据契约。
 
 ## 快速上手
 
@@ -13,7 +17,7 @@
 backend/app/plugins/<your_plugin>/
 ├── plugin.yaml          # 清单(必需)
 ├── provider.py          # Provider 实现(必需)
-├── ...                  # 桥接/依赖文件(按需)
+├── ...                  # client/桥接/依赖文件(按需)
 ```
 
 ### plugin.yaml 字段
@@ -21,16 +25,19 @@ backend/app/plugins/<your_plugin>/
 ```yaml
 name: my_source                          # 唯一标识, 只允许 [a-z0-9_], 也是 provider name
 display_name: "我的数据源"                 # 设置页显示名
-runtime: python                          # 运行时类型: node | python | none
+runtime: none                            # 运行时类型: node | python | none
 entry: app.plugins.my_source.provider:MyProvider   # provider 类的导入路径
 check: app.plugins.my_source.bridge:availability   # 可用性检测函数(可选)
-datasets: [daily, adj_factor, minute, realtime]     # 支持的数据集
+datasets: [realtime]                     # 支持的数据集: daily/adj_factor/minute/realtime/financial
 api_key_env: MY_SOURCE_API_KEY           # (可选)声明后设置页提供 Key 输入框
 hidden: false                            # (可选)true = 已加载但对设置页隐藏,不注册不展示
 description: "数据源描述"
 install_hint: "pip install xxx"          # 未装依赖时显示的安装提示
 ```
 
+只声明真实提供的数据集;未声明的数据集 `provider_has_dataset` 返回 False,自动回退
+TickFlow。不要声明做不了的数据集(粒度含义见下文"能力声明的粒度")。
+
 #### api_key_env(界面配置 API Key)
 
 声明 `api_key_env` 的插件可以在设置页的数据源卡片中直接填写 Key, 对齐
@@ -49,36 +56,74 @@ TickFlow 的「先探后存」语义:
 | runtime | 含义 | 典型场景 |
 |---|---|---|
 | `python` | 纯 Python 依赖, `pip install` | akshare、tushare |
-| `node` | 需要 Node.js 运行时, `npm install` | stock-sdk(Docker 默认不打包,见 [deployment.md](./deployment.md)) |
-
-> stock-sdk 在 Docker 中默认不打包(合规考虑);如需启用,构建时传 `--build-arg INCLUDE_STOCKSDK=1`,开发模式下需手动 `npm install`。
+| `node` | 需要 Node.js 运行时, `npm install` | stock-sdk |
 | `none` | 无额外依赖 | 纯 HTTP API 源 |
 
+> ⚠️ stock-sdk 在 Docker 中默认不打包(合规考虑:它抓取第三方财经网站接口,存在版权与
+> 反爬风险)。如需启用,构建时传 `--build-arg INCLUDE_STOCKSDK=1`,使用风险自负。
+> 详见 [deployment.md](./deployment.md)。
+
 `runtime` 字段当前仅用于 UI 展示, 实际依赖检测由 `check` 函数负责。
 
 ### check 函数
 
-插件自己负责检测依赖是否已安装。后端启动时会调用此函数:
+插件自己负责检测依赖/Key 是否就绪。后端启动时会调用此函数:
 
 ```python
-# app/plugins/my_source/bridge.py
+# app/plugins/my_source/provider.py (或 bridge.py)
 def availability() -> tuple[bool, str]:
     """返回 (是否可用, 原因)。不抛异常。"""
-    try:
-        import akshare  # noqa: F401
-        return True, "ok"
-    except ImportError:
-        return False, "未安装 akshare, 运行: pip install akshare"
+    if not get_api_key():
+        return False, "未配置 MY_SOURCE_API_KEY(可在设置页数据源卡片中直接填写)"
+    return True, "ok"
 ```
 
 - **可用** → 插件注册进路由表, 设置页可切换
-- **不可用** → 设置页显示插件卡片但灰显, 展示 `install_hint`
+- **不可用** → 设置页显示插件卡片但灰显, 展示原因/`install_hint`
+
+## 内部数据契约(所有数据集必须遵守)
+
+以下口径是全项目红线(详见 CONTRIBUTING §3)。金融数据错误往往不抛异常,而是生成
+**看似合理的错误结果**——单位、代码格式、复权口径错了,页面照样能渲染,只是数字全错。
+插件必须在 provider 内完成适配。
+
+### 代码格式
+
+- symbol 统一带交易所后缀: `600519.SH` / `000001.SZ` / `300750.SZ`; ETF、指数同格式。
+- 接口返回裸代码(如 `600519`)或异构格式时,在 client 层实测一页并归一,不要直接透传。
+
+### 单位制
+
+| 字段 | 契约 | 说明 |
+| --- | --- | --- |
+| `change_pct` | **小数制**, `0.0366` = 3.66% | 接口给百分数(3.66)时必须在 provider 内显式 /100 |
+| `turnover_rate`(realtime 入口) | **小数制**, `0.05` = 5% | 下游 enriched 管道统一转百分数值存储 |
+| `volume` | 股 | |
+| `amount` / `turnover` | 元 | |
+| 日K OHLC | **不复权原始价** | 复权由 adj_factor + enriched 管道处理, provider 不得自行复权 |
+
+### 缺字段与空数据
+
+- 接口不提供的字段返回 `None`,禁止"数值小于 1 就乘 100"之类启发式补全——那会掩盖
+  真实的数据错误。
+- 可推导字段按固定口径推导: `change_pct = change_amount / prev_close`(小数制,不乘 100)。
+- 接口结构整体变化(如所有行都识别不出 symbol)要打明确告警日志,不要静默返回空数据。
+
+## 能力声明的粒度(重要)
+
+`datasets` 声明是**数据集级**的,不是资产类型级的:声明了 `realtime`,整个全市场实时
+轮询周期(含指数与 ETF 部分)就全部路由给插件。若你的快照只覆盖 A 股股票:
+
+- 指数行情自动降级为日线推导值(非实时),不报错;
+- ETF 实时计数为 0。
+
+这是当前框架的设计行为。要么在数据里尽量覆盖指数/ETF,要么接受降级并在
+`description` 里向用户说明覆盖范围。
 
 ## Provider 接口契约
 
-Provider 是一个普通 Python 类(无需继承基类), 实现以下方法签名。方法签名对齐
-`GenericHTTPProvider`, 这样 services 层(kline_sync / quote_service 等)的路由逻辑
-零改动即可路由到插件。
+Provider 是普通 Python 类(无需继承基类),方法签名对齐 `GenericHTTPProvider`,
+services 层零改动即可路由。只实现已声明数据集对应的方法,其余可缺省。
 
 ```python
 class MyProvider:
@@ -91,22 +136,57 @@ class MyProvider:
     def close(self) -> None:
         """清理资源(load_all 重建注册表时会调)。"""
 
-    def get_daily(self, symbols, start_time, end_time, asset_type="stock", on_chunk_done=None) -> pl.DataFrame:
-        """日K: 返回 schema [symbol, date, open, high, low, close, volume, amount]"""
+    def get_daily(self, symbols, start_time, end_time, asset_type="stock",
+                  on_chunk_done=None) -> pl.DataFrame:
+        """日K: [symbol, date, open, high, low, close, volume, amount]; 不复权"""
 
-    def get_adj_factors(self, symbols, start_time, end_time, asset_type="stock", on_chunk_done=None) -> pl.DataFrame:
-        """除权因子: 返回 schema [symbol, trade_date, ex_factor]"""
+    def get_adj_factors(self, symbols, start_time, end_time, asset_type="stock",
+                        on_chunk_done=None) -> pl.DataFrame:
+        """除权因子: [symbol, trade_date, ex_factor]"""
 
-    def get_minute(self, symbols, start_time, end_time, asset_type="stock", on_chunk_done=None, freq="1m") -> pl.DataFrame:
-        """分钟K: 返回 schema [symbol, datetime, open, high, low, close, volume, amount]"""
+    def get_minute(self, symbols, start_time, end_time, asset_type="stock",
+                   on_chunk_done=None, freq="1m") -> pl.DataFrame:
+        """分钟K: [symbol, datetime, open, high, low, close, volume, amount]"""
 
     def get_realtime(self) -> list[dict]:
-        """全市场实时快照: 返回 list[dict], 每行含 symbol/last_price/prev_close/open/high/low/volume"""
+        """全市场实时快照 → list[dict]。失败软返回 [], 不抛异常(不阻断轮询线程)。"""
+
+    def get_financials(self, table, symbols, latest_only=False) -> pl.DataFrame:
+        """财务数据(声明 financial 数据集时实现, table 见 financial_sync 调用)。"""
 
     def get_instruments(self, asset_type="stock") -> list[dict]:
-        """标的维表(可选): 返回 tickflow Instrument 形状的行, 供 instrument_sync 复用 flatten"""
+        """(可选)标的维表: 返回 tickflow Instrument 形状的行, 供 instrument_sync 复用 flatten"""
+
+    def test_dataset(self, dataset: str, symbols=None) -> dict:
+        """(强烈建议)设置页"试拉"按钮。
+        返回 {provider, dataset, rows, columns, preview, error?}; 未支持的数据集
+        返回 error 字段说明会回退 TickFlow。"""
 ```
 
+### 异常语义
+
+| 方法 | 失败行为 |
+| --- | --- |
+| `get_realtime` | **软失败**: 返回 `[]` + warning 日志, 保证轮询线程不中断 |
+| `get_minute` | 抛异常时调用方自动回退 TickFlow 重试 |
+| `get_daily` / `get_adj_factors` / `get_financials` | 异常由上层同步流程捕获记录; 无数据返回空 DataFrame |
+
+### get_realtime 行字段
+
+| 字段 | 必需 | 契约 |
+| --- | --- | --- |
+| `symbol` | ✅ | 标准代码带后缀 |
+| `last_price` | ✅ | 最新价 |
+| `prev_close` | ✅ | 昨收, 涨跌幅推导基准 |
+| `open` / `high` / `low` | ✅ | 当日 OHLC |
+| `volume` | ✅ | 股 |
+| `amount` | 建议 | 成交额(元) |
+| `change_pct` | 建议 | **小数制**; 缺失时下游按 change_amount/prev_close 推导 |
+| `change_amount` | 建议 | 涨跌额(元) |
+| `timestamp` | 建议 | 毫秒; 优先用服务端时间(行情归属), 缺失退本地时间 |
+| `name` | 可选 | 快照无名称时置 None, 下游用标的维表关联 |
+| `amplitude` / `turnover_rate` / `session` | 可选 | 缺失置 None, 不启发式伪造; turnover_rate 入口为小数制 |
+
 ### config.datasets 的作用
 
 `provider_has_dataset(name, dataset)` 通过 `dataset in provider.config.datasets` 判断。
@@ -118,14 +198,40 @@ class MyConfig:
     datasets = {"daily": ..., "realtime": ...}  # key 是数据集名, value 任意
 ```
 
+## 限频与性能
+
+- realtime 默认 6s 轮询一轮。优先确认服务端单次 limit 上限: fuyao 实测单页
+  limit=6000 可一次拉完全市场(~5600 只), 1 请求/轮; 若服务端强制小页, 必须做
+  页间隔/自限速(参考 fuyao 的 0.15s 页间隔兜底), 并建议用户把轮询间隔调大(15-30s)。
+- 分页必须有页数上限(防 count 异常导致死循环)和空页终止条件。
+- 拉取由 fetch 锁串行化, 慢不会并发重叠; 实际刷新周期 = 轮询间隔 + 拉取耗时,
+  串行分页的全量快照本身就需要数秒, 不要按"6s 内必须完成"设计。
+
+## 测试要求
+
+插件 PR 必须带契约测试(CONTRIBUTING §9), **不依赖真实网络与 API Key**——用假
+Client/桥接注入。以 `backend/tests/test_fuyao_provider.py` 为范本, 至少覆盖:
+
+1. 字段映射与单位转换: 百分数→小数制、缺失字段按口径推导、缺失字段置 None 不伪造
+2. 接口响应结构变体: 实测结构 vs 官方文档示例双兼容(供应商文档与实际不一致是常态)
+3. 分页: 多页合并、空页终止、页数上限
+4. 软失败: 接口报错返回 []; 整页 schema 变化有告警而非静默空数据
+5. 能力声明: 未声明数据集 `provider_has_dataset` 为 False
+6. Key 语义: 先探后存(无效不落盘)、secrets.json > .env 优先级、availability 两态
+7. loader 集成: 清单解析后正确注册(或 hidden 时正确跳过)
+
+```bash
+cd backend && uv run --extra dev python -m pytest tests/test_<your_plugin>_provider.py -q
+uv run --extra dev python -m ruff check app/plugins/<your_plugin>/ tests/test_<your_plugin>_provider.py
+```
+
 ## 现有插件参考
 
 - **`backend/app/plugins/fuyao/`** — 同花顺官方 REST 数据源(runtime: none, 纯 HTTP 零依赖)
   - 当前提供 `realtime`(A 股全市场快照, 分页拉取); Key 在设置页卡片直接配置(先探后存), 或 `.env` 配 `FUYAO_API_KEY`
-  - `client.py` — httpx 客户端(X-api-key 认证 + 统一信封解包 + 分页)
-  - `provider.py` — Provider 实现(字段映射、百分数→小数制单位转换、软失败、Key 探测)
-  - 单位口径注意: 扶摇 `price_change_ratio_pct` 为百分数数值(1.74 = +1.74%),
-    内部 `change_pct` 契约为小数制, provider 内显式 / 100(见 CONTRIBUTING §3.1)
+  - `client.py` — httpx 客户端(X-api-key 认证 + 统一信封解包 + 分页 + 页间隔限频)
+  - `provider.py` — Provider 实现(实测/文档双字段名映射、百分数→小数制、软失败、Key 探测)
+  - `tests/test_fuyao_provider.py` — 32 个契约测试, 是新插件的测试范本
 - **`backend/app/plugins/stocksdk/`** — Node 型插件, 通过 subprocess 桥接调用 stock-sdk
   - `bridge.py` — Python↔Node 桥接 + availability 检测
   - `bridge.mjs` — Node 端(并发池、重试、SDK 解析)
@@ -133,9 +239,9 @@ class MyConfig:
 
 ## 路由机制(无需关心, 仅参考)
 
-后端启动时, `loader.py` 的 `_load_builtin_plugins()` 扫描 `plugins/` 目录:
+后端启动时, `loader.py` 扫描 `plugins/` 目录:
 1. 读每个子目录的 `plugin.yaml`
-2. 调 `check` 函数检测可用性
+2. `hidden: true` → 跳过(不注册不展示); 否则调 `check` 函数检测可用性
 3. 可用 → 动态 import `entry` 指向的 Provider 类 → 注册进 `_PROVIDERS`
 4. 不可用 → 记录状态, 设置页显示但不可切换