Merge branch 'master' of https://github.com/AntonioMrtz/SpotifyElectron into feat/246-Playlist-Update-Fields-To-Change

Author: AntonioMrtz

.github/disabled_workflows/backend-tests-streaming-serverless.yml

@@ -33,6 +33,7 @@ jobs:
           python -m pytest tests/
         env:
           MONGO_URI: mongodb://root:root@localhost:27017/
+          SECRET_KEY_SIGN: "f24e2f3ac557d487b6d879fb2d86f2b2"
           SERVERLESS_FUNCTION_URL: ${{ secrets.SERVERLESS_FUNCTION_URL }}
           ARCH: "SERVERLESS"
           ENV_VALUE: "PROD"

.github/disabled_workflows/generate-docs.yml

@@ -30,6 +30,7 @@ jobs:
           python generate-docs.py
         env:
             MONGO_URI : ${{ secrets.MONGO_URI }}
+            SECRET_KEY_SIGN : none
             SERVERLESS_FUNCTION_URL : none
             ARCH : BLOB
             ENV_VALUE : TEST

.github/disabled_workflows/generate-openapi-schema-client.yml

@@ -30,6 +30,7 @@ jobs:
           python -m app.tools.generate_openapi
         env:
           MONGO_URI: ${{ secrets.MONGO_URI }}
+          SECRET_KEY_SIGN: none
           ARCH: BLOB
           ENV_VALUE: PROD
 

.github/workflows/backend-tests-database-blob.yml

@@ -33,5 +33,6 @@ jobs:
           python -m pytest tests/
         env:
           MONGO_URI: mongodb://root:root@localhost:27017/
+          SECRET_KEY_SIGN: "f24e2f3ac557d487b6d879fb2d86f2b2"
           ARCH: "BLOB"
           ENV_VALUE: "PROD"

.github/workflows/openapi-check-updated.yml

@@ -47,6 +47,7 @@ jobs:
           python -m app.tools.generate_openapi
         env:
           MONGO_URI: mongodb://root:root@localhost:27017/
+          SECRET_KEY_SIGN: "f24e2f3ac557d487b6d879fb2d86f2b2"
           ARCH: "BLOB"
           ENV_VALUE: "PROD"
 

Backend/Dockerfile

@@ -26,4 +26,4 @@ EXPOSE 8000
 # Docker build command
 # docker build -t spotify_electron_backend_image .
 # Docker run command
-# docker run -d --name spotify_electron_backend -e MONGO_URI=mongo-uri SERVERLESS_FUNCTION_URL=serverless-function-url ARCH=BLOB ENV_VALUE=PROD -p 8000:8000 spotify_electron_backend_image
+# docker run -d --name spotify_electron_backend -e MONGO_URI=mongo-uri SECRET_KEY_SIGN=secret-key-sign SERVERLESS_FUNCTION_URL=serverless-function-url ARCH=BLOB ENV_VALUE=PROD -p 8000:8000 spotify_electron_backend_image

Backend/app/__main__.py

@@ -36,7 +36,7 @@
 from app.spotify_electron.song import song_controller
 from app.spotify_electron.song.providers.song_service_provider import SongServiceProvider
 from app.spotify_electron.stream import stream_controller
-from app.spotify_electron.user import user_controller
+from app.spotify_electron.user import base_user_controller
 from app.spotify_electron.user.artist import artist_controller
 
 main_logger = SpotifyElectronLogger(LOGGING_MAIN).getLogger()
@@ -52,10 +52,12 @@ async def lifespan_handler(app: FastAPI) -> AsyncGenerator[None, Any]:
     main_logger.info("Spotify Electron Backend Started")
 
     environment = PropertiesManager.get_environment()
+    secret_key_sign = getattr(PropertiesManager, AppEnvironment.SECRET_KEY_SIGN_ENV_NAME)
     connection_uri = getattr(PropertiesManager, AppEnvironment.MONGO_URI_ENV_NAME)
 
     AuthConfig.init_auth_config(
         access_token_expire_minutes=AppAuthConfig.ACCESS_TOKEN_EXPIRE_MINUTES,
+        secret_key_sign=secret_key_sign,
         verification_algorithm=AppAuthConfig.VERTIFICATION_ALGORITHM,
         days_to_expire_cookie=AppAuthConfig.DAYS_TO_EXPIRE_COOKIE,
     )
