refactor: rename STREAMING_SERVERLESS with SERVERLESS | [AntonioMrtz#222]

AntonioMrtz · AntonioMrtz · commit 662bcc940ab5 · 2024-09-22T17:52:34.000+02:00
diff --git a/.github/disabled_workflows/backend-tests-streaming-serverless.yml b/.github/disabled_workflows/backend-tests-streaming-serverless.yml
@@ -7,7 +7,7 @@ on:
       - 'master-*'
 
 jobs:
-  run_tests_streaming_serverless:
+  run_tests_serverless:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -35,5 +35,5 @@ jobs:
           MONGO_URI: mongodb://root:root@localhost:27017/
           SECRET_KEY_SIGN: "f24e2f3ac557d487b6d879fb2d86f2b2"
           SERVERLESS_FUNCTION_URL: ${{ secrets.SERVERLESS_FUNCTION_URL }}
-          ARCH: "STREAMING_SERVERLESS"
+          ARCH: "SERVERLESS"
           ENV_VALUE: "PROD"
diff --git a/AWS-Lambda-API/ruff.toml b/AWS-Lambda-API/ruff.toml
diff --git a/Backend/.env.local b/Backend/.env.local
@@ -5,5 +5,5 @@ SECRET_KEY_SIGN=f24e2f3ac557d487b6d879fb2d86f2b2
 SERVERLESS_FUNCTION_URL=https://lambda-url.us-east-1.on.aws/path/
 # PROD,DEV
 ENV_VALUE=DEV
-# BLOB,STREAMING_SERVERLESS
+# BLOB,SERVERLESS
 ARCH=BLOB
diff --git a/Backend/app/common/PropertiesManager.py b/Backend/app/common/PropertiesManager.py
@@ -32,7 +32,7 @@ def __init__(self) -> None:
         self.env_variables = [
             AppEnvironment.MONGO_URI_ENV_NAME,
             AppEnvironment.SECRET_KEY_SIGN_ENV_NAME,
-            AppEnvironment.SERVERLESS_STREAMING_URL_ENV_NAME,
+            AppEnvironment.SERVERLESS_URL_ENV_NAME,
             AppEnvironment.ENV_VALUE_ENV_NAME,
         ]
         self._load_env_variables(self.env_variables)
diff --git a/Backend/app/common/app_schema.py b/Backend/app/common/app_schema.py
@@ -53,7 +53,7 @@ class AppArchitecture:
     """App architecture constants"""
 
     ARCH_BLOB = "BLOB"
-    ARCH_STREAMING_SERVERLESS = "STREAMING_SERVERLESS"
+    ARCH_SERVERLESS = "SERVERLESS"
 
 
 class AppEnvironment:
@@ -64,5 +64,5 @@ class AppEnvironment:
     DEFAULT_ARCHITECTURE = AppArchitecture.ARCH_BLOB
     SECRET_KEY_SIGN_ENV_NAME = "SECRET_KEY_SIGN"
     MONGO_URI_ENV_NAME = "MONGO_URI"
-    SERVERLESS_STREAMING_URL_ENV_NAME = "SERVERLESS_FUNCTION_URL"
+    SERVERLESS_URL_ENV_NAME = "SERVERLESS_FUNCTION_URL"
     ENV_VALUE_ENV_NAME = "ENV_VALUE"
diff --git a/Backend/app/logging/logging_constants.py b/Backend/app/logging/logging_constants.py
@@ -38,9 +38,9 @@
 LOGGING_BASE_SONG_SERVICE = "BASE_SONG_SERVICE"
 LOGGING_BASE_SONG_REPOSITORY = "BASE_SONG_REPOSITORY"
 
-LOGGING_SONG_AWS_SERVERLESS_REPOSITORY = "SONG_AWS_SERVERLESS_REPOSITORY"
-LOGGING_SONG_AWS_SERVERLESS_SERVICE = "SONG_AWS_SERVERLESS_SERVICE"
-LOGGING_SONG_AWS_SERVERLESS_SERVICE_VALIDATIONS = "SONG_AWS_SERVERLESS_SERVICE_VALIDATIONS"
+LOGGING_SONG_SERVERLESS_REPOSITORY = "SONG_SERVERLESS_REPOSITORY"
+LOGGING_SONG_SERVERLESS_SERVICE = "SONG_SERVERLESS_SERVICE"
+LOGGING_SONG_SERVERLESS_SERVICE_VALIDATIONS = "SONG_SERVERLESS_SERVICE_VALIDATIONS"
 
 LOGGING_SONG_BLOB_REPOSITORY = "SONG_BLOB_REPOSITORY"
 LOGGING_SONG_BLOB_SERVICE = "SONG_BLOB_SERVICE"
diff --git a/Backend/app/spotify_electron/song/providers/song_collection_provider.py b/Backend/app/spotify_electron/song/providers/song_collection_provider.py
@@ -22,7 +22,7 @@ def get_song_collection() -> Collection:
         AppArchitecture.ARCH_BLOB: DatabaseConnectionManager.get_collection_connection(
             DatabaseCollection.SONG_BLOB_FILE
         ),
-        AppArchitecture.ARCH_STREAMING_SERVERLESS: DatabaseConnectionManager.get_collection_connection(  # noqa: E501
+        AppArchitecture.ARCH_SERVERLESS: DatabaseConnectionManager.get_collection_connection(  # noqa: E501
             DatabaseCollection.SONG_STREAMING
         ),
     }
diff --git a/Backend/app/spotify_electron/song/providers/song_service_provider.py b/Backend/app/spotify_electron/song/providers/song_service_provider.py
@@ -12,7 +12,7 @@
 from app.spotify_electron.song.song_service_constants import (
     MODULE_PREFIX_NAME,
     SONG_SERVICE_BLOB_MODULE_NAME,
-    SONG_SERVICE_STREAMING_SERVERLESS_MODULE_NAME,
+    SONG_SERVICE_SERVERLESS_MODULE_NAME,
 )
 
 
@@ -27,7 +27,7 @@ def init_service(cls) -> None:
         cls.logger = SpotifyElectronLogger(LOGGING_SONG_SERVICE_PROVIDER).getLogger()
         cls.song_services = {
             AppArchitecture.ARCH_BLOB: SONG_SERVICE_BLOB_MODULE_NAME,
-            AppArchitecture.ARCH_STREAMING_SERVERLESS: SONG_SERVICE_STREAMING_SERVERLESS_MODULE_NAME,  # noqa: E501
+            AppArchitecture.ARCH_SERVERLESS: SONG_SERVICE_SERVERLESS_MODULE_NAME,  # noqa: E501
         }
         cls.create_song_service()
 
diff --git a/Backend/app/spotify_electron/song/serverless/song_repository.py b/Backend/app/spotify_electron/song/serverless/song_repository.py
@@ -7,7 +7,7 @@
 
 import app.spotify_electron.song.providers.song_collection_provider as song_collection_provider
 from app.logging.logging_constants import (
-    LOGGING_SONG_AWS_SERVERLESS_REPOSITORY,
+    LOGGING_SONG_SERVERLESS_REPOSITORY,
 )
 from app.logging.logging_schema import SpotifyElectronLogger
 from app.spotify_electron.genre.genre_schema import Genre
@@ -25,9 +25,7 @@
     validate_song_exists,
 )
 
