Adiciona trigger para atualizar os dados de coleção no opac_5 #1156

samuelveigarangel · 2025-09-25T18:34:41Z

O que esse PR faz?

Adiciona uma estrutura de encode token JWT, baseado em RS256. Não há necessidade de user para autenticar (Chave pública, chave privada).
Adiciona um trigger para realizar uma requisição post para o endpoint /api/v1/update_colleciton/ de opac_5
Realiza melhorias no payload de Collection.
REaliza melhorias no modelo de CollectionLogo

Onde a revisão poderia começar?

pelos commits

Como este poderia ser testado manualmente?

Pré-requisitos:

Ter os serviços opac_5 e core em execução na mesma máquina
Esta PR depende de: Adiciona trigger para atualizar os dados de coleção no opac_5 #1156.
Já existir pelo menos uma coleção cadastrada no opac_5

Gerar par de chaves (caso ainda não existam)

# Gerar novo par de chaves se necessário
openssl genrsa -out jwt_private.pem 2048
openssl rsa -in jwt_private.pem -pubout -out jwt_public.pem

Configurar variáveis de ambiente

No opac_5
- Defina JWT_PUBLIC_KEY_PATH com o caminho absoluto da chave pública (jwt_public.pem).
- Defina OPAC_SERVER_NAME com o endereço acessível do opac_webapp_local (IP do gateway do container) e a porta 8000. Ex.: 172.18.0.1:8000
No core:
- Defina JWT_PRIVATE_KEY_PATH com o caminho absoluto da chave privada (jwt_private.pem).

Configurar coleção no core

Adicione uma coleção no core usando:
- domain: exatamente o mesmo valor de OPAC_SERVER_NAME (por exemplo, 172.18.0.1:8000)
- Demais campos: iguais aos da coleção existente no opac_5.

Validar o fluxo

Ao salvar a coleção no core, será disparado o trigger post_save, que enviará uma requisição HTTP para o domain configurado (valor de OPAC_SERVER_NAME).
Verifique nos logs do opac_5 se a requisição foi recebida e processada com sucesso.
Se aplicável, valide o efeito esperado no opac (por exemplo, sincronização/atualização dos dados da coleção).

Algum cenário de contexto que queira dar?

Screenshots

N/A

Quais são tickets relevantes?

#339

Referências

N/A

… melhor extração

…ara endpoint no opac ao salvar objeto collection

gitguardian · 2025-09-25T18:38:12Z

️✅ There are no secrets present in this pull request anymore.

If these secrets were true positive and are still valid, we highly recommend you to revoke them.
While these secrets were previously flagged, we no longer have a reference to the
specific commits where they were detected. Once a secret has been leaked into a git
repository, you should consider it compromised, even if it was deleted immediately.
Find here more information about risks.

^{_{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}}

Copilot

Pull Request Overview

This PR adds JWT token generation and a webhook trigger system to automatically notify opac_5 when collection data is updated in the core system. The integration uses RS256 JWT authentication and sends HTTP POST requests to update collection information.

Implements JWT token generation using RS256 algorithm for secure service-to-service communication
Adds a post-save signal trigger that sends collection data to opac_5 via webhook when collections are created or updated
Enhances collection logo model by replacing size field with purpose field for better organization

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
requirements/base.txt	Adds JWT dependencies (cryptography and PyJWT)
core/utils/jwt.py	New JWT token generation utility using RS256 algorithm
collection/tasks.py	Celery tasks for sending collection data webhooks to opac_5
collection/signals.py	Post-save signal handler to trigger webhook on collection changes
collection/models.py	Updates CollectionLogo model to use purpose instead of size field
collection/api/v1/serializers.py	Enhanced collection serializers with logo grouping and URL generation
config/settings/base.py	JWT configuration settings and webhook endpoint configuration
.envs/.local/.jwt	JWT environment variables for local development

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-01T15:04:17Z

config/settings/base.py

