#3821 centralizar geração próximo número para create de matérias legislativas by LeandroJatai · Pull Request #3822 · interlegis/sapl

LeandroJatai · 2026-01-27T19:51:06Z

Atualmente a geração de próximo número para matérias é um código replicado em dois pontos:

sapl.materia.forms.ConfirmarProposicaoForm.save()
sapl.materia.views.recuperar_materia()

Um terceiro local se faz necessário, no create da API, em _MateriaLegislativaViewSet, além de outros que possam surgir no futuro.

Este PR centraliza a geração de próximo número em um método estático no model MateriaLegislativa, refatora ConfirmarProposicaoForm e recuperar_materia, além de criar o método create na viewset para que em POSTs seja aplicada a mesma lógica de numeração configurada em Configurações da Aplicação e na sequencia de numeração do tipo de matéria.

Descrição

Issue Relacionada

#3821

Motivação e Contexto

Centraliza a geração de próximo número para matéria legislativa e remove duplicidade de código.

Copilot

Pull request overview

This PR centralizes the logic for generating the next sequential number for legislative matters (MateriaLegislativa) into a single static method get_proximo_numero() in the MateriaLegislativa model. Previously, this logic was duplicated in ConfirmarProposicaoForm.save() and recuperar_materia() view function. The refactoring removes code duplication and adds support for the same numbering logic in the API's create endpoint.

Changes:

Added static method get_proximo_numero() to MateriaLegislativa model to centralize number generation logic
Refactored recuperar_materia() view and ConfirmarProposicaoForm.save() to use the new centralized method
Implemented custom create() method in the API viewset to apply automatic numbering to API-created matters

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
sapl/materia/models.py	Added centralized `get_proximo_numero()` static method that handles all numbering sequence types (A, L, U) and supports preferred numbers
sapl/materia/views.py	Refactored `recuperar_materia()` to use the new centralized method, removing ~40 lines of duplicated logic
sapl/materia/forms.py	Refactored `ConfirmarProposicaoForm.save()` to use the new centralized method, removing ~35 lines of duplicated logic
sapl/api/views_materia.py	Added custom `create()` method to apply automatic numbering when creating MateriaLegislativa via API
sapl/api/serializers.py	Added import for MateriaLegislativa model to support API changes

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

sapl/api/views_materia.py

sapl/api/serializers.py

sapl/api/views_materia.py

sapl/materia/models.py

joaohortsenado

@LeandroJatai no geral achei a mudança ótima e necessária, sempre que pudermos melhorar a reusabilidade do código é excelente.
Fiz comentários em alguns pontos, @edwardoliveira se você puder dar uma conferida, podem haver casos de tech debt antigo que talvez possamos passar em PR específico.

joaohortsenado · 2026-03-14T11:46:53Z

sapl/api/views_materia.py

    class Meta:
        ordering = ['-ano', 'tipo', 'numero']

+    @transaction.atomic


O @transaction.atomic não resolve o problema de concorrência. Duas requests simultâneas podem chamar get_proximo_numero(), obter o mesmo número, e só uma delas vai conseguir salvar (ou pior, ambas salvam se não houver unique_together).

+1.

Felizmente nós temos unique_together em MateriaLegislativa: https://github.com/interlegis/sapl/blob/3.1.x/sapl/materia/models.py#L310, mas realmente precisamos de um mecanismo para evitar race conditions (select_for_update() ou algo similar).

@joaohortsenado as alterações e testes do primeiro commit de hoje foram feitas pelo "claude opus 4.6" tendo como contexto todos os comentários. Após isso chequei todos os comentários cruzando com a implementação.

joaohortsenado · 2026-03-14T11:49:57Z

sapl/materia/models.py

+                numero = {'numero__max': 0}
+        elif numeracao == 'U':  # Único/Universal
+            numero = MateriaLegislativa.objects.filter(
+                tipo=tipo).aggregate(Max('numero'))


Aqui está sendo feito um SELECT MAX(numero) sem select_for_update(), então o número gerado pode já estar em uso quando osave()ocorrer.
Minha sugestão é usar select_for_update() nas queries dentro de get_proximo_numero quando chamado dentro de uma transaction, ou adicionar retry logic.

joaohortsenado · 2026-03-14T11:51:56Z

sapl/materia/models.py