-song_repository_logger = SpotifyElectronLogger(
-    LOGGING_SONG_AWS_SERVERLESS_REPOSITORY
-).getLogger()
+song_repository_logger = SpotifyElectronLogger(LOGGING_SONG_SERVERLESS_REPOSITORY).getLogger()
 
 
 def get_song(name: str) -> SongDAO:
diff --git a/Backend/app/spotify_electron/song/serverless/song_serverless_api.py b/Backend/app/spotify_electron/song/serverless/song_serverless_api.py
@@ -1,5 +1,5 @@
 """
-API to comunicate with AWS Serverless function that handles song files in Cloud
+API to comunicate with Serverless function that handles song files in Cloud
 """
 
 from requests import Response, delete, get, post
@@ -15,7 +15,7 @@ def get_song(song_name: str) -> Response:
         song_name (str): song name
     """
     response = get(
-        f"{getattr(PropertiesManager,AppEnvironment.SERVERLESS_STREAMING_URL_ENV_NAME)}",
+        f"{getattr(PropertiesManager,AppEnvironment.SERVERLESS_URL_ENV_NAME)}",
         params={
             "nombre": song_name,
         },
@@ -34,7 +34,7 @@ def create_song(song_name: str, encoded_bytes: str) -> Response:
         "file": encoded_bytes,
     }
     response = post(
-        f"{getattr(PropertiesManager,AppEnvironment.SERVERLESS_STREAMING_URL_ENV_NAME)}",
+        f"{getattr(PropertiesManager,AppEnvironment.SERVERLESS_URL_ENV_NAME)}",
         json=request_data_body,
         params={"nombre": song_name},
     )
@@ -48,7 +48,7 @@ def delete_song(song_name: str) -> Response:
         song_name (str): song name
     """
     response = delete(
-        f"{getattr(PropertiesManager,AppEnvironment.SERVERLESS_STREAMING_URL_ENV_NAME)}",
+        f"{getattr(PropertiesManager,AppEnvironment.SERVERLESS_URL_ENV_NAME)}",
         params={
             "nombre": song_name,
         },
diff --git a/Backend/app/spotify_electron/song/serverless/song_service.py b/Backend/app/spotify_electron/song/serverless/song_service.py
@@ -10,7 +10,7 @@
     TokenData,
     UserUnauthorizedException,
 )
-from app.logging.logging_constants import LOGGING_SONG_AWS_SERVERLESS_SERVICE
+from app.logging.logging_constants import LOGGING_SONG_SERVERLESS_SERVICE
 from app.logging.logging_schema import SpotifyElectronLogger
 from app.spotify_electron.genre.genre_schema import Genre, GenreNotValidException
 from app.spotify_electron.song.base_song_schema import (
@@ -53,7 +53,7 @@
     get_song_duration_seconds,
 )
 
-song_service_logger = SpotifyElectronLogger(LOGGING_SONG_AWS_SERVERLESS_SERVICE).getLogger()
+song_service_logger = SpotifyElectronLogger(LOGGING_SONG_SERVERLESS_SERVICE).getLogger()
 
 
 def get_song_streaming_url(name: str) -> str:
diff --git a/Backend/app/spotify_electron/song/serverless/validations/song_service_validations.py b/Backend/app/spotify_electron/song/serverless/validations/song_service_validations.py
@@ -1,12 +1,12 @@
 """
-Validations for AWS Serverless function Song service
+Validations for Serverless function Song service
 """
 
 from requests import Response
 from starlette.status import HTTP_200_OK, HTTP_201_CREATED, HTTP_202_ACCEPTED
 
 from app.logging.logging_constants import (
-    LOGGING_SONG_AWS_SERVERLESS_SERVICE_VALIDATIONS,
+    LOGGING_SONG_SERVERLESS_SERVICE_VALIDATIONS,
 )
 from app.logging.logging_schema import SpotifyElectronLogger
 from app.spotify_electron.song.serverless.song_schema import (
@@ -16,7 +16,7 @@
 )
 
 song_service_logger = SpotifyElectronLogger(
-    LOGGING_SONG_AWS_SERVERLESS_SERVICE_VALIDATIONS
+    LOGGING_SONG_SERVERLESS_SERVICE_VALIDATIONS
 ).getLogger()
 
 
