真实联调必须让平台能主动推到本机,所以需要隧道;这两个脚本把「配置切换」和
「联调前该验的东西」自动化,避免手工漏配(尤其 certLink 漏改、占位密钥没换):
- `douyin-mashida:set-public-url`:把 certLink/afterVerifyLink 切成隧道地址,
打印平台侧要配的三项(message_url / topics / 卡券链接),并自检隧道:
用错误签名打公网地址,期望 401 —— 证明「隧道 → Caddy → 后端 → 验签」通了,
不需要密钥、也不产生真实订单
- `douyin-mashida:preflight`:四步自检
① 配置就绪度(含识别早期联调留下的占位密钥,它会让 hasSecret=true 骗过你)
② 真实网关连通性:平台是先校 uid 再校签名,带 --secret 时若平台报的不是
签名错误即证明签名/密钥正确(正式推送前就能排掉密钥问题)
③ 公网回调可达性 ④ certLink 与公网域名是否一致
- 平台文档只给了 code=10000 表示成功,无完整错误码表,故脚本不翻译码值、
只原样打印,并对实测观测到的码(如 10014)加说明
同时修掉 vite dev server 的一个潜在坑:`VITE_ALLOWED_HOSTS` 早已在 .env 与
compose 中配置,但 vite.config.ts 的白名单是硬编码的、从未读取该变量,
换隧道域名必然被 Vite 拦(Blocked request);现已真正接上并默认放行
常见隧道域名后缀。
order-site-backend
快手轻量后端:订单入库、履约任务编排、91 卡券 / kuaishou-cloud / kuaishou-feifei / 行业电子凭证对接、后台管理接口,以及数据库迁移。
快速启动
npm install
cp ../../.env.mac-docker.example ../../.env
npm run dev
推荐优先用仓库根目录 Docker 开发环境(含 PostgreSQL 与 Caddy)。
生产构建:
npm run build
npm run start
常用验证:
npm run typecheck
npm run build
npm test
配置
环境变量来自工作区根目录 .env:
- 默认值:
src/config/defaults.ts - 覆盖:根目录
.env
常用项:
| 变量 | 说明 |
|---|---|
PORT |
服务端口(Compose 中常由 BACKEND_PORT 映射) |
LOG_LEVEL |
debug / info / warn / error |
LOG_MAX_FILE_SIZE_MB |
单个应用日志文件大小上限,默认 20 MB,超出后轮转 |
LOG_MAX_FILES |
同一日期最多保留的日志文件数量,默认 5(含当前文件) |
LOG_RETENTION_DAYS |
日志日期保留天数,默认 30 |
DATABASE_URL |
PostgreSQL 连接串 |
ADMIN_SESSION_SECRET |
后台登录态签名密钥 |
ADMIN_DEFAULT_USERS_JSON |
默认后台用户 |
KAQUAN91_USER_ID / KAQUAN91_SECRET |
91 卡券凭据 |
接口
| 路径 | 说明 |
|---|---|
GET /health |
健康检查 |
GET /health/live |
存活 |
GET /health/ready |
就绪 |
/api/v1/open/91/* |
91 卡券开放接口 |
/api/v1/open/kuaishou-industry/* |
快手行业电子凭证 |
/api/v1/open/kuaishou-feifei/* |
发货平台 feifei 回调等 |
/api/v1/claim/* |
领取页接口 |
/api/v1/admin/* |
后台管理 |
/s/* |
短链跳转 |
目录
| 路径 | 职责 |
|---|---|
src/index.ts |
服务入口 |
src/app.ts |
Express 组装 |
src/routes |
API 路由 |
src/services/order |
订单与任务同步 |
src/services/fulfillment |
履约路由与执行器 |
src/services/platforms |
外部平台实现 |
src/services/admin |
后台读写与配置 |
src/repositories |
数据库访问 |
src/db/migrations |
SQL 迁移 |
数据库迁移
策略:001 基线 + 后续渐进增量。
| 文件 | 作用 |
|---|---|
src/db/migrations/001_init.sql |
空库完整基线结构 |
src/db/migrations/002_*.sql 起 |
增量变更 |
规则:
- 已应用的迁移文件禁止改内容。
- 结构变更只新增文件,不回写
001_init.sql。 - 启动时自动执行未应用迁移;记录在
schema_migrations。 - 文件名必须为
NNN_name.sql(三位序号)。
命令:
# 对齐状态
npm run db:migrate:status
# 手动 up
npm run db:migrate
# 创建下一份增量(生成 00N_xxx.sql 模板)
npm run db:migrate:create -- add_something
创建后编辑 SQL,与业务代码一并提交。Docker 开发环境示例:
docker compose -f ../../docker-compose.dev.yml exec -T backend npm run db:migrate:create -- add_something
docker compose -f ../../docker-compose.dev.yml exec -T backend npm run db:migrate
Docker 开发
开发 Compose 会挂载源码:
postgres提供开发库- 后端启动时安装依赖并
npm run dev - 改
src/或.env通常不必重建镜像
需要重建 backend 镜像的情况:
deploy/docker/backend*.Dockerfile变更- Node 版本或系统依赖变更
package.json/package-lock.json变更
运行产物
日志默认:
data/logs/app-YYYY-MM-DD.logdata/logs/integration-YYYY-MM-DD.log
按天切分并按大小轮转,默认单文件 20MB、单日最多 5 个分片、保留 30 天。成功的 GET/HEAD 请求以 DEBUG 记录,生产默认 LOG_LEVEL=info 不落盘;写请求和所有 4xx/5xx 仍保留 access log。成功的 /health* 探活默认不写 access log。
data/*.json 为本地运行配置,可能含敏感信息,默认不提交;请从 *.example.json 复制后填写。