Uh oh!
There was an error while loading. Please reload this page.
fix(guardrails): add azure_content_safety to loader JSON schema oneOf - #439
Conversation
The DP loader (aisix_etcd) validates each guardrail kine entry against
the JSON schema in models/schema.rs BEFORE deserializing into the Rust
Guardrail struct. That schema's `kind` enum and `oneOf` listed only
`keyword` and `bedrock` — so every `azure_content_safety` guardrail was
rejected and skipped at load time, even though the struct
(guardrail.rs) and the check (aisix-guardrails/prompt_shield.rs) both
support it:
aisix_etcd::loader: schema validation failed; skipping .../guardrails/...
{... "kind":"azure_content_safety" ...} is not valid under any of the
schemas listed in the 'oneOf' keyword
Add the `azure_content_safety` branch, mirroring AzureContentSafetyConfig
in guardrail.rs: `endpoint` + `api_key` required (non-empty), `timeout_ms`
optional (u32, struct default 5000). Also add it to the top-level `kind`
enum.
The existing struct-level test (azure_content_safety_kind_parses)
exercises serde only — it could not catch this because the JSON-schema
gate is a separate code path. Adds three schema-level regression tests.
Fixes#437.ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Free Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe guardrail JSON schema adds a new ChangesAzure Content Safety Guardrail Schema Support
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Note 🎁 Summarized by CodeRabbit FreeYour organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.If you believe this is a mistake and have available seats, please assign one to the pull request author through the subscription management page using the link above. Comment |
Audit follow-up for #439 (MEDIUM-2 / LOW-1). The #437 bug shipped precisely because no test guarded the hand-written loader schema against the struct's field range. Add two boundary tests: - max_timeout_passes: schema must accept timeout_ms = u32::MAX (the struct's max). Fails loud if a future edit tightens the schema below u32::MAX, re-introducing the stricter-than-struct regression class. - timeout_overflow_rejected: u32::MAX + 1 must be rejected at the gate. Keeping the schema's timeout_ms upper bound at u32::MAX (not cp-api's tighter 0/[100,30000]) is intentional: the loader gate must mirror the struct it deserializes into, never be stricter — cp-api validates the tighter range on write, so no valid row is dropped.
moonming
commented
May 29, 2026
Independent audit: APPROVE (no HIGH). Findings addressed.The audit compiled a serde repro of the exact struct shape and cross-checked cp-api's real contract (
All 5 ACS schema tests + the existing 12 guardrail tests pass locally. |
Summary
The DP loader (
aisix_etcd) validates each guardrail kine entry against the JSON schema incrates/aisix-core/src/models/schema.rsbefore deserializing into the RustGuardrailstruct. That schema'skindenum andoneOflisted onlykeywordandbedrock— so everyazure_content_safetyguardrail was rejected and silently skipped at load time, even though the struct (guardrail.rs) and the check (aisix-guardrails/src/prompt_shield.rs) both already support it onmain:Net effect: ACS Prompt Shield guardrails never take effect — chats are never blocked.
Fixes#437.
Change
guardrail_schema()inschema.rs:azure_content_safetyto the top-levelkindenum.azure_content_safetyoneOfbranch mirroringAzureContentSafetyConfig(guardrail.rs):endpoint+api_keyrequired & non-empty,timeout_msoptionalu32(struct default 5000).Why unit tests caught it but the existing test didn't
azure_content_safety_kind_parses(guardrail.rs) exercises serde deserialization only. The loader's JSON-schema gate is a separate code path that no test covered. This PR adds three schema-level regression tests:guardrail_azure_content_safety_passes(no timeout → default)guardrail_azure_content_safety_with_timeout_passesguardrail_azure_content_safety_missing_api_key_rejectedValidation
cargo test -p aisix-core --lib guardrail→ 17 passed (incl. the 3 new).cargo clippy -p aisix-core --libclean;cargo fmt --checkclean.:devimage is built from this.Discovery context
Found while validating api7/AISIX-Cloud#551 end-to-end against a real stack — the cp-api half accepted/projected the ACS guardrail (201) but the DP dropped it at this schema gate. Last DP-side piece for #379 P1 Prompt Shield.
Test plan
cargo test -p aisix-core --lib guardrail(17 pass)cargo clippy/cargo fmt --checkcleanSummary by CodeRabbit