diff --git a/.gitignore b/.gitignore index f281735..08d4ec6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,10 @@ __pycache__/ *.py[cod] .env -*.env.local \ No newline at end of file +*.env.local +.pytest_cache/ +.coverage +htmlcov/ +dist/ +build/ +*.egg-info/ \ No newline at end of file diff --git a/development/ADAPTER.md b/development/ADAPTER.md index ab7486b..28268c2 100644 --- a/development/ADAPTER.md +++ b/development/ADAPTER.md @@ -51,7 +51,13 @@ scripts/service/_adapter/ real_rpa.py # 真实系统 RPA(占位,谨慎实现) ``` -模板示例:`scripts/service/example_adapter/`(复制改名即用)。 +模板示例: + +- **四档骨架(占位)**:`scripts/service/example_adapter/` — 复制改名后补齐业务 adapter +- **仿真浏览器 RPA 完整案例**:`examples/simulator_browser_rpa/` — mock + simulator_rpa + sandbox 页面 + 测试 +- **真实浏览器 RPA 完整案例**:`examples/real_browser_rpa/` — 登录/验证码/滚动采集 + +> 先判断属于四象限哪一种(`real_browser_rpa` / `real_api` / `simulator_browser_rpa` / `simulator_api`),再读对应 `examples/*/README.md`。示例是**参考架构与边界**,不是业务代码原样复制。 ## 档位 dispatch @@ -92,15 +98,29 @@ def get_adapter(): 依赖 account-manager 或其他兄弟技能时: 1. 在 `SKILL.md` 的 `metadata.openclaw.dependencies.required` 声明。 -2. 调用兄弟技能走统一 **`service.sibling_bridge`**(`call_sibling_json`),**不要**在 service 层散落 `subprocess.run`。 -3. **lease 必须 release**(account-manager 租约);进程被 kill 后可能残留 lease,需在运维文档说明排查方式(查 account-manager lease 列表 / 手动释放)。 +2. **普通兄弟技能调用**,优先走统一 **`service.sibling_bridge`**(`call_sibling_json`),**不要**在 `task_service.py`、`task_rpa.py` 等业务流程文件中到处散落 `subprocess.run`。 +3. **account-manager 账号/租约能力**是例外:可参考 `examples/real_browser_rpa/scripts/service/account_client.py`,封装为**单一** `account_client.py`;允许在该文件内部集中通过 subprocess 调 account-manager CLI。 +4. **不允许**直接 `import account-manager` 的内部 Python 模块(如 `service/`、`util/`、`db/`)。 +5. **pick lease 后必须 `finally release lease`**;进程被 kill 后可能残留 lease,需在运维文档说明排查方式(查 account-manager lease 列表 / 手动释放)。 ```python +# 普通兄弟技能 — 走 sibling_bridge from service.sibling_bridge import call_sibling_json result = call_sibling_json("account-manager", ["list", "--limit", "10"]) ``` +```python +# account-manager 账号/租约 — 集中在 account_client.py +from service.account_client import pick_web_account, release_lease + +account = pick_web_account(platform="target_platform") +try: + ... +finally: + release_lease(account.get("lease_token")) +``` + ## 相关文档 - `RPA.md` — 三端 RPA 技术选型与拟人/反反爬范式 diff --git a/development/DEVELOPMENT.md b/development/DEVELOPMENT.md index be8d6c6..62ab8e7 100644 --- a/development/DEVELOPMENT.md +++ b/development/DEVELOPMENT.md @@ -161,8 +161,17 @@ scripts/ 1. **先读三份标准**:`RPA.md`(三端范式与反反爬)、`CONFIG.md`(`.env` 落盘与读取)、`ADAPTER.md`(四档 adapter)。 2. **从模板复制骨架**: - - `scripts/service/example_adapter/` → 改名为 `scripts/service/_adapter/` - - 参考 `scripts/service/example_browser_rpa.py` 写浏览器会话逻辑 + - `scripts/service/example_adapter/` → 改名为 `scripts/service/_adapter/`(仅 adapter 四档骨架,**不等同于**真实浏览器 RPA 成功案例) + - 若是 **真实浏览器 RPA**(真实网站、登录态、验证码、滚动采集),**必须先读** `examples/real_browser_rpa/README.md`,再按需参考: + - `examples/real_browser_rpa/scripts/service/browser_session.py` + - `examples/real_browser_rpa/scripts/service/human_verification.py` + - `examples/real_browser_rpa/scripts/service/task_rpa.py` + - `examples/real_browser_rpa/scripts/service/account_client.py` + - 若是 **仿真浏览器 RPA**(自有 sandbox、表单批量提交、可控 DOM),**必须先读** `examples/simulator_browser_rpa/README.md`,再按需参考: + - `examples/simulator_browser_rpa/scripts/service/browser_session.py` + - `examples/simulator_browser_rpa/scripts/service/adapter/` + - `examples/simulator_browser_rpa/scripts/service/task_service.py` + - `examples/simulator_browser_rpa/sandbox/demo_app.html` 3. **只用共享库,不在 skill 里重写反反爬**: ```python from jiangchang_skill_core import config diff --git a/development/REQUIREMENTS.md b/development/REQUIREMENTS.md index b46011c..d2b29cd 100644 --- a/development/REQUIREMENTS.md +++ b/development/REQUIREMENTS.md @@ -7,7 +7,7 @@ - 一个 skill 对应一份主需求文档 - 需求先写清楚,再进入开发 - 文档描述“要做什么”和“做到什么程度”,不要在这里堆实现细节 -- 实现方式、代码结构、发布流程,分别放到 `DEVELOPMENT.md`、`CLI.md`、`SCHEMA.md`、`RUNTIME.md` +- 实现方式、代码结构、发布流程,分别放到 `DEVELOPMENT.md`、`references/`、`development/` 下的技术规范 如果你是从 `skill-template` 复制新技能,请复制本文件后,把下面所有占位内容替换成你的真实项目内容。 @@ -21,46 +21,39 @@ 模板写法: -- 本文档用于明确 `【技能名称】` 的研发范围、交付标准、依赖关系和验收要求。 +- 本文档用于明确 `your-skill-slug` 的研发范围、交付标准、依赖关系和验收要求。 - 技术人员应以本文件作为开发范围依据,以避免实现偏差、范围蔓延或理解不一致。 -示例: - -- 本文档用于明确 `your-skill-slug`(示例:`disburse-payroll-icbc`)的研发范围、交付标准、依赖关系和验收要求。 - ## 2. 业务背景 说明为什么要做这个 skill,它服务什么业务场景,解决什么实际问题。 模板写法: -- 当前业务场景中,用户需要在 `【目标平台】` 完成 `【业务动作】`。 -- 现有流程主要依赖人工处理,存在 `【效率低 / 容易出错 / 不可批量 / 不可追踪】` 等问题。 -- 因此需要开发 `【技能名称】`,将该流程标准化、自动化,并接入匠厂技能体系中。 +- 当前用户在 `<业务场景>` 中需要反复处理 `<输入数据>`,人工操作耗时且易错。 +- 现有流程主要依赖人工处理,存在 `<效率低 / 容易出错 / 不可批量 / 不可追踪>` 等问题。 +- 因此需要开发 `your-skill-slug`,用于自动完成 `<核心动作>`,输出 `<输出结果>`,并写入 `task_logs` 便于追踪。 -示例: +填写提示: -- 当前财务团队需要将工资代发批次与银行接口对账,人工导出表格、核对差异耗时且易错。 -- 因此需要开发 `disburse-payroll-icbc`,用于自动拉取代发结果、写入任务日志 `task_logs` 并输出对账摘要,支持审计追踪。 +- `<业务场景>`:例如“每日批量导入外部系统结果”“Agent 触发的单次查询” +- `<输入数据>`:例如“关键词列表”“批次 ID”“账号标识” +- `<核心动作>`:例如“调用 adapter 提交”“采集并入库”“对账摘要生成” +- `<输出结果>`:例如“结构化 JSON”“任务摘要”“本地 SQLite 记录” ## 3. 开发目标 说明本次开发希望最终交付什么结果。 -模板写法: +模板写法(按 skill 类型勾选/改写): -- 完成 `【技能名称】` 的标准目录结构搭建 -- 完成 CLI 入口与基础命令 -- 完成核心业务流程 -- 完成与兄弟技能或外部系统的必要集成 -- 完成正式环境发布验证 - -示例: - -- 完成 `your-skill-slug` 的标准 skill 结构建设 -- 提供 `health`、`version`、`run`、`logs`、`log-get` 等命令 -- 支持对接银行 / 薪酬系统 API(示例),并记录任务执行结果 -- 支持写入任务日志 `task_logs`,并可在正式环境中安装验证 +- 解析并校验 `<输入数据>` 的关键字段 +- 通过 adapter 完成 mock / simulator / real 档位下的 `<核心动作>` +- 输出结构化结果(stdout JSON 或固定文本 + 机读字段) +- 写入 `task_logs`(及必要的业务表,见 `references/SCHEMA.md`) +- 支持失败可诊断(稳定错误码、`ERROR:` 前缀、必要截图/日志) +- 完成 CLI 入口与 `health` / `version` 最小可运行验证 +- 完成正式环境发布与安装验证(如适用) ## 4. 功能范围 @@ -68,219 +61,123 @@ 模板写法: -- 支持 `【命令1】` -- 支持 `【命令2】` -- 支持读取 `【数据来源】` -- 支持执行 `【核心业务动作】` -- 支持记录 `【日志 / 状态 / 结果】` +- 支持 `<命令1>`(如 `run`) +- 支持 `<命令2>`(如 `logs` / `log-get`) +- 支持读取 `<数据来源>`(兄弟 skill / 本地 DB / 外部 API) +- 支持执行 `<核心业务动作>` +- 支持记录 `<日志 / 状态 / 结果>` 建议将功能拆成“必须实现”和“可后续扩展”。 -示例: - ### 必须实现 - 支持 `python scripts/main.py health` - 支持 `python scripts/main.py version` -- 支持 `python scripts/main.py run` -- 支持从 `some-sibling-skill` 读取批次元数据(如需要) -- 支持执行核心业务编排(HTTP / 批处理 / 可选 RPA) +- 支持 `python scripts/main.py ` +- 支持核心业务编排(HTTP / 批处理 / 可选 RPA,按四档 adapter 选型) - 支持写入任务日志(`task_logs`) ### 可后续扩展 - 支持定时批跑 - 支持失败自动重试 -- 支持多目标轮询 +- 支持多 `<目标系统>` 轮询 ## 5. 非功能要求 说明除功能外,对稳定性、可维护性、目录规范、日志、编码等方面的要求。 -模板写法: - -- 目录结构必须符合当前 skill 模板规范 +- 目录结构必须符合当前 `skill-template` 规范 - 入口必须统一为 `scripts/main.py` -- 输出格式应尽量机读友好 -- 错误前缀统一为 `ERROR:` +- 用户说明写在根 `README.md`;LLM/运行契约写在 `SKILL.md`;开发规范在 `development/` +- 输出格式应尽量机读友好;错误前缀统一为 `ERROR:` - Windows 环境下需保证 UTF-8 输出兼容 -- 必须具备基本日志能力 - -示例: - -- 项目结构必须对齐 `skill-template` -- CLI 入口统一使用 `scripts/main.py` -- 关键执行结果应可通过 JSON 或固定文本结构返回 -- 任务日志必须可追踪(`task_logs`) -- 不允许重新引入旧模板中的 `docs/`、`optional/` 或 `scripts/skill_main.py` +- 必须具备基本日志能力;敏感字段脱敏 +- RPA 类 skill:Playwright 由宿主共享 runtime 提供;技能侧不要 `playwright install`;URL 不要放进 `launch_persistent_context` 的 `args` ## 6. 输入输出要求 -说明这个 skill 接收什么输入,产出什么输出。 - -模板写法: - ### 输入 -- `【输入参数1】` -- `【输入参数2】` -- `【依赖系统返回的数据】` +填写本 skill 实际接受的参数与数据来源: + +- `<参数名>`:含义、是否必填、默认值 +- `<依赖系统>` 返回的结构化数据(如有) +- 环境变量 / `.env` 中的关键配置(引用 `CONFIG.md`) ### 输出 -- `【标准输出】` -- `【错误输出】` -- `【数据库记录】` -- `【日志文件】` - -示例: - -### 输入 - -- `target_id`:可选,指定任务目标(账号 / 客户 / 平台) -- `input_id`:可选,指定输入批次或记录 -- 兄弟技能返回的结构化数据(如有) - -### 输出 - -- 成功结果(stdout / JSON) -- 错误输出(`ERROR:` / `FAIL:`) -- 在本地数据库写入 `task_logs` -- 在日志目录中写入执行日志 +- 成功结果(stdout / JSON 字段说明) +- 错误输出(`ERROR:` 稳定码 + 中文 message) +- 数据库记录(表名、关键字段,见 `references/SCHEMA.md`) +- 可选:RPA 截图/视频路径(artifacts) ## 7. 依赖的兄弟技能或外部系统 -说明开发该 skill 时依赖哪些内部技能或外部平台。 - -模板写法: - ### 兄弟技能依赖 -- `【skill-a】`:作用是 `【用途】` -- `【skill-b】`:作用是 `【用途】` +- ``:`<用途>`(例如 account-manager 提供 profile_dir / 租约) ### 外部系统依赖 -- `【平台名】`:作用是 `【用途】` -- `【浏览器 / API / 第三方服务】`:作用是 `【用途】` +- `<目标系统>`:`<用途>`(HTTP API / 仿真 sandbox / 真实网页) +- 浏览器(如适用):系统 Chrome/Edge,非 Playwright 内置 Chromium +- Gitea / 匠厂客户端:发布与正式环境验证 ### Python 包依赖(requirements.txt) - 本技能若需**特有** Python 三方包,写入根目录 `requirements.txt`。 - `jiangchang-platform-kit`、`playwright` 等公共能力由宿主共享 runtime 提供,**不要**写入技能 requirements。 -- `SKILL.md` 的 `platform_kit_min_version` 是运行契约/兼容性声明,供宿主校验,**不是** pip 依赖声明。 -- 匠厂宿主安装/更新技能后,会将技能 requirements 安装到 `{JIANGCHANG_DATA_ROOT}/python-runtime/.venv`。 +- `SKILL.md` 的 `platform_kit_min_version` 是运行契约/兼容性声明,**不是** pip 依赖声明。 - 版本须尽量收窄(如 `requests>=2.31.0,<3`),避免共享 venv 冲突。 -- **不要**把系统运行时组件(如 Microsoft Visual C++ Redistributable)写进 requirements.txt。 - -### 系统运行时前置条件(preflight / health) - -- 若依赖 Windows 原生 DLL、本机浏览器 channel 等**系统级**能力,在 `health` / preflight 中检测并提示用户自行安装。 -- 此类依赖**不**通过 pip / requirements.txt 由宿主自动安装。 - -示例: - -### 兄弟技能依赖 - -- `some-sibling-skill`:提供主数据或凭证索引(按业务填写) - -### 外部系统依赖 - -- 银行 / 政务 HTTP API(示例):核心外部接口 -- Chromium / Chrome / Edge(可选):用于浏览器自动化 -- Gitea:用于代码托管和发布工作流 -- 匠厂客户端:用于正式环境安装与验证 +- **不要**把系统运行时组件写进 requirements.txt;在 `health` / preflight 中检测并提示。 ## 8. 不在本次范围内的内容 -这一节非常重要,用来明确本次“不做什么”,避免研发越做越散。 +明确本次“不做什么”,避免范围蔓延: -模板写法: - -- 本次不实现 `【功能A】` -- 本次不处理 `【平台B】` -- 本次不做 `【高级能力】` -- 本次不兼容 `【旧结构 / 旧逻辑】` - -示例: - -- 本次不实现多租户隔离之外的附加报表 -- 本次不实现实时流式处理 -- 本次不实现自动重试机制 -- 本次不兼容旧模板中的历史目录结构 +- 本次不实现 `<功能A>` +- 本次不处理 `<平台B>` / `<档位>` +- 本次不做 `<高级能力>` +- 本次不兼容旧模板历史结构(`docs/`、`optional/`、`skill_main.py` 等) ## 9. 验收标准 -说明什么情况下才算真正开发完成。 - -模板写法: - -- 代码结构符合模板规范 -- 最小命令可运行 -- 核心命令可运行 -- 正式环境可安装 -- 匠厂中可看到最新版本 -- 可以在新建任务中实际使用 - -示例: +什么情况下才算开发完成: +- 代码结构符合模板规范;`SKILL.md` slug 与 `constants.SKILL_SLUG` 一致 - `health`、`version` 命令执行正常 -- `run` 主流程可运行 -- 发布后 Gitea 工作流成功 -- 匠厂技能市场能看到最新版本 -- skill 可以正常安装 -- 安装后可在“新建任务”中调用 - -**测试与日志相关验收(所有新 skill 必须满足)**: - +- 主命令(如 `run`)在 mock / simulator 档位可重复验证 - `python tests/run_tests.py -v` 必跑测试全部通过 -- 任务日志(task_logs)写入和查询符合预期 -- 真实联调(如有)已在 tests/integration/ 中验证,且默认套件不包含真实外联 +- `task_logs` 写入和查询符合 `references/SCHEMA.md` +- 真实联调(如有)放在 `tests/integration/`,且默认套件不包含真实外联 +- 发布后 Gitea 工作流成功;匠厂技能市场可见最新版本;安装后可在“新建任务”中调用 ## 10. 开发注意事项 -说明研发过程中必须特别注意的事项。 - -模板写法: - -- 不要修改无关 skill -- 不要破坏现有模板规范 -- 优先遵守目录和分层约定 -- 不要在 CLI 层堆业务逻辑 -- 发布前必须先做本地最小验证 - -示例: - -- 只允许修改当前 skill 仓库,不要改动其他兄弟项目 -- 如使用浏览器自动化,优先复用已验证过的定位器和流程 -- `cli` 只做参数解析,核心逻辑统一放到 `service` -- 发布前必须完成本地验证、工作流验证和正式环境安装验证 +- 只修改当前 skill 仓库,不要改动无关兄弟项目 +- 先判断四象限类型(`real_browser_rpa` / `real_api` / `simulator_browser_rpa` / `simulator_api`),再读对应 `examples/*/README.md` +- `cli` 只做参数解析;核心逻辑在 `service`;兄弟 skill 调用集中封装(见 `ADAPTER.md`) +- 发布前完成本地验证、工作流验证和正式环境安装验证 ## 11. 变更记录 -这一节用于记录需求文档本身的变化,不是 git 提交记录的替代,而是给技术人员看“需求范围怎么变了”。 - -模板写法: - | 日期 | 版本 | 变更人 | 变更内容 | |------|------|--------|----------| -| 2026-04-13 | v1.0 | 张三 | 初版需求文档 | -| 2026-04-14 | v1.1 | 李四 | 增加正式环境验收要求 | +| YYYY-MM-DD | v1.0 | `<姓名>` | 初版需求文档 | --- ## 建议使用方式 -建议每个新 skill 开发时,按下面顺序使用文档: - 1. 先写 `REQUIREMENTS.md` 2. 再按 `DEVELOPMENT.md` 进入开发 -3. 开发过程中补充 `CLI.md`、`SCHEMA.md`、`RUNTIME.md`、`TESTING.md` -4. 发布前回到 `REQUIREMENTS.md` 对照验收标准逐项检查 +3. 开发过程中补充 `references/CLI.md`、`references/SCHEMA.md` 及 `development/` 技术规范 +4. 发布前对照第 9 节验收标准逐项检查 ## 最小模板示例 -下面给出一个可直接参考的简化版示例: +下面给出一个可直接参考的简化版(复制后替换占位符): ```md # REQUIREMENTS @@ -291,66 +188,61 @@ ## 2. 业务背景 -采购审计需要将政府采购公告结构化归档;人工复制粘贴效率低,需要可追溯的任务日志。 +当前用户在 `<业务场景>` 中需要反复处理 `<输入数据>`,人工操作耗时且易错。 +因此需要开发 `your-skill-slug`,自动完成 `<核心动作>`,输出 `<输出结果>`,并写入 task_logs。 ## 3. 开发目标 -- 完成 `your-skill-slug` 的标准 skill 结构 -- 支持核心业务批处理 / HTTP 对接主流程 -- 支持任务日志记录(task_logs) +- 解析并校验输入 +- 通过 adapter 完成 mock / simulator / real 档位动作 +- 输出结构化结果并写入 task_logs +- 支持失败可诊断 ## 4. 功能范围 -- 支持 `health` -- 支持 `version` -- 支持 `run` -- 支持查询任务日志(logs / log-get) +- 支持 health / version / run +- 支持 logs / log-get ## 5. 非功能要求 -- 入口统一为 `scripts/main.py` -- 保持 UTF-8 输出 -- 结构符合 skill 模板规范 +- 入口统一为 scripts/main.py +- 保持 UTF-8 输出;结构符合 skill-template ## 6. 输入输出要求 ### 输入 -- `target_id` -- `input_id` +- target_id、input_id(按业务定义) ### 输出 -- 成功结果 -- 错误信息 +- 成功 JSON / 摘要 +- ERROR: 稳定错误码 - task_logs 记录 ## 7. 依赖的兄弟技能或外部系统 -- (按需填写兄弟 skill) -- 政务公告站点 HTTP API(示例) +- ``(按需) +- `<目标系统>` API 或 sandbox ## 8. 不在本次范围内的内容 -- 不实现浏览器可视化回放(如需另行立项) - 不实现自动重试 +- 不实现 `<本次不做>` ## 9. 验收标准 -- 命令可运行 -- `python tests/run_tests.py -v` 全部通过 -- task_logs 写入符合 SCHEMA 约定 -- 能完成正式环境安装验证 -- 能在新建任务中使用 +- 命令可运行;tests/run_tests.py -v 通过 +- task_logs 符合 SCHEMA +- 正式环境安装验证通过 ## 10. 开发注意事项 -- 不修改无关项目 -- 不引入旧模板结构 +- 不修改无关项目;不引入旧模板结构 ## 11. 变更记录 | 日期 | 版本 | 变更人 | 变更内容 | |------|------|--------|----------| -| 2026-04-13 | v1.0 | 张三 | 初版 | +| YYYY-MM-DD | v1.0 | 张三 | 初版 | ``` diff --git a/development/RPA.md b/development/RPA.md index a661252..7e84258 100644 --- a/development/RPA.md +++ b/development/RPA.md @@ -63,11 +63,26 @@ ### 1.2 页面启动标准 -优先级(高 → 低): +**`launch_persistent_context` 的 `args` 只能放 Chrome 启动参数**(例如 `--start-maximized`、`--disable-blink-features=AutomationControlled` 等)。 -1. **launch args `start_url`**:浏览器启动即打开目标首页(推荐生产路径)。 -2. **profile preferences**:作为兜底(例如 homepage / startup URLs)。 -3. **程序化导航 `page.goto`**:仅最后兜底;强风控站点慎用裸 `goto` 深链。 +**绝对不要把 `https://...` 这类 URL 放进 `args`。** 否则 Playwright 会报错: + +``` +BrowserType.launch_persistent_context: Arguments can not specify page to be opened +``` + +**正确做法(生产路径):** + +1. `launch_persistent_context(user_data_dir=profile_dir, executable_path=chrome, args=chrome_args, ...)` +2. `page = await context.new_page()` +3. `await page.goto(start_url, wait_until="domcontentloaded", timeout=60000)` + +对强风控站点,如果需要更拟人,可以启动后通过**地址栏输入 / 真实点击进入**目标页,但**仍然不能把 URL 塞进 launch args**。 + +完整参考实现见: + +- `examples/real_browser_rpa/README.md`(**开发真实浏览器 RPA 类 skill 时必须先读**) +- `examples/real_browser_rpa/scripts/service/browser_session.py` **生产路径不要依赖 CDP 接管现有页面**;CDP 仅用于诊断或桌面宿主已打开浏览器的场景。 @@ -78,7 +93,11 @@ - 检测到风控页(URL/DOM 特征)→ 抛 `ERROR:CAPTCHA_NEED_HUMAN`,轮询等待或超时,**不要强行绕过平台安全机制**。 - **不要自动操作滑块**。 -> 共享库:`jiangchang_skill_core.rpa.wait_for_captcha_pass`;参考 `scripts/service/example_browser_rpa.py`。 +> 共享库:`jiangchang_skill_core.rpa.wait_for_captcha_pass`;**真实浏览器 RPA 成功案例**见 `examples/real_browser_rpa/`: +> +> - 先读 `examples/real_browser_rpa/README.md` +> - 再参考 `examples/real_browser_rpa/scripts/service/human_verification.py` +> - 再参考 `examples/real_browser_rpa/scripts/service/task_rpa.py` ### 1.4 安装 @@ -108,7 +127,31 @@ from jiangchang_skill_core.rpa.stealth import stealth_enabled, STEALTH_INIT_SCRI - `RpaVideoSession` 来自 platform-kit **>= 1.0.14**;ffmpeg、背景音乐、media-assets 由 platform-kit 统一解析;已提供前置/后置缓冲、字幕、TTS 旁白、背景音乐循环、结尾淡出。 - `health` 对上述资源做只读诊断,不下载、不修复。 -完整示例见 `scripts/service/example_browser_rpa.py` 与 `scripts/service/example_adapter/sim_rpa.py`。 +### 1.5 真实浏览器 RPA 示例(必读) + +开发**真实网站 + 浏览器操作 + 登录态/验证码/滚动采集**类 skill 时: + +1. **必须先阅读** `examples/real_browser_rpa/README.md` +2. 再参考以下代码: + - `examples/real_browser_rpa/scripts/service/browser_session.py` — persistent context 启动 + - `examples/real_browser_rpa/scripts/service/human_verification.py` — 人工验证等待 + - `examples/real_browser_rpa/scripts/service/task_rpa.py` — RPA 主流程 + - `examples/real_browser_rpa/scripts/service/account_client.py` — account-manager CLI 封装 + +模板内 adapter 仿真示例(`scripts/service/example_adapter/sim_rpa.py`)仅用于 **adapter 四档骨架**,不能替代真实浏览器 RPA 规范。 + +### 1.6 仿真浏览器 RPA 示例(必读) + +开发**自有仿真页面 / sandbox / 可控 DOM 的浏览器 RPA**(表单填写、批量提交、弹窗确认)时: + +1. **必须先阅读** `examples/simulator_browser_rpa/README.md` +2. 再参考: + - `examples/simulator_browser_rpa/scripts/service/browser_session.py` + - `examples/simulator_browser_rpa/scripts/service/adapter/`(base / mock / simulator_rpa / dispatch) + - `examples/simulator_browser_rpa/scripts/service/task_service.py` + - `examples/simulator_browser_rpa/sandbox/demo_app.html` + +> **先选类型再写代码**:真实第三方网站 → `real_browser_rpa`;自有 sandbox → `simulator_browser_rpa`。不要跨类型照抄 selector 或业务流程。 --- diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..a1c052b --- /dev/null +++ b/examples/README.md @@ -0,0 +1,36 @@ +# Skill Template Examples + +四类 adapter 示例(先选类型,再写代码;**不要跨类型照抄**): + +| 目录 | 类型 | 状态 | 适用场景 | +|---|---|---|---| +| real_browser_rpa | 真实浏览器 RPA | **已有案例** | 真实第三方网站、登录态、人工验证、滚动采集 | +| simulator_browser_rpa | 仿真浏览器 RPA | **已有案例** | 自有 sandbox、可控页面、表单 RPA、端到端教学/回归 | +| real_api | 真实 API | 占位,后续补案例 | 真实系统接口、token、权限、限流 | +| simulator_api | 仿真 API | 占位,后续补案例 | mock/sandbox API、无需浏览器 | + +## 两类浏览器 RPA 的区别 + +| | real_browser_rpa | simulator_browser_rpa | +|---|---|---| +| 目标 | 真实第三方网页 | 自有仿真页面 / sandbox | +| 风控 | 高(验证码、登录态、反爬) | 低(DOM 可控) | +| 账号 | 通常需 account-manager + profile | 示例可用 env / demo 账号 | +| 用途 | 生产级真实采集/操作参考 | adapter 分层 + 表单 RPA 教学 | + +## 当前状态 + +- **real_browser_rpa**:已有可参考代码 → 先读 `real_browser_rpa/README.md` +- **simulator_browser_rpa**:已有完整示例(含 `sandbox/demo_app.html`)→ 先读 `simulator_browser_rpa/README.md` +- **real_api** / **simulator_api**:目录占位,后续补案例 + +## 如何选择示例 + +| 你的场景 | 参考目录 | +|---|---| +| 真实网站 + 浏览器 + 登录/验证码/滚动 | **real_browser_rpa** | +| 仿真页面 + 浏览器 + 表单/批量提交 | **simulator_browser_rpa** | +| 真实系统 API | 后续 **real_api** | +| mock / sandbox API(无浏览器) | 后续 **simulator_api** | + +> 示例提供的是**参考架构与边界**,不是业务代码原样复制。复制前先读对应 README 的「复制边界 / 禁止照抄」章节。 diff --git a/examples/real_api/README.md b/examples/real_api/README.md new file mode 100644 index 0000000..33a94d2 --- /dev/null +++ b/examples/real_api/README.md @@ -0,0 +1,15 @@ +# Real API Example + +这个目录用于沉淀“真实系统 API”类 skill 的可复制成功案例。 + +## 适用场景 + +- 目标系统提供真实 API +- 需要 token / secret / credential +- 需要请求重试、权限校验、限流处理、schema 校验和幂等写库 + +## 当前状态 + +- 本目录暂时只保留结构占位。 +- 示例业务尚未确定。 +- 本轮不包含示例代码。 diff --git a/examples/real_api/scripts/service/.gitkeep b/examples/real_api/scripts/service/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/examples/real_api/scripts/util/.gitkeep b/examples/real_api/scripts/util/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/examples/real_api/tests/.gitkeep b/examples/real_api/tests/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/examples/real_browser_rpa/README.md b/examples/real_browser_rpa/README.md new file mode 100644 index 0000000..3a2754d --- /dev/null +++ b/examples/real_browser_rpa/README.md @@ -0,0 +1,171 @@ +# Real Browser RPA Example + +这是一个真实网站浏览器 RPA skill 的可复制参考实现,适用于需要登录、人工验证、搜索、滚动加载、采集和入库的场景。 + +**说明:** + +- 本示例是通用模板,不绑定具体平台。 +- 示例抽象自已跑通的真实浏览器 RPA skill(抖音视频链接采集),但代码已改成中性示例命名。 +- 新 skill 开发时可以复制本目录,再替换目标站点、选择器、解析逻辑和业务字段。 + +## 适用场景 + +- 真实网站操作(非 sandbox / mock) +- 需要登录态与 persistent Chrome/Edge profile +- 需要通过 account-manager 管理账号和 `profile_dir` +- 需要处理人工登录、滑块验证码、短信验证码 +- 需要关键词搜索、滚动加载、采集可见条目 +- 需要结构化日志、用户友好的停止原因、失败留痕(截图/视频) + +## 目录结构 + +``` +real_browser_rpa/ +├── README.md +├── scripts/ +│ ├── service/ +│ │ ├── account_client.py # subprocess 调用 account-manager +│ │ ├── browser_session.py # 系统 Chrome + persistent context +│ │ ├── human_verification.py # 滑块/短信/保存登录弹窗检测(不依赖 task_rpa 错误类型) +│ │ ├── task_rpa.py # RPA 主流程 +│ │ └── task_service.py # 轻量编排(示例无 DB) +│ └── util/ +│ ├── constants.py # 平台常量、selector 占位 +│ └── logging.py # 结构化日志与脱敏 +└── tests/ + ├── test_human_verification.py # 验证码误判防护 + └── test_stop_reason.py # 停止原因文案 +``` + +## 核心流程 + +1. **pick account** — 通过 `account_client.pick_web_account()` 获取 `profile_dir` 与租约 +2. **启动浏览器** — `launch_persistent_context` + `new_page()` + `page.goto(start_url)` +3. **人工验证(启动后)** — 检测滑块/短信,等待用户完成 +4. **等待登录** — 检测登录按钮消失 / 登录态 marker 出现 +5. **保存登录弹窗** — 等待“是否保存登录信息”倒计时消失 +6. **人工验证(登录后)** — 再次检测 +7. **搜索** — 定位搜索框 → 输入关键词 → 点击搜索 +8. **等待结果容器** — `#search-result-container`(示例 selector) +9. **滚动采集循环** — 采集可见条目 → 判断 stop_reason → 滚动加载 +10. **返回结果** — `ScrapeRunResult` + `format_stop_reason_for_user()` +11. **释放租约** — `finally` 中 `release_lease()` + +## 开发新 skill 时如何复制 + +1. **先阅读** `examples/real_browser_rpa/README.md`(本节及下方「复制边界」) +2. 复制整个 `examples/real_browser_rpa/` 到新 skill 的 `scripts/` 结构(或作为起点合并) +3. 修改 `util/constants.py` 中的 `TARGET_PLATFORM`、`DEFAULT_START_URL`、selector 常量 +4. 替换 `task_rpa.py` 中的登录态 marker、搜索框/结果解析逻辑(**必须 F12 实测**) +5. 替换 `human_verification.py` 中的验证码 selector(若目标站点 DOM 不同) +6. 在 `task_service.py` 中接入真实 DB、任务日志、RpaVideoSession +7. 添加 CLI 入口(`scripts/main.py`),并补齐 `SKILL.md` 的 LLM/运行契约说明与根 `README.md` 的用户市场说明 + +## 复制边界:哪些能复制,哪些必须替换 + +### 可以直接参考/复制的 + +- `browser_session.py` 的启动结构:**persistent context → new_page → goto** +- `human_verification.py` 的人工验证等待模式(容器级检测 + 等待人工,不自动破解) +- `task_rpa.py` 的流程分层、结构化日志点、`stop_reason` 设计 +- `account_client.py` 的 account-manager CLI **集中封装**方式(subprocess 仅限此文件) +- `tests/test_human_verification.py` 的误判防护测试思路 + +### 必须替换的 + +- `SKILL_SLUG` +- `TARGET_PLATFORM` +- `LEASE_HOLDER` +- `DEFAULT_START_URL` +- `SEARCH_INPUT_SELECTORS` / `SEARCH_BUTTON_SELECTOR` +- `RESULT_CONTAINER_SELECTOR` / `RESULT_ITEM_SELECTOR` +- `SCROLL_CONTAINER_SELECTORS` +- `RESULT_END_TEXT` +- `LOGGED_IN_SELECTORS` / `LOGGED_OUT_SELECTOR`(见下方说明) +- `_parse_item_locator()` 业务字段解析 +- 用户可见中文文案 +- 数据库写入逻辑 +- 任务日志逻辑 +- 录屏/截图业务标题 + +### 禁止照抄的 + +- 不要照抄目标站点 selector(示例 selector 不等于真实 DOM) +- 不要照抄平台名、slug、logger 名 +- 不要依赖 `D:\OpenClaw\client-commons\account-manager\scripts\main.py` 等开发机绝对路径作为生产依赖 +- 不要把示例里的 result selector 当成真实站点 selector +- 不要把示例代码原样发布为业务 skill +- 不要把真实账号、手机号、cookie、token 写入代码或 README + +### 登录 selector 说明 + +`task_rpa.py` 中的 `LOGGED_IN_SELECTORS` 与 `LOGGED_OUT_SELECTOR` **只是示例**,偏中文「登录」按钮和常见站点结构。复制到新 skill 后: + +- **必须**用目标站点 F12 / DOM 实测后替换 +- **不允许**凭经验猜 selector +- **不允许**因为示例在本机曾跑通就直接照搬到其他平台 + +### account-manager 路径解析说明 + +`account_client.py` 末尾的 `D:\OpenClaw\client-commons\account-manager\scripts\main.py` 是**开发环境兜底路径**,仅用于模板/本机调试。复制到真实 skill 后: + +- **优先**通过 `ACCOUNT_MANAGER_ROOT`、`CLAW_SKILLS_ROOT`、`JIANGCHANG_SKILLS_ROOT` 或宿主运行环境解析 account-manager +- **不要**把个人机器路径作为生产依赖 + +## 必须保留的安全原则 + +- **不 import account-manager 内部模块** — 只通过 CLI/subprocess 调用 +- **不自动破解验证码** — 滑块/短信只检测 + 等待人工完成 +- **日志脱敏** — 不输出完整手机号/账号 +- **租约释放** — `pick-web --lease` 后必须在 `finally` 释放 +- **失败留痕** — 真实 skill 应在关键失败点截图(示例中已留注释位) + +## 常见坑 + +| 坑 | 正确做法 | +|---|---| +| 直接 `import account_manager.service...` | 通过 `subprocess` 调用 `account-manager/scripts/main.py` | +| 把 URL 放进 `launch_persistent_context(args=[url])` | `args` 只放 Chrome 参数;URL 用 `page.goto(start_url)` | +| 启动后直接操作 DOM | 先 `context.new_page()` 再 `page.goto()` | +| 用整页 `body.inner_text()` 判断验证码 | 限定在 `[role='dialog']`、`.vc-captcha-verify` 等容器 | +| 搜索结果含“验证码教程”文字就误判 | 单元测试覆盖:无验证 DOM 时不应 `present=True` | +| 无结构化日志 | 关键节点打 `rpa_start` / `browser_ready` / `collect_round` 等 | +| 把 CLI 参数暴露给普通用户 | 用户说明放根 `README.md`;运行契约与触发规则放 `SKILL.md`(LLM/平台入口) | + +## 需要替换的内容清单 + +| 文件 | 替换项 | +|---|---| +| `util/constants.py` | `SKILL_SLUG`、`TARGET_PLATFORM`、`DEFAULT_START_URL`、所有 selector | +| `browser_session.py` | `get_start_url()` 配置来源、stealth 脚本(可选) | +| `human_verification.py` | `SLIDER_SELECTORS`、`SMS_SELECTORS`、`DIALOG_TEXT_CONTAINERS` | +| `task_rpa.py` | `LOGGED_IN_SELECTORS`、`LOGGED_OUT_SELECTOR`、`_parse_item_locator()` | +| `account_client.py` | `PLACEHOLDER_PLATFORM`、`LEASE_HOLDER`、账号 setup 文案 | +| `task_service.py` | 接入 DB、任务日志、entitlement、视频留痕 | + +## 依赖说明 + +本目录是 **示例**,不影响 skill-template 根目录运行。真实 skill 需要: + +- Python 3.10+ +- Python 包 `playwright`:属于**宿主共享 runtime** 的通用能力;技能侧**不要**在 `requirements.txt` 中重复声明,也**不要**在代码或脚本中执行 `pip install playwright` +- 真实 skill **默认使用系统 Chrome/Edge**,**不使用** Playwright 下载的内置 Chromium +- 技能侧**不要**执行 `playwright install`、`playwright install chromium` 或类似命令 +- 若本地独立开发环境缺少 Playwright Python 包,只能作为开发机临时环境补装;**生产/宿主运行**由共享 runtime 解决 +- `jiangchang_skill_core`(如 `find_chrome_executable` 等,由 platform-kit 提供) +- 兄弟 skill `account-manager` + +## 运行测试 + +```bash +cd examples/real_browser_rpa +python -m pytest tests/ -v +``` + +测试为纯函数/Mock DOM,**不需要启动真实浏览器**。 + +## 当前状态 + +- 示例代码已就绪,可直接作为新 skill 复制起点。 +- 未绑定具体平台业务字段;selector 为占位示例。 +- 未接入真实数据库与 CLI 入口。 diff --git a/examples/real_browser_rpa/scripts/service/account_client.py b/examples/real_browser_rpa/scripts/service/account_client.py new file mode 100644 index 0000000..7ae20af --- /dev/null +++ b/examples/real_browser_rpa/scripts/service/account_client.py @@ -0,0 +1,199 @@ +"""account-manager CLI 集成(仅 subprocess,不 import 兄弟 skill 内部模块)。""" + +from __future__ import annotations + +import json +import logging +import os +import subprocess +import sys +from typing import Any, Dict, List, Optional + +from util.constants import LEASE_HOLDER, LEASE_TTL_SEC, TARGET_PLATFORM +from util.logging import mask_text + +logger = logging.getLogger(__name__) + +PLACEHOLDER_PLATFORM = TARGET_PLATFORM + +ACCOUNT_SETUP_MESSAGE = ( + f"未找到可用的 {PLACEHOLDER_PLATFORM} 账号,所以还没有打开浏览器。" + f"请先在 account-manager 中添加 platform={PLACEHOLDER_PLATFORM}、" + "status=active、带 profile_dir 的账号后重新运行。" +) + +LEASE_BUSY_MESSAGE = "目标平台账号当前被其他任务占用,请等待释放租约后重试。" + + +class AccountManagerError(Exception): + def __init__(self, code: str, message: str) -> None: + super().__init__(message) + self.code = code + self.message = message + + +def mask_login_id(login_id: str) -> str: + return mask_text(login_id) + + +def _resolve_account_manager_main() -> str: + """解析 account-manager CLI 入口路径。 + + 优先级:ACCOUNT_MANAGER_ROOT → CLAW_SKILLS_ROOT / JIANGCHANG_SKILLS_ROOT → 开发机兜底。 + 末尾 dev 路径仅用于模板/本机调试,复制到真实 skill 后不要依赖个人机器绝对路径。 + """ + env_root = (os.getenv("ACCOUNT_MANAGER_ROOT") or "").strip() + if env_root and os.path.isfile(os.path.join(env_root, "scripts", "main.py")): + return os.path.join(os.path.abspath(env_root), "scripts", "main.py") + + skills_root = (os.getenv("CLAW_SKILLS_ROOT") or os.getenv("JIANGCHANG_SKILLS_ROOT") or "").strip() + if skills_root: + candidate = os.path.join(os.path.abspath(skills_root), "account-manager", "scripts", "main.py") + if os.path.isfile(candidate): + return candidate + + # 开发环境兜底:仅模板/本机调试;生产依赖宿主注入的路径变量,勿硬编码个人目录 + dev = r"D:\OpenClaw\client-commons\account-manager\scripts\main.py" + if os.path.isfile(dev): + return dev + + raise AccountManagerError( + "ACCOUNT_NOT_FOUND", + "未找到 account-manager,请配置 ACCOUNT_MANAGER_ROOT 或安装 account-manager 技能。", + ) + + +def _parse_last_json(stdout: str) -> Any: + lines = [ln.strip() for ln in (stdout or "").splitlines() if ln.strip()] + for raw in reversed(lines): + if raw.startswith("ERROR:"): + continue + try: + return json.loads(raw) + except json.JSONDecodeError: + continue + raise AccountManagerError("UNKNOWN_ERROR", "stdout 中没有可解析的 JSON。") + + +def _run_argv(argv_suffix: List[str]) -> subprocess.CompletedProcess[str]: + main_py = _resolve_account_manager_main() + env = os.environ.copy() + return subprocess.run( + [sys.executable, main_py, *argv_suffix], + capture_output=True, + text=True, + encoding="utf-8", + errors="replace", + env=env, + ) + + +def _normalize_error_code(raw: str) -> str: + code = (raw or "").strip() + if code.startswith("ERROR:"): + code = code[6:] + return code + + +def _validate_pick_payload(payload: dict[str, Any]) -> dict[str, Any]: + if payload.get("success") is False: + err = payload.get("error") if isinstance(payload.get("error"), dict) else {} + code = _normalize_error_code(str(err.get("code") or "")) + message = str(err.get("message") or "") + if code == "LEASE_CONFLICT" or "LEASE_CONFLICT" in code: + raise AccountManagerError("LEASE_CONFLICT", LEASE_BUSY_MESSAGE) + if code in ("NO_ACCOUNT", "ACCOUNT_NOT_FOUND") or "NO_ACCOUNT" in code: + raise AccountManagerError("NO_ACCOUNT", message or "没有可用账号。") + raise AccountManagerError(code or "PICK_WEB_FAILED", message or "pick-web 失败。") + + if not isinstance(payload, dict): + raise AccountManagerError("ACCOUNT_NOT_FOUND", "pick-web 返回格式异常。") + if not payload.get("profile_dir"): + raise AccountManagerError("ACCOUNT_NOT_FOUND", "pick-web 返回的账号缺少 profile_dir。") + return payload + + +def _pick_web_with_lease(platform: str) -> Dict[str, Any]: + proc = _run_argv( + [ + "account", + "pick-web", + "--platform", + platform, + "--lease", + "--holder", + LEASE_HOLDER, + "--ttl-sec", + LEASE_TTL_SEC, + ] + ) + out = proc.stdout or "" + if proc.returncode != 0 and not out.strip(): + raise AccountManagerError( + "PICK_WEB_FAILED", + (proc.stderr or "").strip() or "pick-web 子进程失败", + ) + payload = _parse_last_json(out) + if isinstance(payload, dict) and payload.get("success") is False: + return _validate_pick_payload(payload) + if not isinstance(payload, dict): + raise AccountManagerError("ACCOUNT_NOT_FOUND", "pick-web 返回格式异常。") + return payload + + +def _pick_by_id(platform: str, account_id: int) -> Dict[str, Any]: + proc = _run_argv(["account", "get", str(account_id)]) + out = proc.stdout or "" + if proc.returncode != 0 or out.startswith("ERROR:"): + raise AccountManagerError("ACCOUNT_NOT_FOUND", f"指定账号 {account_id} 不存在或获取失败。") + raw = _parse_last_json(out) + if isinstance(raw, dict) and "data" in raw and isinstance(raw["data"], dict): + data = raw["data"] + elif isinstance(raw, dict): + data = raw + else: + raise AccountManagerError("ACCOUNT_NOT_FOUND", "account get 返回非对象 JSON。") + + platform_key = str(data.get("platform_key") or "").lower() + if platform_key != platform.lower(): + raise AccountManagerError( + "ACCOUNT_NOT_FOUND", + f"账号 {account_id} 不是 {platform} 平台账号。", + ) + profile_dir = str(data.get("profile_dir") or "").strip() + if not profile_dir: + raise AccountManagerError("ACCOUNT_NOT_FOUND", f"账号 {account_id} 缺少 profile_dir。") + data["profile_dir"] = profile_dir + data["lease_token"] = "" + return data + + +def pick_web_account(platform: str, account_id: Optional[str] = None) -> dict: + """获取网页账号(profile_dir + lease_token)。""" + platform_key = (platform or PLACEHOLDER_PLATFORM).strip() or PLACEHOLDER_PLATFORM + + if account_id: + try: + aid = int(account_id) + except (TypeError, ValueError): + raise AccountManagerError("ACCOUNT_NOT_FOUND", f"账号 ID 无效:{account_id}") + return _pick_by_id(platform_key, aid) + + try: + return _pick_web_with_lease(platform_key) + except AccountManagerError as exc: + if exc.code in ("NO_ACCOUNT", "ACCOUNT_NOT_FOUND") or "NO_ACCOUNT" in exc.code: + raise AccountManagerError("ACCOUNT_SETUP_REQUIRED", ACCOUNT_SETUP_MESSAGE) from exc + raise + + +def release_lease(lease_token: Optional[str]) -> None: + token = (lease_token or "").strip() + if not token: + return + try: + proc = _run_argv(["lease", "release", token]) + if proc.returncode != 0: + logger.warning("lease_release_failed stdout=%s", (proc.stdout or "").strip()) + except Exception: + logger.warning("lease_release_exception", exc_info=True) diff --git a/examples/real_browser_rpa/scripts/service/browser_session.py b/examples/real_browser_rpa/scripts/service/browser_session.py new file mode 100644 index 0000000..4b89336 --- /dev/null +++ b/examples/real_browser_rpa/scripts/service/browser_session.py @@ -0,0 +1,135 @@ +"""浏览器会话启动(系统 Chrome/Edge + Playwright persistent context)。""" + +from __future__ import annotations + +import logging +import os +from typing import Any, Optional, Tuple + +from util.constants import DEFAULT_START_URL + +logger = logging.getLogger(__name__) + +DEFAULT_PAGE_TIMEOUT_MS = 15_000 +GOTO_TIMEOUT_MS = 60_000 + +STEALTH_INIT_SCRIPT = """ +(() => { + try { Object.defineProperty(navigator, 'webdriver', { get: () => undefined }); } catch (e) {} +})(); +""" + + +def get_start_url() -> str: + return (os.getenv("TARGET_START_URL") or DEFAULT_START_URL).strip() or DEFAULT_START_URL + + +def _headless_from_env() -> bool: + v = (os.getenv("OPENCLAW_BROWSER_HEADLESS") or "0").strip().lower() + return v in ("1", "true", "yes", "on") + + +def _find_chrome_executable() -> str | None: + try: + from jiangchang_skill_core.runtime_env import find_chrome_executable + + chrome = find_chrome_executable() + if chrome and os.path.isfile(chrome): + return chrome + except ImportError: + pass + + candidates = [ + os.path.expandvars(r"%ProgramFiles%\Google\Chrome\Application\chrome.exe"), + os.path.expandvars(r"%ProgramFiles(x86)%\Google\Chrome\Application\chrome.exe"), + os.path.expandvars(r"%ProgramFiles%\Microsoft\Edge\Application\msedge.exe"), + os.path.expandvars(r"%ProgramFiles(x86)%\Microsoft\Edge\Application\msedge.exe"), + ] + for path in candidates: + if path and os.path.isfile(path): + return path + return None + + +async def start_browser_session( + profile_dir: str, + *, + headless: Optional[bool] = None, +) -> Tuple[Any, Any, Any]: + """ + 启动持久化 Chrome profile,new_page + goto 入口页,返回 (playwright, context, page)。 + + 真实 skill 需要安装 playwright 与 jiangchang_skill_core。 + """ + from playwright.async_api import async_playwright + + hl = headless if headless is not None else _headless_from_env() + start_url = get_start_url() + chrome = _find_chrome_executable() + if not chrome: + raise RuntimeError( + "ERROR:MISSING_BROWSER 未检测到 Chrome 或 Edge 浏览器,请先安装系统浏览器后重试。" + ) + + launch_args = ["--start-maximized", "--disable-blink-features=AutomationControlled"] + logger.info( + "browser_launch chrome=%s profile_dir=%s start_url=%s args=%s headless=%s", + chrome, + profile_dir, + start_url, + launch_args, + hl, + ) + print(f"[浏览器] 系统 Chrome: {chrome}") + print(f"[浏览器] profile_dir: [{profile_dir}]") + print(f"[浏览器] startup_url={start_url}") + print(f"[浏览器] args={launch_args}") + + pw = await async_playwright().start() + context = None + try: + context = await pw.chromium.launch_persistent_context( + user_data_dir=profile_dir, + headless=hl, + executable_path=chrome, + locale="zh-CN", + no_viewport=True, + args=launch_args, + ignore_default_args=["--enable-automation"], + ) + await context.add_init_script(STEALTH_INIT_SCRIPT) + + page = await context.new_page() + page.set_default_timeout(DEFAULT_PAGE_TIMEOUT_MS) + + try: + await page.goto(start_url, wait_until="domcontentloaded", timeout=GOTO_TIMEOUT_MS) + except Exception as exc: + raise RuntimeError( + f"浏览器已启动,但未能打开目标首页 {start_url}。" + "请检查网络、Chrome profile、代理或页面访问状态。" + f"({exc})" + ) from exc + + return pw, context, page + except Exception: + if context is not None: + try: + await context.close() + except Exception: + pass + await pw.stop() + raise + + +async def close_browser_context(pw, context) -> None: + try: + if context is not None: + await context.close() + except Exception: + pass + try: + if pw is not None: + await pw.stop() + except Exception: + pass diff --git a/examples/real_browser_rpa/scripts/service/human_verification.py b/examples/real_browser_rpa/scripts/service/human_verification.py new file mode 100644 index 0000000..e6ed82e --- /dev/null +++ b/examples/real_browser_rpa/scripts/service/human_verification.py @@ -0,0 +1,450 @@ +"""人工验证等待:保存登录倒计时、滑块、短信验证码等(不自动破解)。""" + +from __future__ import annotations + +import asyncio +import logging +import random +import re +import time +from dataclasses import dataclass +from typing import Optional + +from util.constants import LOG_LOGGER_NAME + +logger = logging.getLogger(LOG_LOGGER_NAME) + +TEXT_EXCERPT_MAX = 120 + +SAVE_LOGIN_STRONG_MARKERS = ( + "是否保存登录信息", + "下次登录更便捷", + "保存登录信息", +) + +SAVE_LOGIN_CONTAINER_SELECTORS = ( + "[role=\"dialog\"]", + ".semi-modal", + ".semi-modal-content", +) + +SLIDER_SELECTORS = [ + ".vc-captcha-verify.slide", + ".captcha_verify_bar--title", + ".captcha-slider-tips", + "#captcha_verify_image", + ".captcha-slider-btn", +] + +SMS_SELECTORS = [ + ".second-verify-panel", + ".uc-ui-verify_sms-input", + ".uc-ui-verify-new_header-title", + "input[placeholder='手机号']", + "input[placeholder='请输入验证码']", +] + +DIALOG_TEXT_CONTAINERS = [ + "[role='dialog']", + ".semi-modal", + ".semi-modal-content", + ".vc-captcha-verify", + ".second-verify-panel", +] + +RISK_MARKERS = ( + "操作频繁", + "访问过于频繁", + "风险验证", + "安全验证", +) + + +@dataclass +class HumanVerificationState: + present: bool + kind: str + message: str + selector: str = "" + text_excerpt: str = "" + + +@dataclass +class HumanVerificationWaitResult: + timed_out: bool + kind: str = "" + code: str = "" + message: str = "" + stage: str = "" + + +def _text_excerpt(text: str) -> str: + cleaned = re.sub(r"\s+", " ", (text or "").strip()) + if len(cleaned) <= TEXT_EXCERPT_MAX: + return cleaned + return cleaned[:TEXT_EXCERPT_MAX] + "..." + + +def _contains_any(text: str, markers: tuple[str, ...]) -> bool: + return any(m in text for m in markers) + + +async def _selector_visible(page, selector: str) -> bool: + try: + loc = page.locator(selector).first + return await loc.is_visible(timeout=500) + except Exception: + return False + + +async def _selector_inner_text(page, selector: str) -> str: + try: + return await page.locator(selector).first.inner_text(timeout=1000) + except Exception: + return "" + + +async def _visible_text_from_first_visible(page, selectors: tuple[str, ...] | list[str]) -> tuple[str, str]: + for sel in selectors: + try: + loc = page.locator(sel).first + if await loc.is_visible(timeout=500): + text = await loc.inner_text(timeout=1000) + return sel, text or "" + except Exception: + continue + return "", "" + + +def _save_login_popup_from_text(text: str) -> bool: + if not text: + return False + if _contains_any(text, SAVE_LOGIN_STRONG_MARKERS): + return True + if "保存" in text and "取消" in text and ("登录" in text or "登录信息" in text): + return True + return False + + +async def detect_save_login_popup(page) -> bool: + sel, text = await _visible_text_from_first_visible(page, SAVE_LOGIN_CONTAINER_SELECTORS) + if sel and _save_login_popup_from_text(text): + return True + return False + + +async def wait_save_login_countdown_if_present(page, timeout_sec: int = 8) -> bool: + """若出现“保存登录信息”倒计时弹窗则等待其消失;未出现则立即返回 False。""" + if not await detect_save_login_popup(page): + return False + + logger.info("save_login_popup_detected") + print("[登录] 检测到“保存登录信息”倒计时弹窗,等待其自动关闭...") + start = time.monotonic() + deadline = start + timeout_sec + while time.monotonic() < deadline: + if not await detect_save_login_popup(page): + elapsed = round(time.monotonic() - start, 2) + logger.info("save_login_popup_gone elapsed_sec=%s", elapsed) + return True + await asyncio.sleep(0.5) + + elapsed = round(time.monotonic() - start, 2) + logger.warning( + "save_login_popup_still_visible elapsed_sec=%s timeout_sec=%s", + elapsed, + timeout_sec, + ) + print( + f"[登录] 警告:保存登录信息弹窗超过 {timeout_sec} 秒仍未消失," + "将继续后续流程(您可能已手工点击保存/取消)。" + ) + return True + + +async def detect_slider_verification(page) -> Optional[HumanVerificationState]: + sel_slide = ".vc-captcha-verify.slide" + if await _selector_visible(page, sel_slide): + text = await _selector_inner_text(page, sel_slide) + return HumanVerificationState( + present=True, + kind="slider", + message="滑块验证码", + selector=sel_slide, + text_excerpt=_text_excerpt(text), + ) + + sel_title = ".captcha_verify_bar--title" + if await _selector_visible(page, sel_title): + title_text = await _selector_inner_text(page, sel_title) + if "请完成下列验证后继续" in title_text: + return HumanVerificationState( + present=True, + kind="slider", + message="滑块验证码", + selector=sel_title, + text_excerpt=_text_excerpt(title_text), + ) + + sel_tips = ".captcha-slider-tips" + if await _selector_visible(page, sel_tips): + tips_text = await _selector_inner_text(page, sel_tips) + if "拖动完成上方拼图" in tips_text: + return HumanVerificationState( + present=True, + kind="slider", + message="滑块验证码", + selector=sel_tips, + text_excerpt=_text_excerpt(tips_text), + ) + + if await _selector_visible(page, "#captcha_verify_image"): + for btn_sel in (".captcha-slider-btn", ".captcha_verify_slide--button", ".captcha-slider"): + if await _selector_visible(page, btn_sel): + return HumanVerificationState( + present=True, + kind="slider", + message="滑块验证码", + selector=f"#captcha_verify_image+{btn_sel}", + text_excerpt="", + ) + + return None + + +async def detect_sms_verification(page) -> Optional[HumanVerificationState]: + sel_panel = ".second-verify-panel" + if await _selector_visible(page, sel_panel): + text = await _selector_inner_text(page, sel_panel) + return HumanVerificationState( + present=True, + kind="sms", + message="短信验证码", + selector=sel_panel, + text_excerpt=_text_excerpt(text), + ) + + sel_sms = ".uc-ui-verify_sms-input" + if await _selector_visible(page, sel_sms): + text = await _selector_inner_text(page, sel_sms) + return HumanVerificationState( + present=True, + kind="sms", + message="短信验证码", + selector=sel_sms, + text_excerpt=_text_excerpt(text), + ) + + sel_hdr = ".uc-ui-verify-new_header-title" + if await _selector_visible(page, sel_hdr): + hdr_text = await _selector_inner_text(page, sel_hdr) + if "短信验证" in hdr_text: + return HumanVerificationState( + present=True, + kind="sms", + message="短信验证码", + selector=sel_hdr, + text_excerpt=_text_excerpt(hdr_text), + ) + + phone_visible = await _selector_visible( + page, + ".second-verify-panel input[placeholder='手机号'], .uc-ui-verify_sms-input input[placeholder='手机号']", + ) + code_visible = await _selector_visible( + page, + ".second-verify-panel input[placeholder='请输入验证码'], .uc-ui-verify_sms-input input[placeholder='请输入验证码']", + ) + if phone_visible and code_visible: + return HumanVerificationState( + present=True, + kind="sms", + message="短信验证码", + selector="sms-phone-and-code-inputs", + text_excerpt="手机号+请输入验证码", + ) + + return None + + +async def detect_human_verification_from_containers(page) -> Optional[HumanVerificationState]: + sel, text = await _visible_text_from_first_visible(page, DIALOG_TEXT_CONTAINERS) + if not sel or not text: + return None + + if _contains_any(text, RISK_MARKERS): + return HumanVerificationState( + present=True, + kind="risk", + message="安全/频控验证", + selector=sel, + text_excerpt=_text_excerpt(text), + ) + + if sel in (".vc-captcha-verify", ".vc-captcha-verify-visibility"): + if "请完成下列验证后继续" in text or "拖动完成上方拼图" in text: + return HumanVerificationState( + present=True, + kind="slider", + message="滑块验证码", + selector=sel, + text_excerpt=_text_excerpt(text), + ) + + if sel in (".second-verify-panel", ".uc-ui-verify_sms-input"): + if "短信验证" in text or "获取验证码" in text: + return HumanVerificationState( + present=True, + kind="sms", + message="短信验证码", + selector=sel, + text_excerpt=_text_excerpt(text), + ) + + return None + + +async def detect_human_verification(page) -> HumanVerificationState: + """主检测入口:仅在验证码/弹窗容器级检测,不扫整页 body。""" + state = await detect_slider_verification(page) + if state is not None: + return state + state = await detect_sms_verification(page) + if state is not None: + return state + state = await detect_human_verification_from_containers(page) + if state is not None: + return state + return HumanVerificationState(present=False, kind="", message="", selector="", text_excerpt="") + + +def detect_human_verification_from_text(text: str) -> HumanVerificationState: + """ + 根据 HTML/容器文本判断验证弹窗(单元测试辅助,不能作为真实页面主检测入口)。 + 只检查验证容器 DOM 标记,不根据正文关键词误判。 + """ + html_lower = (text or "").lower() + has_slider_dom = ( + "vc-captcha-verify" in html_lower + and "slide" in html_lower + and ( + "captcha-slider-tips" in html_lower + or "captcha_verify_bar--title" in html_lower + or "captcha_verify_image" in html_lower + ) + ) + if has_slider_dom: + selector = ".vc-captcha-verify.slide" + if "captcha-slider-tips" in html_lower: + selector = ".captcha-slider-tips" + return HumanVerificationState( + present=True, + kind="slider", + message="滑块验证码", + selector=selector, + text_excerpt="", + ) + + has_sms_dom = "second-verify-panel" in html_lower or "uc-ui-verify_sms-input" in html_lower + if has_sms_dom: + selector = ".second-verify-panel" if "second-verify-panel" in html_lower else ".uc-ui-verify_sms-input" + return HumanVerificationState( + present=True, + kind="sms", + message="短信验证码", + selector=selector, + text_excerpt="", + ) + + return HumanVerificationState(present=False, kind="", message="", selector="", text_excerpt="") + + +def _wait_log_message(state: HumanVerificationState, wait_sec: int) -> str: + if state.kind == "slider": + return f"[人工验证] 检测到滑块验证码,请在浏览器中手工完成,最多等待 {wait_sec} 秒..." + if state.kind == "sms": + return f"[人工验证] 检测到短信验证码,请在浏览器中手工完成,最多等待 {wait_sec} 秒..." + return f"[人工验证] 检测到安全验证,请在浏览器中手工处理,最多等待 {wait_sec} 秒..." + + +def _timeout_error_code(kind: str) -> str: + if kind == "slider": + return "SLIDER_VERIFICATION_TIMEOUT" + if kind == "sms": + return "SMS_VERIFICATION_TIMEOUT" + return "HUMAN_VERIFICATION_TIMEOUT" + + +def _timeout_error_message(kind: str, wait_sec: int) -> str: + if kind == "slider": + return ( + f"滑块验证码未在 {wait_sec} 秒内完成,任务已停止。" + "请重新运行任务并及时在浏览器中完成验证。" + ) + if kind == "sms": + return ( + f"短信验证码未在 {wait_sec} 秒内完成,任务已停止。" + "请重新运行任务并及时完成短信验证。" + ) + return ( + f"安全验证未在 {wait_sec} 秒内完成,任务已停止。" + "请重新运行任务并及时在浏览器中完成验证。" + ) + + +async def wait_human_verification_if_present( + page, + *, + wait_sec: int = 180, + stage: str = "unknown", +) -> Optional[HumanVerificationWaitResult]: + """ + 若存在人工验证则等待用户完成;无验证或已完成返回 None;超时返回 HumanVerificationWaitResult。 + 不自动拖动滑块、不自动填写短信验证码。 + """ + state = await detect_human_verification(page) + if not state.present: + return None + + logger.warning( + "human_verification_detected stage=%s kind=%s selector=%s text=%s", + stage, + state.kind, + state.selector, + state.text_excerpt, + ) + print(_wait_log_message(state, wait_sec)) + + last_state = state + start = time.monotonic() + deadline = start + wait_sec + + while time.monotonic() < deadline: + state = await detect_human_verification(page) + if not state.present: + elapsed = round(time.monotonic() - start, 2) + logger.info( + "human_verification_passed stage=%s kind=%s elapsed_sec=%s", + stage, + last_state.kind, + elapsed, + ) + await asyncio.sleep(random.uniform(1.0, 2.0)) + return None + last_state = state + await asyncio.sleep(2.0) + + logger.warning( + "human_verification_timeout stage=%s kind=%s wait_sec=%s selector=%s", + stage, + last_state.kind, + wait_sec, + last_state.selector, + ) + return HumanVerificationWaitResult( + timed_out=True, + kind=last_state.kind, + code=_timeout_error_code(last_state.kind), + message=_timeout_error_message(last_state.kind, wait_sec), + stage=stage, + ) diff --git a/examples/real_browser_rpa/scripts/service/task_rpa.py b/examples/real_browser_rpa/scripts/service/task_rpa.py new file mode 100644 index 0000000..07adf3e --- /dev/null +++ b/examples/real_browser_rpa/scripts/service/task_rpa.py @@ -0,0 +1,641 @@ +"""真实网站关键词搜索 RPA 示例(async Playwright)。""" + +from __future__ import annotations + +import asyncio +import logging +import os +import random +import re +import time +from dataclasses import dataclass, field +from typing import Any, Callable, Dict, List, Optional, Tuple + +from service.browser_session import close_browser_context, get_start_url, start_browser_session +from service.human_verification import ( + HumanVerificationWaitResult, + wait_human_verification_if_present, + wait_save_login_countdown_if_present, +) +from util.constants import ( + DEFAULT_MAX_ITEMS, + DEFAULT_MAX_SCROLLS, + DEFAULT_NO_NEW_ROUNDS_LIMIT, + HUMAN_WAIT_TIMEOUT, + LOG_LOGGER_NAME, + RESULT_CONTAINER_SELECTOR, + RESULT_END_TEXT, + RESULT_ITEM_SELECTOR, + SCROLL_CONTAINER_SELECTORS, + SEARCH_BUTTON_SELECTOR, + SEARCH_INPUT_SELECTORS, +) +from util.logging import mask_text, safe_log_value + +logger = logging.getLogger(LOG_LOGGER_NAME) + + +@dataclass +class ScrapeError: + code: str + message: str + browser_started: bool = False + stage: Optional[str] = None + + +@dataclass +class ScrapeRunResult: + success: bool + items: List[Dict[str, Any]] = field(default_factory=list) + stop_reason: Optional[str] = None + error: Optional[ScrapeError] = None + + +StepCallback = Callable[[str], None] + +# 示例登录态 selector — 复制到新 skill 后必须用目标站点 F12/DOM 实测替换,禁止凭经验猜测或跨平台照抄 +LOGGED_IN_SELECTORS = ( + "a[href*='/user/self']", + "[data-user-avatar]", + ".user-avatar", +) +LOGGED_OUT_SELECTOR = "button:has-text('登录')" + + +def format_stop_reason_for_user(stop_reason: str | None, collected_count: int) -> str: + """将内部 stop_reason 枚举翻译为用户可理解的中文说明。""" + if stop_reason == "max_items": + return ( + f"已达到本次默认采集规模({collected_count} 条)。" + "如需更多,可以继续说「继续采集更多」或「尽量多采集」。" + ) + if stop_reason == "end_marker": + return "页面提示没有更多结果,本次采集已完成。" + if stop_reason == "no_new_rounds": + return "连续多次加载没有发现新结果,本次采集已完成。" + if stop_reason == "max_scrolls": + return ( + "已达到本次页面加载保护范围,本次采集已完成。" + "如需更深度采集,可以说明「尽量多采集」。" + ) + if stop_reason == "human_verification_timeout": + return "人工验证未在规定时间内完成,任务已停止。" + return "本次采集已完成。" + + +def _mask_account_ref(account: Dict[str, Any]) -> str: + for key in ("login_id", "phone", "mobile"): + raw = str(account.get(key) or "").strip() + if raw: + return mask_text(raw) + aid = account.get("id") or account.get("account_id") + if aid is not None: + return f"id:{aid}" + return "unknown" + + +def _step_cb(cb: Optional[StepCallback], text: str) -> None: + if cb: + cb(text) + + +async def _random_delay() -> None: + lo = int(os.getenv("RPA_STEP_DELAY_MIN_MS") or "900") + hi = int(os.getenv("RPA_STEP_DELAY_MAX_MS") or "2600") + await asyncio.sleep(random.uniform(lo / 1000.0, hi / 1000.0)) + + +async def _scroll_wait() -> None: + await asyncio.sleep(random.uniform(1.2, 3.5)) + + +def _headless() -> bool: + v = (os.getenv("OPENCLAW_BROWSER_HEADLESS") or "0").strip().lower() + return v in ("1", "true", "yes", "on") + + +def _no_new_limit() -> int: + try: + return int(os.getenv("RPA_NO_NEW_ROUNDS_LIMIT") or str(DEFAULT_NO_NEW_ROUNDS_LIMIT)) + except ValueError: + return DEFAULT_NO_NEW_ROUNDS_LIMIT + + +async def _visible(locator) -> bool: + try: + return await locator.count() > 0 and await locator.is_visible(timeout=500) + except Exception: + return False + + +async def _is_logged_out(page) -> bool: + try: + btn = page.locator(LOGGED_OUT_SELECTOR).first + return await _visible(btn) + except Exception: + return False + + +async def _is_logged_in(page) -> bool: + if await _is_logged_out(page): + return False + for sel in LOGGED_IN_SELECTORS: + try: + loc = page.locator(sel).first + if await _visible(loc): + return True + except Exception: + continue + return False + + +async def _open_login_panel_if_needed(page) -> None: + if not await _is_logged_out(page): + return + try: + btn = page.locator(LOGGED_OUT_SELECTOR).first + if await _visible(btn): + await btn.click() + await asyncio.sleep(random.uniform(1.0, 3.0)) + except Exception: + pass + + +async def _ensure_logged_in(page, *, wait_sec: int) -> None: + if await _is_logged_in(page): + return + + await _open_login_panel_if_needed(page) + if await _is_logged_in(page): + return + + print(f"[登录] 请在浏览器中完成登录,最多等待 {wait_sec} 秒...") + deadline = time.monotonic() + wait_sec + while time.monotonic() < deadline: + if await _is_logged_in(page): + print("[登录] 检测到登录成功") + return + await asyncio.sleep(2.0) + + raise RuntimeError( + f"ERROR:LOGIN_TIMEOUT 浏览器已打开,但未完成登录。" + f"请重新运行任务并在浏览器打开后及时完成登录。" + ) + + +async def _find_search_input(page) -> Tuple[Optional[Any], str]: + for sel in SEARCH_INPUT_SELECTORS: + try: + loc = page.locator(sel).first + if await _visible(loc): + return loc, sel + except Exception: + continue + + candidates: List[Tuple[int, Any, str]] = [] + try: + inputs = await page.locator("input").all() + except Exception: + inputs = [] + for inp in inputs: + try: + if not await inp.is_visible(): + continue + box = await inp.bounding_box() + if not box or box.get("width", 0) < 120: + continue + placeholder = await inp.get_attribute("placeholder") or "" + score = box.get("width", 0) + if "搜索" in placeholder: + score += 500 + if box.get("y", 9999) < 200: + score += 200 + candidates.append((score, inp, f"input placeholder={placeholder!r}")) + except Exception: + continue + if candidates: + candidates.sort(key=lambda x: x[0], reverse=True) + _, inp, sel = candidates[0] + return inp, sel + + try: + ph = page.get_by_placeholder(re.compile("搜索")) + if await ph.count() > 0 and await ph.first.is_visible(): + return ph.first, "placeholder=搜索" + except Exception: + pass + return None, "" + + +async def _find_search_button(page): + try: + btn = page.get_by_role("button", name="搜索") + if await btn.count() > 0 and await btn.first.is_visible(): + return btn.first + except Exception: + pass + try: + btn = page.locator(SEARCH_BUTTON_SELECTOR).first + if await btn.count() > 0 and await btn.is_visible(): + return btn + except Exception: + pass + return None + + +async def _wait_search_results(page, timeout_sec: float = 45.0) -> bool: + deadline = time.monotonic() + timeout_sec + while time.monotonic() < deadline: + try: + url = page.url or "" + if "/search" in url or "search" in url.lower(): + if await page.locator(RESULT_CONTAINER_SELECTOR).count() > 0: + return True + except Exception: + pass + await asyncio.sleep(0.8) + return False + + +async def _has_end_marker(page) -> bool: + try: + container = page.locator(RESULT_CONTAINER_SELECTOR).first + if await container.count() > 0: + text = await container.inner_text(timeout=2000) + if RESULT_END_TEXT in text or "暂时没有更多了" in text: + return True + except Exception: + pass + try: + if await page.locator(f"text={RESULT_END_TEXT}").count() > 0: + return True + except Exception: + pass + return False + + +async def _mouse_wheel_scroll(page) -> Tuple[str, int]: + wheel_delta = random.randint(650, 1200) + for sel in SCROLL_CONTAINER_SELECTORS: + loc = page.locator(sel) + try: + if await loc.count() > 0 and await loc.first.is_visible(): + await loc.first.hover() + await _random_delay() + await page.mouse.wheel(0, wheel_delta) + return sel, wheel_delta + except Exception: + continue + await page.mouse.wheel(0, wheel_delta) + return "page", wheel_delta + + +async def _parse_item_locator(item) -> Dict[str, Any]: + item_id = await item.get_attribute("data-item-id") or await item.get_attribute("id") or "" + title = "" + try: + title = (await item.inner_text(timeout=1000)).strip()[:200] + except Exception: + pass + return { + "item_id": item_id or title[:32] or str(id(item)), + "title": title, + } + + +async def _collect_visible_items(page, seen_ids: set[str]) -> List[Dict[str, Any]]: + new_items: List[Dict[str, Any]] = [] + try: + items = await page.locator(RESULT_ITEM_SELECTOR).all() + except Exception: + items = [] + for item in items: + try: + parsed = await _parse_item_locator(item) + item_id = parsed.get("item_id") + if not item_id or item_id in seen_ids: + continue + seen_ids.add(str(item_id)) + new_items.append(parsed) + except Exception: + continue + return new_items + + +async def _count_visible_items(page) -> int: + try: + return await page.locator(RESULT_ITEM_SELECTOR).count() + except Exception: + return 0 + + +def _fail_result(error: ScrapeError, *, collected: int = 0) -> ScrapeRunResult: + logger.warning( + "rpa_failed code=%s stage=%s message=%s collected=%s", + error.code, + error.stage, + error.message, + collected, + ) + return ScrapeRunResult(success=False, error=error) + + +def _fail_on_verification_timeout( + verification_timeout: HumanVerificationWaitResult, + *, + collected: int = 0, +) -> ScrapeRunResult: + return _fail_result( + ScrapeError( + code=verification_timeout.code, + message=verification_timeout.message, + browser_started=True, + stage=verification_timeout.stage or "unknown", + ), + collected=collected, + ) + + +async def run_keyword_search_async( + account: Dict[str, Any], + keyword: str, + *, + max_items: int = DEFAULT_MAX_ITEMS, + max_scrolls: int = DEFAULT_MAX_SCROLLS, + data_dir: str = "", + batch_id: str = "", + step_callback: Optional[StepCallback] = None, +) -> ScrapeRunResult: + profile_dir = account.get("profile_dir") or "" + account_ref = _mask_account_ref(account) + wait_sec = int(os.getenv("HUMAN_WAIT_TIMEOUT") or str(HUMAN_WAIT_TIMEOUT)) + no_new_limit = _no_new_limit() + + logger.info( + "rpa_start keyword=%s max_items=%s max_scrolls=%s wait_sec=%s batch_id=%s account_ref=%s", + safe_log_value(keyword), + max_items, + max_scrolls, + wait_sec, + batch_id, + account_ref, + ) + + if not profile_dir: + err = ScrapeError( + "ACCOUNT_NOT_FOUND", + "账号缺少 profile_dir。", + browser_started=False, + stage="account_prepare", + ) + return _fail_result(err) + + pw = None + context = None + page = None + browser_started = False + collected_count = 0 + + try: + _step_cb(step_callback, "启动关键词搜索采集任务") + try: + pw, context, page = await start_browser_session(profile_dir, headless=_headless()) + except RuntimeError as exc: + msg = str(exc) + err = ScrapeError( + "MISSING_BROWSER" if "MISSING_BROWSER" in msg else "UNKNOWN_ERROR", + msg.replace("ERROR:MISSING_BROWSER ", "").replace("ERROR:", ""), + browser_started="未能打开目标首页" in msg, + stage="browser_start" if "未能打开目标首页" in msg else "account_prepare", + ) + return _fail_result(err) + browser_started = True + + logger.info( + "browser_ready start_url=%s current_url=%s profile_dir_exists=%s", + get_start_url(), + page.url, + os.path.isdir(profile_dir), + ) + + _step_cb(step_callback, "打开目标站点首页") + await _random_delay() + + verification_timeout = await wait_human_verification_if_present( + page, wait_sec=wait_sec, stage="browser_start" + ) + if verification_timeout: + return _fail_on_verification_timeout(verification_timeout) + + _step_cb(step_callback, "检查账号登录状态") + logger.info("login_check_start current_url=%s", page.url) + try: + await _ensure_logged_in(page, wait_sec=wait_sec) + except RuntimeError as exc: + msg = str(exc) + code = "LOGIN_TIMEOUT" if "LOGIN_TIMEOUT" in msg else "REQUIRE_LOGIN" + err = ScrapeError( + code, + msg.replace("ERROR:LOGIN_TIMEOUT ", "").replace("ERROR:", ""), + browser_started=True, + stage="login_check", + ) + return _fail_result(err) + logger.info("login_check_done current_url=%s", page.url) + + await wait_save_login_countdown_if_present(page) + + verification_timeout = await wait_human_verification_if_present( + page, wait_sec=wait_sec, stage="login_check" + ) + if verification_timeout: + return _fail_on_verification_timeout(verification_timeout) + + _step_cb(step_callback, "定位搜索框") + search_input, input_selector = await _find_search_input(page) + if search_input is None: + err = ScrapeError( + "SEARCH_INPUT_NOT_FOUND", + "未找到搜索输入框。", + browser_started=True, + stage="search", + ) + return _fail_result(err) + logger.info("search_input_found selector=%s", input_selector) + + _step_cb(step_callback, f"输入关键词:{keyword}") + await search_input.click() + await _random_delay() + await page.keyboard.press("Control+A") + await page.keyboard.type(keyword, delay=random.randint(90, 240)) + await _random_delay() + + _step_cb(step_callback, "点击搜索") + search_btn = await _find_search_button(page) + search_method = "button" + if search_btn is not None: + await search_btn.click() + else: + search_method = "enter" + await page.keyboard.press("Enter") + logger.info( + "search_submitted keyword=%s method=%s current_url=%s", + safe_log_value(keyword), + search_method, + page.url, + ) + await _random_delay() + + verification_timeout = await wait_human_verification_if_present( + page, wait_sec=wait_sec, stage="search_verification" + ) + if verification_timeout: + return _fail_on_verification_timeout(verification_timeout) + + _step_cb(step_callback, "等待搜索结果") + if not await _wait_search_results(page): + verification_timeout = await wait_human_verification_if_present( + page, wait_sec=wait_sec, stage="search_results" + ) + if verification_timeout: + return _fail_on_verification_timeout(verification_timeout) + + if not await _wait_search_results(page, timeout_sec=10.0): + err = ScrapeError( + "RESULT_CONTAINER_NOT_FOUND", + "搜索结果未出现,且未检测到需要人工处理的验证码,请检查关键词或页面状态。", + browser_started=True, + stage="search", + ) + return _fail_result(err) + + container_count = await page.locator(RESULT_CONTAINER_SELECTOR).count() + logger.info( + "search_results_ready current_url=%s container_count=%s", + page.url, + container_count, + ) + + try: + await page.locator(RESULT_CONTAINER_SELECTOR).first.wait_for(state="visible", timeout=15_000) + except Exception: + err = ScrapeError( + "RESULT_CONTAINER_NOT_FOUND", + "搜索结果容器未出现。", + browser_started=True, + stage="search", + ) + return _fail_result(err) + + seen_ids: set[str] = set() + collected: List[Dict[str, Any]] = [] + no_new_rounds = 0 + stop_reason = "max_scrolls" + rounds_executed = 0 + + for scroll_round in range(max_scrolls + 1): + rounds_executed = scroll_round + _step_cb(step_callback, "读取当前结果列表") + visible_count = await _count_visible_items(page) + batch = await _collect_visible_items(page, seen_ids) + new_count = len(batch) + if batch: + collected.extend(batch) + no_new_rounds = 0 + else: + no_new_rounds += 1 + + collected_count = len(collected) + end_marker = await _has_end_marker(page) + logger.info( + "collect_round round=%s max_scrolls=%s visible_count=%s new_count=%s " + "collected=%s no_new_rounds=%s no_new_limit=%s end_marker=%s current_url=%s", + scroll_round, + max_scrolls, + visible_count, + new_count, + collected_count, + no_new_rounds, + no_new_limit, + end_marker, + page.url, + ) + + if len(collected) >= max_items: + collected = collected[:max_items] + stop_reason = "max_items" + break + + if end_marker: + stop_reason = "end_marker" + _step_cb(step_callback, "发现结果到底或达到采集数量") + break + + if no_new_rounds >= no_new_limit: + stop_reason = "no_new_rounds" + logger.info( + "collect_no_new_stop round=%s no_new_rounds=%s no_new_limit=%s collected=%s", + scroll_round, + no_new_rounds, + no_new_limit, + collected_count, + ) + break + + if scroll_round >= max_scrolls: + break + + _step_cb(step_callback, "滚动加载更多结果") + scroll_target, wheel_delta = await _mouse_wheel_scroll(page) + logger.info( + "scroll round=%s target=%s wheel_delta=%s", + scroll_round, + scroll_target, + wheel_delta, + ) + await _scroll_wait() + + verification_timeout = await wait_human_verification_if_present( + page, wait_sec=wait_sec, stage="collect" + ) + if verification_timeout: + return _fail_on_verification_timeout( + verification_timeout, + collected=collected_count, + ) + + logger.info( + "collect_stop reason=%s collected=%s rounds=%s no_new_rounds=%s", + stop_reason, + collected_count, + rounds_executed, + no_new_rounds, + ) + + if not collected: + err = ScrapeError( + "NO_RESULTS", + "未采集到任何结果。", + browser_started=True, + stage="collect", + ) + return _fail_result(err, collected=0) + + _step_cb(step_callback, "采集完成") + logger.info( + "rpa_success collected=%s stop_reason=%s", + len(collected[:max_items]), + stop_reason, + ) + return ScrapeRunResult(success=True, items=collected[:max_items], stop_reason=stop_reason) + + except Exception as exc: + err = ScrapeError( + "UNKNOWN_ERROR", + str(exc), + browser_started=browser_started, + stage="rpa", + ) + return _fail_result(err, collected=collected_count) + finally: + await close_browser_context(pw, context) diff --git a/examples/real_browser_rpa/scripts/service/task_service.py b/examples/real_browser_rpa/scripts/service/task_service.py new file mode 100644 index 0000000..08f7fc8 --- /dev/null +++ b/examples/real_browser_rpa/scripts/service/task_service.py @@ -0,0 +1,137 @@ +"""轻量任务编排示例(无真实数据库依赖)。""" + +from __future__ import annotations + +import asyncio +import uuid +from typing import Any, Optional + +from service.account_client import AccountManagerError, pick_web_account, release_lease +from service.task_rpa import ( + ScrapeRunResult, + format_stop_reason_for_user, + run_keyword_search_async, +) +from util.constants import ( + DEFAULT_MAX_ITEMS, + DEFAULT_MAX_SCROLLS, + SKILL_SLUG, + TARGET_PLATFORM, +) + + +def _error_payload( + code: str, + message: str, + *, + browser_started: Optional[bool] = None, + stage: Optional[str] = None, +) -> dict[str, Any]: + payload: dict[str, Any] = { + "success": False, + "error": {"code": code, "message": message}, + } + if browser_started is not None: + payload["browser_started"] = browser_started + if stage: + payload["stage"] = stage + return payload + + +def _success_payload( + *, + keyword: str, + collected_count: int, + items: list[dict[str, Any]], + stop_reason: Optional[str], +) -> dict[str, Any]: + return { + "success": True, + "skill": SKILL_SLUG, + "keyword": keyword, + "collected_count": collected_count, + "items": items, + "stop_reason": stop_reason, + "stop_reason_message": format_stop_reason_for_user(stop_reason, collected_count), + } + + +async def run_keyword_search_task( + keyword: str, + *, + max_items: int = DEFAULT_MAX_ITEMS, + max_scrolls: int = DEFAULT_MAX_SCROLLS, + account_id: Optional[str] = None, + platform: str = TARGET_PLATFORM, +) -> dict[str, Any]: + """ + 编排一次关键词搜索采集。 + + 真实 skill 中还应: + - 写 SQLite 入库(items 表) + - 写 scrape_tasks / task_logs 任务日志 + - 使用 RpaVideoSession 录制步骤留痕 + - 失败时 capture_failure 截图 + """ + batch_id = uuid.uuid4().hex[:12] + data_dir = "" # 示例占位;真实 skill 使用 get_skill_data_dir() + lease_token: Optional[str] = None + account: Optional[dict[str, Any]] = None + + try: + account = pick_web_account(platform, account_id) + lease_token = account.get("lease_token") + + scrape_result: ScrapeRunResult = await run_keyword_search_async( + account, + keyword, + max_items=max_items, + max_scrolls=max_scrolls, + data_dir=data_dir, + batch_id=batch_id, + ) + + if not scrape_result.success: + err = scrape_result.error + return _error_payload( + err.code if err else "UNKNOWN_ERROR", + err.message if err else "未知错误", + browser_started=err.browser_started if err else True, + stage=err.stage if err else "rpa", + ) + + collected_count = len(scrape_result.items) + return _success_payload( + keyword=keyword, + collected_count=collected_count, + items=scrape_result.items[:10], + stop_reason=scrape_result.stop_reason, + ) + except AccountManagerError as exc: + return _error_payload( + exc.code, + exc.message, + browser_started=False, + stage="account_prepare", + ) + finally: + release_lease(lease_token) + + +def run_keyword_search_task_sync( + keyword: str, + *, + max_items: int = DEFAULT_MAX_ITEMS, + max_scrolls: int = DEFAULT_MAX_SCROLLS, + account_id: Optional[str] = None, + platform: str = TARGET_PLATFORM, +) -> dict[str, Any]: + return asyncio.run( + run_keyword_search_task( + keyword, + max_items=max_items, + max_scrolls=max_scrolls, + account_id=account_id, + platform=platform, + ) + ) diff --git a/examples/real_browser_rpa/scripts/util/constants.py b/examples/real_browser_rpa/scripts/util/constants.py new file mode 100644 index 0000000..f90f552 --- /dev/null +++ b/examples/real_browser_rpa/scripts/util/constants.py @@ -0,0 +1,31 @@ +"""示例常量(复制到新 skill 时请替换为目标站点与业务字段)。""" + +SKILL_SLUG = "example-real-browser-rpa" +LOG_LOGGER_NAME = "openclaw.skill.example_real_browser_rpa" + +TARGET_PLATFORM = "target_platform" +LEASE_HOLDER = "example-real-browser-rpa" +LEASE_TTL_SEC = "1800" + +DEFAULT_START_URL = "https://example.com" +DEFAULT_MAX_ITEMS = 100 +DEFAULT_MAX_SCROLLS = 40 +DEFAULT_NO_NEW_ROUNDS_LIMIT = 5 +HUMAN_WAIT_TIMEOUT = 180 + +RESULT_END_TEXT = "没有更多结果了" + +# 示例 selector — 复制到新 skill 时按目标站点 DOM 替换 +SEARCH_INPUT_SELECTORS = ( + 'input[type="search"]', + 'input[name="q"]', + 'input[placeholder*="搜索"]', +) +SEARCH_BUTTON_SELECTOR = 'button:has-text("搜索")' +RESULT_CONTAINER_SELECTOR = "#search-result-container" +RESULT_ITEM_SELECTOR = "[data-result-item]" +SCROLL_CONTAINER_SELECTORS = ( + "#search-result-container", + ".search-result-scroll", + ".route-scroll-container", +) diff --git a/examples/real_browser_rpa/scripts/util/logging.py b/examples/real_browser_rpa/scripts/util/logging.py new file mode 100644 index 0000000..d0a014c --- /dev/null +++ b/examples/real_browser_rpa/scripts/util/logging.py @@ -0,0 +1,34 @@ +"""示例结构化日志工具。""" + +from __future__ import annotations + +import logging +import re +from typing import Any + +from util.constants import LOG_LOGGER_NAME + + +def get_logger(name: str | None = None) -> logging.Logger: + return logging.getLogger(name or LOG_LOGGER_NAME) + + +def mask_text(value: str, *, keep_start: int = 2, keep_end: int = 2) -> str: + s = (value or "").strip() + if len(s) >= 11 and s.isdigit(): + return s[:3] + "****" + s[-4:] + if len(s) > keep_start + keep_end: + return s[:keep_start] + "****" + s[-keep_end:] + return "****" + + +def safe_log_value(value: Any) -> str: + if value is None: + return "" + text = str(value) + if re.fullmatch(r"\d{7,}", text): + return mask_text(text) + if "@" in text and len(text) > 6: + local, _, domain = text.partition("@") + return f"{mask_text(local, keep_start=1, keep_end=1)}@{domain}" + return text diff --git a/examples/real_browser_rpa/tests/conftest.py b/examples/real_browser_rpa/tests/conftest.py new file mode 100644 index 0000000..5b922c9 --- /dev/null +++ b/examples/real_browser_rpa/tests/conftest.py @@ -0,0 +1,10 @@ +"""pytest 路径配置:将 examples/real_browser_rpa/scripts 加入 import 路径。""" + +from __future__ import annotations + +import sys +from pathlib import Path + +SCRIPTS = Path(__file__).resolve().parents[1] / "scripts" +if str(SCRIPTS) not in sys.path: + sys.path.insert(0, str(SCRIPTS)) diff --git a/examples/real_browser_rpa/tests/test_human_verification.py b/examples/real_browser_rpa/tests/test_human_verification.py new file mode 100644 index 0000000..5b27f82 --- /dev/null +++ b/examples/real_browser_rpa/tests/test_human_verification.py @@ -0,0 +1,170 @@ +# -*- coding: utf-8 -*- +"""人工验证检测单元测试(DOM 精准检测,不依赖真实浏览器)。""" +from __future__ import annotations + +import asyncio +import time +import unittest + +from service.human_verification import ( + HumanVerificationWaitResult, + detect_human_verification, + detect_human_verification_from_text, + wait_human_verification_if_present, + wait_save_login_countdown_if_present, +) + + +SLIDER_HTML = """ +
+
请完成下列验证后继续
+
按住左边按钮拖动完成上方拼图
+
+""" + +SMS_HTML = """ +
+
+
短信验证
+ + + +
+
+""" + +SEARCH_RESULTS_HTML = """ +
+
RPA 滑块验证码识别教程
+
短信验证码自动化
+
+""" + + +class MockLocator: + def __init__(self, selector: str, visible: set[str], texts: dict[str, str]) -> None: + self._selector = selector + self._visible = visible + self._texts = texts + + @property + def first(self) -> MockLocator: + return self + + async def is_visible(self, timeout: int = 500) -> bool: + return self._selector in self._visible + + async def inner_text(self, timeout: int = 1000) -> str: + return self._texts.get(self._selector, "") + + async def count(self) -> int: + return 1 if self._selector in self._visible else 0 + + +class MockPage: + def __init__(self, visible: set[str], texts: dict[str, str] | None = None) -> None: + self._visible = visible + self._texts = texts or {} + + def locator(self, selector: str) -> MockLocator: + return MockLocator(selector, self._visible, self._texts) + + +class TestHumanVerificationFromText(unittest.TestCase): + def test_slider_dom_detect(self) -> None: + state = detect_human_verification_from_text(SLIDER_HTML) + self.assertTrue(state.present) + self.assertEqual(state.kind, "slider") + self.assertTrue(state.selector) + + def test_sms_dom_detect(self) -> None: + state = detect_human_verification_from_text(SMS_HTML) + self.assertTrue(state.present) + self.assertEqual(state.kind, "sms") + self.assertTrue(state.selector) + + def test_search_results_not_misclassified(self) -> None: + state = detect_human_verification_from_text(SEARCH_RESULTS_HTML) + self.assertFalse(state.present) + + def test_body_keywords_without_dom_not_misclassified(self) -> None: + text = "RPA 滑块验证码识别教程\n短信验证码自动化" + state = detect_human_verification_from_text(text) + self.assertFalse(state.present) + + +class TestHumanVerificationDomDetect(unittest.TestCase): + def test_slider_dom_visible(self) -> None: + page = MockPage( + {".vc-captcha-verify.slide"}, + {".vc-captcha-verify.slide": "请完成下列验证后继续"}, + ) + state = asyncio.run(detect_human_verification(page)) + self.assertTrue(state.present) + self.assertEqual(state.kind, "slider") + self.assertEqual(state.selector, ".vc-captcha-verify.slide") + + def test_sms_dom_visible(self) -> None: + page = MockPage( + {".second-verify-panel"}, + {".second-verify-panel": "短信验证 获取验证码"}, + ) + state = asyncio.run(detect_human_verification(page)) + self.assertTrue(state.present) + self.assertEqual(state.kind, "sms") + + def test_no_verification_when_empty(self) -> None: + page = MockPage(set()) + state = asyncio.run(detect_human_verification(page)) + self.assertFalse(state.present) + + +class TestSaveLoginCountdown(unittest.TestCase): + def test_wait_not_present_no_delay(self) -> None: + page = MockPage(set()) + start = time.monotonic() + result = asyncio.run(wait_save_login_countdown_if_present(page, timeout_sec=8)) + elapsed = time.monotonic() - start + self.assertFalse(result) + self.assertLess(elapsed, 1.0) + + +class TestHumanVerificationWait(unittest.TestCase): + def test_wait_timeout_slider_dom(self) -> None: + page = MockPage( + {".vc-captcha-verify.slide"}, + {".vc-captcha-verify.slide": "请完成下列验证后继续"}, + ) + result = asyncio.run( + wait_human_verification_if_present(page, wait_sec=1, stage="search_verification") + ) + self.assertIsInstance(result, HumanVerificationWaitResult) + self.assertTrue(result.timed_out) + self.assertEqual(result.code, "SLIDER_VERIFICATION_TIMEOUT") + self.assertIn("滑块验证码未在 1 秒内完成", result.message) + self.assertEqual(result.stage, "search_verification") + + def test_wait_timeout_sms_dom(self) -> None: + page = MockPage( + {".second-verify-panel"}, + {".second-verify-panel": "短信验证 获取验证码"}, + ) + result = asyncio.run( + wait_human_verification_if_present(page, wait_sec=1, stage="login_check") + ) + self.assertIsInstance(result, HumanVerificationWaitResult) + self.assertTrue(result.timed_out) + self.assertEqual(result.code, "SMS_VERIFICATION_TIMEOUT") + self.assertEqual(result.stage, "login_check") + + def test_collect_no_verification_immediate_none(self) -> None: + page = MockPage(set()) + start = time.monotonic() + err = asyncio.run(wait_human_verification_if_present(page, wait_sec=180, stage="collect")) + elapsed = time.monotonic() - start + self.assertIsNone(err) + self.assertLess(elapsed, 1.0) + + +if __name__ == "__main__": + unittest.main() diff --git a/examples/real_browser_rpa/tests/test_stop_reason.py b/examples/real_browser_rpa/tests/test_stop_reason.py new file mode 100644 index 0000000..70110e5 --- /dev/null +++ b/examples/real_browser_rpa/tests/test_stop_reason.py @@ -0,0 +1,34 @@ +# -*- coding: utf-8 -*- +"""stop_reason 用户友好文案单元测试。""" +from __future__ import annotations + +import unittest + +from service.task_rpa import format_stop_reason_for_user + + +class TestFormatStopReasonForUser(unittest.TestCase): + def test_max_items(self) -> None: + msg = format_stop_reason_for_user("max_items", 100) + self.assertIn("默认采集规模", msg) + self.assertIn("100", msg) + + def test_end_marker(self) -> None: + msg = format_stop_reason_for_user("end_marker", 42) + self.assertIn("没有更多结果", msg) + + def test_no_new_rounds(self) -> None: + msg = format_stop_reason_for_user("no_new_rounds", 30) + self.assertIn("连续多次加载没有发现新结果", msg) + + def test_max_scrolls(self) -> None: + msg = format_stop_reason_for_user("max_scrolls", 80) + self.assertIn("页面加载保护范围", msg) + + def test_none_or_unknown(self) -> None: + self.assertEqual(format_stop_reason_for_user(None, 10), "本次采集已完成。") + self.assertEqual(format_stop_reason_for_user("unknown", 10), "本次采集已完成。") + + +if __name__ == "__main__": + unittest.main() diff --git a/examples/simulator_api/README.md b/examples/simulator_api/README.md new file mode 100644 index 0000000..bae6cd4 --- /dev/null +++ b/examples/simulator_api/README.md @@ -0,0 +1,15 @@ +# Simulator API Example + +这个目录用于沉淀“仿真环境 / API”类 skill 的可复制成功案例。 + +## 适用场景 + +- 使用 mock / sandbox / simulator API +- 不需要启动浏览器 +- 适合演示输入校验、API 调用、结果入库、日志、错误契约和测试 + +## 当前状态 + +- 本目录暂时只保留结构占位。 +- 示例业务尚未确定。 +- 本轮不包含示例代码。 diff --git a/examples/simulator_api/scripts/service/.gitkeep b/examples/simulator_api/scripts/service/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/examples/simulator_api/scripts/util/.gitkeep b/examples/simulator_api/scripts/util/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/examples/simulator_api/tests/.gitkeep b/examples/simulator_api/tests/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/examples/simulator_browser_rpa/README.md b/examples/simulator_browser_rpa/README.md new file mode 100644 index 0000000..df62a0b --- /dev/null +++ b/examples/simulator_browser_rpa/README.md @@ -0,0 +1,125 @@ +# Simulator Browser RPA Example + +这是一个**仿真浏览器 RPA** 的可复制参考实现:在可控 sandbox 页面上,通过 Playwright 完成登录、表单填写、弹窗确认、结果解析。 + +本示例抽象自已跑通的「批量提交类」浏览器自动化 skill,但已去业务化,不包含真实银行/真实资金语义。 + +## 适合什么场景 + +- 自有 **仿真系统 / sandbox / training 页面** +- 需要 **浏览器 RPA** 做端到端演示或回归 +- 表单较复杂:多步登录、Tab 切换、动态增行、PIN 弹窗、成功页解析 +- 需要 **adapter 分层**:mock(CI)与 simulator_rpa(半集成)可切换 + +## 不适合什么场景 + +- **真实第三方网站 + 高风控 + 人工验证码** → 优先看 [`../real_browser_rpa/README.md`](../real_browser_rpa/README.md) +- 目标系统有稳定 **官方 API** → 不要硬写浏览器 RPA,后续参考 `real_api` +- **不要把本示例的业务字段、selector、sandbox URL 原样复制**到你的 skill + +## 目录结构 + +``` +simulator_browser_rpa/ +├── README.md +├── sandbox/ +│ └── demo_app.html # 本地仿真页面(稳定 data-testid / name) +├── scripts/ +│ ├── service/ +│ │ ├── browser_session.py # 浏览器启动(URL 仅 page.goto) +│ │ ├── account_client.py # 账号来源集中封装 +│ │ ├── task_service.py # 编排层 +│ │ └── adapter/ +│ │ ├── base.py # BatchItem / BatchSubmitResult 契约 +│ │ ├── mock.py # mock/unit 档 +│ │ ├── simulator_rpa.py +│ │ └── __init__.py # select_adapter +│ └── util/ +│ ├── constants.py +│ └── logging.py +└── tests/ + ├── test_adapter_dispatch.py + ├── test_simulator_rpa_unit.py + └── test_stop_reason.py +``` + +## 文件职责 + +| 文件 | 职责 | +|---|---| +| `browser_session.py` | 系统 Chrome/Edge + launch args 规范;支持 profile / 无 profile | +| `account_client.py` | 示例从环境变量读账号;真实 skill 可在此集中对接 account-manager | +| `adapter/base.py` | 数据契约与 `BatchAdapterBase` | +| `adapter/mock.py` | 不启浏览器,供 unit/mock/CI | +| `adapter/simulator_rpa.py` | 仿真 RPA 主流程 | +| `task_service.py` | 校验输入 → 选 adapter → 提交 → 返回 summary | +| `sandbox/demo_app.html` | 可控 DOM,配合 selector 稳定 | +| `tests/` | dispatch、URL 不进 launch args、失败转结果 | + +## 核心流程 + +1. `task_service.run_batch_submit(target, items)` 校验参数 +2. `select_adapter()` 按 `OPENCLAW_TEST_TARGET` 选择 mock 或 simulator RPA +3. simulator 档:`pick_simulator_account()` → `set_credentials()` → `submit_batch()` +4. RPA:登录两步 → 批量页 → 填表 → 提交 → PIN → 解析 `batch_id` +5. 失败截图(有 `artifacts_dir` 时)→ 返回 `BatchSubmitResult` + +## 复制到新 skill 时怎么做 + +**保留:** + +- adapter 分层(base / mock / simulator_rpa / `select_adapter`) +- `browser_session.py` 启动规范(**URL 不进 launch args**) +- `account_client.py` 集中封装模式 +- 关键节点结构化日志 + 失败截图 +- 测试:dispatch、launch args、错误转 `BatchSubmitResult` + +**替换:** + +- `BatchItem` 字段与校验规则 +- `sandbox/demo_app.html` 或 `SIMULATOR_BASE_URL` 指向的页面 +- 全部 DOM selector(必须 F12 实测) +- `task_service.py` 输入输出与 DB/任务日志 +- mock 返回字段、成功页 `batch_id` 解析逻辑 + +## 明确禁止 + +- 不要复制 `__pycache__`、`.pytest_cache`、`artifacts/`、`recordings/` 等生成物 +- **不要在技能侧**执行 `playwright install` / `pip install playwright`(Python 包由宿主共享 runtime 提供) +- **不要把 URL 放进** `launch_persistent_context(args=[...])` +- **不要在** `task_service.py` / RPA 主流程里散落 account-manager subprocess +- **不要把真实生产系统**配置到 `simulator_rpa` 档位 +- 不要照抄 slug、logger 名、演示账号到生产 skill + +## 依赖说明 + +- Python 3.10+ +- Python 包 `playwright`:由**宿主共享 runtime** 提供;技能侧不要写入 `requirements.txt`,不要 `pip install playwright` +- 默认使用**系统 Chrome/Edge**,不使用 Playwright 内置 Chromium +- 技能侧不要执行 `playwright install` / `playwright install chromium` +- 本地独立开发若缺 Playwright Python 包,仅作开发机临时补装;生产由宿主解决 +- `jiangchang_skill_core.runtime_env.find_chrome_executable`(可选,用于查找系统浏览器) + +## 环境变量(示例) + +| 变量 | 说明 | +|---|---| +| `OPENCLAW_TEST_TARGET` | `mock`/`unit` → Mock;默认 → Simulator RPA | +| `SIMULATOR_BASE_URL` | 仿真页 URL;默认本地 `sandbox/demo_app.html` 的 file URI | +| `SIMULATOR_LOGIN_ID` / `PASSWORD` / `TOKEN_PIN` | 演示账号 | +| `SIMULATOR_PROFILE_DIR` | 可选 persistent profile | +| `OPENCLAW_BROWSER_HEADLESS` | `0` 默认有头;`1` 无头模式(CI 可用) | + +## 运行测试 + +```bash +cd examples/simulator_browser_rpa +python -m pytest tests/ -v +``` + +测试为 mock/纯函数,**不需要启动真实浏览器**。 + +## 当前状态 + +- 示例代码与 sandbox 页面已就绪,可作为仿真浏览器 RPA 复制起点。 +- 未接入完整 CLI、数据库与 entitlement。 diff --git a/examples/simulator_browser_rpa/sandbox/demo_app.html b/examples/simulator_browser_rpa/sandbox/demo_app.html new file mode 100644 index 0000000..721eb5b --- /dev/null +++ b/examples/simulator_browser_rpa/sandbox/demo_app.html @@ -0,0 +1,141 @@ + + + + + 仿真批量提交系统(示例 Sandbox) + + + +

仿真业务系统 · 批量提交(示例)

+ +
+

登录 · 第一步

+
+ + +
+
+ + + + + + + + + + + + diff --git a/examples/simulator_browser_rpa/scripts/service/.gitkeep b/examples/simulator_browser_rpa/scripts/service/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/examples/simulator_browser_rpa/scripts/service/account_client.py b/examples/simulator_browser_rpa/scripts/service/account_client.py new file mode 100644 index 0000000..aa4f417 --- /dev/null +++ b/examples/simulator_browser_rpa/scripts/service/account_client.py @@ -0,0 +1,40 @@ +"""仿真账号来源封装(示例级;真实 skill 可在此集中对接 account-manager)。""" + +from __future__ import annotations + +import os +from dataclasses import dataclass +from typing import Optional + +from util.constants import ( + DEFAULT_DEMO_LOGIN_ID, + DEFAULT_DEMO_PASSWORD, + DEFAULT_DEMO_TOKEN_PIN, + ENV_SIMULATOR_LOGIN_ID, + ENV_SIMULATOR_PASSWORD, + ENV_SIMULATOR_PROFILE_DIR, + ENV_SIMULATOR_TOKEN_PIN, +) + + +@dataclass +class SimulatorAccount: + login_id: str + password: str + token_pin: str + profile_dir: str = "" + + +def pick_simulator_account() -> SimulatorAccount: + """ + 示例账号来源:优先读环境变量,否则返回内置 demo 账号。 + + 真实 skill 若依赖 account-manager,应把 subprocess / sibling_bridge 调用 + 集中在本模块,不要散落到 task_service 或 RPA 主流程中。 + """ + return SimulatorAccount( + login_id=(os.getenv(ENV_SIMULATOR_LOGIN_ID) or DEFAULT_DEMO_LOGIN_ID).strip(), + password=(os.getenv(ENV_SIMULATOR_PASSWORD) or DEFAULT_DEMO_PASSWORD).strip(), + token_pin=(os.getenv(ENV_SIMULATOR_TOKEN_PIN) or DEFAULT_DEMO_TOKEN_PIN).strip(), + profile_dir=(os.getenv(ENV_SIMULATOR_PROFILE_DIR) or "").strip(), + ) diff --git a/examples/simulator_browser_rpa/scripts/service/adapter/__init__.py b/examples/simulator_browser_rpa/scripts/service/adapter/__init__.py new file mode 100644 index 0000000..67ae8e5 --- /dev/null +++ b/examples/simulator_browser_rpa/scripts/service/adapter/__init__.py @@ -0,0 +1,40 @@ +"""adapter 工厂:按 OPENCLAW_TEST_TARGET 选择实现。""" + +from __future__ import annotations + +import logging +import os +from typing import Optional + +from service.adapter.base import BatchAdapterBase, BatchItem, BatchSubmitResult +from service.adapter.mock import MockBatchAdapter +from service.adapter.simulator_rpa import SimulatorBrowserRpaAdapter + +logger = logging.getLogger(__name__) + +__all__ = [ + "select_adapter", + "BatchAdapterBase", + "BatchItem", + "BatchSubmitResult", + "MockBatchAdapter", + "SimulatorBrowserRpaAdapter", +] + + +def select_adapter(artifacts_dir: Optional[str] = None) -> BatchAdapterBase: + target = os.environ.get("OPENCLAW_TEST_TARGET", "").strip().lower() + + if target in ("mock", "unit"): + logger.info("target '%s': MockBatchAdapter", target) + return MockBatchAdapter() + + if target == "real_rpa": + logger.warning("target real_rpa 未实现,回退 MockBatchAdapter") + return MockBatchAdapter() + + if target and target != "simulator_rpa": + logger.warning("未知 target '%s',回退 simulator_rpa", target) + + logger.info("target '%s': SimulatorBrowserRpaAdapter", target or "(unset=default)") + return SimulatorBrowserRpaAdapter(artifacts_dir=artifacts_dir) diff --git a/examples/simulator_browser_rpa/scripts/service/adapter/base.py b/examples/simulator_browser_rpa/scripts/service/adapter/base.py new file mode 100644 index 0000000..d026151 --- /dev/null +++ b/examples/simulator_browser_rpa/scripts/service/adapter/base.py @@ -0,0 +1,32 @@ +"""批量提交 adapter 基类与数据契约。""" + +from __future__ import annotations + +from dataclasses import dataclass, field +from typing import Any, Dict, List, Optional + + +@dataclass +class BatchItem: + row_index: int + name: str + account: str + amount: float + note: str = "" + + +@dataclass +class BatchSubmitResult: + ok: bool + batch_id: Optional[str] + submitted_count: int + submitted_amount: float + error_msg: Optional[str] + artifacts: Dict[str, Any] = field(default_factory=dict) + + +class BatchAdapterBase: + name: str = "base" + + def submit_batch(self, target: str, items: List[BatchItem]) -> BatchSubmitResult: + raise NotImplementedError diff --git a/examples/simulator_browser_rpa/scripts/service/adapter/mock.py b/examples/simulator_browser_rpa/scripts/service/adapter/mock.py new file mode 100644 index 0000000..3b1447b --- /dev/null +++ b/examples/simulator_browser_rpa/scripts/service/adapter/mock.py @@ -0,0 +1,36 @@ +"""mock / unit 档位:不启动浏览器。""" + +from __future__ import annotations + +import time +from typing import List + +from service.adapter.base import BatchAdapterBase, BatchItem, BatchSubmitResult + + +class MockBatchAdapter(BatchAdapterBase): + name = "mock" + + def submit_batch(self, target: str, items: List[BatchItem]) -> BatchSubmitResult: + del target + if not items: + return BatchSubmitResult( + ok=False, + batch_id=None, + submitted_count=0, + submitted_amount=0.0, + error_msg="items 为空", + artifacts={"adapter": self.name}, + ) + + time.sleep(0.05) + total = sum(it.amount for it in items) + fake_batch_id = f"MOCK-{int(time.time())}" + return BatchSubmitResult( + ok=True, + batch_id=fake_batch_id, + submitted_count=len(items), + submitted_amount=total, + error_msg=None, + artifacts={"adapter": self.name}, + ) diff --git a/examples/simulator_browser_rpa/scripts/service/adapter/simulator_rpa.py b/examples/simulator_browser_rpa/scripts/service/adapter/simulator_rpa.py new file mode 100644 index 0000000..f343e89 --- /dev/null +++ b/examples/simulator_browser_rpa/scripts/service/adapter/simulator_rpa.py @@ -0,0 +1,340 @@ +"""仿真浏览器 RPA:操作 sandbox/demo_app.html 完成批量提交。""" + +from __future__ import annotations + +import logging +import os +import random +import re +import time +from typing import List, Optional + +from service.adapter.base import BatchAdapterBase, BatchItem, BatchSubmitResult +from service.browser_session import browser_session, find_chrome_executable +from util.constants import ( + DEFAULT_DEMO_CAPTCHA, + DEFAULT_DEMO_LOGIN_ID, + DEFAULT_DEMO_PASSWORD, + DEFAULT_DEMO_TOKEN_PIN, + DEFAULT_TIMEOUT_MS, + LOGIN_NAVIGATE_TIMEOUT_MS, + SUBMIT_NAVIGATE_TIMEOUT_MS, + resolve_simulator_base_url, +) + +logger = logging.getLogger(__name__) + +_PAUSE_MIN_MS = 500 +_PAUSE_MAX_MS = 2000 + + +class RpaError(Exception): + def __init__(self, message: str, screenshot_path: Optional[str] = None): + super().__init__(message) + self.screenshot_path = screenshot_path + + +class SimulatorBrowserRpaAdapter(BatchAdapterBase): + name = "simulator_browser_rpa" + + def __init__( + self, + base_url: Optional[str] = None, + headless: Optional[bool] = None, + artifacts_dir: Optional[str] = None, + ) -> None: + self.base_url = (base_url or resolve_simulator_base_url()).rstrip("/") + if headless is None: + env = os.environ.get("OPENCLAW_BROWSER_HEADLESS", "").strip().lower() + self.headless = env in ("1", "true", "yes") + else: + self.headless = headless + self.artifacts_dir = artifacts_dir + + self._login_id: str = DEFAULT_DEMO_LOGIN_ID + self._password: str = DEFAULT_DEMO_PASSWORD + self._token_pin: str = DEFAULT_DEMO_TOKEN_PIN + self._profile_dir: Optional[str] = None + + def set_credentials( + self, + login_id: str, + password: str, + token_pin: str, + profile_dir: str, + ) -> None: + self._login_id = login_id + self._password = password + self._token_pin = token_pin + stripped = (profile_dir or "").strip() + self._profile_dir = stripped or None + + def submit_batch(self, target: str, items: List[BatchItem]) -> BatchSubmitResult: + try: + from playwright.sync_api import sync_playwright # noqa: F401 + except ImportError: + return BatchSubmitResult( + ok=False, + batch_id=None, + submitted_count=0, + submitted_amount=0.0, + error_msg=( + "playwright Python 包不可用。" + "生产/宿主运行由共享 runtime 提供;技能侧不要 pip install playwright。" + ), + artifacts={"adapter": self.name}, + ) + + if not items: + return BatchSubmitResult( + ok=False, + batch_id=None, + submitted_count=0, + submitted_amount=0.0, + error_msg="items 为空", + artifacts={"adapter": self.name}, + ) + + if not find_chrome_executable(): + return BatchSubmitResult( + ok=False, + batch_id=None, + submitted_count=0, + submitted_amount=0.0, + error_msg="未检测到 Chrome 或 Edge 浏览器,请安装系统浏览器后重试。", + artifacts={"adapter": self.name}, + ) + + start_url = self.base_url + try: + with browser_session( + start_url, + profile_dir=self._profile_dir, + headless=self.headless, + ) as page: + try: + logger.info("rpa_login_start url=%s", start_url) + self._login(page) + logger.info("rpa_login_done") + + self._goto_batch_page(page) + logger.info("rpa_batch_page_ready") + + self._fill_batch_form(page, target, items) + logger.info("rpa_batch_form_filled rows=%s", len(items)) + + batch_id = self._submit_and_get_batch_id(page) + logger.info("rpa_submit_success batch_id=%s", batch_id) + + total = sum(it.amount for it in items) + return BatchSubmitResult( + ok=True, + batch_id=batch_id, + submitted_count=len(items), + submitted_amount=total, + error_msg=None, + artifacts={"adapter": self.name}, + ) + except RpaError as exc: + logger.error("rpa_failed: %s", exc) + arts = {"adapter": self.name} + if exc.screenshot_path: + arts["screenshot"] = exc.screenshot_path + return BatchSubmitResult( + ok=False, + batch_id=None, + submitted_count=0, + submitted_amount=0.0, + error_msg=str(exc), + artifacts=arts, + ) + except Exception as exc: + sp = self._safe_screenshot(page, "unexpected_error") + logger.exception("rpa_unexpected: %s", exc) + arts = {"adapter": self.name} + if sp: + arts["screenshot"] = sp + return BatchSubmitResult( + ok=False, + batch_id=None, + submitted_count=0, + submitted_amount=0.0, + error_msg=f"未预期异常:{type(exc).__name__}: {exc}", + artifacts=arts, + ) + except Exception as outer: + return BatchSubmitResult( + ok=False, + batch_id=None, + submitted_count=0, + submitted_amount=0.0, + error_msg=f"启动浏览器失败:{outer}", + artifacts={"adapter": self.name}, + ) + + def _pause(self, min_ms: int = _PAUSE_MIN_MS, max_ms: int = _PAUSE_MAX_MS) -> None: + time.sleep(random.uniform(min_ms, max_ms) / 1000.0) + + def _login(self, page) -> None: + try: + page.wait_for_selector('form[name="simLoginStep1"]', timeout=LOGIN_NAVIGATE_TIMEOUT_MS) + self._pause() + page.fill('form[name="simLoginStep1"] input[name="loginId"]', self._login_id) + self._pause() + page.click('form[name="simLoginStep1"] button[type="submit"]') + except Exception as exc: + sp = self._safe_screenshot(page, "login_step1_failed") + raise RpaError(f"登录第一步失败:{exc}", screenshot_path=sp) from exc + + try: + page.wait_for_selector('form[name="simLoginStep2"]', timeout=DEFAULT_TIMEOUT_MS) + self._pause() + page.fill('form[name="simLoginStep2"] input[name="password"]', self._password) + page.fill('form[name="simLoginStep2"] input[name="captcha"]', DEFAULT_DEMO_CAPTCHA) + self._pause() + page.click('form[name="simLoginStep2"] button[type="submit"]') + except Exception as exc: + sp = self._safe_screenshot(page, "login_step2_failed") + raise RpaError(f"登录第二步失败:{exc}", screenshot_path=sp) from exc + + try: + page.wait_for_selector('form[name="simBatchForm"]', timeout=LOGIN_NAVIGATE_TIMEOUT_MS) + except Exception as exc: + sp = self._safe_screenshot(page, "login_navigate_failed") + raise RpaError(f"登录后未进入批量提交页:{exc}", screenshot_path=sp) from exc + + def _goto_batch_page(self, page) -> None: + try: + page.wait_for_selector('form[name="simBatchForm"]', timeout=DEFAULT_TIMEOUT_MS) + self._pause() + except Exception as exc: + sp = self._safe_screenshot(page, "goto_batch_failed") + raise RpaError(f"进入批量提交页失败:{exc}", screenshot_path=sp) from exc + + def _select_target_account(self, page, target: str) -> None: + sel = page.locator('select[name="fromAccountNo"]') + sel.wait_for(timeout=DEFAULT_TIMEOUT_MS) + n = sel.locator("option").count() + matched_value: Optional[str] = None + first_value: Optional[str] = None + for i in range(n): + opt = sel.locator("option").nth(i) + val = opt.get_attribute("value") or "" + if not val.strip(): + continue + label_txt = opt.inner_text() + if first_value is None: + first_value = val + if target.strip() and target.strip() in label_txt: + matched_value = val + break + pick = matched_value or first_value + if not pick: + raise RpaError("来源账户下拉无可选项") + if not matched_value and target.strip(): + logger.warning("target '%s' 未匹配选项,回退 value=%s", target, pick) + sel.select_option(value=pick) + self._pause() + + def _fill_batch_form(self, page, target: str, items: List[BatchItem]) -> None: + try: + page.get_by_role("button", name=re.compile(r"页面填写")).click() + except Exception as exc: + sp = self._safe_screenshot(page, "tab_switch_failed") + raise RpaError(f"切换到页面填写失败:{exc}", screenshot_path=sp) from exc + + try: + self._select_target_account(page, target) + except RpaError: + raise + except Exception as exc: + sp = self._safe_screenshot(page, "select_account_failed") + raise RpaError(f"选择来源账户失败:{exc}", screenshot_path=sp) from exc + + try: + existing = page.locator("tr[data-row-index]").count() + need_more = max(0, len(items) - existing) + add_btn = page.get_by_role("button", name=re.compile(r"新增一行")) + for _ in range(need_more): + self._pause(400, 900) + add_btn.click() + except Exception as exc: + sp = self._safe_screenshot(page, "add_rows_failed") + raise RpaError(f"新增明细行失败:{exc}", screenshot_path=sp) from exc + + for it in items: + try: + row = page.locator(f'tr[data-row-index="{it.row_index}"]') + row.wait_for(timeout=DEFAULT_TIMEOUT_MS) + self._pause(300, 800) + row.locator('input[name="name"]').fill(it.name) + row.locator('input[name="account"]').fill(it.account) + row.locator('input[name="note"]').fill(it.note or "") + row.locator('input[name="amount"]').fill(f"{it.amount}") + except Exception as exc: + sp = self._safe_screenshot(page, f"fill_row_{it.row_index}_failed") + raise RpaError(f"填第 {it.row_index} 行失败:{exc}", screenshot_path=sp) from exc + + try: + page.fill('input[name="purpose"]', "仿真批量提交示例") + except Exception as exc: + logger.warning("填写用途失败(非致命):%s", exc) + + def _submit_and_get_batch_id(self, page) -> str: + try: + self._pause(800, 1500) + page.locator('form[name="simBatchForm"] button[type="submit"]').click() + except Exception as exc: + sp = self._safe_screenshot(page, "click_submit_failed") + raise RpaError(f"点击提交失败:{exc}", screenshot_path=sp) from exc + + dlg_sel = 'div[role="dialog"][aria-modal="true"]' + try: + page.wait_for_selector(dlg_sel, timeout=DEFAULT_TIMEOUT_MS) + except Exception as exc: + sp = self._safe_screenshot(page, "pin_dialog_not_open") + raise RpaError(f"PIN 弹窗未出现:{exc}", screenshot_path=sp) from exc + + try: + pin_input = page.locator(f'{dlg_sel} input[type="password"][inputmode="numeric"]') + self._pause(500, 1200) + pin_input.fill(self._token_pin) + except Exception as exc: + sp = self._safe_screenshot(page, "fill_pin_failed") + raise RpaError(f"填写 PIN 失败:{exc}", screenshot_path=sp) from exc + + try: + page.locator(dlg_sel).get_by_role("button", name=re.compile(r"确认提交")).click() + except Exception as exc: + sp = self._safe_screenshot(page, "click_confirm_failed") + raise RpaError(f"确认提交失败:{exc}", screenshot_path=sp) from exc + + try: + page.wait_for_selector('[data-testid="batch-id"]', timeout=SUBMIT_NAVIGATE_TIMEOUT_MS) + except Exception as exc: + sp = self._safe_screenshot(page, "success_area_not_visible") + raise RpaError(f"提交后未出现成功区域:{exc}", screenshot_path=sp) from exc + + batch_id = page.locator('[data-testid="batch-id"]').get_attribute("data-batch-id") or "" + if not batch_id: + batch_id = page.locator('[data-testid="batch-id"]').inner_text().strip() + url = page.url + if not batch_id and "#/batch/" in url: + batch_id = url.split("#/batch/", 1)[1].split("?")[0].split("#")[0].strip("/") + if not batch_id: + sp = self._safe_screenshot(page, "batch_id_empty") + raise RpaError(f"无法解析 batch_id,url={url}", screenshot_path=sp) + return batch_id + + def _safe_screenshot(self, page, tag: str) -> Optional[str]: + if not self.artifacts_dir: + return None + try: + os.makedirs(self.artifacts_dir, exist_ok=True) + path = os.path.join(self.artifacts_dir, f"{tag}_{int(time.time())}.png") + page.screenshot(path=path, full_page=True) + logger.info("screenshot_saved path=%s", path) + return path + except Exception as exc: + logger.warning("screenshot_failed tag=%s err=%s", tag, exc) + return None diff --git a/examples/simulator_browser_rpa/scripts/service/browser_session.py b/examples/simulator_browser_rpa/scripts/service/browser_session.py new file mode 100644 index 0000000..b951c3a --- /dev/null +++ b/examples/simulator_browser_rpa/scripts/service/browser_session.py @@ -0,0 +1,138 @@ +"""浏览器会话启动(系统 Chrome/Edge;URL 仅通过 page.goto 打开)。""" + +from __future__ import annotations + +import logging +import os +from contextlib import contextmanager +from typing import Any, Generator, Iterator, List, Optional, Tuple + +logger = logging.getLogger(__name__) + +DEFAULT_PAGE_TIMEOUT_MS = 15_000 +GOTO_TIMEOUT_MS = 60_000 + +CHROME_LAUNCH_ARGS: List[str] = [ + "--start-maximized", + "--disable-blink-features=AutomationControlled", +] + +STEALTH_INIT_SCRIPT = """ +(() => { + try { Object.defineProperty(navigator, 'webdriver', { get: () => undefined }); } catch (e) {} +})(); +""" + + +def chrome_launch_args() -> List[str]: + return list(CHROME_LAUNCH_ARGS) + + +def _headless_from_env() -> bool: + v = (os.getenv("OPENCLAW_BROWSER_HEADLESS") or "0").strip().lower() + return v in ("1", "true", "yes", "on") + + +def _find_chrome_executable() -> str | None: + try: + from jiangchang_skill_core.runtime_env import find_chrome_executable + + chrome = find_chrome_executable() + if chrome and os.path.isfile(chrome): + return chrome + except ImportError: + pass + + candidates = [ + os.path.expandvars(r"%ProgramFiles%\Google\Chrome\Application\chrome.exe"), + os.path.expandvars(r"%ProgramFiles(x86)%\Google\Chrome\Application\chrome.exe"), + os.path.expandvars(r"%ProgramFiles%\Microsoft\Edge\Application\msedge.exe"), + os.path.expandvars(r"%ProgramFiles(x86)%\Microsoft\Edge\Application\msedge.exe"), + ] + for path in candidates: + if path and os.path.isfile(path): + return path + return None + + +def _clear_node_options() -> None: + os.environ.pop("NODE_OPTIONS", None) + + +@contextmanager +def browser_session( + start_url: str, + *, + profile_dir: Optional[str] = None, + headless: Optional[bool] = None, +) -> Generator[Any, None, None]: + """ + 同步 Playwright 浏览器会话。 + + - Playwright Python 包由宿主共享 runtime 提供;技能侧不要 playwright install。 + - launch args 仅放 Chrome 参数,不含 URL。 + - 流程:launch → new_page → goto(start_url) + """ + from playwright.sync_api import sync_playwright + + _clear_node_options() + hl = headless if headless is not None else _headless_from_env() + chrome = _find_chrome_executable() + if not chrome: + raise RuntimeError( + "未检测到 Chrome 或 Edge 浏览器,请安装系统浏览器后重试。" + ) + + args = chrome_launch_args() + logger.info( + "browser_launch chrome=%s profile_dir=%s start_url=%s args=%s headless=%s", + chrome, + profile_dir or "", + start_url, + args, + hl, + ) + + browser_holder = None + context = None + with sync_playwright() as pw: + try: + if profile_dir: + context = pw.chromium.launch_persistent_context( + user_data_dir=profile_dir, + headless=hl, + executable_path=chrome, + locale="zh-CN", + no_viewport=True, + args=args, + ignore_default_args=["--enable-automation"], + ) + else: + browser_holder = pw.chromium.launch( + headless=hl, + executable_path=chrome, + args=args, + ignore_default_args=["--enable-automation"], + ) + context = browser_holder.new_context(no_viewport=True, locale="zh-CN") + + context.add_init_script(STEALTH_INIT_SCRIPT) + page = context.new_page() + page.set_default_timeout(DEFAULT_PAGE_TIMEOUT_MS) + page.goto(start_url, wait_until="domcontentloaded", timeout=GOTO_TIMEOUT_MS) + yield page + finally: + try: + if context is not None: + context.close() + except Exception as exc: + logger.warning("browser_context_close_failed: %s", exc) + if browser_holder is not None: + try: + browser_holder.close() + except Exception as exc: + logger.warning("browser_close_failed: %s", exc) + + +def find_chrome_executable() -> str | None: + return _find_chrome_executable() diff --git a/examples/simulator_browser_rpa/scripts/service/task_service.py b/examples/simulator_browser_rpa/scripts/service/task_service.py new file mode 100644 index 0000000..b122c59 --- /dev/null +++ b/examples/simulator_browser_rpa/scripts/service/task_service.py @@ -0,0 +1,104 @@ +"""轻量任务编排:校验输入 → 选 adapter → 提交批次。""" + +from __future__ import annotations + +import os +import tempfile +import uuid +from typing import Any, Dict, List, Optional + +from service.account_client import pick_simulator_account +from service.adapter import BatchItem, SimulatorBrowserRpaAdapter, select_adapter +from util.logging import get_logger + +logger = get_logger(__name__) + + +def _validate_items(items: List[Dict[str, Any]]) -> tuple[List[BatchItem], Optional[str]]: + if not items: + return [], "items 不能为空" + parsed: List[BatchItem] = [] + for idx, raw in enumerate(items, start=1): + name = str(raw.get("name") or "").strip() + account = str(raw.get("account") or "").strip() + note = str(raw.get("note") or "").strip() + try: + amount = float(raw.get("amount")) + except (TypeError, ValueError): + return [], f"第 {idx} 行 amount 无效" + if amount <= 0: + return [], f"第 {idx} 行 amount 必须大于 0" + if not name or not account: + return [], f"第 {idx} 行 name/account 不能为空" + parsed.append( + BatchItem( + row_index=int(raw.get("row_index") or idx), + name=name, + account=account, + amount=amount, + note=note, + ) + ) + return parsed, None + + +def run_batch_submit( + target: str, + items: List[Dict[str, Any]], + *, + force: bool = False, + artifacts_dir: Optional[str] = None, +) -> Dict[str, Any]: + """ + 最小编排示例。 + + 真实 skill 中还应:写 task_logs、entitlement、RpaVideoSession 等。 + """ + del force # 示例占位;真实 skill 可用于跳过确认 + + target_key = (target or "").strip() + if not target_key: + return {"success": False, "error": {"code": "INVALID_TARGET", "message": "target 不能为空"}} + + batch_items, err = _validate_items(items) + if err: + return {"success": False, "error": {"code": "INVALID_ITEMS", "message": err}} + + art_dir = artifacts_dir or os.path.join( + tempfile.gettempdir(), + "openclaw-simulator-rpa-artifacts", + uuid.uuid4().hex[:8], + ) + os.makedirs(art_dir, exist_ok=True) + logger.info("batch_submit_start target=%s item_count=%s artifacts_dir=%s", target_key, len(batch_items), art_dir) + + adapter = select_adapter(artifacts_dir=art_dir) + if isinstance(adapter, SimulatorBrowserRpaAdapter): + account = pick_simulator_account() + adapter.set_credentials( + account.login_id, + account.password, + account.token_pin, + account.profile_dir, + ) + + result = adapter.submit_batch(target_key, batch_items) + summary: Dict[str, Any] = { + "success": result.ok, + "target": target_key, + "adapter": result.artifacts.get("adapter") or adapter.name, + "submitted_count": result.submitted_count, + "submitted_amount": result.submitted_amount, + "batch_id": result.batch_id, + "artifacts": result.artifacts, + "artifacts_dir": art_dir, + } + if not result.ok: + summary["error"] = {"code": "BATCH_SUBMIT_FAILED", "message": result.error_msg or "提交失败"} + logger.info( + "batch_submit_done success=%s batch_id=%s adapter=%s", + result.ok, + result.batch_id, + adapter.name, + ) + return summary diff --git a/examples/simulator_browser_rpa/scripts/util/.gitkeep b/examples/simulator_browser_rpa/scripts/util/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/examples/simulator_browser_rpa/scripts/util/constants.py b/examples/simulator_browser_rpa/scripts/util/constants.py new file mode 100644 index 0000000..8f3aa67 --- /dev/null +++ b/examples/simulator_browser_rpa/scripts/util/constants.py @@ -0,0 +1,34 @@ +"""仿真浏览器 RPA 示例常量。""" + +from __future__ import annotations + +import os +from pathlib import Path + +SKILL_SLUG = "example-simulator-browser-rpa" +LOG_LOGGER_NAME = "openclaw.skill.example_simulator_browser_rpa" + +DEFAULT_TIMEOUT_MS = 15_000 +LOGIN_NAVIGATE_TIMEOUT_MS = 30_000 +SUBMIT_NAVIGATE_TIMEOUT_MS = 60_000 + +DEFAULT_DEMO_LOGIN_ID = "demo001" +DEFAULT_DEMO_PASSWORD = "demo-password" +DEFAULT_DEMO_CAPTCHA = "0000" +DEFAULT_DEMO_TOKEN_PIN = "123456" + +ENV_SIMULATOR_BASE_URL = "SIMULATOR_BASE_URL" +ENV_SIMULATOR_LOGIN_ID = "SIMULATOR_LOGIN_ID" +ENV_SIMULATOR_PASSWORD = "SIMULATOR_PASSWORD" +ENV_SIMULATOR_TOKEN_PIN = "SIMULATOR_TOKEN_PIN" +ENV_SIMULATOR_PROFILE_DIR = "SIMULATOR_PROFILE_DIR" + +_EXAMPLE_ROOT = Path(__file__).resolve().parents[2] +DEFAULT_DEMO_APP_PATH = _EXAMPLE_ROOT / "sandbox" / "demo_app.html" + + +def resolve_simulator_base_url() -> str: + env = (os.getenv(ENV_SIMULATOR_BASE_URL) or "").strip() + if env: + return env.rstrip("/") + return DEFAULT_DEMO_APP_PATH.as_uri() diff --git a/examples/simulator_browser_rpa/scripts/util/logging.py b/examples/simulator_browser_rpa/scripts/util/logging.py new file mode 100644 index 0000000..492292d --- /dev/null +++ b/examples/simulator_browser_rpa/scripts/util/logging.py @@ -0,0 +1,15 @@ +"""示例日志工具。""" + +from __future__ import annotations + +import logging + +from util.constants import LOG_LOGGER_NAME + + +def get_logger(name: str | None = None) -> logging.Logger: + return logging.getLogger(name or LOG_LOGGER_NAME) + + +def configure_logging(level: int = logging.INFO) -> None: + logging.basicConfig(level=level, format="%(levelname)s %(name)s %(message)s") diff --git a/examples/simulator_browser_rpa/tests/.gitkeep b/examples/simulator_browser_rpa/tests/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/examples/simulator_browser_rpa/tests/conftest.py b/examples/simulator_browser_rpa/tests/conftest.py new file mode 100644 index 0000000..0ba6eb8 --- /dev/null +++ b/examples/simulator_browser_rpa/tests/conftest.py @@ -0,0 +1,10 @@ +"""pytest 路径:将 examples/simulator_browser_rpa/scripts 加入 import 路径。""" + +from __future__ import annotations + +import sys +from pathlib import Path + +SCRIPTS = Path(__file__).resolve().parents[1] / "scripts" +if str(SCRIPTS) not in sys.path: + sys.path.insert(0, str(SCRIPTS)) diff --git a/examples/simulator_browser_rpa/tests/test_adapter_dispatch.py b/examples/simulator_browser_rpa/tests/test_adapter_dispatch.py new file mode 100644 index 0000000..decd00d --- /dev/null +++ b/examples/simulator_browser_rpa/tests/test_adapter_dispatch.py @@ -0,0 +1,64 @@ +# -*- coding: utf-8 -*- +"""adapter 工厂 dispatch 单元测试。""" +from __future__ import annotations + +import os +import unittest +from unittest.mock import patch + +from service.adapter import ( + BatchItem, + MockBatchAdapter, + SimulatorBrowserRpaAdapter, + select_adapter, +) + + +class TestAdapterDispatch(unittest.TestCase): + def test_default_returns_simulator_rpa(self) -> None: + with patch.dict(os.environ, {}, clear=False): + os.environ.pop("OPENCLAW_TEST_TARGET", None) + adapter = select_adapter() + self.assertIsInstance(adapter, SimulatorBrowserRpaAdapter) + + def test_unit_returns_mock(self) -> None: + with patch.dict(os.environ, {"OPENCLAW_TEST_TARGET": "unit"}): + self.assertIsInstance(select_adapter(), MockBatchAdapter) + + def test_mock_returns_mock(self) -> None: + with patch.dict(os.environ, {"OPENCLAW_TEST_TARGET": "mock"}): + self.assertIsInstance(select_adapter(), MockBatchAdapter) + + def test_simulator_rpa_returns_simulator(self) -> None: + with patch.dict(os.environ, {"OPENCLAW_TEST_TARGET": "simulator_rpa"}): + self.assertIsInstance(select_adapter(), SimulatorBrowserRpaAdapter) + + def test_real_rpa_falls_back_to_mock(self) -> None: + with patch.dict(os.environ, {"OPENCLAW_TEST_TARGET": "real_rpa"}): + self.assertIsInstance(select_adapter(), MockBatchAdapter) + + def test_unknown_target_falls_back_simulator_rpa(self) -> None: + with patch.dict(os.environ, {"OPENCLAW_TEST_TARGET": "simulator_api"}): + self.assertIsInstance(select_adapter(), SimulatorBrowserRpaAdapter) + + +class TestMockAdapter(unittest.TestCase): + def test_mock_success(self) -> None: + items = [ + BatchItem(row_index=1, name="Alice", account="1001", amount=10.5), + BatchItem(row_index=2, name="Bob", account="1002", amount=20.0), + ] + result = MockBatchAdapter().submit_batch("acct-demo-001", items) + self.assertTrue(result.ok) + self.assertEqual(result.submitted_count, 2) + self.assertEqual(result.submitted_amount, 30.5) + self.assertTrue((result.batch_id or "").startswith("MOCK-")) + + def test_mock_empty_items(self) -> None: + result = MockBatchAdapter().submit_batch("acct-demo-001", []) + self.assertFalse(result.ok) + self.assertEqual(result.error_msg, "items 为空") + + +if __name__ == "__main__": + unittest.main() diff --git a/examples/simulator_browser_rpa/tests/test_simulator_rpa_unit.py b/examples/simulator_browser_rpa/tests/test_simulator_rpa_unit.py new file mode 100644 index 0000000..05f5921 --- /dev/null +++ b/examples/simulator_browser_rpa/tests/test_simulator_rpa_unit.py @@ -0,0 +1,76 @@ +# -*- coding: utf-8 -*- +"""SimulatorBrowserRpaAdapter 单元测试(不启动真实浏览器)。""" +from __future__ import annotations + +import unittest +from unittest.mock import MagicMock, patch + +from service.adapter import BatchItem, SimulatorBrowserRpaAdapter +from service.browser_session import CHROME_LAUNCH_ARGS + + +class TestSimulatorRpaUnit(unittest.TestCase): + def test_set_credentials_and_empty_profile_dir(self) -> None: + adapter = SimulatorBrowserRpaAdapter() + adapter.set_credentials("demo001", "pwd", "pin", " ") + self.assertEqual(adapter._login_id, "demo001") + self.assertIsNone(adapter._profile_dir) + + def test_submit_batch_empty_items(self) -> None: + adapter = SimulatorBrowserRpaAdapter() + result = adapter.submit_batch("acct-demo-001", []) + self.assertFalse(result.ok) + self.assertIn("items", result.error_msg or "") + + @patch("service.adapter.simulator_rpa.find_chrome_executable", return_value=None) + def test_no_chrome_returns_error_without_launch(self, _chrome: MagicMock) -> None: + adapter = SimulatorBrowserRpaAdapter() + items = [BatchItem(row_index=1, name="A", account="1", amount=1.0)] + result = adapter.submit_batch("acct-demo-001", items) + self.assertFalse(result.ok) + msg = result.error_msg or "" + self.assertTrue("Chrome" in msg or "Edge" in msg or "浏览器" in msg) + + def test_chrome_launch_args_must_not_contain_url(self) -> None: + for arg in CHROME_LAUNCH_ARGS: + lowered = arg.lower() + self.assertFalse(lowered.startswith("http://")) + self.assertFalse(lowered.startswith("https://")) + self.assertFalse(lowered.startswith("file://")) + + @patch("service.adapter.simulator_rpa.browser_session") + @patch("service.adapter.simulator_rpa.find_chrome_executable", return_value="C:/Chrome/chrome.exe") + def test_start_url_opened_via_goto_not_launch_args( + self, + _chrome: MagicMock, + mock_session: MagicMock, + ) -> None: + from service.adapter.simulator_rpa import RpaError + + adapter = SimulatorBrowserRpaAdapter(base_url="file:///demo/demo_app.html") + items = [BatchItem(row_index=1, name="A", account="1", amount=1.0)] + + page = MagicMock() + mock_cm = MagicMock() + mock_cm.__enter__.return_value = page + mock_cm.__exit__.return_value = False + mock_session.return_value = mock_cm + + with patch.object(adapter, "_login", side_effect=RpaError("login fail")): + result = adapter.submit_batch("acct-demo-001", items) + + self.assertFalse(result.ok) + mock_session.assert_called_once() + called_start_url = mock_session.call_args[0][0] + self.assertEqual(called_start_url, "file:///demo/demo_app.html") + for arg in CHROME_LAUNCH_ARGS: + self.assertNotIn(arg, called_start_url) + + def test_safe_screenshot_without_artifacts_dir(self) -> None: + adapter = SimulatorBrowserRpaAdapter(artifacts_dir=None) + page = MagicMock() + self.assertIsNone(adapter._safe_screenshot(page, "tag")) + + +if __name__ == "__main__": + unittest.main() diff --git a/examples/simulator_browser_rpa/tests/test_stop_reason.py b/examples/simulator_browser_rpa/tests/test_stop_reason.py new file mode 100644 index 0000000..1b061b1 --- /dev/null +++ b/examples/simulator_browser_rpa/tests/test_stop_reason.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +"""RPA 失败结果与 artifacts 单元测试。""" +from __future__ import annotations + +import unittest +from unittest.mock import MagicMock, patch + +from service.adapter import BatchItem, SimulatorBrowserRpaAdapter +from service.adapter.simulator_rpa import RpaError + + +class TestBatchSubmitFailureResult(unittest.TestCase): + @patch("service.adapter.simulator_rpa.find_chrome_executable", return_value="C:/Chrome/chrome.exe") + @patch("service.adapter.simulator_rpa.browser_session") + def test_rpa_error_converts_to_failed_result(self, mock_session: MagicMock, _chrome: MagicMock) -> None: + page = MagicMock() + mock_cm = MagicMock() + mock_cm.__enter__.return_value = page + mock_cm.__exit__.return_value = False + mock_session.return_value = mock_cm + + adapter = SimulatorBrowserRpaAdapter(artifacts_dir="/tmp/art") + items = [BatchItem(row_index=1, name="A", account="1", amount=1.0)] + + with patch.object(adapter, "_login", side_effect=RpaError("登录第一步失败:timeout", screenshot_path="/tmp/art/x.png")): + result = adapter.submit_batch("acct-demo-001", items) + + self.assertFalse(result.ok) + self.assertIn("登录第一步失败", result.error_msg or "") + self.assertEqual(result.artifacts.get("adapter"), "simulator_browser_rpa") + self.assertEqual(result.artifacts.get("screenshot"), "/tmp/art/x.png") + + @patch("service.adapter.simulator_rpa.find_chrome_executable", return_value="C:/Chrome/chrome.exe") + @patch("service.adapter.simulator_rpa.browser_session") + def test_unexpected_error_includes_adapter_name(self, mock_session: MagicMock, _chrome: MagicMock) -> None: + page = MagicMock() + mock_cm = MagicMock() + mock_cm.__enter__.return_value = page + mock_cm.__exit__.return_value = False + mock_session.return_value = mock_cm + + adapter = SimulatorBrowserRpaAdapter(artifacts_dir=None) + items = [BatchItem(row_index=1, name="A", account="1", amount=1.0)] + + with patch.object(adapter, "_login", side_effect=RuntimeError("boom")): + result = adapter.submit_batch("acct-demo-001", items) + + self.assertFalse(result.ok) + self.assertIn("未预期异常", result.error_msg or "") + self.assertEqual(result.artifacts.get("adapter"), "simulator_browser_rpa") + self.assertNotIn("screenshot", result.artifacts) + + +if __name__ == "__main__": + unittest.main()