Adiciona endpoint que recebe dados de coleção do core. by samuelveigarangel · Pull Request #341 · scieloorg/opac_5

samuelveigarangel · 2025-09-25T18:56:56Z

O que esse PR faz?

Adiciona uma estrutura de decode token JWT, baseado em RS256. Não há necessidade de user para autenticar (Chave pública, chave privada).
Adiciona um endpoint (/api/v1/update_collection) para receber os dados de collection do core.
Adiciona funções para completar os dados de collection e sponsor.

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 core#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?

Não aprovar esta PR antes de realizar o merge de scieloorg/core#1156 e estar em produção para gerar os par de chaves a partir do ambiente de produção e ser adicionado a chave publicar nesta PR

Screenshots

N/A

Quais são tickets relevantes?

#339

Referências

N/A

…e_collection

robertatakenaka · 2025-09-30T14:17:46Z

opac/webapp/controllers.py

+    list_logo = []
+    list_logo.append(logos.get("homepage", ""))
+    list_logo.append(logos.get("header", ""))
+    list_logo.append(logos.get("menu", ""))


@samuelveigarangel otimize: list_logo = [logos.get(key, "") for key in ["homepage", "header", "menu"]]

robertatakenaka · 2025-09-30T14:44:27Z

opac/webapp/controllers.py

+    if main_name and collection.name != main_name:
+        collection.name = main_name
+
+    sponsors = handler_collection_sponsos(json_data.get("supporting_organizations"))


@samuelveigarangel Existe uma ordem desejável de apresentação dos logos dos sponsors. Garanta que a ordem seja preservada.

robertatakenaka · 2025-09-30T14:54:24Z

opac/webapp/controllers.py

+    logo = handler_with_logo(logo_url=logo_url, folder="img/sponsors")
+
+    # Por causa do order unique, evitar error ao mudar a ordem
+    temp_order = -int(time.time()*1000) # incrementa um valor aleatório em order.


@samuelveigarangel isso pode fazer parte do dado registrado no core. Assim evita processamento excessivo e a ordem é garantida na origem.

robertatakenaka

@samuelveigarangel fazer as correções

Copilot

Pull Request Overview

This PR adds JWT-based authentication and an endpoint to receive collection data updates from the core service. The implementation enables the core service to push collection and sponsor data to OPAC using RS256 JWT tokens for authentication.

Key changes:

Implements JWT token validation using RS256 algorithm with public/private key pairs
Adds /api/v1/update_collection endpoint to receive collection data from core
Creates utility functions for downloading and handling logo files from external URLs

Reviewed Changes

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

Show a summary per file

File	Description
opac/webapp/utils/handler_with_logo.py	New utility for downloading and storing logo files from URLs
opac/webapp/main/views.py	Adds update_collection endpoint and cleans up imports
opac/webapp/main/helper.py	JWT token extraction and verification functions
opac/webapp/main/decorators.py	JWT authentication decorator for API endpoints
opac/webapp/controllers.py	Collection and sponsor data processing functions
opac/webapp/config/default.py	JWT configuration settings

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

Copilot · 2025-10-03T16:20:58Z

opac/webapp/utils/handler_with_logo.py

+            for chuck in resp.iter_content(chunk_size=8192):
+                f.write(chuck)


Corrected spelling of 'chuck' to 'chunk'.

Suggested change

for chuck in resp.iter_content(chunk_size=8192):

f.write(chuck)

for chunk in resp.iter_content(chunk_size=8192):

f.write(chunk)

Copilot · 2025-10-03T16:20:58Z

opac/webapp/main/decorators.py

+        try:
+            g.jwt = verify_jwt(token)            
+        except PyJWTError as e:
+            print("Erro na validação JWT:", str(e))


Using print() for error logging is not recommended. Replace with proper logging using the logger module.

Copilot · 2025-10-03T16:20:58Z

opac/webapp/controllers.py

