From 7a76c6239af03e81404a8cf40ea94184ba0bdd2d Mon Sep 17 00:00:00 2001
From: Wilson Neto <wilson.neto@profusion.mobi>
Date: Tue, 17 Sep 2024 09:37:01 -0300
Subject: [PATCH] feat(debug): add SQL query debugging option

Added two environment variables `DEBUG` and `DEBUG_SQL_QUERY` for
debugging. The `DEBUG_SQL_QUERY` variable is separated to control
verbose SQL query logging. Updated settings to handle these variables
and configure logging accordingly.
---
 backend/README.md            |  7 ++++++
 backend/kernelCI/settings.py | 41 +++++++++++++++++++++++++++++++++---
 2 files changed, 45 insertions(+), 3 deletions(-)

diff --git a/backend/README.md b/backend/README.md
index 9e312085..04e854bd 100644
--- a/backend/README.md
+++ b/backend/README.md
@@ -53,3 +53,10 @@ We are not using sessions or anything like that right now, so changing the secre
 
 # Requests
 In the `/requests` directory we have scripts that execute requests to endpoints using [httpie](https://httpie.io/)
+
+
+# Debug
+
+For debugging we have two env variables
+
+`DEBUG` and `DEBUG_SQL_QUERY` that can be set to `True` to enable debugging. The reason `DEBUG_SQL_QUERY` is separated is that it can be very verbose.
\ No newline at end of file
diff --git a/backend/kernelCI/settings.py b/backend/kernelCI/settings.py
index 4ddb8d5d..9e0e6b17 100644
--- a/backend/kernelCI/settings.py
+++ b/backend/kernelCI/settings.py
@@ -48,6 +48,12 @@ def get_json_env_var(name, default):
 if isBooleanOrStringTrue(ENV_DEBUG):
     DEBUG = True
 
+DEBUG_SQL_QUERY = False
+
+ENV_DEBUG_SQL_QUERY = get_json_env_var("DEBUG_SQL_QUERY", False)
+
+if isBooleanOrStringTrue(ENV_DEBUG_SQL_QUERY) and DEBUG:
+    DEBUG_SQL_QUERY = True
 
 SESSION_COOKIE_SECURE = True
 CSRF_COOKIE_SECURE = True
@@ -127,9 +133,9 @@ def get_json_env_var(name, default):
 
 
 CACHES = {
-    'default': {
-        'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
-        'LOCATION': 'ecom',
+    "default": {
+        "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
+        "LOCATION": "ecom",
     }
 }
 
@@ -196,4 +202,33 @@ def __getitem__(self, item):
     SECURE_SSL_REDIRECT = False
     SECURE_HSTS_SECONDS = 3600
 
+if DEBUG_SQL_QUERY:
+    LOGGING = {
+        "disable_existing_loggers": False,
+        "version": 1,
+        "handlers": {
+            "console": {
+                # logging handler that outputs log messages to terminal
+                "class": "logging.StreamHandler",
+                "level": "DEBUG",  # message level to be written to console
+            },
+        },
+        "loggers": {
+            "": {
+                # this sets root level logger to log debug and higher level
+                # logs to console. All other loggers inherit settings from
+                # root level logger.
+                "handlers": ["console"],
+                "level": "DEBUG",
+                "propagate": False,  # this tells logger to send logging message
+                # to its parent (will send if set to True)
+            },
+            "django.db": {
+                # django also has database level logging
+                "level": "DEBUG"
+            },
+        },
+    }
+
+
 CACHE_TIMEOUT = int(get_json_env_var("CACHE_TIMEOUT", "600"))