Added missing logging

Author: Seluj78

backend/PyMatcha/models/notification.py

@@ -23,6 +23,7 @@
 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
@@ -61,6 +62,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}")
         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/routes/api/auth/email.py

@@ -42,49 +42,46 @@
 
 @auth_email_bp.route("/auth/confirm/<token>", methods=["POST"])
 def confirm_email(token):
-    current_app.logger.debug("/auth/confirm/{} -> Call".format(token))
     try:
         email, token_type = confirm_token(token, expiration=7200)
     except (SignatureExpired, BadSignature) as e:
         if e == SignatureExpired:
-            current_app.logger.debug("/auth/confirm -> Signature Expired")
+            current_app.logger.debug(f"Signature Expired for token {token}")
             raise BadRequestError("Signature Expired.", "Request another email confirmation and try again.")
         else:
-            current_app.logger.debug("/auth/confirm -> Bad Expired")
+            current_app.logger.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("/auth/confirm -> Wrong token type")
+            current_app.logger.debug(f"Wrong token type for token {token}")
             raise BadRequestError("Wrong token type.")
         try:
             u = get_user(email)
         except NotFoundError:
-            current_app.logger.debug("/auth/confirm -> User not found")
             raise NotFoundError("User not found.")
         if u.is_confirmed:
-            current_app.logger.debug("/auth/confirm -> User already confirmed")
+            current_app.logger.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("/auth/confirm -> User {} confirmed.".format(u.id))
+        current_app.logger.debug(f"User {u.id} confirmed.")
         return Success("Confirmation successful.")
 
 
 @auth_email_bp.route("/auth/confirm/new", methods=["POST"])
 @validate_params(REQUIRED_KEYS_NEW_EMAIL_CONF)
 def request_new_email_conf():
-    current_app.logger.debug("/auth/confirm/new -> Call")
     data = request.get_json()
     email = data["email"]
     try:
         u = get_user(email)
     except NotFoundError:
-        current_app.logger.debug("/auth/confirm/new -> User not found")
+        pass
     else:
         if u.is_confirmed:
-            current_app.logger.debug("/auth/confirm/new -> User found, Already confirmed.")
+            current_app.logger.debug("Already confirmed.")
         else:
             current_app.logger.debug("/auth/confirm/new -> User found, sending new confirmation email")
             token = generate_confirmation_token(email=email, token_type="confirm")

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

@@ -45,22 +45,22 @@
 @auth_login_bp.route("/auth/login", methods=["POST"])
 @validate_params(REQUIRED_KEYS_LOGIN)
 def auth_login():
-    current_app.logger.debug("/auth/login -> Call")
     data = request.get_json()
     username = data["username"]
     password = data["password"]
     try:
         u = get_user(username)
     except NotFoundError:
-        current_app.logger.debug("/auth/login -> User not found")
+        current_app.logger.debug("User not found for login")
         raise UnauthorizedError("Incorrect username or password.")
     if not check_password(u.password, password):
-        current_app.logger.debug("/auth/login -> Password invalid")
+        current_app.logger.debug("Password invalid for login")
         raise UnauthorizedError("Incorrect username or password.")
 
     if not u.is_confirmed:
-        current_app.logger.debug("/auth/login -> User is trying to login unconfirmed")
+        current_app.logger.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}")
     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("/auth/login -> Returning access token for user {}".format(username))
+    current_app.logger.debug("Returning access token for user {}".format(username))
     u.is_online = True
     u.dt_lastseen = datetime.datetime.utcnow()
     u.save()
@@ -81,6 +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']}")
     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)
@@ -97,4 +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}")
     return Success("Logout successful.")

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

@@ -42,78 +42,74 @@
 @auth_password_bp.route("/auth/password/forgot", methods=["POST"])
 @validate_params(REQUIRED_KEYS_PASSWORD_FORGOT)
 def forgot_password():
-    current_app.logger.debug("/auth/password/forgot -> Call")
     data = request.get_json()
     try:
         get_user(data["email"])
     except NotFoundError:
-        current_app.logger.debug("/auth/password/forgot -> User {} not found, no email sent".format(data["email"]))
+        current_app.logger.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("/auth/password/forgot -> Sending worker request to send email")
+        current_app.logger.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(
-        "/auth/password/forgot -> Password reset mail sent successfully for user {}".format(data["email"])
-    )
+    current_app.logger.debug("Password reset mail sent successfully for user.")
     return Success("Password reset mail sent successfully if user exists in DB.")
 
 
 @auth_password_bp.route("/auth/password/reset", methods=["POST"])
 @validate_params(REQUIRED_KEYS_PASSWORD_RESET)
 def reset_password():
-    current_app.logger.debug("/auth/password/reset -> Call")
     data = request.get_json()
+    token = data["token"]
     try:
-        email, token_type = confirm_token(data["token"], expiration=7200)
+        email, token_type = confirm_token(token, expiration=7200)
     except (SignatureExpired, BadSignature) as e:
         if e == SignatureExpired:
-            current_app.logger.debug("/auth/password/reset -> Signature Expired")
+            current_app.logger.debug(f"Signature Expired for {token}")
             raise BadRequestError("Signature Expired.", "Request another password reset and try again.")
         else:
-            current_app.logger.debug("/auth/password/reset -> Bad Signature")
+            current_app.logger.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("/auth/password/reset -> Wrong token type")
+            current_app.logger.debug(f"Wrong token type for {token}")
             raise BadRequestError("Wrong token type.")
         try:
             u = get_user(email)
         except NotFoundError:
-            current_app.logger.debug("/auth/password/reset -> User not found")
             raise NotFoundError("User not found.")
