Bring up to date with production

Author: tylers-username

.github/workflows/test.yaml

@@ -40,22 +40,34 @@ jobs:
           cache: 'pip'
 
       ################################################################################################
-      # B. Test repo.
-      - name: "4. Run Frontend tests."
+      # B. Prettify, lint, and test repo.
+      - name: "4. Preparing"
         run: |
           echo "::notice::Running react-scripts tests."
           export CI=true
           npm install cross-env npm-run-all -g
           npm install
-          npm run test:frontend
+      - name: "5. Verifying backend code is pretty"
+        run: | 
+          npm run prettier:backend
+      - name: "6. Verifying frontend code is pretty"
+        run: |
+          npm run prettier:frontend
+      - name: "7. Linting frontend"
+        run: npm run lint:frontend
+      - name: "8. Run Frontend tests"
+        run: npm run test:frontend
+      - name: "9. Run Backend linting"
+        run: |
+          npm run lint:backend
 
       ################################################################################################
       # C. Ensure no vulnerabilities.
-      - name: "5. Test: there should be no Python vulnerabilities."
+      - name: "10. Test: there should be no Python vulnerabilities."
         run: |
           echo "::notice::Checking for vulnerabilities in backend Python app dependencies."
           npm run test:backend
-      - name: "6. Test: there should be no HIGH Node.js vulnerabilities."
+      - name: "11. Test: there should be no HIGH Node.js vulnerabilities."
         run: |
           echo "::notice::Checking for high vulnerabilities in frontend Node.js app dependencies."
           cd frontend
@@ -69,7 +81,7 @@ jobs:
           else
               echo "::notice::No HIGH vulnerabilities found on frontend app."
           fi
-      - name: "7. Test: there should be no CRITICAL Node.js vulnerabilities."
+      - name: "12. Test: there should be no CRITICAL Node.js vulnerabilities."
         run: |
           echo "::notice::Checking for critical vulnerabilities in frontend Node.js app dependencies."
           cd frontend

backend/app/routes.py

@@ -1,39 +1,66 @@
+"""
+This module sets defines the routes for your Flask application
+"""
+
 import os
-from flask import Blueprint, jsonify
 import base64
 import json
+from flask import Blueprint, jsonify
 
-bp = Blueprint('routes', __name__)
+bp = Blueprint("routes", __name__)
 
-service_relationship ="redis_session"
+SERVICE_RELATIONSHIP = "redis_session"
 
-API_PREFIX = '/api/v1'
+API_PREFIX = "/api/v1"
 
-@bp.route(f'{API_PREFIX}/environment')
+
+@bp.route(f"{API_PREFIX}/environment")
 def environment():
-    return jsonify(type=getPlatformEnvironment(), session_storage=getSessionStorageType())
+    """
+    Returns the environment type and sessions storage type as json
+    """
+    return jsonify(
+        type=get_platform_environment(), session_storage=get_session_storage_type()
+    )
+
 
-@bp.route('/api/')
+@bp.route("/api/")
 def home():
+    """
+    Returns a welcome message for the home route.
+    """
     return "Hello from the Python backend!"
 
-def getSessionStorageType():
-    platform_relationships_data = os.environ.get('PLATFORM_RELATIONSHIPS')
-    
+
+def get_session_storage_type():
+    """
+    Returns the type of session storage from the PLATFORM_RELATIONSHIPS environment variable.
+    If the variable is not set or if it does not contain the SERVICE_RELATIONSHIP, it returns "file"
+    If the variable is set and contains the SERVICE_RELATIONSHIP, it returns "redis".
+    If there is an error decoding the PLATFORM_RELATIONSHIPS variable, it returns "file".
+    """
+    platform_relationships_data = os.environ.get("PLATFORM_RELATIONSHIPS")
+
     if not platform_relationships_data:
-        return 'file'
+        return "file"
 
     try:
-        platform_relationships = json.loads(base64.b64decode(platform_relationships_data))
-        
-        if service_relationship in platform_relationships:
-            return 'redis'
-        else:
-            return 'file'
+        platform_relationships = json.loads(
+            base64.b64decode(platform_relationships_data)
+        )
+
+        if SERVICE_RELATIONSHIP in platform_relationships:
+            return "redis"
+
+        return "file"
     except (json.JSONDecodeError, TypeError, ValueError):
         # Catching potential exceptions due to invalid JSON or other issues
-        return 'file'
+        return "file"
 
 
-def getPlatformEnvironment():
-    return os.environ.get('PLATFORM_ENVIRONMENT_TYPE', 'local')
+def get_platform_environment():
+    """
+    Returns the type of the environment from PLATFORM_ENVIRONMENT_TYPE environment variable.
+    If the variable is not set, it returns "local".
+    """
+    return os.environ.get("PLATFORM_ENVIRONMENT_TYPE", "local")

backend/main.py

@@ -1,38 +1,55 @@
-from flask import Flask
+"""
+This module sets up the Flask application and its configurations.
+
+It initializes the Flask app, sets up CORS, loads environment variables,
+configures session management (commented out, pending Redis implementation),
+registers the routes, and runs the app with the specified port and debug settings.
+"""
+
 import os
-# from flask_session import Session
+from flask import Flask
 from flask_cors import CORS
-from app import routes
 from dotenv import load_dotenv
+from app import routes
+
+# from flask_session import Session
+
+
+def create_app():
+    """
+    Create and configure an instance of the Flask application.
 
-def createApp():
+    Environment variables are loaded, the Flask app is initialized, and
+    Redis configuration for sessions is set up if available. Routes are
+    also registered with the application instance before it is returned.
+    """
     # Bring in environment variables
     load_dotenv()
 
     # Initialize app
-    app = Flask(__name__)
+    flask_app = Flask(__name__)
 
     # Use Redis for Sessions if available
     # if 'implement redis but consider how to handle in local dev environment':
     #     app.config['SESSION_TYPE'] = 'redis'  # Session storage type
     #     app.config['SESSION_PERMANENT'] = False  # Make the sessions non-permanent
     #     app.config['SESSION_USE_SIGNER'] = True  # Securely sign the session cookie
     #     app.config['SESSION_KEY_PREFIX'] = 'session:'  # Prefix for storing session data in Redis
-    #     app.config['SESSION_REDIS'] = redis.StrictRedis(host='localhost', port=6379, db=0)  # Redis configuration
+    #     app.config['SESSION_REDIS'] = redis.StrictRedis(host='localhost', port=6379, db=0)
 
     #     sess = Session()
     #     sess.init_app(app)
 
+    flask_app.register_blueprint(routes.bp)
 
-    app.register_blueprint(routes.bp)
+    return flask_app
 
-    return app
 
-app = createApp()
+app = create_app()
 CORS(app)
 
 if __name__ == "__main__":
-    flask_environment = os.environ.get('FLASK_ENV', 'local')
+    flask_environment = os.environ.get("FLASK_ENV", "local")
     enable_debug = flask_environment != "production"
-    web_port = os.environ.get('PORT', 8000)
+    web_port = os.environ.get("PORT", 8000)
     app.run(port=web_port, debug=enable_debug)

backend/requirements.txt

@@ -40,3 +40,5 @@ toml==0.10.2
 urllib3==2.0.7
 webencodings==0.5.1
 Werkzeug==3.0.1
+pylint==3.0.2
+black==23.3.0

backend/scripts/lint_backend.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+python3 -m venv env
+source env/bin/activate
+pip install --upgrade pip
+pip install -r requirements.txt
+
+pylint main.py app/**/*.py

backend/scripts/prettier_backend.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+python3 -m venv env
+source env/bin/activate
+pip install --upgrade pip
+pip install -r requirements.txt
+
+black . --diff --color --check

frontend/.eslintrc

@@ -1,7 +1,4 @@
 {
-    "extends": [
-      "react-app",
-      "plugin:testing-library/react"
-    ],
-    "plugins": ["testing-library"]
-  }
+  "extends": ["react-app", "plugin:testing-library/react"],
+  "plugins": ["testing-library"]
+}

frontend/.prettierignore

@@ -0,0 +1,2 @@
+build
+coverage

frontend/.prettierrc

@@ -0,0 +1 @@
+{}

frontend/package.json

@@ -27,7 +27,9 @@
     "build": "react-scripts build",
     "test": "react-scripts test",
     "eject": "react-scripts eject",
-    "lint": "eslint src --ext .js,.jsx,.ts,.tsx"
+    "lint": "eslint src --ext .js,.jsx,.ts,.tsx",
+    "pretty": "prettier . --check",
+    "pretty:fix": "prettier . --write"
   },
   "eslintConfig": {
     "extends": [