zulip/zulip

Add RealmAuditLog entries for CustomProfileField changes

Open

#36.715 aberto em 20 de nov. de 2025

Ver no GitHub
 (29 comments) (0 reactions) (1 assignee)Python (19.672 stars) (7.339 forks)batch import
area: settings (admin/org)help wantedin progress

Description

As noted in https://github.com/zulip/zulip/pull/21336#issuecomment-1060782695, it appears that we never added RealmAuditLog support for custom profile field changes, either at the organization or user level.

This is not a good first issue; one needs to be familiar with the audit log system and able to do an effective discussion about design for these. But it could be good for a contributor who's already done some adjacent PRs.

Guia do colaborador

Pilha de tecnologia
pythondjango
Domain
backenddatabase
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
4
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
3-5 days
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
blocked
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
mostly clear
Prerequisites
Familiarity with Zulip audit log systemPythonDjango
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
15
Direção de pesquisa
Review the referenced PR (https://github.com/zulip/zulip/pull/21336) and comments to understand the current state of RealmAuditLog. Investigate existing audit log entries for similar entity changes (e.g., realm or user level modifications) to determine the pattern. Design new audit log event types for custom profile field changes, considering both organization level and user level modifications. Implementation will involve modifying the event type definitions and adding logging calls in the relevant code paths (likely in zerver/lib/actions.py or similar).