feat: disable some code sections if we are doing local development

Author: IgnacioHeredia

ai4papi/conf.py

@@ -2,13 +2,20 @@
 Manage configurations of the API.
 """
 
+import os
 from pathlib import Path
 from string import Template
 import subprocess
 
 import yaml
 
 
+# Check if we are developing from local, to disable parts of the code that are compute
+# intensive (eg. disables calls to Github API)
+# The variables 'FORWARDED_ALLOW_IPS' serves as proxy for this, as it is only defined
+# when running from the Docker container
+IS_DEV = False if os.getenv('FORWARDED_ALLOW_IPS') else True
+
 # Paths
 main_path = Path(__file__).parent.absolute()
 paths = {

ai4papi/utils.py

@@ -9,6 +9,8 @@
 from fastapi import HTTPException
 import requests
 
+import ai4papi.conf as papiconf
+
 
 # Persistent requests session for faster requests
 session = requests.Session()
@@ -191,6 +193,12 @@ def get_github_info(owner, repo):
     """
     Retrieve information from a Github repo
     """
+    # Avoid running this function if were are doing local development, because
+    # repeatedly calling the Github API will otherwise get you blocked
+    if papiconf.IS_DEV:
+        print('[info] Skipping Github API info fetching (development).')
+        return {}
+
     # Retrieve information from Github API
     url = f"https://api.github.com/repos/{owner}/{repo}"
     headers = {'Authorization': f'token {github_token}'} if github_token else {}

tests/main.py

@@ -10,6 +10,13 @@
 #TODO: move to proper testing package
 #TODO: rename test script: modules --> test_modules
 
+import ai4papi.conf as papiconf
+
+
+# We want to test full functionality, without disabling any parts
+papiconf.IS_DEV = False
+
+
 import catalog.modules
 import catalog.tools
 import deployments.modules