Feature/logging app config by jvras58 · Pull Request #11 · jvras58/FastCrud

jvras58 · 2026-02-07T01:29:20Z

This pull request introduces comprehensive logging improvements across the authentication, authorization, assignment, and role API modules, enhancing observability and traceability of user actions and system events. Additionally, it updates the CI workflow to use the latest tools and simplifies environment variable management. The most important changes are grouped below:

Logging Enhancements Across API Modules:

Added structured logging to all key actions in assignment, authorization, authentication, and role routers and controllers, including creation, update, deletion, fetching, and listing of resources, as well as authentication and access validation. This includes logging both successful operations and warnings for failures or unauthorized actions. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [21] [22] [23] [24] [25]

CI Workflow Modernization:

Updated .github/workflows/ci.yml to use uv for dependency management and testing, replaced actions/checkout@v3 with v4, removed Poetry setup, and ensured environment variables are set for test runs.

Environment Variable Cleanup:

Removed redundant PostgreSQL environment variables from .env-prod.semple, keeping only the DB_URL for clarity and consistency.

These changes collectively improve system reliability, make debugging easier, and modernize the development workflow.

…e funções de papel

…torização

…veis de ambiente

…o User

…ss the application - Updated logger messages in authentication, authorization, role, transaction, user, and generic controller modules to use single quotes. - Adjusted string formatting in various logging statements for improved readability. - Ensured consistency in exception messages and logging throughout the application.

…definir postgres_*

Copilot

Pull request overview

This PR aims to improve observability across the FastAPI app by adding structured logging to core routers/controllers, centralizing logging configuration, and modernizing CI/environment configuration.

Changes:

Introduces a centralized logging setup (app/utils/logging.py) and adds log statements across multiple API modules and controllers.
Updates CI to use uv instead of Poetry and adjusts environment variables for test runs.
Cleans up environment configuration samples and tweaks local Docker Compose configuration.

Reviewed changes

Copilot reviewed 24 out of 25 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
tests/conftest.py	Attempts to raise logging level during tests via env vars.
seeds/seed_transactions.py	Refactors seed data quoting; still seeds operation codes.
seeds/seed_super_user.py	Minor string quoting change.
pyproject.toml	Updates project metadata and dependencies (incl. FastAPI version bump, adds pyjwt).
compose.yml	Hardcodes Postgres container credentials and updates healthcheck accordingly.
app/utils/settings.py	Adds logging-related settings and removes unused setting.
app/utils/logging.py	Adds centralized logging configuration utilities.
app/utils/generic_controller.py	Adds logging around CRUD operations in the generic controller.
app/utils/exceptions.py	Fixes malformed module docstring.
app/startup.py	Calls logging setup during app import and normalizes quoting.
app/models/user.py	Removes `ProcessedText` relationship/type-check import.
app/api/user/router.py	Adds logging for user CRUD endpoints and access-related actions.
app/api/user/controller.py	Adds logging around user lookups and password hashing.
app/api/transaction/router.py	Adds logging for transaction CRUD endpoints.
app/api/transaction/enum_operation_code.py	Removes `OP_2000001` enum constant.
app/api/role/router.py	Adds logging for role CRUD endpoints.
app/api/authorization/router.py	Adds logging for authorization CRUD endpoints.
app/api/authorization/middleware.py	Adds request timing logging to middleware.
app/api/authorization/controller.py	Adds logging for access validation and authorization lookup counts.
app/api/authentication/router.py	Adds logging around login attempts/failures.
app/api/authentication/controller.py	Adds logging for authentication/token validation flows.
app/api/assignment/router.py	Adds logging for assignment CRUD endpoints.
.github/workflows/ci.yml	Switches CI to `uv`, updates checkout action, and sets env vars.
.env-prod.semple	Removes redundant Postgres vars, keeping `DB_URL` and security/swagger vars.

Copilot · 2026-02-07T01:37:31Z

 """Application startup and configuration."""
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
+from utils.logging import setup_logging


setup_logging is imported from utils.logging, but there is no top-level utils/ package in the repo (only app/utils). This will raise ModuleNotFoundError when importing app.startup. Import it from app.utils.logging (or otherwise make the package layout consistent).

Suggested change

from utils.logging import setup_logging

from app.utils.logging import setup_logging

Copilot · 2026-02-07T01:37:32Z

 from sqlalchemy import String, and_, select
 from sqlalchemy.exc import IntegrityError
 from sqlalchemy.orm import Session
+from utils.logging import get_logger


This imports get_logger from utils.logging, but the codebase uses app.utils.* imports and there is no top-level utils package. This will break at import time; switch to from app.utils.logging import get_logger (or align the package structure consistently).

Suggested change

from utils.logging import get_logger

from app.utils.logging import get_logger

Copilot · 2026-02-07T01:37:32Z

+import logging.handlers
+from pathlib import Path
+
+from utils.settings import get_settings


This module imports get_settings from utils.settings, but the settings live under app/utils/settings.py and there is no top-level utils package. As written, importing app.utils.logging will fail with ModuleNotFoundError. Update the import to app.utils.settings (and keep imports consistent across the project).

Suggested change

from utils.settings import get_settings

from app.utils.settings import get_settings

Copilot · 2026-02-07T01:37:32Z

+settings = get_settings()
+


settings = get_settings() is assigned at import time but never used, and setup_logging() repeatedly calls get_settings() instead. Either remove the unused settings variable or use it consistently to avoid extra lookups and to keep module import side-effects minimal.

Copilot · 2026-02-07T01:37:32Z

+# TODO: Desligar logs durante os testes, ou configurar para um nível mais alto
+os.environ.setdefault("LOG_LEVEL", "CRITICAL")
+os.environ.setdefault("LOG_CONSOLE_LEVEL", "CRITICAL")


These os.environ.setdefault(...) calls happen after from app.startup import app (line 16). Since app.startup now calls setup_logging() at import time, logging will already be configured before these env vars are applied, so this won’t actually silence logs in tests. Move the env configuration above the app.startup import (or configure logging via pytest/logging config).

Copilot · 2026-02-07T01:37:33Z

+                'operation_code': EnumOperationCode.OP_2000001.value,
+                'name': 'Data Processing - Execute',
+                'description': 'Perform data processing with AI',
+                'audit_user_ip': '0.0.0.0',
+                'audit_user_login': 'system',
            },


EnumOperationCode.OP_2000001 is referenced here, but OP_2000001 was removed from EnumOperationCode in this PR. Seeding will crash with AttributeError. Either re-add the enum value or remove/update this seed entry to match the enum.

Copilot · 2026-02-07T01:37:33Z

+            logger.warning(
+                f'Object {self.model.__name__} with ID {obj_id} not found.'
+            )
            raise ObjectNotFoundException(self.model.__name__, str(obj_id))


The newly added log messages use f-strings (e.g., f'Object ... {obj_id} ...'). Prefer logger parameterization (logger.info('...', arg)) to avoid eager string formatting when the log level is disabled, especially in a generic controller used across the app.

Copilot · 2026-02-07T01:37:33Z

+      POSTGRES_USER: fastapi_user
+      POSTGRES_PASSWORD: fastapi_password
+      POSTGRES_DB: fastapi
    volumes:
      - postgres_data:/var/lib/postgresql/data
    ports:
      - "5433:5432"
    healthcheck:
-      test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER} -d ${POSTGRES_DB}"]
+      test: ["CMD-SHELL", "pg_isready -U fastapi_user -d fastapi"]


Postgres credentials are now hardcoded in compose.yml. This reduces flexibility and can lead to accidental reuse of weak credentials across environments. Prefer ${POSTGRES_USER:-fastapi_user}-style defaults (and keep the healthcheck in sync) so users can override via .env without editing the compose file.

jvras58 added 15 commits February 5, 2026 22:58

feat: adicionar configuração de logging e integrar no aplicativo

6d09b6b

feat: traduzir comentários de configuração de logging para inglês

1ff1195

feat: adicionar logging para operações CRUD no GenericController

32364d8

feat: adicionar logging detalhado nas operações das routes

0e86cc4

fix: corrigir a definição do código de operação para a visualização d…

e940829

…e funções de papel

feat: adicionar logging detalhado em controladores e middleware de au…

30cf9c1

…torização

feat: atualizar configuração do CI para uso de uv e simplificar variá…

0517148

…veis de ambiente

refactor: remover importação e relacionamento não utilizados no model…

ef2905d

…o User

chore: update configuration for FastAPI

e15ac69

fix(pyproject): rename project to avoid PyPI fastapi name clash

ebb2d5d

fix: corrigir importação de erro JWT para usar a biblioteca correta

dca37aa

chore: atualizar configurações de ambiente do .env para não precisar …

f1cb311

…definir postgres_*

refactor: ajustar aspas para consistência nas configurações do modelo

8cf9ac1

chore: adicionar configuração de nível de log para testes

c6accb4

Copilot AI review requested due to automatic review settings February 7, 2026 01:29

Copilot started reviewing on behalf of jvras58 February 7, 2026 01:29 View session

jvras58 merged commit 731573c into main Feb 7, 2026
5 checks passed

Copilot AI reviewed Feb 7, 2026

View reviewed changes

jvras58 deleted the feature/logging_app_config branch February 7, 2026 22:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/logging app config#11

Feature/logging app config#11
jvras58 merged 15 commits into
mainfrom
feature/logging_app_config

jvras58 commented Feb 7, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 7, 2026

Uh oh!

Copilot AI Feb 7, 2026

Uh oh!

Copilot AI Feb 7, 2026

Uh oh!

Copilot AI Feb 7, 2026

Uh oh!

Copilot AI Feb 7, 2026

Uh oh!

Copilot AI Feb 7, 2026

Uh oh!

Copilot AI Feb 7, 2026

Uh oh!

Copilot AI Feb 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	from utils.logging import setup_logging
	from app.utils.logging import setup_logging

	from utils.logging import get_logger
	from app.utils.logging import get_logger

	from utils.settings import get_settings
	from app.utils.settings import get_settings

Conversation

jvras58 commented Feb 7, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants