mirror of https://github.com/rustfs/rustfs.git synced 2026-07-26 16:28:15 +00:00

Files

T

安正超 a63aaf933d fix(notify): normalize lock ordering to prevent deadlock (#3199 )

* fix(notify): normalize lock ordering to prevent deadlock

replace_targets() and shutdown() acquired target_list before replay_workers,
opposite to runtime_view.rs order. This is an ABBA deadlock pattern.

- Swap to replay_workers -> target_list order (canonical)
- Add lock order comments
- 82 notify tests pass

* docs(notify): update runtime facade lock order

* docs(notify): clarify runtime facade lock order

---------

Co-authored-by: houseme <housemecn@gmail.com>

2026-06-03 15:37:59 +00:00

2.5 KiB

Raw Permalink 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: replay_workers → target_list.
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 Permalink Blame History