+with open(JWT_PRIVATE_KEY_PATH, "rb") as f:
+    JWT_PRIVATE_KEY = f.read()


Reading the JWT private key file at settings import time will cause the application to crash if the file doesn't exist. This should be moved to a function that's called when needed, or wrapped in a try/except block with appropriate error handling.

Suggested change

with open(JWT_PRIVATE_KEY_PATH, "rb") as f:

JWT_PRIVATE_KEY = f.read()

def get_jwt_private_key():

try:

with open(JWT_PRIVATE_KEY_PATH, "rb") as f:

return f.read()

except (FileNotFoundError, IOError) as e:

# You may want to log the error or handle it differently

return None

Copilot · 2025-10-01T15:04:17Z

collection/tasks.py

+    for schema in ["http", "https"]:
+        url = f"{schema}://{host_or_url}"
+        try:
+            resp = requests.post(url, timeout=timeout)


The function fetch_with_schema_guess is sending a POST request without any data or headers to test connectivity, but it should use a GET request instead since it's only checking if the URL is reachable.

Suggested change

resp = requests.post(url, timeout=timeout)

resp = requests.get(url, timeout=timeout)

Copilot · 2025-10-01T15:04:18Z

core/models.py

+        ordering = ['sort_order', 'language']

    def __str__(self):
        return f"{self.collection} - {self.language} ({self.size})"


The __str__ method references self.size which was removed from the model. This should be updated to reference the new field or removed entirely.

Suggested change

return f"{self.collection} - {self.language} ({self.size})"

return f"{self.collection} - {self.language}"

Copilot · 2025-10-01T15:04:18Z

collection/tasks.py

+        if resp.status_code != 200:
+            logging.error(f"Erro ao enviar dados de coleção para {url}. Status: {resp.status_code}. Body: {resp.text}")  
+        resp.raise_for_status()
+        return resp.json()
+    except Exception as e:


The error logging occurs before raise_for_status(), which means the function will continue and potentially raise an exception after logging. The logging should be inside an exception handler or the raise_for_status() should be moved before the logging.

Suggested change

if resp.status_code != 200:

logging.error(f"Erro ao enviar dados de coleção para {url}. Status: {resp.status_code}. Body: {resp.text}")

resp.raise_for_status()

return resp.json()

except Exception as e:

resp.raise_for_status()

return resp.json()

except Exception as e:

logging.error(f"Erro ao enviar dados de coleção para {url}. Exception: {e}")

Copilot · 2025-10-01T15:04:19Z

collection/api/v1/serializers.py

-            return rendition.url
+            domain = Site.objects.get(is_default_site=True).hostname
+            domain = f"http://{domain}"
+            return f"{domain}{obj.logo.file.url}"


Using obj.logo.file.url directly bypasses Wagtail's image rendition system and may expose internal file paths. Consider using obj.logo.url instead for consistency with the original implementation.

Suggested change

return f"{domain}{obj.logo.file.url}"

return f"{domain}{obj.logo.url}"

Copilot · 2025-10-01T15:04:19Z

core/templates/home/scieloorg/header.html

+                            {% trans 'Sobre o SciELO' %}
+                        {% endif %}
+                    </span>
                    </span>


There's a duplicate closing </span> tag. The closing span tag on line 94 should be removed as it creates invalid HTML structure.

Suggested change

</span>

…guess

…to issue-opac-339

Copilot

Pull Request Overview

Copilot reviewed 17 out of 17 changed files in this pull request and generated 7 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-07T19:18:38Z

collection/tasks.py

+    try:
+        resp = requests.post(pattern_url, json=payload, headers=headers, timeout=5)
+        resp.raise_for_status()
+        return resp.json()
+    except Exception as e:
+        logging.error(f"Erro ao enviar dados de coleção para {url}. Status: {resp.status_code}. Body: {resp.text}")  


The variable resp is referenced before it's guaranteed to be defined. If the exception occurs during the requests.post() call, resp won't exist, causing a NameError.

Suggested change

try:

