mirror of https://github.com/rustfs/rustfs.git synced 2026-08-06 05:17:42 +00:00

Files

T

安正超 b5e565c0ce chore(agents): add Rust code quality rules and skill (#3144 )

* docs: update security advisory lessons

* chore(agents): add Rust code quality rules and skill

Add rules derived from full-project code review (48 findings across
7 dimensions) to prevent recurring issues in agent-generated code.

AGENTS.md changes:
- crates/AGENTS.md: error type design, concurrency, recursion safety,
  type casting, test quality rules
- root AGENTS.md: serde safety, naming conventions
- crates/ecstore/AGENTS.md: allocation discipline, lock ordering,
  recursion safety, dead code policy
- crates/notify/AGENTS.md: lock ordering for runtime_view/facade

Skill changes:
- code-change-verification: add Rust-specific checks (unwrap, as cast,
  clone, lock order, recursion, error types, test assertions)
- security-advisory-lessons: add serde deserialization safety pattern
- NEW rust-code-quality: automated scan + manual review checklist

2026-05-31 22:19:36 +08:00

2.5 KiB

Raw Blame History

Notify Crate Instructions

Applies to crates/notify/.

rustfs-notify is the domain layer for bucket notification semantics. It builds rules, event dispatch flow, and config/runtime orchestration on top of shared plugin/runtime primitives from rustfs-targets.

Domain Boundaries

Keep notify-specific business logic here:
- bucket/rule evaluation
- event bridge and pipeline dispatch
- notify config reload orchestration
Keep shared runtime/plugin mechanics in rustfs-targets:
- do not duplicate replay worker lifecycle logic
- do not reimplement plugin descriptor/registry/catalog semantics
- do not move install/control-plane state into this crate

Runtime Layering Rules

runtime_facade.rs is the mutation/orchestration boundary: activation, replace, stop workers, shutdown.
runtime_view.rs is read-only runtime observation: active targets, metrics/health snapshots, runtime status snapshots.
config_manager.rs should map config to runtime updates through facade/view and runtime_target_id_for_subsystem; avoid bypassing these boundaries.
stream.rs is a compatibility shim; new replay/runtime work should prefer shared helpers in rustfs-targets::runtime.

Concurrency

runtime_view.rs acquires locks in order: stream_cancellers → target_list.
runtime_facade.rs acquires locks in order: target_list → replay_workers.
These orders must not be reversed in new code. When adding a function that needs both target_list and stream_cancellers, acquire stream_cancellers first (matching runtime_view.rs order).
Do not hold write guards across .await points unless the hold time is bounded and the operation is unavoidably async.

Change Style

Preserve best-effort dispatch semantics and observability signals unless the task explicitly requests behavior changes.
Reuse existing notify constants and subsystem mappings from rustfs_config.
Keep changes local and avoid cross-crate refactors from this crate unless required by the task.

Testing

Keep unit tests close to changed modules.
Add regression tests for:
- rules to runtime target resolution
- runtime facade replace/shutdown behavior
- runtime view health/status/metrics snapshots
Suggested validation:
- cargo test -p rustfs-notify
- Focused: cargo test -p rustfs-notify runtime_facade
- Focused: cargo test -p rustfs-notify runtime_view
- Focused: cargo test -p rustfs-notify config_manager
Full gate before commit: make pre-commit

2.5 KiB Raw Blame History