+    return data
+
+
+def set_atributtes_logos(collection, logos, name_logos=["home_logo", "logo_menu", "header_logo"], langs=["pt", "en", "es"]):


Corrected spelling of 'atributtes' to 'attributes'.

Suggested change

def set_atributtes_logos(collection, logos, name_logos=["home_logo", "logo_menu", "header_logo"], langs=["pt", "en", "es"]):

def set_attributes_logos(collection, logos, name_logos=["home_logo", "logo_menu", "header_logo"], langs=["pt", "en", "es"]):

Copilot · 2025-10-03T16:20:59Z

opac/webapp/controllers.py

+    return obj
+
+
+def handler_collection_sponsos(data):


Corrected spelling of 'sponsos' to 'sponsors'.

Suggested change

def handler_collection_sponsos(data):

def handler_collection_sponsors(data):

Copilot · 2025-10-03T16:20:59Z

opac/webapp/controllers.py

+    for logo in list_logo:
+        if not logo:
+            continue
+        for name_logo, lang in zip(name_logos, langs):  
+            if hasattr(collection, f"{name_logo}_{lang}"):
+                logo = handler_with_logo(logo_url=logo.get(lang), folder=f"img/{name_logo}")                
+                if logo.get("rel_path"):
+                    collection_logo = f"http://{current_app.config['SERVER_NAME']}{logo.get('rel_path')}"


Variable name collision: 'logo' is used both for the outer loop variable and the return value from handler_with_logo. This creates confusion and potential bugs.

Suggested change

for logo in list_logo:

if not logo:

continue

for name_logo, lang in zip(name_logos, langs):

if hasattr(collection, f"{name_logo}_{lang}"):

logo = handler_with_logo(logo_url=logo.get(lang), folder=f"img/{name_logo}")

if logo.get("rel_path"):

collection_logo = f"http://{current_app.config['SERVER_NAME']}{logo.get('rel_path')}"

for logo_data in list_logo:

if not logo_data:

continue

for name_logo, lang in zip(name_logos, langs):

if hasattr(collection, f"{name_logo}_{lang}"):

logo_info = handler_with_logo(logo_url=logo_data.get(lang), folder=f"img/{name_logo}")

if logo_info.get("rel_path"):

collection_logo = f"http://{current_app.config['SERVER_NAME']}{logo_info.get('rel_path')}"

Copilot · 2025-10-03T16:20:59Z

opac/webapp/config/default.py

+with open(JWT_PUBLIC_KEY_PATH, "rb") as f:
+    JWT_PUBLIC_KEY_PEM = f.read()


File operations at module level should include proper error handling. If the JWT public key file doesn't exist or is unreadable, this will cause the application to fail during import.

Suggested change

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

JWT_PUBLIC_KEY_PEM = f.read()

try:

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

JWT_PUBLIC_KEY_PEM = f.read()

except (FileNotFoundError, PermissionError, OSError) as e:

JWT_PUBLIC_KEY_PEM = None

import warnings

warnings.warn(

f"Could not read JWT public key from '{JWT_PUBLIC_KEY_PATH}': {e}. "

"JWT_PUBLIC_KEY_PEM is set to None."

)

…nsors

Copilot

Pull Request Overview

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

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

Copilot · 2025-10-07T19:19:16Z

opac/webapp/utils/handler_with_logo.py

+    # abs_path /app/opac/webapp/static/img/sponsors/screenshot_from_2024-10-14_11-20-16.png
+    abs_path = os.path.join(current_app.static_folder, rel_path)
+    os.makedirs(os.path.dirname(abs_path), exist_ok=True)
+    print(os.path.join(current_app.static_url_path, rel_path))


Debug print statement should be removed or replaced with proper logging.

Suggested change

print(os.path.join(current_app.static_url_path, rel_path))

logging.info(f"Logo static URL path: {os.path.join(current_app.static_url_path, rel_path)}")

Copilot · 2025-10-07T19:19:17Z

