Feature-flag changes can be saved without a compliance audit entry; state the audit log's durability per resource

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#1,042 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
backend, documentation

Hướng nghiên cứu

Bắt đầu với backend/app/api/v1/endpoints/feature_flags.py, sau đó so sánh hành vi ghi audit của tệp này với bảo đảm giao dịch được mô tả trong docs/api/endpoints.md. Ngoài ra, hãy đọc các tuyên bố về nhật ký audit trong bảng mô hình đe dọa và docs/architecture/overview.md. Hoàn thành nghĩa là tài liệu nêu rõ bảo đảm về độ bền của từng tài nguyên và, đối với các mục audit theo nguyên tắc best-effort, giải thích rằng các mục bị bỏ lỡ có thể được thấy qua chỉ số audit-failure hiện có.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement post-launch

Feature-flag create, update and delete write their compliance audit entry after the flag change has been committed, and a failure to write it is logged and ignored (backend/app/api/v1/endpoints/feature_flags.py, e.g. lines ~364-384: "non-fatal: do not fail the request if this fails"). So a flag change can be saved with no compliance audit entry. User administration is different: docs/api/endpoints.md states that its audit entry is written in the same transaction and that nothing is saved if it cannot be written.

The docs describe the audit log as an "immutable audit trail" (the threat-model table and docs/architecture/overview.md), which readers can take to mean complete.

Expected: state the durability promise per resource. Either write the flag's audit entry in the same transaction (as user administration does), or say in the audit-logging docs which changes are recorded best-effort and how a missed entry is visible (the existing audit-failure metric). Found in a code review (2026-10-06).

Ngôn ngữ chính
Python
Star
0
Fork
4
Merge trung bình
5 giờ 19 phút
Pull request đã merge (30 ngày)
503

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Controlvar/controlvar

Tất cả issue của Controlvar/controlvar

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.