resp = requests.post(pattern_url, json=payload, headers=headers, timeout=5)

resp.raise_for_status()

return resp.json()

except Exception as e:

logging.error(f"Erro ao enviar dados de coleção para {url}. Status: {resp.status_code}. Body: {resp.text}")

resp = None

try:

resp = requests.post(pattern_url, json=payload, headers=headers, timeout=5)

resp.raise_for_status()

return resp.json()

except Exception as e:

if resp is not None:

logging.error(f"Erro ao enviar dados de coleção para {url}. Status: {resp.status_code}. Body: {resp.text}")

else:

logging.error(f"Erro ao enviar dados de coleção para {url}. Nenhuma resposta recebida. Exception: {e}")

Copilot · 2025-10-07T19:18:38Z

collection/tasks.py

    Collection.load(user)
+
+
+def fetch_with_protocol_guess(host_or_url, timeout=10):


Function is missing a return type annotation and docstring explanation of what happens when both protocols fail.

Copilot · 2025-10-07T19:18:38Z

collection/tasks.py

+    collection = Collection.objects.get(acron3=collection_acron, is_active=True)
+
+    if not collection.domain:
+        return None


Function returns None when both HTTP and HTTPS protocols fail, but the caller expects a URL string. This could cause issues in _send_payload when concatenating with settings.ENDPOINT_COLLECTION.

Copilot · 2025-10-07T19:18:39Z

organization/api/v1/serializers.py

+            domain = Site.objects.get(is_default_site=True).hostname
+            domain = f"http://{domain}"
+            return f"{domain}{obj.logo.url}"


The code assumes there's always a default site. If no default site exists, this will raise a DoesNotExist exception. Consider using get_or_create() or handling the exception.

Suggested change

domain = Site.objects.get(is_default_site=True).hostname

domain = f"http://{domain}"

return f"{domain}{obj.logo.url}"

try:

domain = Site.objects.get(is_default_site=True).hostname

domain = f"http://{domain}"

return f"{domain}{obj.logo.url}"

except Site.DoesNotExist:

return None

Copilot · 2025-10-07T19:18:39Z

collection/api/v1/serializers.py

+            domain = Site.objects.get(is_default_site=True).hostname
+            domain = f"http://{domain}"


Same issue as in organization serializer - assumes there's always a default site. If no default site exists, this will raise a DoesNotExist exception.

Copilot · 2025-10-07T19:18:39Z

core/choices.py