@@ -68,7 +70,7 @@ async def lifespan_handler(app: FastAPI) -> AsyncGenerator[None, Any]:
     app.include_router(playlist_controller.router)
     app.include_router(song_controller.router)
     app.include_router(genre_controller.router)
-    app.include_router(user_controller.router)
+    app.include_router(base_user_controller.router)
     app.include_router(artist_controller.router)
     app.include_router(login_controller.router)
     app.include_router(search_controller.router)

Backend/app/auth/auth_schema.py

@@ -2,8 +2,6 @@
 Authentication schema for domain model
 """
 
-import binascii
-import os
 from dataclasses import dataclass
 
 from app.exceptions.base_exceptions_schema import SpotifyElectronException
@@ -24,7 +22,9 @@ class TokenData:
 
 
 class FakeRequest:
-    """Fake Request Object for bypassing authentication token HTTP incoming format"""
+    """Fake Request Object for bypassing authentication token HTTP incoming format
+    TODO this must go with https://trello.com/c/rSvoOwPn/452-jwt-auth-backend-performance-improvements
+    """
 
     headers: dict[str, str] = {}
 
@@ -45,19 +45,20 @@ class AuthConfig:
     def init_auth_config(
         cls,
         verification_algorithm: str,
+        secret_key_sign: str,
         access_token_expire_minutes: int,
         days_to_expire_cookie: int,
     ) -> None:
         """Init authentication configuration, required to start the app successfully
 
         Args:
             verification_algorithm (str): JWT verification algorithm
+            secret_key_sign (str): 32 byte key(16 characters) for signing JWT Tokens that\
+                  will authenticate the user
             access_token_expire_minutes (int): minutes until the JWT expires
             days_to_expire_cookie (int): days until cookies expire
         """
-        random_bytes = os.urandom(16)
-        hex_string = binascii.hexlify(random_bytes).decode("utf-8")
-        cls.SIGNING_SECRET_KEY = hex_string
+        cls.SIGNING_SECRET_KEY = secret_key_sign
 
         cls.VERTIFICATION_ALGORITHM = verification_algorithm
         cls.ACCESS_TOKEN_EXPIRE_MINUTES = access_token_expire_minutes

Backend/app/auth/auth_service.py

@@ -28,10 +28,10 @@
 from app.logging.logging_constants import LOGGING_AUTH_SERVICE
 from app.logging.logging_schema import SpotifyElectronLogger
 from app.spotify_electron.login.login_schema import InvalidCredentialsLoginException
-from app.spotify_electron.user.user.user_schema import (
-    UserDTO,
-    UserNotFoundException,
-    UserServiceException,
+from app.spotify_electron.user.base_user_schema import (
+    BaseUserDTO,
+    BaseUserNotFoundException,
+    BaseUserServiceException,
 )
 from app.spotify_electron.utils.validations.validation_utils import validate_parameter
 
@@ -132,7 +132,7 @@ def get_jwt_token_data(
 
 def get_current_user(
     token: TokenData,
-) -> UserDTO:
+) -> BaseUserDTO:
     """Get current user from JWT Token
 
     Args:
