admin/craftlabs-authorization-sdk
1
0
Fork 0
mirror of https://github.com/hpd840321/craftlabs-authorization-sdk.git synced 2026-06-09 10:00:30 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(i6): solidify I5_I6 design markdown; add Dependabot and ci-security (Trivy, npm audit)

Browse Source 
Made-with: Cursor
This commit is contained in:
huangping
2026-04-06 22:48:58 +08:00
parent 499fef3c2f
commit ce49fe143c
7 changed files with 118 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/dependabot.yml
+24
View File
@@ -0,0 +1,24 @@
version: 2
updates:
- package-ecosystem: maven
directory: "/services"
schedule:
interval: weekly
open-pull-requests-limit: 5
- package-ecosystem: maven
directory: "/java"
schedule:
interval: weekly
open-pull-requests-limit: 5
- package-ecosystem: npm
directory: "/web/delivery-platform-ui"
schedule:
interval: weekly
open-pull-requests-limit: 5
- package-ecosystem: github-actions
directory: "/"
schedule:
interval: monthly
.github/workflows/ci-java.yml
+2 -2
View File
@@ -2,9 +2,9 @@ name: ci-java
on: on:
push: push:
branches: [main, master] branches: [main, master, develop]
pull_request: pull_request:
branches: [main, master] branches: [main, master, develop]
jobs: jobs:
maven: maven:
.github/workflows/ci-platform.yml
+2 -2
View File
@@ -2,14 +2,14 @@ name: ci-platform
on: on:
push: push:
branches: [main, master] branches: [main, master, develop]
paths: paths:
- "services/**" - "services/**"
- "web/**" - "web/**"
- "contracts/**" - "contracts/**"
- ".github/workflows/ci-platform.yml" - ".github/workflows/ci-platform.yml"
pull_request: pull_request:
branches: [main, master] branches: [main, master, develop]
paths: paths:
- "services/**" - "services/**"
- "web/**" - "web/**"
.github/workflows/ci-security.yml
+53
View File
@@ -0,0 +1,53 @@
name: ci-security
on:
push:
branches: [main, master, develop]
pull_request:
branches: [main, master, develop]
workflow_dispatch:
jobs:
trivy-maven-modules:
name: Trivy (Java / Maven manifests)
runs-on: ubuntu-latest
permissions:
contents: read
strategy:
fail-fast: false
matrix:
include:
- scan-ref: services
- scan-ref: java
steps:
- uses: actions/checkout@v4
- name: Run Trivy filesystem scan
uses: aquasecurity/trivy-action@0.28.0
with:
scan-type: fs
scan-ref: ${{ matrix.scan-ref }}
scanners: vuln
vuln-type: os,library
severity: CRITICAL,HIGH
exit-code: "1"
ignore-unfixed: true
npm-audit-ui:
name: npm audit (delivery-platform-ui)
runs-on: ubuntu-latest
permissions:
contents: read
defaults:
run:
working-directory: web/delivery-platform-ui
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: "20"
cache: npm
cache-dependency-path: web/delivery-platform-ui/package-lock.json
- name: Install and audit
run: |
npm ci
npm audit --audit-level=high
docs/engineering/iterations/I5_I6_DESIGN.md
+27 -55
View File
@@ -2,14 +2,13 @@
> **仓库**：`craftlabs-authorization-sdk`（分支 `develop`）。 > **仓库**：`craftlabs-authorization-sdk`（分支 `develop`）。
> **角色**：解决方案架构设计稿；**不**在本任务中落地代码。 > **角色**：解决方案架构设计稿；**不**在本任务中落地代码。
> **实现锚点**（与现有模式一致）：`delivery-platform-api` 使用 Flyway `V5__…` 起（当前末版为 `V4__delivery_batch_and_license_sn.sql`）、`AuditService` + `AuditEntityTypes` / `AuditActions`、`ApiExceptionHandler`、公开业务 API 经 `SecurityConfig` + `JwtAuthenticationFilter`（`Authorization: Bearer`）；OpenAPI SSOT 为 `[contracts/openapi/delivery-platform-api.json](../../../contracts/openapi/delivery-platform-api.json)` 与 `OpenApiContractSnapshotTest`。 > **实现锚点**（与现有模式一致）：`delivery-platform-api` 使用 Flyway `V5__…` 起（当前末版为 `V4__delivery_batch_and_license_sn.sql`）、`AuditService` + `AuditEntityTypes` / `AuditActions`、`ApiExceptionHandler`、公开业务 API 经 `SecurityConfig` + `JwtAuthenticationFilter`（`Authorization: Bearer`）；OpenAPI SSOT 为 [`contracts/openapi/delivery-platform-api.json`](../../../contracts/openapi/delivery-platform-api.json) 与 `OpenApiContractSnapshotTest`。
> **Webhook 工程名**：本工作区已实现为 `license-webhook-ingress`（`[services/README.md](../../../services/README.md)`：`webhook_callback_receipt`、`Idempotency-Key`）。 > **Webhook 工程名**：本工作区已实现为 `license-webhook-ingress`（[`services/README.md`](../../../services/README.md)：`webhook_callback_receipt`、`Idempotency-Key`）。
--- ---
## 0. 上游文档走查（按路径引用，不全文摘录） ## 0. 上游文档走查（按路径引用，不全文摘录）
| 文档 | 与本设计的关系（摘要） | | 文档 | 与本设计的关系（摘要） |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [docs/engineering/PARALLEL_ITERATION_INDEX.md](../PARALLEL_ITERATION_INDEX.md) | 定义三轨并行；**I5** 为 **Callback + Schema** 硬耦合周；**I6** 为 **UAT** 与 SDK 冻结；同步点含 **I5 起**：Callback payload / inbox DTO、**Idempotency-Key**、Webhook→平台投递方式；**I6**：UAT 场景、`VITE_API_BASE`、两枚 Fat JAR 与 SDK 版本。 | | [docs/engineering/PARALLEL_ITERATION_INDEX.md](../PARALLEL_ITERATION_INDEX.md) | 定义三轨并行；**I5** 为 **Callback + Schema** 硬耦合周；**I6** 为 **UAT** 与 SDK 冻结；同步点含 **I5 起**：Callback payload / inbox DTO、**Idempotency-Key**、Webhook→平台投递方式；**I6**：UAT 场景、`VITE_API_BASE`、两枚 Fat JAR 与 SDK 版本。 |
@@ -19,29 +18,25 @@
| [docs/chuangfei-platform-product-modules.md](../../chuangfei-platform-product-modules.md) §6–7 | **M5 P0**：收件箱列表/详情/处理状态/关联失败兜底/事件类型字典（M5-F01～F05 等）；**M6 P0**：产品线（M6-F01）、环境维度与 `bitanswer.url`（M6-F02）；P1 如比特 ID 映射、JSON 模板、发布记录等 **I5 MVP 可裁减**。 | | [docs/chuangfei-platform-product-modules.md](../../chuangfei-platform-product-modules.md) §6–7 | **M5 P0**：收件箱列表/详情/处理状态/关联失败兜底/事件类型字典（M5-F01～F05 等）；**M6 P0**：产品线（M6-F01）、环境维度与 `bitanswer.url`（M6-F02）；P1 如比特 ID 映射、JSON 模板、发布记录等 **I5 MVP 可裁减**。 |
| [docs/chuangfei-platform-bpm-and-roadmap.md](../../chuangfei-platform-bpm-and-roadmap.md) | **BP-06**：Webhook 验签 → 落库 → 解析关联 → Ops 处置；重复投递幂等。**BP-10**：M6 与 Schema、客户端配置发布链路；**依赖**本仓 `schemas/craftlabs-auth-config.schema.json`。 | | [docs/chuangfei-platform-bpm-and-roadmap.md](../../chuangfei-platform-bpm-and-roadmap.md) | **BP-06**：Webhook 验签 → 落库 → 解析关联 → Ops 处置；重复投递幂等。**BP-10**：M6 与 Schema、客户端配置发布链路；**依赖**本仓 `schemas/craftlabs-auth-config.schema.json`。 |
--- ---
## Part A — I5：本单体工作区内的 MVP 切片 ## Part A — I5：本单体工作区内的 MVP 切片
### A.1 问题与目标结果 ### A.1 问题与目标结果
| 维度 | 说明 | | 维度 | 说明 |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **业务问题** | 比特规则 **HTTPS Callback** 需 **不断链、可审计、可运营处置**；平台侧需统一收件箱，避免只在 Webhook 边缘落库不可见。 | | **业务问题** | 比特规则 **HTTPS Callback** 需 **不断链、可审计、可运营处置**；平台侧需统一收件箱，避免只在 Webhook 边缘落库不可见。 |
| **I5 目标结果（E2E）** | **模拟或真实 Callback** 经 `license-webhook-ingress` →（持久化收据后）**投递** → `delivery-platform-api` **Inbox 表出现一行**；运营账号用 JWT 在 UI **列表可见、详情可打开**。 | | **I5 目标结果（E2E）** | **模拟或真实 Callback** 经 `license-webhook-ingress` →（持久化收据后）**投递** → `delivery-platform-api` **Inbox 表出现一行**；运营账号用 JWT 在 UI **列表可见、详情可打开**。 |
| **幂等** | 与轨道 A 一致：`**Idempotency-Key`**（HTTP 头）+ 比特稳定 `**message_id**`（或等价字段）；DB **唯一约束 `(source_system, external_message_id)`**；重复请求 **不重复插入**、返回与首次一致的接受语义（HTTP 200 + 相同 `inboxId` 或约定 DTO）。 | | **幂等** | 与轨道 A 一致：**`Idempotency-Key`**（HTTP 头）+ 比特稳定 **`message_id`**（或等价字段）；DB **唯一约束 `(source_system, external_message_id)`**；重复请求 **不重复插入**、返回与首次一致的接受语义（HTTP 200 + 相同 `inboxId` 或约定 DTO）。 |
| **schemaVersion** | 事件体或头携带 `**schemaVersion`**（与轨道 A 的 `X-Event-Schema-Version` 二选一或并存，**须写 ADR 定一种主口径**）；平台拒绝无法识别的 major 版本时返回 **4xx** 并记录可观测字段，避免静默损坏。 | | **schemaVersion** | 事件体或头携带 **`schemaVersion`**（与轨道 A 的 `X-Event-Schema-Version` 二选一或并存，**须写 ADR 定一种主口径**）；平台拒绝无法识别的 major 版本时返回 **4xx** 并记录可观测字段，避免静默损坏。 |
### A.2 数据模型（`delivery-platform-api`，PostgreSQL + Flyway） ### A.2 数据模型（`delivery-platform-api`，PostgreSQL + Flyway）
命名与现有表一致采用 `**platform_*` 前缀**（见 `V1`～`V4` 迁移）。 命名与现有表一致采用 **`platform_*` 前缀**（见 `V1`～`V4` 迁移）。
#### A.2.1 `platform_callback_inbox`（M5 Inbox P0） #### A.2.1 `platform_callback_inbox`（M5 Inbox P0）
| 列（示例） | 类型/说明 | | 列（示例） | 类型/说明 |
| ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- | | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- |
| `id` | UUID / BIGSERIAL PK | | `id` | UUID / BIGSERIAL PK |
@@ -50,7 +45,7 @@
| **唯一约束** | `UNIQUE (source_system, external_message_id)` | | **唯一约束** | `UNIQUE (source_system, external_message_id)` |
| `schema_version` | VARCHAR，与 payload 解析版本对齐 | | `schema_version` | VARCHAR，与 payload 解析版本对齐 |
| `event_type` | VARCHAR，与 M5-F05 字典一致（如 `sn:pre_activate`） | | `event_type` | VARCHAR，与 M5-F05 字典一致（如 `sn:pre_activate`） |
| `status` | ENUM/VARCHAR：`**PENDING` / `PROCESSED` / `FAILED` / `IGNORED`**（对应产品「待处理、已处理、失败、忽略」） | | `status` | ENUM/VARCHAR：**`PENDING` / `PROCESSED` / `FAILED` / `IGNORED`**（对应产品「待处理、已处理、失败、忽略」） |
| `raw_payload` | **JSONB**（或 TEXT + 大小上限）；UI **脱敏展示** | | `raw_payload` | **JSONB**（或 TEXT + 大小上限）；UI **脱敏展示** |
| `idempotency_key` | VARCHAR NULL，审计与排障 | | `idempotency_key` | VARCHAR NULL，审计与排障 |
| **关联（均可 NULL，支撑 M5-F04）** | `license_sn_id` → `platform_license_sn`；`contract_id` / `project_id`（若已有表）；解析字段如 `sn_code`、`mid` 等冗余列便于列表筛选 | | **关联（均可 NULL，支撑 M5-F04）** | `license_sn_id` → `platform_license_sn`；`contract_id` / `project_id`（若已有表）；解析字段如 `sn_code`、`mid` 等冗余列便于列表筛选 |
@@ -58,60 +53,51 @@
| `received_at` | 平台收件时间 | | `received_at` | 平台收件时间 |
| `processed_at` / `processed_by_user_id` | 运营处置 | | `processed_at` / `processed_by_user_id` | 运营处置 |
| `failure_reason` / `operator_note` | 文本，P1 可扩展「失败原因分类」字典 | | `failure_reason` / `operator_note` | 文本，P1 可扩展「失败原因分类」字典 |
| 标准审计 | 与现有实体一致可补充 `created_at`/`updated_at`；关键状态迁移建议走 `**AuditService`**（扩展 `AuditEntityTypes` / `AuditActions`） | | 标准审计 | 与现有实体一致可补充 `created_at`/`updated_at`；关键状态迁移建议走 **`AuditService`**（扩展 `AuditEntityTypes` / `AuditActions`） |
#### A.2.2 M6 最小只读支撑表 #### A.2.2 M6 最小只读支撑表
仅包含 **I5 UI 与 Inbox 筛选** 所需字段；**不做** M6-F03～F06 全量。 仅包含 **I5 UI 与 Inbox 筛选** 所需字段；**不做** M6-F03～F06 全量。
| 表 | P0 字段（示例） |
| 表 | P0 字段（示例） | | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | **`platform_product_line`** | `id`、`code`（唯一）、`name`、`description` NULL、启用标志 |
| `**platform_product_line`** | `id`、`code`（唯一）、`name`、`description` NULL、启用标志 | | **`platform_integration_environment`** | `id`、`code`（唯一）、`name`、`bitanswer_base_url`（对应 M6-F02）、`kind`（DEV/TEST/STAGING/PROD 等枚举）、可选 `product_line_id` 或后续多对多（MVP 可 **单列 FK** 简化） |
| `**platform_integration_environment**` | `id`、`code`（唯一）、`name`、`bitanswer_base_url`（对应 M6-F02）、`kind`（DEV/TEST/STAGING/PROD 等枚举）、可选 `product_line_id` 或后续多对多（MVP 可 **单列 FK** 简化） |
**MVP 裁减**：比特产品/模版/业务 ID 映射（M6-F03）、特征映射（M6-F04）、JSON 模板与发布记录（M6-F05/F06）**推迟**至 V1.1 或 Mid，除非比特联调硬依赖。 **MVP 裁减**：比特产品/模版/业务 ID 映射（M6-F03）、特征映射（M6-F04）、JSON 模板与发布记录（M6-F05/F06）**推迟**至 V1.1 或 Mid，除非比特联调硬依赖。
### A.3 公开 REST API（JWT，`/api/v1`） ### A.3 公开 REST API（JWT，`/api/v1`）
与现有 Controller 风格一致；**RBAC**：与当前演示一致 `**SYS_ADMIN` / `DEVELOPER`** 均可访问 MVP 接口（与 `[AuthController](../../../services/delivery-platform-api/src/main/java/cn/craftlabs/platform/api/auth/AuthController.java)` 对齐），**I7+** 再收紧为 Ops 专用权限码。 与现有 Controller 风格一致；**RBAC**：与当前演示一致 **`SYS_ADMIN` / `DEVELOPER`** 均可访问 MVP 接口（与 [`AuthController`](../../../services/delivery-platform-api/src/main/java/cn/craftlabs/platform/api/auth/AuthController.java) 对齐），**I7+** 再收紧为 Ops 专用权限码。
| 方法 | 路径 | 说明 | | 方法 | 路径 | 说明 |
| ------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | | ------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `GET` | `/api/v1/callback-inbox` | 分页；查询建议：`status`、`eventType`、`snCode`、`projectId`、`productLineId`、`environmentId`、`from`/`to`（`receivedAt`）、`page`、`size` | | `GET` | `/api/v1/callback-inbox` | 分页；查询建议：`status`、`eventType`、`snCode`、`projectId`、`productLineId`、`environmentId`、`from`/`to`（`receivedAt`）、`page`、`size` |
| `GET` | `/api/v1/callback-inbox/{id}` | 详情；含 `rawPayload`（或单独 `GET .../payload` 若需权限分级） | | `GET` | `/api/v1/callback-inbox/{id}` | 详情；含 `rawPayload`（或单独 `GET .../payload` 若需权限分级） |
| `PATCH` | `/api/v1/callback-inbox/{id}/status` | 运营状态迁移：`**PENDING` → `PROCESSED` / `FAILED` / `IGNORED`**；非法迁移 **409** + 业务错误码（与合同/交付模式一致，经 `**ApiExceptionHandler`**） | | `PATCH` | `/api/v1/callback-inbox/{id}/status` | 运营状态迁移：**`PENDING` → `PROCESSED` / `FAILED` / `IGNORED`**；非法迁移 **409** + 业务错误码（与合同/交付模式一致，经 **`ApiExceptionHandler`**） |
| `PATCH` | `/api/v1/callback-inbox/{id}/link`（可选） | 人工挂接：`licenseSnId` / `projectId` / `contractId` 等，支撑 M5-F04 | | `PATCH` | `/api/v1/callback-inbox/{id}/link`（可选） | 人工挂接：`licenseSnId` / `projectId` / `contractId` 等，支撑 M5-F04 |
**可选**：`POST /api/v1/callback-inbox/simulate`（**仅非生产**，对应 M5-F10 P2 — **I5 若排期紧可不做**，改用 curl → Webhook → 平台链）。 **可选**：`POST /api/v1/callback-inbox/simulate`（**仅非生产**，对应 M5-F10 P2 — **I5 若排期紧可不做**，改用 curl → Webhook → 平台链）。
**M6 只读** **M6 只读**
| 方法 | 路径 | 说明 | | 方法 | 路径 | 说明 |
| ----- | ---------------------------------------------------------------- | ------ | | ----- | ---------------------------------------------------------------- | ------ |
| `GET` | `/api/v1/integration/environments` | 列表/分页 | | `GET` | `/api/v1/integration/environments` | 列表/分页 |
| `GET` | `/api/v1/integration/product-lines` | 列表/分页 | | `GET` | `/api/v1/integration/product-lines` | 列表/分页 |
| `GET` | `/api/v1/integration/environments/{id}`、`.../product-lines/{id}` | 详情（按需） | | `GET` | `/api/v1/integration/environments/{id}`、`.../product-lines/{id}` | 详情（按需） |
写接口（维护环境/产品线）MVP 可 **仅种子数据 + Flyway** 或 **管理员 POST**（若 I5 周可交付则加 `POST/PUT`，否则 **推迟**）。 写接口（维护环境/产品线）MVP 可 **仅种子数据 + Flyway** 或 **管理员 POST**（若 I5 周可交付则加 `POST/PUT`，否则 **推迟**）。
### A.4 内部 API（平台服务间，`license-webhook-ingress` → `delivery-platform-api`） ### A.4 内部 API（平台服务间，`license-webhook-ingress` → `delivery-platform-api`）
| 项 | 说明 | | 项 | 说明 |
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **路径** | `POST /internal/v1/callback-events` | | **路径** | `POST /internal/v1/callback-events` |
| **认证（MVP 推荐）** | 共享密钥：`**X-Platform-Internal-Token`**（或 `Authorization: Bearer <internal>`），配置与 `PLATFORM_JWT_SECRET` 分离；**生产建议路线图**：mTLS 或双向签名（文档中注明 **I6 Runbook：轮换步骤**）。 | | **认证（MVP 推荐）** | 共享密钥：**`X-Platform-Internal-Token`**（或 `Authorization: Bearer <internal>`），配置与 `PLATFORM_JWT_SECRET` 分离；**生产建议路线图**：mTLS 或双向签名（文档中注明 **I6 Runbook：轮换步骤**）。 |
| **幂等** | 请求头 `**Idempotency-Key`** + 体 `**sourceSystem` + `externalMessageId**` 与 Inbox 唯一键一致；重复 POST → **200** 且 body 指向同一 `inboxId`。 | | **幂等** | 请求头 **`Idempotency-Key`** + 体 **`sourceSystem` + `externalMessageId`** 与 Inbox 唯一键一致；重复 POST → **200** 且 body 指向同一 `inboxId`。 |
| **行为** | 校验 `schemaVersion` → 插入或跳过（幂等）→ 尝试解析并 **填充关联列**（失败则 `status=PENDING` 保留人工挂接）。 | | **行为** | 校验 `schemaVersion` → 插入或跳过（幂等）→ 尝试解析并 **填充关联列**（失败则 `status=PENDING` 保留人工挂接）。 |
**请求 / 响应 JSON 示例（示意）** **请求 / 响应 JSON 示例（示意）**
```http ```http
@@ -142,44 +128,38 @@ Content-Type: application/json
### A.5 `license-webhook-ingress` 链路 ### A.5 `license-webhook-ingress` 链路
| 步骤 | 说明 | | 步骤 | 说明 |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------- | | ---------------- | ------------------------------------------------------------------------------------------------------------------------- |
| 1 | **验签 / token**（现有 `x-bitanswer-token` 与 `CRAFTLABS_WEBHOOK_EXPECTED_TOKEN`） | | 1 | **验签 / token**（现有 `x-bitanswer-token` 与 `CRAFTLABS_WEBHOOK_EXPECTED_TOKEN`） |
| 2 | **持久化收据**（现有 `**webhook_callback_receipt`** + `**Idempotency-Key**` 幂等） | | 2 | **持久化收据**（现有 **`webhook_callback_receipt`** + **`Idempotency-Key`** 幂等） |
| 3 | **HTTP 转发** 至平台 `POST /internal/v1/callback-events`：**带重试**（指数退避、最大次数、超时）；贯通 `**traceparent` / `X-Request-Id`**（轨道 A §3） | | 3 | **HTTP 转发** 至平台 `POST /internal/v1/callback-events`：**带重试**（指数退避、最大次数、超时）；贯通 **`traceparent` / `X-Request-Id`**（轨道 A §3） |
| **对比特的 HTTP 响应** | 与轨道 A 一致：**2xx 须在收据已持久化（或可靠入队）之后**再返回。**MVP 推荐**：先落库收据即对比特 **2xx**，平台投递 **异步重试**；若 **同步** 转发，须 **短超时** 且平台幂等，避免比特侧超时重放放大。 | | **对比特的 HTTP 响应** | 与轨道 A 一致：**2xx 须在收据已持久化（或可靠入队）之后**再返回。**MVP 推荐**：先落库收据即对比特 **2xx**，平台投递 **异步重试**；若 **同步** 转发，须 **短超时** 且平台幂等，避免比特侧超时重放放大。 |
| **平台非 2xx** | Webhook 侧重试；仍失败则记 **DLQ/失败计数**（日志 + DB 字段，**M5-F08 完整监控可推迟**）；**不**因平台暂时不可用而对已持久化收据重复向比特报错（若已 2xx）。 | | **平台非 2xx** | Webhook 侧重试；仍失败则记 **DLQ/失败计数**（日志 + DB 字段，**M5-F08 完整监控可推迟**）；**不**因平台暂时不可用而对已持久化收据重复向比特报错（若已 2xx）。 |
### A.6 OpenAPI 与 springdoc ### A.6 OpenAPI 与 springdoc
| 项 | 说明 | | 项 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **SSOT** | 更新 `[contracts/openapi/delivery-platform-api.json](../../../contracts/openapi/delivery-platform-api.json)`：仅 **公开** `/api/v1/callback-inbox*`、`/api/v1/integration/*` 路径、`components/schemas`、错误码与 `security`（Bearer JWT）。 | | **SSOT** | 更新 [`contracts/openapi/delivery-platform-api.json`](../../../contracts/openapi/delivery-platform-api.json)：仅 **公开** `/api/v1/callback-inbox*`、`/api/v1/integration/*` 路径、`components/schemas`、错误码与 `security`（Bearer JWT）。 |
| **内部路由** | `**/internal/`** 建议排除在默认 springdoc 分组之外**，或打上 tag `**internal`** 且 **生产禁用**该分组（与「对外契约」分离，避免集成方误用）。 | | **内部路由** | **`/internal/**` 建议排除在默认 springdoc 分组之外**，或打上 tag **`internal`** 且 **生产禁用**该分组（与「对外契约」分离，避免集成方误用）。 |
| **校验** | `UPDATE_OPENAPI=1 mvn test -Dtest=OpenApiContractSnapshotTest`（见 `[contracts/README.md](../../../contracts/README.md)`）。 | | **校验** | `UPDATE_OPENAPI=1 mvn test -Dtest=OpenApiContractSnapshotTest`（见 [`contracts/README.md`](../../../contracts/README.md)）。 |
### A.7 前端（`web/delivery-platform-ui`） ### A.7 前端（`web/delivery-platform-ui`）
| 路由 | 页面职责 | | 路由 | 页面职责 |
| ---------------------------- | ---------------------------------------------------- | | ---------------------------- | ---------------------------------------------------- |
| `/callbacks` | Inbox 列表、`CallbackInboxTable`；跳转详情 | | `/callbacks` | Inbox 列表、`CallbackInboxTable`；跳转详情 |
| `/callbacks/:id` | 详情 + `**CallbackPayloadViewer`（脱敏）**；状态 PATCH、可选人工挂接 | | `/callbacks/:id` | 详情 + **`CallbackPayloadViewer`（脱敏）**；状态 PATCH、可选人工挂接 |
| `/integration/environments` | M6 环境只读表 | | `/integration/environments` | M6 环境只读表 |
| `/integration/product-lines` | 产品线只读表 | | `/integration/product-lines` | 产品线只读表 |
路由 meta：**权限码与 I1 壳一致**；菜单对 **SYS_ADMIN / DEVELOPER** 可见（MVP）。 路由 meta：**权限码与 I1 壳一致**；菜单对 **SYS_ADMIN / DEVELOPER** 可见（MVP）。
### A.8 SDK 轨道（本仓库，I5 硬交付清单） ### A.8 SDK 轨道（本仓库，I5 硬交付清单）
- **Schema**：`schemas/craftlabs-auth-config.schema.json` 等 — 若 BP-10 变更类型触及「平台导出 → Schema → 客户端」，按 [轨道 C §3](../tracks/03-client-sdk.md) bump 规则执行。 - **Schema**：`schemas/craftlabs-auth-config.schema.json` 等 — 若 BP-10 变更类型触及「平台导出 → Schema → 客户端」，按 [轨道 C §3](../tracks/03-client-sdk.md) bump 规则执行。
- **Java `AuthConfigs`**：与 Schema 同步（表见轨道 C BP-10）。 - **Java `AuthConfigs`**：与 Schema 同步（表见轨道 C BP-10）。
- `**examples/**`：与最新字段及环境变量说明一致；CI 与 Schema 校验对齐。 - **`examples/`**：与最新字段及环境变量说明一致；CI 与 Schema 校验对齐。
- **文档**：明确 **SDK 版本线 ≠ 平台 Fat JAR 版本**；引用 BPM **BP-10** 与产品 M6-F01/F02 口径。 - **文档**：明确 **SDK 版本线 ≠ 平台 Fat JAR 版本**；引用 BPM **BP-10** 与产品 M6-F01/F02 口径。
- **不做**：Native 与 Webhook 运行时耦合；平台不嵌入 JNI。 - **不做**：Native 与 Webhook 运行时耦合；平台不嵌入 JNI。
@@ -187,22 +167,20 @@ Content-Type: application/json
## Part B — I6：规划与收口文档 ## Part B — I6：规划与收口文档
| 主题 | 内容要点 | 执行文档 | | 主题 | 内容要点 | 执行文档 |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| **UAT 门禁** | 跑通 **BP-01～06、11** 主链路（与 [轨道 B I6](../tracks/02-frontend-platform-ui.md) E2E 一致）；**Callback** 场景含重复投递幂等、关联失败人工挂接。 | [I6_CLOSEOUT.md §2](./I6_CLOSEOUT.md) | | **UAT 门禁** | 跑通 **BP-01～06、11** 主链路（与 [轨道 B I6](../tracks/02-frontend-platform-ui.md) E2E 一致）；**Callback** 场景含重复投递幂等、关联失败人工挂接。 | [I6_CLOSEOUT.md §2](./I6_CLOSEOUT.md) |
| **冻结清单** | **SDK**：定版 tag、CHANGELOG、**BitAnswer 兼容矩阵**（轨道 C）；**OpenAPI** 快照冻结；**两 JAR** 版本与镜像标签可追踪；前端 `**VITE_API_BASE`** 环境矩阵文档化。 | [I6_CLOSEOUT.md §3～§4](./I6_CLOSEOUT.md) | | **冻结清单** | **SDK**：定版 tag、CHANGELOG、**BitAnswer 兼容矩阵**（轨道 C）；**OpenAPI** 快照冻结；**两 JAR** 版本与镜像标签可追踪；前端 **`VITE_API_BASE`** 环境矩阵文档化。 | [I6_CLOSEOUT.md §3～§4](./I6_CLOSEOUT.md) |
| **Runbook** | `[services/RUNBOOK.md](../../../services/RUNBOOK.md)`：**内部 token 轮换**、Webhook→平台连通性检查、DB 迁移顺序（`flyway_platform_api` / `flyway_webhook`）。 | RUNBOOK **§10** | | **Runbook** | [`services/RUNBOOK.md`](../../../services/RUNBOOK.md)：**内部 token 轮换**、Webhook→平台连通性检查、DB 迁移顺序（`flyway_platform_api` / `flyway_webhook`）。 | RUNBOOK **§10** |
| **安全加固** | **安全响应头**、Cookie/Session 策略（若 Mid 前仍为 JWT 则文档化 **仅 Bearer**）、依赖扫描与已知 CVE 处理；**禁止** I6 周排入大块新功能（仅缺陷与加固）。 | 平台 `SecurityConfig` + Runbook | | **安全加固** | **安全响应头**、Cookie/Session 策略（若 Mid 前仍为 JWT 则文档化 **仅 Bearer**）、依赖扫描与已知 CVE 处理；**禁止** I6 周排入大块新功能（仅缺陷与加固）。 | 平台 `SecurityConfig` + Runbook + [CI 依赖/CVE 扫描](../../../.github/workflows/ci-security.yml) |
| **实现审核** | I1～I6 对照设计与三轨道文档 | [I6_IMPLEMENTATION_REVIEW.md](./I6_IMPLEMENTATION_REVIEW.md) | | **实现审核** | I1～I6 对照设计与三轨道文档 | [I6_IMPLEMENTATION_REVIEW.md](./I6_IMPLEMENTATION_REVIEW.md) |
--- ---
## Part C — 实现顺序与 MVP 切割 ## Part C — 实现顺序与 MVP 切割
1. **平台 DB（Flyway `V5+`）**：`platform_callback_inbox` + M6 两表 + 必要索引与外键；种子数据（环境/产品线）可选。 1. **平台 DB（Flyway `V5+`）**：`platform_callback_inbox` + M6 两表 + 必要索引与外键；种子数据（环境/产品线）可选。
2. **平台内部 API**：`POST /internal/v1/callback-events` + 幂等与 `schemaVersion` 校验 + `**AuditService` 钩子**（状态/关联变更）。 2. **平台内部 API**：`POST /internal/v1/callback-events` + 幂等与 `schemaVersion` 校验 + **`AuditService` 钩子**（状态/关联变更）。
3. **平台公开 API**：`GET/PATCH` callback-inbox、M6 只读 GET；**统一异常**经 `ApiExceptionHandler`。 3. **平台公开 API**：`GET/PATCH` callback-inbox、M6 只读 GET；**统一异常**经 `ApiExceptionHandler`。
4. **OpenAPI 快照** 与契约测试更新。 4. **OpenAPI 快照** 与契约测试更新。
5. **Webhook**：在收据落库后增加 **转发客户端**（重试、观测头）；配置项：`PLATFORM_INTERNAL_BASE_URL`、`PLATFORM_INTERNAL_TOKEN`。 5. **Webhook**：在收据落库后增加 **转发客户端**（重试、观测头）；配置项：`PLATFORM_INTERNAL_BASE_URL`、`PLATFORM_INTERNAL_TOKEN`。
@@ -212,7 +190,6 @@ Content-Type: application/json
**MVP 明确推迟（若全量 M5/M6 过大）** **MVP 明确推迟（若全量 M5/M6 过大）**
| 推迟项 | 说明 | | 推迟项 | 说明 |
| ---------- | ------------------------------------------ | | ---------- | ------------------------------------------ |
| M6-F03～F09 | 比特 ID 映射、特征映射、模板库、发布记录、影响分析 | | M6-F03～F09 | 比特 ID 映射、特征映射、模板库、发布记录、影响分析 |
@@ -220,12 +197,10 @@ Content-Type: application/json
| M5-F10 | 模拟投递 UI（可用 curl/Postman 代替） | | M5-F10 | 模拟投递 UI（可用 curl/Postman 代替） |
| MQ 投递 | 保留 HTTP MVP；MQ + 消费者为 ADR 备选（轨道 A 已列 B 方案） | | MQ 投递 | 保留 HTTP MVP；MQ + 消费者为 ADR 备选（轨道 A 已列 B 方案） |
--- ---
## Part D — 可追溯性（设计章节 → 产品功能点） ## Part D — 可追溯性（设计章节 → 产品功能点）
| 设计章节 | 产品模块 / 功能点（适用处） | | 设计章节 | 产品模块 / 功能点（适用处） |
| ------------------------------- | ------------------------------ | | ------------------------------- | ------------------------------ |
| A.1 幂等与 schemaVersion | M5 运营基础；BP-06 | | A.1 幂等与 schemaVersion | M5 运营基础；BP-06 |
@@ -238,15 +213,12 @@ Content-Type: application/json
| A.8 SDK / Schema | **BP-10**；**M6** 配置治理（文档与校验链） | | A.8 SDK / Schema | **BP-10**；**M6** 配置治理（文档与校验链） |
| Part B I6 | BP-01～06、11 UAT；M11 安全与运维 | | Part B I6 | BP-01～06、11 UAT；M11 安全与运维 |
--- ---
## 修订记录 ## 修订记录
| 日期 | 说明 | | 日期 | 说明 |
| ---------- | ----------------------------------------------------------------- | | ---------- | ----------------------------------------------------------------- |
| 2026-04-06 | 初版：I5/I6 架构设计，对齐并行索引、三轨道文档与产品 M5/M6 P0。 | | 2026-04-06 | 初版：I5/I6 架构设计，对齐并行索引、三轨道文档与产品 M5/M6 P0。 |
| 2026-04-06 | Part B 关联 I6 收口文档（CLOSEOUT / IMPLEMENTATION_REVIEW）与 RUNBOOK §10。 | | 2026-04-06 | Part B 关联 I6 收口文档（CLOSEOUT / IMPLEMENTATION_REVIEW）与 RUNBOOK §10。 |
| 2026-04-06 | 固化 Markdown 引用与强调；Part B 补充 CI 依赖/CVE 扫描入口。 |
docs/engineering/iterations/I6_CLOSEOUT.md
+2
View File
@@ -45,6 +45,7 @@
| **前端** | 生产构建使用明确 `VITE_API_BASE`（见 §4） | | **前端** | 生产构建使用明确 `VITE_API_BASE`（见 §4） |
| **SDK（本仓）** | 定版 tag、`CHANGELOG`、[轨道 C](../tracks/03-client-sdk.md) **兼容矩阵** 填齐；**I6 周内禁止 MAJOR Schema**（与设计一致） | | **SDK（本仓）** | 定版 tag、`CHANGELOG`、[轨道 C](../tracks/03-client-sdk.md) **兼容矩阵** 填齐；**I6 周内禁止 MAJOR Schema**（与设计一致） |
| **内部 Token** | 平台 `PLATFORM_INTERNAL_TOKEN` / `CRAFTLABS_PLATFORM_INTERNAL_TOKEN` 与 Webhook `craftlabs.platform.internal.token` **同值**；轮换走 [RUNBOOK §10](../../../services/RUNBOOK.md) | | **内部 Token** | 平台 `PLATFORM_INTERNAL_TOKEN` / `CRAFTLABS_PLATFORM_INTERNAL_TOKEN` 与 Webhook `craftlabs.platform.internal.token` **同值**；轮换走 [RUNBOOK §10](../../../services/RUNBOOK.md) |
| **依赖 / CVE** | PR 合并前 **`ci-security`** 通过：Trivy 扫描 `services/`、`java/`（`CRITICAL`+`HIGH`，仅已修复项见 workflow）；`npm audit --audit-level=high`（`web/delivery-platform-ui`）。**Dependabot** 周度提 PR（`.github/dependabot.yml`）。 |
--- ---
@@ -65,3 +66,4 @@
| 日期 | 说明 | | 日期 | 说明 |
|------|------| |------|------|
| 2026-04-06 | I6 收口执行包初版：UAT 表、冻结清单、VITE 矩阵。 | | 2026-04-06 | I6 收口执行包初版：UAT 表、冻结清单、VITE 矩阵。 |
| 2026-04-06 | 冻结清单补充 CI 依赖/CVE 与 Dependabot。 |
docs/engineering/iterations/I6_IMPLEMENTATION_REVIEW.md
+1 -1
View File
@@ -62,7 +62,7 @@
|-------------------------------|------|------| |-------------------------------|------|------|
| UAT 检查表 | [I6_CLOSEOUT.md](./I6_CLOSEOUT.md) | 过程性文档；**不替代**自动化 E2E | | UAT 检查表 | [I6_CLOSEOUT.md](./I6_CLOSEOUT.md) | 过程性文档；**不替代**自动化 E2E |
| Runbook：内部 Token、连通性、轮换 | [RUNBOOK.md §10](../../../services/RUNBOOK.md) | 无 | | Runbook：内部 Token、连通性、轮换 | [RUNBOOK.md §10](../../../services/RUNBOOK.md) | 无 |
| 安全响应头 | `SecurityConfig.apiHeaders`：`X-Content-Type-Options`、frame deny、Referrer-Policy | **HSTS** 依设计交由边缘层 | | 安全响应头与依赖门禁 | `SecurityConfig.apiHeaders`：`X-Content-Type-Options`、frame deny、Referrer-Policy；**`ci-security`**（Trivy + `npm audit`）与 **Dependabot** | **HSTS** 依设计交由边缘层 |
| 前端生产 `VITE_API_BASE` | `main.js` + README + CLOSEOUT §4 | 无 | | 前端生产 `VITE_API_BASE` | `main.js` + README + CLOSEOUT §4 | 无 |
| 首页全链路导航 | `HomeView` 模块链接 | 满足轨道 B I6「全链路导航」最低要求 | | 首页全链路导航 | `HomeView` 模块链接 | 满足轨道 B I6「全链路导航」最低要求 |