Initial commit: TaskPool React panel

- React frontend with route-level code splitting - Backend rebranded from Baihu to TaskPool - DB brand migration script and local compatibility
2026-07-26 08:43:52 +08:00
commit e6956aa001
397 changed files with 73621 additions and 0 deletions
@@ -0,0 +1,58 @@
+const taskpool = require('taskpool');
+
+/**
+ * 内建工具环境变量管理测试示例 (Node.js)
+ * 
+ * 使用说明：
+ * 1. 确保已在该 Node.js 环境下安装过内建包。
+ * 2. 运行时系统需要注入有效的 OpenAPI 凭证 (BHPKG_OPENAPI_TOKEN 或 OPENAPI_TOKEN)。
+ */
+
+async function main() {
+    console.log("====== 开始运行 Node.js 环境变量管理示例 ======");
+
+    try {
+        // 获取全部环境变量
+        const envs = await taskpool.getEnvs();
+        console.log(`当前共有 ${envs.length} 个环境变量`);
+
+        // 新增一个临时环境变量
+        const newEnvName = "BHPKG_TEST_KEY_JS";
+        const newEnvVal = "HelloTaskPoolJS";
+        console.log(`正在创建环境变量: ${newEnvName}...`);
+        const createdEnv = await taskpool.addEnv(
+            newEnvName,
+            newEnvVal,
+            "Node.js SDK 测试自动创建"
+        );
+        console.log(`创建成功: ID=${createdEnv.id}, Name=${createdEnv.name}`);
+
+        // 查询该环境变量
+        const checkedEnv = await taskpool.getEnv(newEnvName);
+        if (checkedEnv) {
+            console.log(`成功查询到变量: ${checkedEnv.name} = ${checkedEnv.value}`);
+
+            // 修改该环境变量的值
+            const updatedVal = "HelloTaskPoolJS_Updated";
+            console.log(`正在修改环境变量的值为: ${updatedVal}...`);
+            const updatedEnv = await taskpool.updateEnv(
+                checkedEnv.id,
+                newEnvName,
+                updatedVal,
+                "Node.js SDK 测试自动更新"
+            );
+            console.log(`更新成功: Value=${updatedEnv.value}`);
+
+            // 删除该临时环境变量
+            console.log(`正在删除临时环境变量: ID=${checkedEnv.id}...`);
+            await taskpool.deleteEnv(checkedEnv.id);
+            console.log("删除成功！");
+        }
+
+    } catch (e) {
+        console.error(`环境变量操作失败: ${e.message}`);
+        console.log("提示: 请确保在面板任务设置中正确注入了 OpenAPI Token。");
+    }
+}
+
+main();
@@ -0,0 +1,55 @@
+import taskpool
+
+# 内建工具环境变量管理测试示例 (Python)
+# 
+# 前提条件：
+# 1. 已经在环境中安装了 taskpool 包（例如通过 `taskpool builtininstall`）
+# 2. 环境中已注入有效环境变量：
+#    - BHPKG_OPENAPI_TOKEN (必填，用于管理接口鉴权)
+
+def main():
+    print("====== 开始运行 Python 环境变量管理示例 ======")
+
+    try:
+        # 获取全部环境变量
+        envs = taskpool.get_envs()
+        print(f"当前共有 {len(envs)} 个环境变量")
+        
+        # 新增一个临时环境变量
+        new_env_name = "BHPKG_TEST_KEY"
+        new_env_val = "HelloTaskPool"
+        print(f"正在创建环境变量: {new_env_name}...")
+        created_env = taskpool.add_env(
+            name=new_env_name,
+            value=new_env_val,
+            remark="Python SDK 测试自动创建"
+        )
+        print(f"创建成功: ID={created_env.get('id')}, Name={created_env.get('name')}")
+
+        # 查询刚才创建的环境变量详情
+        checked_env = taskpool.get_env(new_env_name)
+        if checked_env:
+            print(f"成功查询到变量: {checked_env.get('name')} = {checked_env.get('value')}")
+
+            # 修改该环境变量的值
+            updated_val = "HelloTaskPool_Updated"
+            print(f"正在修改环境变量的值为: {updated_val}...")
+            updated_env = taskpool.update_env(
+                id=checked_env.get("id"),
+                name=new_env_name,
+                value=updated_val,
+                remark="Python SDK 测试自动更新"
+            )
+            print(f"更新成功: Value={updated_env.get('value')}")
+
+            # 删除该临时环境变量
+            print(f"正在删除临时环境变量: ID={checked_env.get('id')}...")
+            taskpool.delete_env(checked_env.get("id"))
+            print("删除成功！")
+            
+    except Exception as e:
+        print(f"环境变量操作失败: {e}")
+        print("提示: 请确保在面板任务设置中正确注入了 OpenAPI Token。")
+
+if __name__ == "__main__":
+    main()
@@ -0,0 +1,26 @@
+const taskpool = require('taskpool');
+
+/**
+ * 内建通知测试示例 (Node.js)
+ * 
+ * 使用说明：
+ * 1. 确保已在该 Node.js 环境下安装过内建包。
+ * 2. 系统会自动注入 BHPKG_NOTIFY_TOKEN 和 BHPKG_NOTIFY_CHANNEL。
+ */
+
+console.log("正在尝试发送 Node.js 内建通知...");
+
+try {
+    // 简单的一行代码即可完成推送
+    taskpool.notify(
+        "Node.js 任务提醒", 
+        "这是一条来自 Node.js 示例脚本的通知消息。无需配置 API 地址或 Token。"
+    );
+    
+    console.log("发送请求已提交。");
+    console.log("提示：内建包采用异步非阻塞发送，不会干扰主逻辑执行。");
+    
+} catch (e) {
+    console.error(`通知失败: ${e.message}`);
+    console.error("请检查环境变量是否注入，或是否已运行过 'taskpool builtininstall'。");
+}
@@ -0,0 +1,30 @@
+import taskpool
+
+# 内建通知测试示例 (Python)
+# 
+# 前提条件：
+# 1. 已经在环境中安装了 taskpool 包（例如通过 `taskpool builtininstall`）
+# 2. 环境中已注入有效环境变量：
+#    - BHPKG_NOTIFY_TOKEN
+#    - BHPKG_NOTIFY_CHANNEL
+
+def main():
+    print("正在尝试发送 Python 内建通知...")
+    try:
+        # 调用内建 notify 函数
+        # 内部会自动使用 BHPKG_NOTIFY_TOKEN & BHPKG_NOTIFY_CHANNEL 进行鉴权和投递
+        response = taskpool.notify(
+            title="Python 任务提醒",
+            text="这是一条来自 Python 示例脚本的通知消息。调用非常简单！"
+        )
+        print("发送请求已处理。")
+        if response:
+            print(f"服务器响应: {response}")
+            
+    except ImportError as e:
+        print(f"错误: 库未正确加载。请确保已执行过环境初始化。详情: {e}")
+    except Exception as e:
+        print(f"发送过程发生异常: {e}")
+
+if __name__ == "__main__":
+    main()
@@ -0,0 +1,40 @@
+const taskpool = require('taskpool');
+
+/**
+ * 内建工具任务管理测试示例 (Node.js)
+ * 
+ * 使用说明：
+ * 1. 确保已在该 Node.js 环境下安装过内建包。
+ * 2. 运行时系统需要注入有效的 OpenAPI 凭证 (BHPKG_OPENAPI_TOKEN 或 OPENAPI_TOKEN)。
+ */
+
+async function main() {
+    console.log("====== 开始运行 Node.js 任务管理与执行控制示例 ======");
+
+    try {
+        // 获取所有任务列表
+        const tasks = await taskpool.getTasks();
+        console.log(`成功获取到 ${tasks.length} 个定时任务:`);
+        tasks.slice(0, 5).forEach(task => { // 仅展示前5项
+            console.log(`  - [${task.id}] ${task.name} (表达式: ${task.schedule || ''}, 备注: ${task.remark || ''})`);
+        });
+
+        // 尝试触发第一个任务的运行
+        if (tasks.length > 0) {
+            const targetTask = tasks[0];
+            console.log(`\n尝试手动触发任务运行: [${targetTask.id}] ${targetTask.name}...`);
+            await taskpool.executeTask(targetTask.id);
+            console.log("执行指令发送成功。");
+        }
+
+        // 获取最近的执行结果列表
+        const results = await taskpool.getLastResults();
+        console.log(`\n最近共有 ${results.length} 条任务执行记录。`);
+
+    } catch (e) {
+        console.error(`任务操作失败: ${e.message}`);
+        console.log("提示: 请确保在面板任务设置中正确注入了 OpenAPI Token。");
+    }
+}
+
+main();
@@ -0,0 +1,36 @@
+import taskpool
+
+# 内建工具任务管理与执行控制测试示例 (Python)
+# 
+# 前提条件：
+# 1. 已经在环境中安装了 taskpool 包（例如通过 `taskpool builtininstall`）
+# 2. 环境中已注入有效环境变量：
+#    - BHPKG_OPENAPI_TOKEN (必填，用于管理接口鉴权)
+
+def main():
+    print("====== 开始运行 Python 任务管理与执行控制示例 ======")
+
+    try:
+        # 获取所有任务列表
+        tasks = taskpool.get_tasks()
+        print(f"成功获取到 {len(tasks)} 个定时任务:")
+        for task in tasks[:5]:  # 仅打印前5个
+            print(f"  - [{task.get('id')}] {task.get('name')} (表达式: {task.get('schedule')}, 备注: {task.get('remark')})")
+
+        # 示例：尝试触发第一个任务的运行
+        if tasks:
+            target_task = tasks[0]
+            print(f"\n尝试手动触发任务运行: [{target_task.get('id')}] {target_task.get('name')}...")
+            result = taskpool.execute_task(target_task.get("id"))
+            print("执行指令发送成功。")
+
+        # 获取最近的执行结果列表
+        results = taskpool.get_last_results()
+        print(f"\n最近共有 {len(results)} 条任务执行记录。")
+            
+    except Exception as e:
+        print(f"任务操作失败: {e}")
+        print("提示: 请确保在面板任务设置中正确注入了 OpenAPI Token。")
+
+if __name__ == "__main__":
+    main()
@@ -0,0 +1,43 @@
+#!/bin/bash
+
+# ==============================================================================
+# PHP 环境构建依赖安装脚本
+# ==============================================================================
+# 说明：
+# 如果你需要使用 PHP 环境，由于 mise 安装某些 PHP 版本时需要从源码编译，
+# 建议在面板的“任务训练”中创建一个“开机任务”，并关联此脚本，
+# 以确保容器重启后依然具备编译 PHP 所需的系统依赖。
+# ==============================================================================
+
+set -e
+
+echo "正在检测 PHP 编译依赖..."
+
+# Debian 系统依赖包列表
+PACKAGES="autoconf bison build-essential libssl-dev libxml2-dev pkg-config libsqlite3-dev zlib1g-dev libcurl4-openssl-dev libpng-dev libjpeg-dev libonig-dev libzip-dev"
+CHECK_CMD="dpkg -l"
+INSTALL_CMD="apt-get install -y"
+UPDATE_CMD="apt-get update"
+
+MISSING_PACKAGES=""
+for pkg in $PACKAGES; do
+    if ! $CHECK_CMD "$pkg" >/dev/null 2>&1; then
+        MISSING_PACKAGES="$MISSING_PACKAGES $pkg"
+    fi
+done
+
+if [ -z "$MISSING_PACKAGES" ]; then
+    echo "所有依赖已就绪，跳过安装。"
+    exit 0
+fi
+
+echo "检测到缺失依赖: $MISSING_PACKAGES"
+
+# 执行安装
+if [ -n "$UPDATE_CMD" ]; then
+    $UPDATE_CMD
+fi
+
+$INSTALL_CMD $MISSING_PACKAGES
+
+echo "PHP 编译依赖安装完成！"
@@ -0,0 +1,32 @@
+
+
+/*
+下面是测试实例
+*/
+
+const puppeteer = require('puppeteer-core');
+
+(async () => {
+  // 连接 Browserless（注意 token）
+  const browser = await puppeteer.connect({
+    browserWSEndpoint: 'ws://localhost:3000?token=your-secret-token'
+  });
+
+  const page = await browser.newPage();
+
+  // 访问百度
+  await page.goto('https://www.baidu.com', {
+    waitUntil: 'networkidle2',
+    timeout: 30000
+  });
+
+  // 截图
+  await page.screenshot({
+    path: 'baidu.png',
+    fullPage: true
+  });
+
+  console.log('✅ 截图完成：baidu.png');
+
+  await browser.close();
+})();
@@ -0,0 +1,25 @@
+"""
+Python 示例：通过 Playwright 连接 Browserless，并抓取页面截图。
+运行前请先在 TaskPool 的“语言依赖”中为 Python 安装 playwright 包。
+如果使用 Browserless，请不要执行 `playwright install`。
+"""
+
+from playwright.sync_api import sync_playwright
+
+
+def main() -> None:
+    with sync_playwright() as p:
+        browser = p.chromium.connect_over_cdp(
+            "http://browser:3000?token=your-secret-token"
+        )
+
+        page = browser.new_page()
+        page.goto("https://www.baidu.com", wait_until="networkidle", timeout=30000)
+        page.screenshot(path="baidu.png", full_page=True)
+
+        print("截图已保存为 baidu.png")
+        browser.close()
+
+
+if __name__ == "__main__":
+    main()
@@ -0,0 +1,170 @@
+# Playwright 示例
+
+这组示例用于演示如何在 TaskPool 中通过远程 Browserless / Chromium 服务执行浏览器自动化，并完成一次最小可用的页面截图。
+
+当前目录包含两个脚本：
+
+```text
+example/
+└── playwright/
+    ├── playwright.js
+    ├── playwright.py
+    └── readme.md
+```
+
+- `playwright.js`：Node.js 示例，使用 `puppeteer-core` 连接 Browserless
+- `playwright.py`：Python 示例，使用 `playwright` 连接 Browserless
+
+其中 Python 方案是最主流、也最接近 Puppeteer 使用体验的一种。
+同时建议在 TaskPool 中为 Python 示例安装并使用 Python `3.11` 版本，因为过高版本的 Python 可能会出现依赖安装失败。
+
+## 先安装语言依赖
+
+运行脚本前，请先到 TaskPool 的“语言依赖”页面安装对应的包，否则任务会因为缺少模块而失败。
+
+- 运行 `playwright.js` 前，请在 Node.js 语言依赖中安装：`puppeteer-core`
+- 运行 `playwright.py` 前，请在 Python 语言依赖中安装：`playwright`
+- Python 运行环境建议选择：`3.11`，避免因为版本过高导致依赖安装失败
+
+安装完成后，再创建任务执行对应脚本。
+
+如果你当前是通过 Browserless 连接远程浏览器：
+
+- 不要执行 `playwright install`
+- 不需要额外下载 Chromium / Firefox / WebKit
+- 直接使用 `connect_over_cdp` 连接远程浏览器即可
+
+## 适用场景
+
+- 验证 TaskPool 到 Browserless 的网络连通性
+- 验证远程浏览器地址和 Token 是否配置正确
+- 快速测试浏览器自动化脚本是否能正常运行
+
+## 推荐部署方式
+
+建议配合 `browserless/chromium` 一起使用，再由 TaskPool 中的脚本连接远程浏览器服务。
+
+参考 `docker-compose.yml`：
+
+```yaml
+version: "3.8"
+
+services:
+  browser:
+    image: ghcr.io/browserless/chromium:latest
+    container_name: browser
+    restart: unless-stopped
+    environment:
+      MAX_CONCURRENT_SESSIONS: 5
+      MAX_QUEUE_LENGTH: 20
+      CONNECTION_TIMEOUT: 300000
+      DEFAULT_LAUNCH_ARGS: '["--no-sandbox","--disable-setuid-sandbox","--disable-dev-shm-usage"]'
+      TOKEN: your-secret-token
+      ENABLE_DEBUGGER: "false"
+    shm_size: "1gb"
+    mem_limit: 2g
+    cpus: 2
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:3000/healthz"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+
+  taskpool:
+    image: ghcr.io/engigu/taskpool:latest
+    container_name: taskpool
+    restart: unless-stopped
+    ports:
+      - "8052:8052"
+    volumes:
+      - ./data:/app/data
+      - ./envs:/app/envs
+    environment:
+      - TZ=Asia/Shanghai
+      - BH_SERVER_PORT=8052
+      - BH_SERVER_HOST=0.0.0.0
+      - BH_DB_TYPE=sqlite
+      - BH_DB_PATH=/app/data/taskpool.db
+      - BH_DB_TABLE_PREFIX=taskpool_
+    logging:
+      driver: json-file
+      options:
+        max-size: "10m"
+        max-file: "3"
+    depends_on:
+      - browser
+```
+
+## 使用步骤
+
+1. 启动 `browser` 和 `taskpool` 服务。
+2. 在 TaskPool 的“语言依赖”中安装对应包。
+3. 按实际环境修改脚本中的 Browserless 地址和 Token。
+4. 在 TaskPool 中创建任务并运行对应脚本。
+
+Python 示例的核心写法如下：
+
+```python
+from playwright.sync_api import sync_playwright
+
+with sync_playwright() as p:
+    browser = p.chromium.connect_over_cdp(
+        "http://browser:3000?token=your-secret-token"
+    )
+    page = browser.new_page()
+    page.goto("https://www.baidu.com")
+    page.screenshot(path="baidu.png")
+    browser.close()
+```
+
+## 运行前检查
+
+- Browserless 服务已经正常启动
+- TaskPool 可以访问 Browserless 地址
+- `TOKEN` 与 Browserless 配置保持一致
+- 脚本中的地址、端口和协议填写正确
+
+## 常见问题
+
+### 1. 报错提示找不到模块
+
+通常是还没有在“语言依赖”中安装对应包：
+
+- Node.js 示例需要 `puppeteer-core`
+- Python 示例需要 `playwright`
+
+### 2. 为什么没有执行 `playwright install`
+
+这是预期行为。
+
+如果你使用的是 Browserless 这类远程浏览器服务，Playwright 只是作为客户端发起连接，不需要在任务池容器里再下载本地浏览器，所以通常不要执行 `playwright install`。
+
+### 3. 连接不上 Browserless
+
+请优先检查：
+
+- Browserless 服务是否正常启动
+- Token 是否正确
+- TaskPool 与 Browserless 是否在同一网络中
+- 地址是否写成了当前运行环境可访问的地址
+
+### 4. 页面打开超时
+
+可以尝试：
+
+- 换一个更稳定的目标站点
+- 调大超时时间
+- 增加 Browserless 容器的 `shm_size`
+- 检查容器 CPU / 内存是否不足
+
+### 5. 没有看到截图文件
+
+请确认：
+
+- 脚本已经执行成功
+- 截图保存路径是否正确
+- 任务工作目录是否符合预期
+
+## 说明
+
+这组示例主要用于快速验证 TaskPool 与远程浏览器服务之间的连通性，以及对应语言环境是否已经配置完成。