Merge branch 'main' into DEP-245-delete-users

Author: NatSquared

.github/workflows/engagement-api-ci.yml

@@ -52,7 +52,7 @@ jobs:
   testing:
     needs: setup-job
     env:
-      FLASK_ENV: "testing"
+      ENV: "testing"
       DATABASE_TEST_URL: "postgresql://postgres:postgres@localhost:5432/postgres"
       SITE_URL: "http://localhost:3000"
 

CHANGELOG.MD

@@ -6,6 +6,13 @@
   - Added success and error messages to provide feedback on the deletion process.
   - Reworked the user details component to rearrange the existing layout and accommodate the new delete button, while ensuring a clear and intuitive user experience.
 
+## April 1, 2026
+
+- **Chore** Change trigger for environment detection [🎟️ DEP-242](https://citz-gdx.atlassian.net/browse/DEP-242)
+  - Updated Helm templates to set a new environment variable `ENV` in the API deployment, which is then used by the API to determine the current environment (dev/test/prod).
+  - The env variable is loaded in config.py and is available as current_app.config['ENVIRONMENT'] for use in the API codebase.
+  - Also added REACT_APP_ENV variable to the web deployment and updated the web app to use this variable for environment detection on the frontend as well. This is curently used to determine whether to show the EnvironmentBanner that warns users that they are in a non-prod environment, but can be used for other environment-specific frontend logic as needed.
+
 ## March 31, 2026
 
 - **Chore** OpenShift and Helm value changes from MET to DEP [🎟️ DEP-231](https://citz-gdx.atlassian.net/browse/DEP-231)

api/sample.env

@@ -2,10 +2,10 @@
 # For more information on these values, please see the documentation
 # or api/src/api/config.py 
 
-# Changes Flask's run mode and the set of env vars are used to configure the app. You should not need to change this here.
-FLASK_ENV=development
+# Used to control certain production-specific behaviours
+ENV=dev
 
-USE_DEBUG=True # Enable a dev-friendly debug mode
+FLASK_DEBUG=True # Enable a dev-friendly debug mode
 TESTING= # Handle errors normally (False) or raise exceptions (True)
 
 # CORS Settings

api/src/api/__init__.py

@@ -77,7 +77,7 @@ def _deprecated_print(*args, **kwargs):
 )
 
 
-def create_app(run_mode=os.getenv('FLASK_ENV', 'development')):
+def create_app(run_mode=os.getenv('ENV', 'prod')):
     """Create flask app."""
     from api.resources import API_BLUEPRINT  # pylint: disable=import-outside-toplevel
 
@@ -104,7 +104,7 @@ def create_app(run_mode=os.getenv('FLASK_ENV', 'development')):
     app.register_blueprint(API_BLUEPRINT)
 
     # Setup jwt for keycloak
-    if os.getenv('FLASK_ENV', 'production') != 'testing':
+    if os.getenv('ENV', 'production') != 'testing':
         setup_jwt_manager(app, jwt)
 
     # Database connection initialize

api/src/api/config.py

@@ -46,16 +46,19 @@ def get_named_config(environment: Union[str, None]) -> 'Config':
     :raises: KeyError if the requested configuration is not found.
     """
     config_mapping = {
+        'dev': DevConfig,
         'development': DevConfig,
+        'test': DevConfig,
         'default': ProdConfig,
         'staging': ProdConfig,
+        'prod': ProdConfig,
         'production': ProdConfig,
         'testing': TestConfig,
         'docker': DockerConfig,
     }
     try:
         print(f'Loading configuration: {environment}...')
-        return config_mapping.get(environment or 'production', ProdConfig)()
+        return config_mapping.get(environment or 'prod', ProdConfig)()
     except KeyError as e:
         raise KeyError(f'Configuration "{environment}" not found.') from e
 
@@ -91,7 +94,7 @@ def __init__(self) -> None:
             setattr(self, f'JWT_OIDC_{key}', value)
 
         # Enable live reload and interactive API debugger for developers
-        os.environ['FLASK_DEBUG'] = str(self.USE_DEBUG)
+        os.environ['FLASK_DEBUG'] = str(self.DEBUG)
 
     @property
     # pylint: disable=invalid-name
@@ -116,7 +119,7 @@ def SQLALCHEMY_DATABASE_URI(self) -> str:
 
     # If enabled, the interactive debugger will be shown for any
     # unhandled Exceptions, and the server will be reloaded when code changes.
-    USE_DEBUG = env_truthy('FLASK_DEBUG', default=False)
+    DEBUG = env_truthy('FLASK_DEBUG', default=False)
 
     # SQLAlchemy settings
     # Echoes the SQL queries generated - useful for debugging

api/src/api/services/engagement_service.py

@@ -1,13 +1,13 @@
 """Service for engagement management."""
 
+import os
 from datetime import datetime, timezone
 from http import HTTPStatus
-import os
 from typing import Mapping, Optional, Sequence, Union
 
 from sqlalchemy.exc import SQLAlchemyError
 from sqlalchemy.orm import selectinload
-from flask import current_app
+from flask import current_app, has_app_context
 from flask_restx import abort
 from marshmallow import ValidationError
 
@@ -550,7 +550,13 @@ def delete(cls, engagement_id: int):
         one_of_roles = (Role.SUPER_ADMIN.value, Role.UNPUBLISH_ENGAGEMENT.value)
         authorization.check_auth(one_of_roles=one_of_roles)
 
-        current_env = os.getenv('FLASK_ENV', 'production').lower()
+        current_env = (
+            (current_app.config.get('ENVIRONMENT') if has_app_context() else '') or
+            os.getenv('ENV') or
+            os.getenv('DEPLOYMENT_ENV') or
+            'prod'
+        ).strip().lower()
+
         if current_env in ('prod', 'production'):
             abort(HTTPStatus.FORBIDDEN, 'Cannot delete an engagement in production environment')
 

api/tests/unit/services/test_engagement.py

@@ -132,7 +132,7 @@ def test_delete_failure_engagement_published(session, mocker):
 
 def test_delete_failure_production_environment(db, monkeypatch, mocker):
     """Engagement delete should be blocked in production (403 Forbidden)."""
-    monkeypatch.setenv('FLASK_ENV', 'production')
+    monkeypatch.setenv('ENV', 'prod')
     mocker.patch.object(authorization, 'check_auth', return_value=True)
 
     with pytest.raises(Forbidden) as excinfo:

notify-api/src/notify_api/config.py

@@ -39,7 +39,7 @@ def get_named_config(config_name: str = 'production'):
 
     :raise: KeyError: if an unknown configuration is requested
     """
-    if config_name in ['production', 'staging', 'default']:
+    if config_name in ['production', 'prod', 'staging', 'default']:
         config = ProdConfig()
     elif config_name == 'testing':
         config = TestConfig()
@@ -54,6 +54,7 @@ class _Config():  # pylint: disable=too-few-public-methods
     """Base class configuration that should set reasonable defaults for all the other configurations."""
 
     PROJECT_ROOT = os.path.abspath(os.path.dirname(__file__))
+    ENVIRONMENT = os.getenv('ENV', 'production')
 
     # GC Notify
     GC_NOTIFY_API_KEY = os.getenv('GC_NOTIFY_API_KEY')

openshift/api/templates/configmap.yaml

@@ -8,6 +8,7 @@ metadata:
         app-group: engagement-app
 data:
     # Engagement API configuration
+    ENV: {{ .Values.environment | quote }}
     CORS_ORIGINS: {{ .Values.site.url }}
     DEFAULT_TENANT_SHORT_NAME: {{ .Values.tenant.shortName }}
     ACCESS_REQUEST_EMAIL_TEMPLATE_ID: {{ .Values.email.templateID.accessRequest }}

openshift/web/templates/configmap.yaml

@@ -8,6 +8,7 @@ metadata:
     environment: {{ .Values.environment }}
 data:
     ENV: "{{ .Values.environment }}"
+    REACT_APP_ENVIRONMENT: "{{ .Values.environment }}"
     # This data gets turned into config.js by the nginx config
     # Common
     REACT_APP_PUBLIC_URL: "{{ .Values.site.url }}"