Backfill `organisation_id` on existing audit logs

Đang mở
  • Có gì không ổn?
#8,935 2 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ó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
36/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
django, postgresql, python
Lĩnh vực
backend, databases

Hướng nghiên cứu

Start by reading #8888 and tracing the audit log model, organisation-scoped list and filter queries, webhooks, and integrations described in the issue. Identify the existing migration and backfill patterns, then assess how the backfill can run while writes, listing, search, and deliveries continue. Done means the acceptance criteria hold: every relevant API log has its organisation, queries are no slower, and results and deliveries are unchanged.

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

Mô tả

After #8888, we gain a nullable AuditLog.organisation field for organisation-level audit logs.

Existing project and environment logs keep organisation_id = NULL, so every organisation-scoped read still has to look up the organisation through project:

  • organisation_id = X OR project.organisation_id = X in the organisation and all-logs endpoints, and in the organisation filter. In /api/v1/audit/, this leads to two OR'd joins, which poses a duplicate row risk in results.
  • fallback chains through project in audit log webhooks and integrations.

Besides that, users see organisation: null in API responses for most logs.

We propose to backfill the field value for existing audit logs, which will gain us:

  • One way to scope by organisation, index-friendly queries, and impler webhook + integrations code: WHERE organisation_id = X everywhere instead of OR / joins / project fallback logic. Also, no duplicate row risk in /api/v1/audit/.
  • A clear meaning for "organisation-level": project_id IS NULL AND environment_id IS NULL, with no reliance on NULL meaning something by convention.
  • A complete API: organisation is set on every log that belongs to an organisation.
  • Easier future work: organisation-wide features such as retention, export and analytics can rely on a single column.
Acceptance criteria
  • Every audit log that belongs to a project or environment shows its organisation in the API (organisation is not null), including logs created before #8888.
  • The organisation audit log list is faster than existing p95 of 900ms, or at least no slower.
  • Users see no impact while the backfill runs: audit logs keep being written and listed, and search keeps working.
  • The organisation audit log shows exactly the same logs as before the backfill: none missing, none duplicated, and audit log webhooks and integrations are delivered exactly as before.
Ngôn ngữ chính
Python
Star
7.1k
Fork
603
Merge trung bình
3 ngày 8 giờ
Pull request đã merge (30 ngày)
102

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 Flagsmith/flagsmith

Tất cả issue của Flagsmith/flagsmith

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.