Backfill `organisation_id` on existing audit logs

オープン
  • 何か問題がありますか？
#8,935 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
36/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
django, postgresql, python
領域
backend, databases

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.
主要言語
Python
スター
7.1k
フォーク
603
平均マージ
3日 8時間
マージ済み PR（30日）
102

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Flagsmith/flagsmith のほかの issue

Flagsmith/flagsmith の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。