opac/webapp/main/helper.py

+    return jwt.decode(
+        token,
+        public_key,
+        algorithms=[current_app.config["JWT_ALG"]],
+        audience=current_app.config["JWT_AUD"],
+        issuer=current_app.config["JWT_ISS"],
+        # options={"require": ["exp", "iat", "nbf", "iss", "aud"]},


Commented code should be removed if not needed, or uncommented with proper explanation if required for JWT validation.

Suggested change

return jwt.decode(

token,

public_key,

algorithms=[current_app.config["JWT_ALG"]],

audience=current_app.config["JWT_AUD"],

issuer=current_app.config["JWT_ISS"],

# options={"require": ["exp", "iat", "nbf", "iss", "aud"]},

# Enforce presence of standard claims for robust JWT validation

return jwt.decode(

token,

public_key,

algorithms=[current_app.config["JWT_ALG"]],

audience=current_app.config["JWT_AUD"],

issuer=current_app.config["JWT_ISS"],

options={"require": ["exp", "iat", "nbf", "iss", "aud"]},

Copilot · 2025-10-07T19:19:17Z

opac/webapp/main/decorators.py

+        try:
+            g.jwt = verify_jwt(token)            
+        except PyJWTError as e:
+            logging.error("Erro na validação JWT:", str(e))


Error message should be in English to maintain consistency with codebase.

Suggested change

logging.error("Erro na validação JWT:", str(e))

logging.error("Error validating JWT:", str(e))

Copilot · 2025-10-07T19:19:17Z

opac/webapp/controllers.py

+    Atribuí os logos do modelo collection. (home_logo, logo_menu, header_logo)
+    Ex:


Docstring should be in English and has Portuguese text.

Suggested change

Atribuí os logos do modelo collection. (home_logo, logo_menu, header_logo)

Ex:

Assigns the logos to the collection model. (home_logo, logo_menu, header_logo)

Example:

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

opac/webapp/controllers.py

+            "logo_url": "https://core.scielo.org/media/original_images/logo.png"
+        }
+    """
+    import time


Import statement should be at the top of the file, not inside a function.

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

opac/webapp/config/default.py

+with open(JWT_PUBLIC_KEY_PATH, "rb") as f:
+    JWT_PUBLIC_KEY_PEM = f.read()
+


Opening the JWT public key file at import time will cause the application to fail if the file doesn't exist. This should be handled with proper error handling or moved to a function that's called when needed.

Suggested change

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

JWT_PUBLIC_KEY_PEM = f.read()

def get_jwt_public_key_pem():

"""

Reads the JWT public key from the configured path.

Returns the key contents as bytes.

Raises FileNotFoundError with a clear message if the file is missing.

"""

try:

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

return f.read()

except FileNotFoundError:

raise FileNotFoundError(

f"JWT public key file not found at '{JWT_PUBLIC_KEY_PATH}'. "

"Please ensure the file exists and the path is correct."

)

except Exception as e:

raise RuntimeError(

f"An error occurred while reading the JWT public key file at '{JWT_PUBLIC_KEY_PATH}': {e}"

)

samuelveigarangel added 7 commits September 25, 2025 15:09

adiciona func updat_collection

a48e6ed

Adiciona estrutura para decodificação e autorização do endpoint updat…

8e58d74

…e_collection

Adiciona funções para atribuir valores nos attr de collection e sponsor

937ae43

remove inutils imports

e00eb70

gitignore update

74a57c6

Remove print

90d2e49

Altera ISS e AUD de JWT

305993d

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

remove token publico

625dc7f

robertatakenaka reviewed Sep 30, 2025

View reviewed changes

robertatakenaka requested changes Sep 30, 2025

View reviewed changes

robertatakenaka requested a review from Copilot October 3, 2025 16:19

Copilot AI reviewed Oct 3, 2025

View reviewed changes

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

samuelveigarangel added 7 commits October 6, 2025 16:12

melhora atribuição da variavel list_logo

0488045

muda set_atributtes_logos para set_attributtes_logos

bae1b77

muda nome chuck para chunk

7409146

Add logging error

89cef51

altera nomes de variaveis em set_attributtes_logos

3238cc0

Adiciona função para pegar get_jwt_public_key

45b5db8

muda nome func handler_collection_sponsos para handler_collection_spo…

89248b9

…nsors

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

Copilot AI reviewed Oct 7, 2025

View reviewed changes

samuelveigarangel mentioned this pull request Oct 23, 2025

Apresentação defeituosa de Logo / página do periódico #349

Closed

samuelveigarangel added 2 commits November 18, 2025 10:26

Adiciona condição para verificar se ha sponsors

81e47d1

Adiciona chave publica

5d60f66

robertatakenaka mentioned this pull request Dec 18, 2025

Correção do link do logo #365

Open

		for chuck in resp.iter_content(chunk_size=8192):
		f.write(chuck)

		return data


		def set_atributtes_logos(collection, logos, name_logos=["home_logo", "logo_menu", "header_logo"], langs=["pt", "en", "es"]):

	def set_atributtes_logos(collection, logos, name_logos=["home_logo", "logo_menu", "header_logo"], langs=["pt", "en", "es"]):
	def set_attributes_logos(collection, logos, name_logos=["home_logo", "logo_menu", "header_logo"], langs=["pt", "en", "es"]):

	def handler_collection_sponsos(data):
	def handler_collection_sponsors(data):

		with open(JWT_PUBLIC_KEY_PATH, "rb") as f:
		JWT_PUBLIC_KEY_PEM = f.read()

-with open(JWT_PUBLIC_KEY_PATH, "rb") as f:
-    JWT_PUBLIC_KEY_PEM = f.read()
+try:
+    with open(JWT_PUBLIC_KEY_PATH, "rb") as f:
+        JWT_PUBLIC_KEY_PEM = f.read()
+except (FileNotFoundError, PermissionError, OSError) as e:
+    JWT_PUBLIC_KEY_PEM = None
+    import warnings
+    warnings.warn(
+        f"Could not read JWT public key from '{JWT_PUBLIC_KEY_PATH}': {e}. "
+        "JWT_PUBLIC_KEY_PEM is set to None."
+    )

	print(os.path.join(current_app.static_url_path, rel_path))
	logging.info(f"Logo static URL path: {os.path.join(current_app.static_url_path, rel_path)}")

	logging.error("Erro na validação JWT:", str(e))
	logging.error("Error validating JWT:", str(e))

		Atribuí os logos do modelo collection. (home_logo, logo_menu, header_logo)
		Ex:

-    Atribuí os logos do modelo collection. (home_logo, logo_menu, header_logo)
-    Ex:
+    Assigns the logos to the collection model. (home_logo, logo_menu, header_logo)
+    Example:

-with open(JWT_PUBLIC_KEY_PATH, "rb") as f:
-    JWT_PUBLIC_KEY_PEM = f.read()
+def get_jwt_public_key_pem():
+    """
+    Reads the JWT public key from the configured path.
+    Returns the key contents as bytes.
+    Raises FileNotFoundError with a clear message if the file is missing.
+    """
+    try:
+        with open(JWT_PUBLIC_KEY_PATH, "rb") as f:
+            return f.read()
+    except FileNotFoundError:
+        raise FileNotFoundError(
+            f"JWT public key file not found at '{JWT_PUBLIC_KEY_PATH}'. "
+            "Please ensure the file exists and the path is correct."
+        )
+    except Exception as e:
+        raise RuntimeError(
+            f"An error occurred while reading the JWT public key file at '{JWT_PUBLIC_KEY_PATH}': {e}"
+        )

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!

robertatakenaka Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

robertatakenaka Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

robertatakenaka Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

robertatakenaka left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 3, 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

samuelveigarangel commented Sep 25, 2025 •

edited

Loading