SuperAPI AI 工具集

supaguard

测试与质量

查看项目

更新于 10-26 17:17

技能介绍

Supaguard 是一个合成监控平台,提供 CLI 工具用于从源代码创建、测试和部署监控检查。该技能激活后,可帮助用户完成从源码分析到部署监控的完整流程。

用途:当用户需要设置合成监控、运行时间监控、健康检查或生产环境可观测性时,该技能读取代码库,生成 Playwright 监控脚本,并通过 supaguard CLI 部署为周期性检查。适用于监控登录流程、结账流程或关键用户旅程。

主要能力:

  • 源码分析:扫描组件、路由、data-testid、API 端点和表单,识别关键流程(认证、核心产品流程、结账、用户设置)。
  • 脚本生成:基于 Playwright 生成监控脚本,使用稳定的选择器(data-testid、aria-label、role、id),避免依赖 CSS 类。
  • 本地测试:脚本写入 /tmp/sg-check-{random}.ts,通过 supaguard checks test 命令测试,失败时迭代调整(最多 3 次)。
  • 部署:支持定时(cron)或按需检查,可多区域部署(US East、EU North、India Central),频率可选 5/10/15/30 分钟或每小时。
  • 告警:部署后可配置告警。

使用方式:

  • 前置检查:运行 which supaguard 确认 CLI 安装(缺失时提示 npm install -g supaguard),运行 supaguard whoami --json 确认登录状态。
  • 工作流:读取源码 → 识别关键流程 → 获取生产 URL → 生成脚本到 /tmp → 测试 → 交互式询问检查名称、调度、区域、频率 → 部署 → 显示成功横幅和仪表板链接。
  • 部署命令示例:supaguard checks create /tmp/sg-check-{random}.ts --name "Check Name" --locations eastus,northeurope --cron "*/5 * * * *" --skip-test --json。按需检查使用远期 cron 后立即暂停。

适用场景:为 Web 应用设置合成监控;生成 Playwright 监控脚本(非 CI/CD 测试);监控登录、结账等关键用户旅程;管理监控检查和告警。不适用于编写 CI/CD 的 Playwright 测试、一般测试/QA 工作流或构建自定义可观测性平台。

限制与约束:

  • 脚本必须写入 /tmp,禁止写入项目目录或提交到 git。
  • 脚本必须包含 import { test, expect } from "@playwright/test" 和至少一个 test() 块。
  • 禁止导入 Node.js 内置模块(child_process、fs、net、http、https、vm 等),禁止使用 eval()、Function()、process.exit 等。
  • 脚本总超时 60 秒,单测试超时 30 秒。
  • 必须使用 --json 标志解析输出。
  • 禁止使用 React Testing Library API,应使用 Playwright 的 page.getBy*() 方法。
  • 需处理 cookie 同意横幅。
  • 部署前需交互式询问用户配置,不自动部署。
  • 首次激活时检查伴生技能安装情况。