@@ -141,7 +141,7 @@ def get_current_user(
 
     Raises:
     ------
-        UserNotFoundException: token user not found
+        BaseUserNotFoundException: token user not found
         JWTGetUserException: if error while retrieving user from token
     Returns:
         Artist | User: the user or artist associated with the JWT Token
@@ -151,9 +151,9 @@ def get_current_user(
         jwt_username = token.username
 
         user = base_user_service.get_user(jwt_username)
-    except UserNotFoundException as exception:
+    except BaseUserNotFoundException as exception:
         auth_service_logger.exception(f"User {jwt_username} not found")
-        raise UserNotFoundException from exception
+        raise BaseUserNotFoundException from exception
     except Exception as exception:
         auth_service_logger.exception(f"Unexpected exception getting user from token {token}")
         raise JWTGetUserException from exception
@@ -218,7 +218,7 @@ def login_user(name: str, password: str) -> str:
     ------
         InvalidCredentialsLoginException: bad user credentials
         VerifyPasswordException: failing authenticating user and password
-        UserNotFoundException: user doesn't exists
+        BaseUserNotFoundException: user doesn't exists
         UnexpectedLoginUserException: unexpected error during user login
 
     Returns:
@@ -252,10 +252,10 @@ def login_user(name: str, password: str) -> str:
     except CreateJWTException as exception:
         auth_service_logger.exception(f"Error creating JWT Token from data: {jwt_data}")
         raise VerifyPasswordException from exception
-    except UserNotFoundException as exception:
+    except BaseUserNotFoundException as exception:
         auth_service_logger.exception(f"User {name} doesn't exists")
-        raise UserNotFoundException from exception
-    except UserServiceException as exception:
+        raise BaseUserNotFoundException from exception
+    except BaseUserServiceException as exception:
         auth_service_logger.exception(
             f"Unexpected error in User service while login user: {name}"
         )
@@ -276,7 +276,7 @@ def login_user_with_token(raw_token: str) -> None:
 
     Raises:
         JWTValidationException: invalid JWT credentials
-        UserNotFoundException: user doesn't exists
+        BaseUserNotFoundException: user doesn't exists
         UnexpectedLoginUserException: unexpected error during user login
     """
     try:
@@ -288,10 +288,10 @@ def login_user_with_token(raw_token: str) -> None:
     except (JWTValidationException, BadJWTTokenProvidedException) as exception:
         auth_service_logger.exception(f"Error validating jwt token data: {raw_token}")
         raise JWTValidationException from exception
-    except UserNotFoundException as exception:
+    except BaseUserNotFoundException as exception:
         auth_service_logger.exception(f"User {token_data.username} not found")
-        raise UserNotFoundException from exception
-    except UserServiceException as exception:
+        raise BaseUserNotFoundException from exception
+    except BaseUserServiceException as exception:
         auth_service_logger.exception(
             f"Unexpected error in User service while auto login user: {token_data.username}"
         )

Backend/app/common/PropertiesManager.py

@@ -31,6 +31,7 @@ def __init__(self) -> None:
         self.config_sections = [AppConfig.APP_INI_SECTION]
         self.env_variables = [
             AppEnvironment.MONGO_URI_ENV_NAME,
+            AppEnvironment.SECRET_KEY_SIGN_ENV_NAME,
             AppEnvironment.SERVERLESS_URL_ENV_NAME,
             AppEnvironment.ENV_VALUE_ENV_NAME,
         ]

Backend/app/common/app_schema.py

@@ -70,6 +70,7 @@ class AppEnvironment:
     ARCHITECTURE_ENV_NAME = "ARCH"
 
     DEFAULT_ARCHITECTURE = AppArchitecture.ARCH_BLOB
+    SECRET_KEY_SIGN_ENV_NAME = "SECRET_KEY_SIGN"
     MONGO_URI_ENV_NAME = "MONGO_URI"
     SERVERLESS_URL_ENV_NAME = "SERVERLESS_FUNCTION_URL"
     ENV_VALUE_ENV_NAME = "ENV_VALUE"

Backend/app/spotify_electron/login/login_controller.py

@@ -25,7 +25,7 @@
 )
 from app.common.PropertiesMessagesManager import PropertiesMessagesManager
 from app.spotify_electron.login.login_schema import InvalidCredentialsLoginException
-from app.spotify_electron.user.user.user_schema import UserNotFoundException
+from app.spotify_electron.user.base_user_schema import BaseUserNotFoundException
 
 router = APIRouter(
     prefix="/login",
@@ -60,7 +60,7 @@ def login_user(
             status_code=HTTP_403_FORBIDDEN,
             content=PropertiesMessagesManager.loginVerifyPassword,
         )
-    except UserNotFoundException:
+    except BaseUserNotFoundException:
         return Response(
             status_code=HTTP_404_NOT_FOUND,
             content=PropertiesMessagesManager.userNotFound,
@@ -100,7 +100,7 @@ def login_user_with_jwt(token: str) -> Response:
             status_code=HTTP_403_FORBIDDEN,
             content=PropertiesMessagesManager.tokenInvalidCredentialsAutoLogin,
         )
-    except UserNotFoundException:
+    except BaseUserNotFoundException:
         return Response(
             status_code=HTTP_404_NOT_FOUND,
             content=PropertiesMessagesManager.userNotFound,