visualregressiontracker/api

Visual Regression Tracker 后端应用

镜像概述

本镜像为Visual Regression Tracker的后端应用，是视觉回归测试跟踪工具的核心服务组件。基于Node.js和PostgreSQL构建，提供数据存储、API接口服务及业务逻辑处理，支持前端视觉回归测试工具的功能实现。

核心功能与特性

• 数据管理：通过Prisma ORM与PostgreSQL数据库交互，处理测试结果、用户信息、测试用例等数据的存储与查询
• API服务：提供RESTful API接口，支持前后端数据交互，包括测试任务创建、视觉差异结果记录、用户操作等核心业务流程
• 测试集成：支持与前端视觉测试工具集成，处理测试流程中的后端逻辑，如测试结果比对、历史数据追踪等
• 可配置化：通过环境变量灵活配置数据库连接、服务端口、日志级别等关键参数，适应不同部署环境需求

使用场景与适用范围

适用于需要实施视觉回归测试的开发团队，作为Visual Regression Tracker工具链的后端支撑组件，可集成到自动化测试流程中，支持持续集成/持续部署(CI/CD)环境下的视觉差异跟踪与管理。

使用方法与配置说明

环境准备

• 安装Docker及Docker Compose
• 确保网络环境允许访问PostgreSQL服务端口(默认5432)

Docker Compose部署示例

yaml
version: '3'
services:
  postgres:
    image: postgres:14
    environment:
      POSTGRES_USER: vrt_user
      POSTGRES_PASSWORD: vrt_password
      POSTGRES_DB: visual_regression_tracker
    ports:
      - "5432:5432"
    volumes:
      - postgres_data:/var/lib/postgresql/data
    restart: unless-stopped

  backend:
    build: .
    depends_on:
      - postgres
    environment:
      - NODE_ENV=production
      - DATABASE_URL="postgresql://vrt_user:vrt_password@postgres:5432/visual_regression_tracker"
      # 根据需求添加其他环境变量（如服务端口PORT等）
    ports:
      - "3000:3000"
    volumes:
      - ./secrets:/app/secrets  # 用于HTTPS证书挂载（本地开发环境）
    restart: unless-stopped

volumes:
  postgres_data:

本地开发环境配置

基础设置步骤

1. 安装Node.js 18 (LTS)版本
2. 克隆代码仓库：git clone https://github.com/Visual-Regression-Tracker/Visual-Regression-Tracker.git
3. 进入后端目录：cd Visual-Regression-Tracker/backend
4. 配置环境变量：
   • 更新根目录下的.env文件（服务配置）
   • 更新prisma/.env文件（数据库连接配置）
5. 启动PostgreSQL服务：在单独终端执行docker compose up
6. 安装依赖：npm i
7. 数据库初始化：
   • 创建数据库结构：npx prisma db push
   • 应用数据库迁移：npx prisma migrate deploy
   • 播种初始数据：npx prisma db seed
8. 启动服务：
   • 开发调试模式：npm run start:debug
   • 运行单元测试：npm run test
   • 运行端到端测试：npm run test:e2e

本地HTTPS配置

1. 生成自签名SSL证书（可通过自签名证书生成工具在线生成）
2. 创建/secrets目录（如不存在）
3. 将生成的证书文件重命名为：
   • 证书文件：ssl.cert
   • 私钥文件：ssl.key
4. 将上述两个文件放置于/secrets目录下

注意事项

• 生产环境部署时需使用正式SSL证书，避免使用自签名证书
• 数据库连接字符串需与PostgreSQL服务的用户名、密码、数据库名配置保持一致
• 依赖服务（PostgreSQL）需在后端服务启动前完成初始化，建议通过depends_on配置确保启动顺序