Backfill `organisation_id` on existing audit logs

Abierto
  • ¿Algo no está bien?
#8,935 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
36/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
django, postgresql, python
Área
backend, databases

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
Python
Estrellas
7.1k
Forks
603
Merge medio
3 d 8 h
PR fusionados (30 d)
102

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Flagsmith/flagsmith

Todos los issues de Flagsmith/flagsmith

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.