-
 LOGO_SIZE_CHOICES = [


LOGO_SIZE_CHOICES is still defined but appears to be unused after the refactoring to purpose-based logos. Consider removing this unused constant.

Copilot · 2025-10-07T19:18:39Z

collection/models.py

+        ordering = ['sort_order', 'language']
        unique_together = [
-            ("collection", "size", "language"),
+            ('collection', 'language', 'purpose'),


[nitpick] The unique constraint uses single quotes while other parts of the codebase use double quotes for consistency. Consider using double quotes.

Suggested change

('collection', 'language', 'purpose'),

("collection", "language", "purpose"),

…to issue-opac-339

samuelveigarangel added 13 commits September 25, 2025 14:27

add cryptography e PyJWT

df2b135

Remove field size de BaseLogo

02f061e

Add purpose em Collection

22f9159

Adiciona url e logo_url

cf7b1a1

Remove LOGO_SIZE

1d730b2

Add LOGO_PURPOSE

a57d962

Var de ambiente local

16d4349

Adiciona variaveis de ambiente relacionado a JWT

03e82f7

Adiciona classe ListSerializer para agrupar logos por purpose e ficar…

45b4f04

… melhor extração

Adiciona signal e codificação do token para mandar requisições post p…

247bfdd

…ara endpoint no opac ao salvar objeto collection

fix header

4cf1d9b

migration

9511cc5

remove jwt_private_local.pem

823d7fe

scieloorg deleted a comment from gitguardian bot Sep 25, 2025

samuelveigarangel mentioned this pull request Sep 25, 2025

Adiciona endpoint que recebe dados de coleção do core. scieloorg/opac_5#341

Open

samuelveigarangel requested a review from robertatakenaka September 25, 2025 19:08

samuelveigarangel changed the title ~~Issue opac 339~~ Adiciona trigger para atualizar os dados de coleção no opac_5 Sep 25, 2025

samuelveigarangel and others added 4 commits September 25, 2025 16:13

Adiciona variável para ativar update da coleção em opac_5

36dd9fb

remove event em build_collection_webhook

5bb31a7

remove ip fixo

4e5e7b4

Merge branch 'main' into issue-opac-339

d7bae8f

pitangainnovare requested a review from Copilot October 1, 2025 15:02

Copilot AI reviewed Oct 1, 2025

View reviewed changes

robertatakenaka requested a review from gitnnolabs October 6, 2025 12:05

samuelveigarangel added 5 commits October 6, 2025 15:34

remove value JWT_PRIVATE_KEY_PATH

37c06aa

Cria função para ler chave privada

f79d60d

muda metodo post para get em fetch_with_schema_guess

cdffec6

Muda nome da funcao fetch_with_schema_guess para fetch_with_protocol_…

c76f5ed

…guess

Move logging.error para handler exception

cdee2ec

samuelveigarangel and others added 4 commits October 6, 2025 15:51

remove span duplicado

a9a4b3e

Merge branch 'issue-opac-339' of github.com:samuelveigarangel/core in…

f5e1bf7

…to issue-opac-339

Merge branch 'main' into issue-opac-339

b234dfa

remove self.size em BaseLogo.__str__

e6e6f50

robertatakenaka requested a review from Copilot October 7, 2025 19:17

Copilot AI reviewed Oct 7, 2025

View reviewed changes

samuelveigarangel and others added 12 commits October 28, 2025 00:52

refactor get_logo_url

36bdc83

Refactor get_logo_url

3e8c2a9

fix: corrige validações e chamadas duplicadas em webhooks de coleção

24640cf

Merge branch 'main' into issue-opac-339

8857316

Merge branch 'issue-opac-339' of github.com:samuelveigarangel/core in…

1e3e1e8

…to issue-opac-339

organiza e remove imports

22344ae

migration merge

cd1e4cd

Transforma leitura da chave privada em variavel de ambiente

b5091f4

Merge branch 'main' into issue-opac-339

98ff528

Add validação de tamanho para logos

e530db2

Fix build_collection_webhook

627ab2c

Cria funções para obter url de Imagefield e wagtail.images

d43f61d

		with open(JWT_PRIVATE_KEY_PATH, "rb") as f:
		JWT_PRIVATE_KEY = f.read()

	resp = requests.post(url, timeout=timeout)
	resp = requests.get(url, timeout=timeout)

	return f"{self.collection} - {self.language} ({self.size})"
	return f"{self.collection} - {self.language}"

	return f"{domain}{obj.logo.file.url}"
	return f"{domain}{obj.logo.url}"

		Collection.load(user)


		def fetch_with_protocol_guess(host_or_url, timeout=10):

		domain = Site.objects.get(is_default_site=True).hostname
		domain = f"http://{domain}"

	('collection', 'language', 'purpose'),
	("collection", "language", "purpose"),

Adiciona trigger para atualizar os dados de coleção no opac_5 #1156

Are you sure you want to change the base?

Adiciona trigger para atualizar os dados de coleção no opac_5 #1156

Uh oh!

Conversation

samuelveigarangel commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

O que esse PR faz?

Onde a revisão poderia começar?

Como este poderia ser testado manualmente?

Pré-requisitos:

Algum cenário de contexto que queira dar?

Screenshots

Quais são tickets relevantes?

Referências

Uh oh!

gitguardian bot commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

️✅ There are no secrets present in this pull request anymore.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

samuelveigarangel commented Sep 25, 2025 •

edited

Loading

gitguardian bot commented Sep 25, 2025 •

edited

Loading