Fixed logging

Author: Seluj78

backend.Dockerfile

@@ -7,4 +7,4 @@ ENV PYTHONDONTWRITEBYTECODE 1
 EXPOSE 5000
 ADD .env .
 RUN export $(cat .env | xargs)
-CMD exec gunicorn --chdir /www --bind :5000 --workers 1 --threads 1 PyMatcha:application
+CMD exec gunicorn --chdir /www --bind :5000 --workers 1 --threads 1 PyMatcha:application --log-level INFO

backend/PyMatcha/__init__.py

@@ -47,7 +47,6 @@
     "FLASK_DEBUG",
     "FLASK_HOST",
     "FLASK_SECRET_KEY",
-    "ENABLE_LOGGING",
     "CELERY_BROKER_URL",
     "CELERY_RESULT_BACKEND",
     "DB_HOST",
@@ -69,7 +68,6 @@
         raise EnvironmentError(f"{item} is not set in the server's environment or .env file. It is required.")
 
 from PyMatcha.utils.static import (
-    ENABLE_LOGGING,
     FLASK_SECRET_KEY,
     CELERY_RESULT_BACKEND,
     CELERY_BROKER_URL,
@@ -83,8 +81,7 @@
     REDIS_HOST,
 )
 
-if ENABLE_LOGGING == "True":
-    setup_logging()
+setup_logging()
 
 sentry_sdk.init(
     dsn="https://bb17c14c99d448e2804bf2f105d4ec52@o450203.ingest.sentry.io/5434438",

backend/PyMatcha/models/notification.py

@@ -23,7 +23,6 @@
 from typing import Dict
 from typing import Optional
 
-from flask import current_app
 from PyMatcha.utils import create_notifications_table
 from PyMatcha.utils.orm import Field
 from PyMatcha.utils.orm import Model
@@ -62,7 +61,7 @@ def create(
             return None
         if not dt_received:
             dt_received = datetime.utcnow()
-        current_app.logger.debug(f"Creating notification for user {user_id} from {trigger_id} with type {type}")
+        logging.debug(f"Creating notification for user {user_id} from {trigger_id} with type {type}")
         new_notif = Notification(
             user_id=user_id, content=content, type=type, link_to=link_to, is_seen=is_seen, dt_received=dt_received
         )

backend/PyMatcha/models/user.py

@@ -272,12 +272,15 @@ def get_likes_sent(self):
         return Like.get_multis(liker_id=self.id)
 
     def get_blocks(self):
+        logging.debug("Getting all blocks for user {}".format(self.id))
         return Block.get_multis(blocker_id=self.id)
 
     def get_all_notifications(self):
+        logging.debug("Getting all notifications for user {}".format(self.id))
         return Notification.get_multis(user_id=self.id)
 
     def get_unread_notifications(self):
+        logging.debug("Getting all unread notifications for user {}".format(self.id))
         return Notification.get_multis(user_id=self.id, is_seen=False)
 
     def already_likes(self, liked_id: int) -> bool:

backend/PyMatcha/routes/api/auth/email.py

@@ -17,9 +17,9 @@
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
 import datetime
+import logging
 
 from flask import Blueprint
-from flask import current_app
 from flask import render_template
 from flask import request
 from itsdangerous import BadSignature
@@ -46,27 +46,27 @@ def confirm_email(token):
         email, token_type = confirm_token(token, expiration=7200)
     except (SignatureExpired, BadSignature) as e:
         if e == SignatureExpired:
-            current_app.logger.debug(f"Signature Expired for token {token}")
+            logging.debug(f"Signature Expired for token {token}")
             raise BadRequestError("Signature Expired.", "Request another email confirmation and try again.")
         else:
-            current_app.logger.debug(f"Bad Expired for token {token}")
+            logging.debug(f"Bad Expired for token {token}")
             raise BadRequestError("Bad Signature.", "Request another password reset and try again.")
     else:
         if token_type != "confirm":
-            current_app.logger.debug(f"Wrong token type for token {token}")
+            logging.debug(f"Wrong token type for token {token}")
             raise BadRequestError("Wrong token type.")
         try:
             u = get_user(email)
         except NotFoundError:
             raise NotFoundError("User not found.")
         if u.is_confirmed:
-            current_app.logger.debug("User already confirmed")
+            logging.debug("User already confirmed")
             raise BadRequestError("Email already confirmed.", "")
         else:
             u.is_confirmed = True
             u.confirmed_on = datetime.datetime.utcnow()
             u.save()
-        current_app.logger.debug(f"User {u.id} confirmed.")
+        logging.debug(f"User {u.id} confirmed.")
         return Success("Confirmation successful.")
 
 
@@ -81,12 +81,12 @@ def request_new_email_conf():
         pass
     else:
         if u.is_confirmed:
-            current_app.logger.debug("Already confirmed.")
+            logging.debug("Already confirmed.")
         else:
-            current_app.logger.debug("/auth/confirm/new -> User found, sending new confirmation email")
+            logging.debug("/auth/confirm/new -> User found, sending new confirmation email")
             token = generate_confirmation_token(email=email, token_type="confirm")
             link = FRONTEND_EMAIL_CONFIRMATION_URL + token
             rendered_html = render_template("confirm_email.html", link=link)
             send_mail_html.delay(dest=data["email"], subject="Confirm your email on PyMatcha", html=rendered_html)
-    current_app.logger.debug("/auth/confirm/new -> New confirmation email sent if user exists in database")
+    logging.debug("/auth/confirm/new -> New confirmation email sent if user exists in database")
     return Success("New confirmation email sent if user exists in database and isn't already confirmed.")

backend/PyMatcha/routes/api/auth/login.py

@@ -17,9 +17,9 @@
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
 import datetime
+import logging
 
 from flask import Blueprint
-from flask import current_app
 from flask import request
 from flask_jwt_extended import create_access_token
 from flask_jwt_extended import create_refresh_token
@@ -51,16 +51,16 @@ def auth_login():
     try:
         u = get_user(username)
     except NotFoundError:
-        current_app.logger.debug("User not found for login")
+        logging.debug("User not found for login")
         raise UnauthorizedError("Incorrect username or password.")
     if not check_password(u.password, password):
-        current_app.logger.debug("Password invalid for login")
+        logging.debug("Password invalid for login")
         raise UnauthorizedError("Incorrect username or password.")
 
     if not u.is_confirmed:
-        current_app.logger.debug("User is trying to login unconfirmed")
+        logging.debug("User is trying to login unconfirmed")
         raise UnauthorizedError("User needs to be confirmed first.", "Try again when you have confirmed your email.")
-    current_app.logger.debug(f"Creating token for {u.id}")
+    logging.debug(f"Creating token for {u.id}")
     access_token = create_access_token(identity=u.get_jwt_info(), fresh=True)
     refresh_token = create_refresh_token(identity=u.get_jwt_info())
     access_jti = get_jti(access_token)
@@ -69,7 +69,7 @@ def auth_login():
     redis.set("is_revoked_jti:" + access_jti, "false", ACCESS_TOKEN_EXPIRES * 1.2)
     redis.set("is_revoked_jti:" + refresh_jti, "false", REFRESH_TOKEN_EXPIRES * 1.2)
 
-    current_app.logger.debug("Returning access token for user {}".format(username))
+    logging.debug("Returning access token for user {}".format(username))
     u.is_online = True
     u.dt_lastseen = datetime.datetime.utcnow()
     u.save()
@@ -81,7 +81,7 @@ def auth_login():
 @jwt_refresh_token_required
 def refresh():
     current_user = get_jwt_identity()
-    current_app.logger.info(f"Refreshing token for {current_user['id']}")
+    logging.info(f"Refreshing token for {current_user['id']}")
     access_token = create_access_token(identity=current_user)
     access_jti = get_jti(encoded_token=access_token)
     redis.set("is_revoked_jti:" + access_jti, "false", ACCESS_TOKEN_EXPIRES * 1.2)
@@ -98,5 +98,5 @@ def logout():
     refresh_jti = get_jti(refresh_token)
     redis.set("is_revoked_jti:" + access_jti, "true", ACCESS_TOKEN_EXPIRES * 1.2)
     redis.set("is_revoked_jti:" + refresh_jti, "true", REFRESH_TOKEN_EXPIRES * 1.2)
-    current_app.logger.info(f"Revoked tokens with jtis {access_jti}, {refresh_jti}")
+    logging.info(f"Revoked tokens with jtis {access_jti}, {refresh_jti}")
     return Success("Logout successful.")

backend/PyMatcha/routes/api/auth/password.py

@@ -16,8 +16,9 @@
     You should have received a copy of the GNU General Public License
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
+import logging
+
 from flask import Blueprint
-from flask import current_app
 from flask import render_template
 from flask import request
 from itsdangerous import BadSignature
@@ -46,15 +47,15 @@ def forgot_password():
     try:
         get_user(data["email"])
     except NotFoundError:
-        current_app.logger.debug("User not found, no email sent")
+        logging.debug("User not found, no email sent")
         pass
     else:
         token = generate_confirmation_token(email=data["email"], token_type="reset")
         link = FRONTEND_PASSWORD_RESET_URL + token
         rendered_html = render_template("password_reset.html", link=link)
-        current_app.logger.debug("Sending worker request to send email")
+        logging.debug("Sending worker request to send email")
         send_mail_html.delay(dest=data["email"], subject="Reset your password on PyMatcha", html=rendered_html)
-    current_app.logger.debug("Password reset mail sent successfully for user.")
+    logging.debug("Password reset mail sent successfully for user.")
     return Success("Password reset mail sent successfully if user exists in DB.")
 
 
@@ -67,26 +68,26 @@ def reset_password():
         email, token_type = confirm_token(token, expiration=7200)
     except (SignatureExpired, BadSignature) as e:
         if e == SignatureExpired:
-            current_app.logger.debug(f"Signature Expired for {token}")
+            logging.debug(f"Signature Expired for {token}")
             raise BadRequestError("Signature Expired.", "Request another password reset and try again.")
         else:
-            current_app.logger.debug(f"Bad Signature for {token}")
+            logging.debug(f"Bad Signature for {token}")
             raise BadRequestError("Bad Signature.", "Request another password reset and try again.")
     else:
         if token_type != "reset":
-            current_app.logger.debug(f"Wrong token type for {token}")
+            logging.debug(f"Wrong token type for {token}")
             raise BadRequestError("Wrong token type.")
         try:
             u = get_user(email)
         except NotFoundError:
             raise NotFoundError("User not found.")
         if u.previous_reset_token == token:
-            current_app.logger.debug("Token already used")
+            logging.debug("Token already used")
             raise BadRequestError("Token already used", "Please request a new one.")
         u.password = hash_password(data["password"])
         u.previous_reset_token = token
         u.save()
-        current_app.logger.debug("Password reset successfully")
+        logging.debug("Password reset successfully")
         return Success("Password reset successful.")
 
 
@@ -99,17 +100,17 @@ def check_token_validity():
         email, token_type = confirm_token(token, expiration=7200)
     except (SignatureExpired, BadSignature) as e:
         if e == SignatureExpired:
-            current_app.logger.debug(f"Signature Expired for {token}")
+            logging.debug(f"Signature Expired for {token}")
             raise BadRequestError("Signature Expired.", "Request another password reset and try again.")
         else:
-            current_app.logger.debug(f"Bad Signature for {token}")
+            logging.debug(f"Bad Signature for {token}")
             raise BadRequestError("Bad Signature.", "Request another password reset and try again.")
     else:
         try:
             u = get_user(email)
         except NotFoundError:
             raise NotFoundError("User not found.")
         if u.previous_reset_token == token:
-            current_app.logger.debug("Token already used")
+            logging.debug("Token already used")
             raise BadRequestError("Token already used", "Please request a new one.")
         return Success("Reset token is correct.")

backend/PyMatcha/routes/api/auth/register.py

@@ -16,8 +16,9 @@
     You should have received a copy of the GNU General Public License
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
+import logging
+
 from flask import Blueprint
-from flask import current_app
 from flask import render_template
 from flask import request
 from PyMatcha.models.user import User
@@ -39,7 +40,7 @@ def api_create_user():
     data = request.get_json()
     data["email"] = data["email"].lower()
     try:
-        current_app.logger.debug("Trying to register new user")
+        logging.debug("Trying to register new user")
         new_user = User.register(
             email=data["email"],
             username=data["username"],
@@ -48,12 +49,12 @@ def api_create_user():
             last_name=data["last_name"],
         )
     except ConflictError as e:
-        current_app.logger.warning("Conflict error on user register: {}".format(e))
+        logging.warning("Conflict error on user register: {}".format(e))
         raise e
     else:
         token = generate_confirmation_token(email=data["email"], token_type="confirm")
         link = FRONTEND_EMAIL_CONFIRMATION_URL + token
         rendered_html = render_template("confirm_email.html", link=link)
         send_mail_html.delay(dest=data["email"], subject="Confirm your email on PyMatcha", html=rendered_html)
-        current_app.logger.info("Registered new user successfully.")
+        logging.info("Registered new user successfully.")
         return SuccessOutputMessage("email", new_user.email, "New user successfully created.")

backend/PyMatcha/routes/api/debug.py

@@ -1,7 +1,7 @@
 import datetime
+import logging
 
 from flask import Blueprint
-from flask import current_app
 from flask import jsonify
 from flask import request
 from flask_jwt_extended import current_user
@@ -34,19 +34,19 @@ def debug_confirm_user(uid):
     """
     This route confirms a given user without having to send and receive an email
     """
-    current_app.logger.debug("/debug/users/confirm/{} -> Call".format(uid))
+    logging.debug("/debug/users/confirm/{} -> Call".format(uid))
     try:
         u = get_user(uid)
     except NotFoundError:
-        current_app.logger.debug("/debug/users/confirm -> User not found")
+        logging.debug("/debug/users/confirm -> User not found")
         raise NotFoundError("User {} not found".format(uid))
     if u.is_confirmed:
-        current_app.logger.debug("/debug/users/confirm -> User already confirmed")
+        logging.debug("/debug/users/confirm -> User already confirmed")
         return Success("User already confirmed.")
     u.is_confirmed = True
     u.confirmed_on = datetime.datetime.utcnow()
     u.save()
-    current_app.logger.debug("/debug/users/confirm -> User {} confirmed.".format(u.id))
+    logging.debug("/debug/users/confirm -> User {} confirmed.".format(u.id))
     return Success("User successfully confirmed.")
 
 

backend/PyMatcha/routes/api/history.py

@@ -16,8 +16,9 @@
     You should have received a copy of the GNU General Public License
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
+import logging
+
 from flask import Blueprint
-from flask import current_app
 from flask_jwt_extended import current_user
 from flask_jwt_extended import jwt_required
 from PyMatcha.models.user import User
@@ -44,7 +45,7 @@ def history_viewed_people():
         user_dict["common_tags"] = common_tags
         user_dict["distance"] = distance
         viewed_people.append(user_dict)
-    current_app.logger.info(f"Returning viewed profiles for user {current_user.id}")
+    logging.info(f"Returning viewed profiles for user {current_user.id}")
     return SuccessOutput("viewed", viewed_people)
 
 
@@ -63,7 +64,7 @@ def history_viewed_me():
         user_dict["common_tags"] = common_tags
         user_dict["distance"] = distance
         viewed_people.append(user_dict)
-    current_app.logger.info(f"Returning profiles who viewed user {current_user.id}")
+    logging.info(f"Returning profiles who viewed user {current_user.id}")
     return SuccessOutput("viewed_me", viewed_people)
 
 
@@ -82,7 +83,7 @@ def history_liked_people():
         user_dict["common_tags"] = common_tags
         user_dict["distance"] = distance
         liked_people.append(user_dict)
-    current_app.logger.info(f"Returning liked profiles for user {current_user.id}")
+    logging.info(f"Returning liked profiles for user {current_user.id}")
     return SuccessOutput("liked", liked_people)
 
 
@@ -101,7 +102,7 @@ def history_liked_me():
         user_dict["common_tags"] = common_tags
         user_dict["distance"] = distance
         liked_people.append(user_dict)
-    current_app.logger.info(f"Returning profiles who liked user {current_user.id}")
+    logging.info(f"Returning profiles who liked user {current_user.id}")
     return SuccessOutput("liked_me", liked_people)
 
 
@@ -120,5 +121,5 @@ def history_blocked():
         user_dict["common_tags"] = common_tags
         user_dict["distance"] = distance
         blocked_people.append(user_dict)
-    current_app.logger.info(f"Returning blocked profiles for user {current_user.id}")
+    logging.info(f"Returning blocked profiles for user {current_user.id}")
     return SuccessOutput("blocked", blocked_people)