diff --git a/Backend/app/spotify_electron/song/song_service_constants.py b/Backend/app/spotify_electron/song/song_service_constants.py
@@ -3,5 +3,5 @@
 """
 
 MODULE_PREFIX_NAME = "app.spotify_electron.song."
-SONG_SERVICE_STREAMING_SERVERLESS_MODULE_NAME = "serverless.song_service"
+SONG_SERVICE_SERVERLESS_MODULE_NAME = "serverless.song_service"
 SONG_SERVICE_BLOB_MODULE_NAME = "blob.song_service"
diff --git a/Backend/tests/test__properties_manager.py b/Backend/tests/test__properties_manager.py
@@ -8,7 +8,7 @@
     AppEnvironment.ARCHITECTURE_ENV_NAME: "ARCH",
     AppEnvironment.SECRET_KEY_SIGN_ENV_NAME: "SECRET_KEY_SIGN",
     AppEnvironment.MONGO_URI_ENV_NAME: "MONGO_URI",
-    AppEnvironment.SERVERLESS_STREAMING_URL_ENV_NAME: "SERVERLESS_FUNCTION_URL",
+    AppEnvironment.SERVERLESS_URL_ENV_NAME: "SERVERLESS_FUNCTION_URL",
     AppEnvironment.ENV_VALUE_ENV_NAME: "ENV_VALUE",
 }
 
diff --git a/Electron/src/__tests__/components/Footer/PlayerFiles.test.tsx b/Electron/src/__tests__/components/Footer/PlayerFiles.test.tsx
@@ -1,7 +1,7 @@
 import '@testing-library/jest-dom';
 import '@testing-library/jest-dom/extend-expect';
 import { render } from '@testing-library/react';
-import PlayerFiles from 'components/footer/Player/PlayerStreamingFiles';
+import PlayerFiles from 'components/footer/Player/PlayerFiles';
 import Global from 'global/global';
 import UserType from 'utils/role';
 import { act } from 'react-test-renderer';
diff --git a/Electron/src/__tests__/components/Footer/PlayerServerless.test.tsx b/Electron/src/__tests__/components/Footer/PlayerServerless.test.tsx
@@ -1,7 +1,7 @@
 import '@testing-library/jest-dom';
 import '@testing-library/jest-dom/extend-expect';
 import { render } from '@testing-library/react';
-import PlayerStreaming from 'components/footer/Player/PlayerStreaming';
+import PlayerServerless from 'components/footer/Player/PlayerServerless';
 import Global from 'global/global';
 import UserType from 'utils/role';
 import { act } from 'react-test-renderer';
@@ -96,7 +96,7 @@ test('Render Player', async () => {
 
   await act(async () => {
     component = render(
-      <PlayerStreaming
+      <PlayerServerless
         volume={0}
         songName={songName}
         changeSongInfo={jest.fn()}
diff --git a/Electron/src/components/footer/Footer.tsx b/Electron/src/components/footer/Footer.tsx
@@ -4,8 +4,8 @@ import Global from 'global/global';
 import styles from './footer.module.css';
 import SongInfo from './SongInfo/SongInfo';
 import SongConfig from './SongConfig/SongConfig';
-import PlayerStreaming from './Player/PlayerStreaming';
-import PlayerFiles from './Player/PlayerStreamingFiles';
+import PlayerServerless from './Player/PlayerServerless';
+import PlayerFiles from './Player/PlayerFiles';
 import { PropsSongInfo } from './SongInfo/types/propsSongInfo';
 
 interface PropsFooter {
@@ -22,8 +22,8 @@ export default function Footer({ songName }: PropsFooter) {
     >
       <SongInfo songInfo={songInfo} />
 
-      {Global.songArchitecture === SongArchitecture.STREAMING_ARCHITECTURE ? (
-        <PlayerStreaming
+      {Global.songArchitecture === SongArchitecture.SERVERLESS_ARCHITECTURE ? (
+        <PlayerServerless
           volume={volume}
           songName={songName}
           changeSongInfo={setSongInfo}
diff --git a/Electron/src/components/footer/Player/PlayerFiles.tsx b/Electron/src/components/footer/Player/PlayerFiles.tsx
@@ -14,7 +14,7 @@ import { PropsPlayer } from './types/propsPlayer';
 
 // TODO refactor common logic with streaming player
 
-export default function Player({
+export default function PlayerFiles({
   volume,
   songName,
   changeSongInfo,
diff --git a/Electron/src/components/footer/Player/PlayerServerless.tsx b/Electron/src/components/footer/Player/PlayerServerless.tsx
@@ -13,7 +13,7 @@ import styles from './player.module.css';
 import TimeSlider from './TimeSlider/TimeSlider';
 import { PropsPlayer } from './types/propsPlayer';
 
-export default function PlayerStreaming({
+export default function PlayerServerless({
   volume,
   songName,
   changeSongInfo,
diff --git a/Electron/src/global/SongArchitecture.ts b/Electron/src/global/SongArchitecture.ts
@@ -1,5 +1,5 @@
 enum SongArchitecture {
-  STREAMING_ARCHITECTURE = 'STREAMING_ARCHITECTURE',
+  SERVERLESS_ARCHITECTURE = 'SERVERLESS_ARCHITECTURE',
   FILE_ARCHITECTURE = 'FILE_ARCHITECTURE',
 }
 export default SongArchitecture;
diff --git a/Electron/src/global/global.ts b/Electron/src/global/global.ts
@@ -1,7 +1,7 @@
 import SongArchitecture from './SongArchitecture';
 
 namespace Global {
-  export const backendBaseUrl: string = 'http://127.0.0.1:8000';
+  export const backendBaseUrl: string = 'https://backend-api-qsyq.onrender.com';
   export const appVersion: string = '1.0.0';
 
   export const repositoryUrl: string =
diff --git a/Serverless-API/.env.local b/Serverless-API/.env.local
diff --git a/Serverless-API/constants.py b/Serverless-API/constants.py
diff --git a/Serverless-API/lambda_function.py b/Serverless-API/lambda_function.py
diff --git a/Serverless-API/requirements.txt b/Serverless-API/requirements.txt
diff --git a/docs/Architecture.md b/docs/Architecture.md
@@ -3,7 +3,7 @@
 The app has two different architectures. These architectures only differ on song store, managment, serving
 and playing. `BLOB` architecture is recommended for both testing and production and only requires a MongoDB database instance.
 
-`STREAMING_SERVERLESS` architecture is also provided, it requires a serverless function to manage song resources and streaming. This architecture uses AWS Lambda for serverless function, S3 Bucket for storing songs and Cloudfront for streaming songs into the client using a URL.
+`SERVERLESS` architecture is also provided, it requires a serverless function to manage song resources and streaming. This architecture uses AWS Lambda for serverless function, S3 Bucket for storing songs and Cloudfront for streaming songs into the client using a URL.
 
 ## BLOB
 
@@ -32,7 +32,7 @@ encoded base64 bytes of the song data and injects it into the music player.
 ![BLOB ARCHITECTURE](assets/architecture/app_architecture_blob.png)
 
 
-## STREAMING_SERVERLESS (deprecated)
+## SERVERLESS (deprecated)
 
 As seen in the architecture diagram below, the song data is manage using and AWS Lambda serverless function, it
 stores the data into an S3 Bucket. The stored data is linked with Cloudfront streaming service which provides
@@ -47,8 +47,8 @@ export const songArchitecture: SongArchitecture = SongArchitecture.STREAMING_ARC
 Backend has to use the following config in `.env`:
 
 ```
-ARCH=STREAMING_SERVERLESS
+ARCH=SERVERLESS
 ```
 
-![STREAMING SERVERLESS ARCHITECTURE](assets/architecture/app_architecture_aws_serverless.png)
-![STREAMING SONG ARCHITECTURE](assets/architecture/song_architecture_aws_serverless.png)
+![STREAMING SERVERLESS ARCHITECTURE](assets/architecture/app_architecture_serverless.png)
+![STREAMING SONG ARCHITECTURE](assets/architecture/song_architecture_serverless.png)
diff --git a/docs/assets/architecture/app_architecture_serverless.png b/docs/assets/architecture/app_architecture_serverless.png
diff --git a/docs/assets/architecture/song_architecture_serverless.png b/docs/assets/architecture/song_architecture_serverless.png
diff --git a/docs/backend/Environment.md b/docs/backend/Environment.md
@@ -28,7 +28,7 @@ In this section we will explain the meaning and the usage of the environment var
   - `DEV`: development environment. Enables hot reload.
 - **ARCH**: the song architecture selected, it can be one of the following [architectures](../Architecture.md):
   - `BLOB(Recommended for testing and production)`: song architecture with no streaming/cloud, storing and serving songs directly from the database.
-  - `STREAMING_SERVERLESS`: (deprecated) song architecture using AWS Serverless Function with streaming.
+  - `SERVERLESS`: (deprecated) song architecture using AWS Serverless Function with streaming.
 
 ### ➡️ No streaming with songs stored in database (`BLOB`)
 
@@ -41,7 +41,7 @@ ENV_VALUE=DEV
 ARCH=BLOB
 ```
 
-### ➡️ Streaming using AWS Serverless Functions (`STREAMING_SERVERLESS`)(deprecated)
+### ➡️ Streaming using AWS Serverless Functions (`SERVERLESS`)(deprecated)
 
 - **SERVERLESS_FUNCTION_URL**: the url of the AWS serverless function (Lambda) that manages songs and comunicates with cloud storage.
 - **MONGO_URI**: the database connection URI such as `mongodb://root:root@localhost:27017/`, this will connect backend into the selected database for storing all persistent data but not including song files.
@@ -51,7 +51,7 @@ MONGO_URI=mongodb://root:root@localhost:27017/
 SECRET_KEY_SIGN=f24e2f3ac557d487b6d879fb2d86f2b2
 SERVERLESS_FUNCTION_URL=https://lambda-url.us-east-1.on.aws/path/
 ENV_VALUE=DEV
-ARCH=STREAMING_SERVERLESS
+ARCH=SERVERLESS
 ```
 
 ---
@@ -81,7 +81,7 @@ You can also use the following `.env` file for changing between architectures as
 ```
 MONGO_URI=mongodb://root:root@localhost:27017/
 SECRET_KEY_SIGN=f24e2f3ac557d487b6d879fb2d86f2b2
-STREAMING_SERVERLESS=https://lambda-url.us-east-1.on.aws/path/
+SERVERLESS=https://lambda-url.us-east-1.on.aws/path/
 ENV_VALUE=DEV
 ARCH=BLOB
 ```
diff --git a/docs/backend/SETUP.md b/docs/backend/SETUP.md
diff --git a/docs/backend/Testing.md b/docs/backend/Testing.md

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ def __init__(self) -> None:`
`32`	`32`	`self.env_variables = [`
`33`	`33`	`AppEnvironment.MONGO_URI_ENV_NAME,`
`34`	`34`	`AppEnvironment.SECRET_KEY_SIGN_ENV_NAME,`
`35`		`- AppEnvironment.SERVERLESS_STREAMING_URL_ENV_NAME,`
	`35`	`+ AppEnvironment.SERVERLESS_URL_ENV_NAME,`
`36`	`36`	`AppEnvironment.ENV_VALUE_ENV_NAME,`
`37`	`37`	`]`
`38`	`38`	`self._load_env_variables(self.env_variables)`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ def get_song_collection() -> Collection:`
`22`	`22`	`AppArchitecture.ARCH_BLOB: DatabaseConnectionManager.get_collection_connection(`
`23`	`23`	`DatabaseCollection.SONG_BLOB_FILE`
`24`	`24`	`),`
`25`		`- AppArchitecture.ARCH_STREAMING_SERVERLESS: DatabaseConnectionManager.get_collection_connection( # noqa: E501`
	`25`	`+ AppArchitecture.ARCH_SERVERLESS: DatabaseConnectionManager.get_collection_connection( # noqa: E501`
`26`	`26`	`DatabaseCollection.SONG_STREAMING`
`27`	`27`	`),`
`28`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`from app.spotify_electron.song.song_service_constants import (`
`13`	`13`	`MODULE_PREFIX_NAME,`
`14`	`14`	`SONG_SERVICE_BLOB_MODULE_NAME,`
`15`		`- SONG_SERVICE_STREAMING_SERVERLESS_MODULE_NAME,`
	`15`	`+ SONG_SERVICE_SERVERLESS_MODULE_NAME,`
`16`	`16`	`)`
`17`	`17`
`18`	`18`
`@@ -27,7 +27,7 @@ def init_service(cls) -> None:`
`27`	`27`	`cls.logger = SpotifyElectronLogger(LOGGING_SONG_SERVICE_PROVIDER).getLogger()`
`28`	`28`	`cls.song_services = {`
`29`	`29`	`AppArchitecture.ARCH_BLOB: SONG_SERVICE_BLOB_MODULE_NAME,`
`30`		`- AppArchitecture.ARCH_STREAMING_SERVERLESS: SONG_SERVICE_STREAMING_SERVERLESS_MODULE_NAME, # noqa: E501`
	`30`	`+ AppArchitecture.ARCH_SERVERLESS: SONG_SERVICE_SERVERLESS_MODULE_NAME, # noqa: E501`
`31`	`31`	`}`
`32`	`32`	`cls.create_song_service()`
`33`	`33`