-        if u.previous_reset_token == data["token"]:
-            current_app.logger.debug("/auth/password/reset -> Token already used")
+        if u.previous_reset_token == token:
+            current_app.logger.debug("Token already used")
             raise BadRequestError("Token already used", "Please request a new one.")
         u.password = hash_password(data["password"])
-        u.previous_reset_token = data["token"]
+        u.previous_reset_token = token
         u.save()
-        current_app.logger.debug("/auth/password/reset -> Password reset successfully")
+        current_app.logger.debug("Password reset successfully")
         return Success("Password reset successful.")
 
 
 @auth_password_bp.route("/auth/password/check_token", methods=["POST"])
 @validate_params({"token": str})
 def check_token_validity():
     data = request.get_json()
+    token = data["token"]
     try:
-        email, token_type = confirm_token(data["token"], expiration=7200)
+        email, token_type = confirm_token(token, expiration=7200)
     except (SignatureExpired, BadSignature) as e:
         if e == SignatureExpired:
-            current_app.logger.debug("/auth/password/reset -> Signature Expired")
+            current_app.logger.debug(f"Signature Expired for {token}")
             raise BadRequestError("Signature Expired.", "Request another password reset and try again.")
         else:
-            current_app.logger.debug("/auth/password/reset -> Bad Signature")
+            current_app.logger.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:
-            current_app.logger.debug("/auth/password/reset -> User not found")
             raise NotFoundError("User not found.")
-        if u.previous_reset_token == data["token"]:
-            current_app.logger.debug("/auth/password/reset -> Token already used")
+        if u.previous_reset_token == token:
+            current_app.logger.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

@@ -36,11 +36,10 @@
 @auth_register_bp.route("/auth/register", methods=["POST"])
 @validate_params(REQUIRED_KEYS_USER_CREATION)
 def api_create_user():
-    current_app.logger.debug("/auth/register -> Call")
     data = request.get_json()
     data["email"] = data["email"].lower()
     try:
-        current_app.logger.debug("Trying to register new user {}, {}".format(data["email"], data["username"]))
+        current_app.logger.debug("Trying to register new user")
         new_user = User.register(
             email=data["email"],
             username=data["username"],
@@ -56,4 +55,5 @@ def api_create_user():
         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.")
         return SuccessOutputMessage("email", new_user.email, "New user successfully created.")

backend/PyMatcha/routes/api/history.py

@@ -1,4 +1,23 @@
+"""
+    PyMatcha - A Python Dating Website
+    Copyright (C) 2018-2019 jlasne/gmorer
+    <jlasne@student.42.fr> - <lauris.skraucis@gmail.com>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+"""
 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
@@ -25,6 +44,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}")
     return SuccessOutput("viewed", viewed_people)
 
 
@@ -43,6 +63,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}")
     return SuccessOutput("viewed_me", viewed_people)
 
 
@@ -61,6 +82,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}")
     return SuccessOutput("liked", liked_people)
 
 
@@ -79,6 +101,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}")
     return SuccessOutput("liked_me", liked_people)
 
 
@@ -97,4 +120,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}")
     return SuccessOutput("blocked", blocked_people)

backend/PyMatcha/routes/api/like.py

@@ -2,6 +2,7 @@
 from datetime import timedelta
 
 from flask import Blueprint
+from flask import current_app
 from flask import request
 from flask_jwt_extended import current_user
 from flask_jwt_extended import jwt_required
@@ -50,6 +51,7 @@ def like_profile(uid):
     Like.create(liker_id=current_user.id, liked_id=u.id, is_superlike=is_superlike)
 
     if u.already_likes(current_user.id):
+        current_app.logger.debug(f"Creating match between user {current_user.id} and {u.id}")
         Match.create(user_1=current_user.id, user_2=u.id)
         Notification.create(
             trigger_id=current_user.id,
@@ -75,6 +77,7 @@ def like_profile(uid):
         return Success("It's a match !")
 
     if is_superlike:
+        current_app.logger.debug(f"Creating superlike between user {current_user.id} and {u.id}")
         Notification.create(
             trigger_id=current_user.id,
             user_id=u.id,
@@ -84,6 +87,7 @@ def like_profile(uid):
         )
         return Success("Superliked user.")
     else:
+        current_app.logger.debug(f"Creating like between user {current_user.id} and {u.id}")
         Notification.create(
             trigger_id=current_user.id,
             user_id=u.id,
@@ -106,15 +110,17 @@ def unlike_profile(uid):
     if not current_user.already_likes(u.id):
         raise BadRequestError("You never liked this person in the first place.")
     Like.get_multi(liked_id=u.id, liker_id=current_user.id).delete()
+    current_app.logger.debug(f"Deleting like between user {current_user.id} and {u.id}")
 
     m1 = Match.get_multi(user_1=u.id, user_2=current_user.id)
     m2 = Match.get_multi(user_1=current_user.id, user_2=u.id)
 
     if m1:
+        current_app.logger.debug(f"Deleting match between user {current_user.id} and {u.id}")
         m1.delete()
     elif m2:
+        current_app.logger.debug(f"Deleting match between user {current_user.id} and {u.id}")
         m2.delete()
-
     Notification.create(
         trigger_id=current_user.id,
         user_id=u.id,

backend/PyMatcha/routes/api/match.py

@@ -1,4 +1,5 @@
 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.utils.success import SuccessOutput
@@ -9,4 +10,5 @@
 @match_bp.route("/matches", methods=["GET"])
 @jwt_required
 def get_user_matches():
+    current_app.logger.debug(f"Getting matches for {current_user.id}")
     return SuccessOutput("matches", [m.to_dict() for m in current_user.get_matches()])