From ddefbd5cab870e423150457c9f2d56c354e8c511 Mon Sep 17 00:00:00 2001
From: Ming Wen <moonbingbing@gmail.com>
Date: Sun, 17 May 2026 09:06:49 +0800
Subject: [PATCH] ci: add schema drift check for resource JSON Schemas
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Adds a new `schema-drift` job to the CI workflow that runs
`cargo run -p aisix-core --bin dump-schema` and asserts
`git diff --exit-code schemas/` is clean. PRs that modify resource
struct in `crates/aisix-core/src/models/` but forget to regenerate
the schema files now fail CI with a fix instruction in the error
message.

## Why

Refs api7/ai-gateway#304 item #1. The `dump-schema` tool and
`schemas/resources/*.schema.json` files were introduced in #308;
without an enforcement mechanism the committed schemas can silently
diverge from the Rust types as the resource graph evolves
(especially during issue #302 Phase A, which is actively mutating
ProviderKey / Model). This job is that enforcement.

## Job placement

Sits as a peer to `lint` — fast, independent, no service deps. Runs
in parallel with `lint` / `rust-unit` / `build-bin`. Not a `needs:`
target of any downstream job, so a drift failure does not block the
e2e or coverage signals.

## Verification

- Positive path: `cargo run -p aisix-core --bin dump-schema` on the
  HEAD of this PR succeeds and `git diff --exit-code schemas/` is
  empty (no drift in tree)
- Negative path: locally introduced a synthetic drift by truncating
  `schemas/resources/api_key.schema.json` to `{}`. `git diff
  --exit-code schemas/` returned non-zero — the check fires as
  expected. Reverted with `git checkout schemas/resources/api_key.schema.json`.
- YAML parses with `python3 -c "import yaml; yaml.safe_load(open(...))"`.

## Stack

Builds on #308 (which adds the binary + initial schemas). Base will
switch to `main` once #308 merges.

Refs api7/ai-gateway#304 (#1).
---
 .github/workflows/ci.yml | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 3fad1a40..7a6e8bc4 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -28,6 +28,26 @@ jobs:
       - name: cargo clippy
         run: cargo clippy --workspace --all-targets -- -D warnings
 
+  schema-drift:
+    name: schema drift (resources)
+    runs-on: ubicloud-standard-2
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: arduino/setup-protoc@v3
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: Swatinem/rust-cache@v2
+      - name: regenerate schemas
+        run: cargo run -p aisix-core --bin dump-schema
+      - name: assert no drift
+        run: |
+          if ! git diff --exit-code schemas/; then
+            echo "::error::Resource JSON Schemas in 'schemas/resources/' drift from the Rust types in 'crates/aisix-core/src/models/'."
+            echo "::error::Fix: run 'cargo run -p aisix-core --bin dump-schema' locally and commit the diff."
+            exit 1
+          fi
+
   rust-unit:
     name: rust unit + coverage
     runs-on: ubicloud-standard-2