+                numero_preferido_int = None
+
+        # Verifica se o número preferido está disponível
+        if numero_preferido_int is not None and not MateriaLegislativa.objects.filter(


Se o numero_preferido já está em uso, o método silenciosamente ignora e retorna o próximo sequencial. Isso pode ser confuso na API: o cliente envia numero=5 e recebe a matéria criada com numero=47 sem nenhum aviso.
Acho que poderia retornar um erro ou ao menos um aviso quando o número preferido não pode ser usado.... o que acha?

+1. IMHO, um erro seria melhor.

joaohortsenado · 2026-03-15T19:12:34Z

sapl/api/views_materia.py

+            numero, ano = MateriaLegislativa.get_proximo_numero(
+                tipo=tipo,
+                ano=ano,
+                numero_preferido=numero


O campo numero do payload é passado como numero_preferido. Isso significa que na API nunca é possível forçar um número específico, ele sempre pode ser sobrescrito. Se o cliente envia numero=5 e ele já existe, recebe outro número sem erro. Isso quebra a expectativa de uma API REST onde o cliente espera que os dados enviados sejam respeitados ou rejeitados.

+1. IMO, deveria haver uma rejeição se numero_preferido informado mas já existir.

joaohortsenado · 2026-03-15T19:15:06Z

sapl/api/views_materia.py


+    @transaction.atomic
+    def create(self, request, *args, **kwargs):
+        data = deepcopy(request.data)


O deepcopy pode ter comportamento inesperado dependendo do content type. Um simples request.data.copy() (ou dict(request.data)) é mais idiomático para django rest framework

joaohortsenado · 2026-03-15T19:18:37Z

sapl/materia/views.py

@@ -340,53 +340,15 @@ def get(self, request, *args, **kwargs):

 @permission_required('materia.detail_materialegislativa')
 def recuperar_materia(request):


O código original retornava vazio quando tipo ou ano estavam ausentes. A nova versão não tem essa guarda. Se ano não vier no GET, get_proximo_numero usa o ano atual, o que muda o comportamento da view. Pode ser intencional, mas vale verificar se o frontend depende do comportamento anterior. (@edwardoliveira se puder opinar sobre isso, você tem mais conhecimento que eu... talvez nao seja um problema, o que acha?)

joaohortsenado · 2026-03-15T19:21:22Z

sapl/materia/models.py

+        Returns:
+            tuple[int, int]: Uma tupla contendo (numero, ano) da matéria.
+        """
+        from django.db.models import Max


O Max pode ser importado no topo do arquivo sem problema. Para os outros, o import local é aceitável, mas vale documentar o motivo com um comentário (provavelmente para evitar imports circulares??)

sapl/materia/models.py

sapl/api/views_materia.py

edwardoliveira · 2026-03-15T20:33:09Z

sapl/api/views_materia.py

    class Meta:
        ordering = ['-ano', 'tipo', 'numero']

+    @transaction.atomic


+1.

Felizmente nós temos unique_together em MateriaLegislativa: https://github.com/interlegis/sapl/blob/3.1.x/sapl/materia/models.py#L310, mas realmente precisamos de um mecanismo para evitar race conditions (select_for_update() ou algo similar).

edwardoliveira · 2026-03-15T20:41:17Z

sapl/materia/models.py

                                 update_fields=update_fields)

+    @staticmethod
+    def get_proximo_numero(tipo, ano=None, numero_preferido=None):


Nit: renomear para numero_candidato

edwardoliveira · 2026-03-15T20:51:20Z

sapl/materia/models.py

+                numero_preferido_int = None
+
+        # Verifica se o número preferido está disponível
+        if numero_preferido_int is not None and not MateriaLegislativa.objects.filter(


+1. IMHO, um erro seria melhor.

edwardoliveira · 2026-03-15T21:13:28Z

sapl/api/views_materia.py

+            numero, ano = MateriaLegislativa.get_proximo_numero(
+                tipo=tipo,
+                ano=ano,
+                numero_preferido=numero


+1. IMO, deveria haver uma rejeição se numero_preferido informado mas já existir.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…ativa

LeandroJatai requested review from Copilot and edwardoliveira January 27, 2026 19:51

Copilot started reviewing on behalf of LeandroJatai January 27, 2026 19:51 View session

Copilot AI reviewed Jan 27, 2026

View reviewed changes

LeandroJatai changed the title ~~#3821 centralizar geracao proximo numero ml~~ #3821 centralizar geração próximo número para create de matérias legislativas Jan 28, 2026

joaohortsenado self-requested a review March 14, 2026 11:35

joaohortsenado requested changes Mar 15, 2026

View reviewed changes

edwardoliveira reviewed Mar 15, 2026

View reviewed changes

LeandroJatai and others added 9 commits March 16, 2026 07:42

refact: cria método get_proximo_numero

61f1a8b

feat: impl numeração automática em cadastros via API

6dc4991

Update sapl/materia/models.py

a85a83e

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update sapl/api/serializers.py

e9a9ab5

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update sapl/api/views_materia.py

43e6850

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update sapl/materia/models.py

51a2ccd

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update sapl/materia/models.py

346e833

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Add transaction atomic no endpoint create

e9da827

add validação de tipo se tipo não é objeto do model TipoMateriaLegisl…

a9f66a9

…ativa

LeandroJatai force-pushed the 3821_centralizar_geracao_proximo_numero_ml branch from f96a98f to a9f66a9 Compare March 16, 2026 10:42

LeandroJatai added 4 commits March 16, 2026 08:32

refact: aplica solicitações de reviewer e cria testes

9d36879

fix: altera numero_preferido para numero_candidato

a66c052

fix: remove espaços entre classes

00c6400

fix: corrige uso de transaction e ausencia dele

fef28d2

LeandroJatai requested a review from joaohortsenado March 16, 2026 12:06

LeandroJatai added 3 commits March 16, 2026 09:08

fix: corrige testes devido mudança de norme de variável

17302b3

fix: altera seleção para select_for_update

5899636

fix: mudança de nome remanescente para numero_candidato

fa3d7aa

		@@ -340,53 +340,15 @@ def get(self, request, args, *kwargs):

		@permission_required('materia.detail_materialegislativa')
		def recuperar_materia(request):

Conversation

LeandroJatai commented Jan 27, 2026

Descrição

Issue Relacionada

Motivação e Contexto

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joaohortsenado left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants