Add logger (#34)

* Refactor configuration and utility structure

* Implement logging setup and improve error handling

* Add response logging and adjust console log level to WARNING

* Update expected JSON response in index route test

* Disable validation for the entire codebase in super-linter configuration

* Remove unused imports and streamline logging setup message

Author: Vianpyro

.gitignore

@@ -1,3 +1,6 @@
+# Log files
+*.log
+
 # Ignore all pem files
 *.pem
 

app.py

@@ -3,15 +3,19 @@
 
 from flask import Flask, jsonify, request
 from flask_cors import CORS
+from werkzeug.exceptions import HTTPException
 
-from config.settings import Config, limiter
+from config.logging import setup_logging
+from config.ratelimit import limiter
+from config.settings import Config
 from routes import register_routes
 from utility.database import extract_error_message
 
 app = Flask(__name__)
 app.config.from_object(Config)
 CORS(app)
 limiter.init_app(app)
+logger = setup_logging()
 
 if app.config["TESTING"]:
     limiter.enabled = False
@@ -26,16 +30,13 @@ def home():
 register_routes(app)
 
 
-# Add a status field to all JSON responses
 @app.after_request
-def add_status(response):
-    if response.is_json:
-        original_data = response.get_json()
-        new_response = {
-            "success": response.status_code in range(200, 300),
-            "data": original_data if original_data != [] else None,
-        }
-        response.set_data(jsonify(new_response).data)
+def log_response(response):
+    sender = request.remote_addr
+    method = request.method
+    path = request.path
+    status_code = response.status_code
+    logger.info(f"{sender}: {method} {path} {status_code}")
     return response
 
 
@@ -47,6 +48,9 @@ def add_common_headers(response):
 
 @app.errorhandler(429)
 def ratelimit_error(e):
+    logger.warning(
+        f"Rate limit exceeded: {request.method} {request.path} - {e.description}"
+    )
     return (
         jsonify(
             error="Too many requests",
@@ -59,20 +63,11 @@ def ratelimit_error(e):
 
 @app.errorhandler(Exception)
 def handle_exception(e):
-    # If the app is in debug mode, return the full traceback
-    if app.debug:
-        return (
-            jsonify(
-                error="Internal Server Error",
-                message=str(e),
-                type=type(e).__name__,
-                url=request.url,
-                traceback=traceback.format_exc().splitlines(),
-            ),
-            500,
-        )
-
-    # Otherwise, return a more user-friendly error message
+    if isinstance(e, HTTPException):
+        return e
+
+    trace = traceback.format_exc().splitlines()[-1]
+    logger.exception(f"An unhandled exception occurred: {trace}")
     error_message = extract_error_message(str(e))
     return jsonify(error="Internal Server Error", message=error_message), 500
 
@@ -84,4 +79,5 @@ def handle_exception(e):
     )
     args = parser.parse_args()
 
+    logger.info("Starting Flask application...")
     app.run(host="0.0.0.0", port=5000, debug=args.debug)

config/logging.py

@@ -0,0 +1,36 @@
+import datetime
+import logging
+
+
+def setup_logging():
+    logger = logging.getLogger(__name__)
+    logger.setLevel(logging.DEBUG)
+
+    # Generate filename (YYYY-MM-DD-HH-MM-SS.log)
+    timestamp = datetime.datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
+    log_filename = f"{timestamp}.log"
+
+    # Create file handler
+    file_handler = logging.FileHandler(log_filename)
+    file_handler.setLevel(logging.DEBUG)
+
+    # Create console handler
+    console_handler = logging.StreamHandler()
+    console_handler.setLevel(logging.WARNING)
+
+    # Create formatter
+    formatter = logging.Formatter(
+        "%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+        datefmt="%Y-%m-%d %H:%M:%S",
+    )
+
+    # Add formatter to handlers
+    file_handler.setFormatter(formatter)
+    console_handler.setFormatter(formatter)
+
+    # Add handlers to logger
+    logger.addHandler(file_handler)
+    logger.addHandler(console_handler)
+    logger.info("Logging setup complete.")
+
+    return logger

config/ratelimit.py

@@ -0,0 +1,7 @@
+from flask_limiter import Limiter
+from flask_limiter.util import get_remote_address
+
+limiter = Limiter(
+    key_func=get_remote_address,
+    default_limits=["1000 per day", "200 per hour", "30 per minute", "3 per second"],
+)

config/settings.py

@@ -2,13 +2,15 @@
 from datetime import timedelta
 
 from dotenv import load_dotenv
-from flask_limiter import Limiter
-from flask_limiter.util import get_remote_address
 
 # Load environment variables from `.env` file
 load_dotenv()
 
 
+# Pagination configuration
+DEFAULT_PAGE_SIZE = 10
+
+
 class Config:
     # Database configuration
     MYSQL_HOST = os.getenv("DB_HOST", "host.docker.internal")
@@ -29,11 +31,3 @@ class Config:
 
 if not os.path.exists(Config.IMAGES_FOLDER):
     os.makedirs(Config.IMAGES_FOLDER)
-
-# Pagination configuration
-DEFAULT_PAGE_SIZE = 10
-
-limiter = Limiter(
-    key_func=get_remote_address,
-    default_limits=["1000 per day", "200 per hour", "30 per minute", "3 per second"],
-)

routes/authentication.py

@@ -2,7 +2,7 @@
 from flask import Blueprint, jsonify, request
 from pymysql import MySQLError
 
-from config.settings import limiter
+from config.ratelimit import limiter
 from jwt_helper import (
     TokenError,
     extract_token_from_header,

tests/test_routes/test_index.py

@@ -19,7 +19,7 @@ def test_index_route_status_code(client):
 def test_index_route_json(client):
     """Ensure the index route returns the correct JSON response"""
     response = client.get("/")
-    expected_response = {"data": {"message": "Hello there!"}, "success": True}
+    expected_response = {"message": "Hello there!"}
 
     assert response.is_json
     assert response.get_json() == expected_response