Move musicbrainz config to env

Author: CalPinSW

ansible/.ansible-secrets.template.yml

@@ -2,4 +2,6 @@ spotify_client_id: spotify_client_id
 spotify_secret: spotify_secret
 debug_mode: false
 flask_secret_key: flask_secret_key
-db_connection_string: postgresql://username:password@hostname:port/database
+musicbrainz_url: musicbrainz_url
+musicbrainz_user_agent: musicbrainz_user_agent
+db_connection_string: db_connection_string

backend/.env.j2

@@ -15,5 +15,9 @@ SPOTIFY_CLIENT_ID={{spotify_client_id}}
 SPOTIFY_SECRET={{spotify_secret}}
 SPOTIFY_REDIRECT_URI="{{backend_url}}/auth/get-user-code"
 
+# Musicbrainz Api
+MUSICBRAINZ_URL={{musicbrainz_url}}
+MUSICBRAINZ_USER_AGENT={{musicbrainz_user_agent}}
+
 # Database Connection String
-DB_CONNECTION_STRING=postgresql://username:password@hostname:port/database
+DB_CONNECTION_STRING={{db_connection_string}}

backend/.env.template

@@ -15,5 +15,9 @@ SPOTIFY_CLIENT_ID="https://developer.spotify.com/dashboard"
 SPOTIFY_SECRET="https://developer.spotify.com/dashboard"
 SPOTIFY_REDIRECT_URI="http://localhost:8080/spotify-redirect"
 
+# Musicbrainz Api
+MUSICBRAINZ_URL=https://musicbrainz.org/ws/2
+MUSICBRAINZ_USER_AGENT="Application PlaylistManager/1.0 - Hobby project (put maintainers email here)"
+
 # Database Connection String
 DB_CONNECTION_STRING=postgresql://username:password@hostname:port/database

backend/.env.test

@@ -15,5 +15,9 @@ SPOTIFY_CLIENT_ID="https://developer.spotify.com/dashboard"
 SPOTIFY_SECRET="https://developer.spotify.com/dashboard"
 SPOTIFY_REDIRECT_URI="http://localhost:8080/spotify-redirect"
 
+# Musicbrainz Api
+MUSICBRAINZ_URL=https://musicbrainz.org/ws/2
+MUSICBRAINZ_USER_AGENT="Application PlaylistManager/1.0 - Hobby project (put maintainers email here)"
+
 # Database Connection String
 DB_CONNECTION_STRING=postgresql://username:password@hostname:port/database

backend/src/flask_config.py

@@ -8,6 +8,8 @@ def __init__(self):
         self.BACKEND_URL = os.environ.get("BACKEND_URL")
         self.FRONTEND_URL = os.environ.get("FRONTEND_URL")
         self.DB_CONNECTION_STRING = os.environ.get("DB_CONNECTION_STRING")
+        self.MUSICBRAINZ_URL = os.environ.get("MUSICBRAINZ_URL")
+        self.MUSICBRAINZ_USER_AGENT = os.environ.get("MUSICBRAINZ_USER_AGENT")
         if not self.SECRET_KEY:
             raise ValueError(
                 "No SECRET_KEY set for Flask application. Did you follow the setup instructions?"

backend/src/musicbrainz.py

@@ -5,11 +5,14 @@
 from src.exceptions.Unauthorized import UnauthorizedException
 from time import sleep
 
+from src.flask_config import Config
 
+
+### Musicbrainz requests must be followed by a 1 second sleep if being sent in bulk to avoid rate limiting
 class MusicbrainzClient:
     request_headers = {
         "Accept": "application/json",
-        "User-Agent": "Application PlaylistManager/1.0 - Hobby project ([email protected])",
+        "User-Agent": Config().MUSICBRAINZ_USER_AGENT,
     }
 
     def response_handler(self, response: requests.Response, jsonify=True):
@@ -30,23 +33,23 @@ def get_genre_list(self, limit=100, offset=0) -> List[str]:
         else:
             query = f"?limit={limit}&offset={offset}"
         response = requests.get(
-            url="https://musicbrainz.org/ws/2/genre/all" + query,
+            url=Config().MUSICBRAINZ_URL + "/genre/all" + query,
             headers=self.request_headers,
         )
         data = response.json()
         genre_list = [genre["name"] for genre in data["genres"]]
         if genre_list == []:
             return []
         else:
-            sleep(2)  # Needed to avoid rate limiting
+            sleep(1)
             return genre_list + self.get_genre_list(limit, offset + limit)
 
     def get_album_genres(self, artist_name: str, album_title: str) -> List[str]:
         query = quote_plus(
             f'artistname:"{artist_name}" AND releasegroup:"{album_title}"'
         )
         response = requests.get(
-            url="https://musicbrainz.org/ws/2/release-group?query=" + query,
+            url=Config().MUSICBRAINZ_URL + "/release-group?query=" + query,
             headers=self.request_headers,
         )
         data = response.json()