Update default language to pull from central config

Author: NatSquared

api/src/api/services/engagement_service.py

@@ -44,7 +44,6 @@ class EngagementService:
     """Engagement management service."""
 
     otherdateformat = '%Y-%m-%d'
-    default_language_code = 'en'
     JSONScalar = Union[str, int, float, bool, None]
     JSONValue = Union[
         JSONScalar,
@@ -146,7 +145,9 @@ def _get_scope_options(user_roles, has_team_access):
             # If user has VIEW_ENGAGEMENT role, e.g. TEAM MEMBER, return scope options to include assigned
             # engagements and public engagements
             return EngagementScopeOptions(
-                engagement_status_ids=[Status.Published.value, Status.Closed.value],
+                engagement_status_ids=[
+                    Status.Published.value, Status.Closed.value
+                ],
                 include_assigned=True,
             )
         if Role.VIEW_ASSIGNED_ENGAGEMENTS.value in user_roles:
@@ -175,7 +176,9 @@ def publish_scheduled_engagements():
         engagements = EngagementModel.publish_scheduled_engagements_due()
 
         if not engagements:
-            current_app.logger.info('There are no engagements scheduled for publication')
+            current_app.logger.info(
+                'There are no engagements scheduled for publication'
+            )
             return None
 
         current_app.logger.info('Engagements published: %s', engagements)
@@ -186,7 +189,9 @@ def publish_scheduled_engagements():
                 SourceAction.PUBLISHED.value,
                 True,
             )
-            current_app.logger.info('Engagement published added to email queue: %s', engagement.id)
+            current_app.logger.info(
+                'Engagement published added to email queue: %s', engagement.id
+            )
         return engagements
 
     @staticmethod
@@ -198,7 +203,9 @@ def create_engagement(request_json: dict):
         eng_model = EngagementService._create_engagement_model(request_json)
 
         if request_json.get('status_block'):
-            EngagementService._create_eng_status_block(eng_model.id, request_json)
+            EngagementService._create_eng_status_block(
+                eng_model.id, request_json
+            )
 
         # Always sync languages so an English translation row is created immediately.
         # If the caller didn't request specific languages, default to English-only.
@@ -257,7 +264,9 @@ def _save_or_update_eng_block(engagement_id, status_block):
             survey_status = survey_block.get('survey_status')
             survey_block_text = survey_block.get('block_text')
             status_block: EngagementStatusBlockModel = (
-                EngagementStatusBlockModel.get_by_status(engagement_id, survey_status)
+                EngagementStatusBlockModel.get_by_status(
+                    engagement_id, survey_status
+                )
             )
             # If the status block exists, update it. Otherwise, create a new one.
             if status_block:
@@ -301,7 +310,9 @@ def _save_or_update_surveys(engagement_id, surveys):
                         engagement_id=engagement_id,
                         is_hidden=survey.get('is_hidden', False),
                         is_template=survey.get('is_template', False),
-                        generate_dashboard=survey.get('generate_dashboard', True),
+                        generate_dashboard=survey.get(
+                            'generate_dashboard', True
+                        ),
                     )
                 )
 
@@ -328,7 +339,9 @@ def _validate_and_assign_survey(survey_id: int, engagement_id: int):
                 raise ValueError('selected survey does not exist')
 
             if survey.engagement_id != engagement_id:
-                raise ValueError('selected survey does not belong to this engagement')
+                raise ValueError(
+                    'selected survey does not belong to this engagement'
+                )
 
         return survey_id
 
@@ -357,14 +370,16 @@ def edit_engagement(data: dict):
         requested_languages = data.pop('languages', None)
         suggested_engagements = data.pop('suggested_engagements', None)
         if suggested_engagements is None:
-            suggested_engagements = data.pop('suggested_engagements_input', None)
+            suggested_engagements = data.pop(
+                'suggested_engagements_input', None)
         # Defensive: relationship keys are not valid for SQL UPDATE mappings.
         data.pop('suggested_engagement_links', None)
         epic_fields = 'end_date' in data or 'start_date' in data
         selected_survey_id = data.get('selected_survey_id', None)
         engagement_id = data.get('id', None)
         authorization.check_auth(
-            one_of_roles=(MembershipType.TEAM_MEMBER.name, Role.EDIT_ENGAGEMENT.value),
+            one_of_roles=(MembershipType.TEAM_MEMBER.name,
+                          Role.EDIT_ENGAGEMENT.value),
             engagement_id=engagement_id,
         )
 
@@ -379,9 +394,11 @@ def edit_engagement(data: dict):
             if data:
                 if selected_survey_id:
                     data['selected_survey_id'] = \
-                        EngagementService._validate_and_assign_survey(selected_survey_id, engagement_id)
+                        EngagementService._validate_and_assign_survey(
+                            selected_survey_id, engagement_id)
 
-                updated_engagement = EngagementModel.edit_engagement(data, commit=False)
+                updated_engagement = EngagementModel.edit_engagement(
+                    data, commit=False)
 
                 if not updated_engagement:
                     raise ValueError(engagement)
@@ -395,10 +412,12 @@ def edit_engagement(data: dict):
                 )
 
             if suggested_engagements is not None:
-                EngagementService._sync_suggestions(engagement, suggested_engagements)
+                EngagementService._sync_suggestions(
+                    engagement, suggested_engagements)
 
             if requested_languages is not None:
-                EngagementService._sync_translation_languages(engagement_id, requested_languages)
+                EngagementService._sync_translation_languages(
+                    engagement_id, requested_languages)
 
             db.session.commit()
         except (BusinessException, ValueError, ValidationError, SQLAlchemyError):
@@ -424,7 +443,8 @@ def _sync_suggestions(engagement: EngagementModel, suggestions_data):
             if r.suggested_engagement_id is not None
         }
 
-        normalized = SuggestedEngagementSyncItemSchema(many=True).load(suggestions_data)
+        normalized = SuggestedEngagementSyncItemSchema(
+            many=True).load(suggestions_data)
         now = datetime.now(timezone.utc)
         ordered: list[SuggestedEngagementModel] = []
 
@@ -460,10 +480,13 @@ def _normalize_language_codes(language_codes: object) -> list[str]:
         if not isinstance(language_codes, list):
             raise ValueError('languages must be a list of language codes')
 
+        default_language_code = EngagementService._get_default_language_code()
+
         normalized_codes: list[str] = []
         for code in language_codes:
             if not isinstance(code, str):
-                raise ValueError('languages must only contain string language codes')
+                raise ValueError(
+                    'languages must only contain string language codes')
 
             normalized = code.strip().lower()
             if not normalized:
@@ -472,32 +495,48 @@ def _normalize_language_codes(language_codes: object) -> list[str]:
             if normalized not in normalized_codes:
                 normalized_codes.append(normalized)
 
-        # English is always implicitly available.
-        if EngagementService.default_language_code not in normalized_codes:
-            normalized_codes.append(EngagementService.default_language_code)
+        # The default language is always implicitly available.
+        if default_language_code not in normalized_codes:
+            normalized_codes.append(default_language_code)
 
         return normalized_codes
 
+    @staticmethod
+    def _get_default_language_code() -> str:
+        default_language = (
+            (current_app.config.get('DEFAULT_LANGUAGE')
+             if has_app_context() else None)
+            or os.getenv('DEFAULT_LANGUAGE')
+            or 'en'
+        )
+        return default_language.strip().lower()
+
     @staticmethod
     def _sync_translation_languages(engagement_id: int, language_codes: object) -> None:
-        normalized_codes = EngagementService._normalize_language_codes(language_codes)
-        translation_codes = set(normalized_codes)  # Includes English — all languages get a translation row.
+        normalized_codes = EngagementService._normalize_language_codes(
+            language_codes)
+        # Includes English — all languages get a translation row.
+        translation_codes = set(normalized_codes)
 
         requested_languages = (
-            LanguageModel.query.filter(LanguageModel.code.in_(translation_codes)).all()
+            LanguageModel.query.filter(
+                LanguageModel.code.in_(translation_codes)).all()
             if translation_codes
             else []
         )
 
         requested_codes = {language.code for language in requested_languages}
         missing_codes = translation_codes - requested_codes
         if missing_codes:
-            raise ValueError(f'Invalid language code(s): {", ".join(sorted(missing_codes))}')
+            raise ValueError(
+                f'Invalid language code(s): {", ".join(sorted(missing_codes))}')
 
-        requested_language_ids = {language.id for language in requested_languages}
+        requested_language_ids = {
+            language.id for language in requested_languages}
 
         existing_translations = (
-            EngagementTranslation.query.filter_by(engagement_id=engagement_id).all()
+            EngagementTranslation.query.filter_by(
+                engagement_id=engagement_id).all()
         )
         existing_by_language_id = {
             translation.language_id: translation for translation in existing_translations
@@ -519,7 +558,8 @@ def _sync_translation_languages(engagement_id: int, language_codes: object) -> N
     @staticmethod
     def validate_fields(data):
         """Validate all fields."""
-        empty_fields = [not data[field] for field in ['name', 'start_date', 'end_date']]
+        empty_fields = [not data[field]
+                        for field in ['name', 'start_date', 'end_date']]
 
         if data['start_date'] > data['end_date']:
             raise ValueError('Start date cannot be after End date')
@@ -565,7 +605,8 @@ def _send_closeout_emails(engagement: EngagementModel) -> None:
     @staticmethod
     def _render_email_template(engagement: EngagementModel, lang_code):
         template = Template.get_template('email_engagement_closeout.html')
-        dashboard_path = EngagementService._get_dashboard_path(engagement, lang_code)
+        dashboard_path = EngagementService._get_dashboard_path(
+            engagement, lang_code)
         engagement_url = notification.get_tenant_site_url(
             engagement.tenant_id, dashboard_path
         )
@@ -596,7 +637,8 @@ def _get_tenant_name(tenant_id):
 
     @staticmethod
     def _get_dashboard_path(engagement: EngagementModel, lang_code):
-        engagement_slug = EngagementSlugModel.find_by_engagement_id(engagement.id)
+        engagement_slug = EngagementSlugModel.find_by_engagement_id(
+            engagement.id)
         paths = current_app.config['PATH_CONFIG']
         if engagement_slug:
             return paths['ENGAGEMENT']['DASHBOARD_SLUG'].format(
@@ -609,7 +651,8 @@ def _get_dashboard_path(engagement: EngagementModel, lang_code):
     @classmethod
     def delete(cls, engagement_id: int):
         """Delete an existing engagement and its translations."""
-        one_of_roles = (Role.SUPER_ADMIN.value, Role.UNPUBLISH_ENGAGEMENT.value)
+        one_of_roles = (Role.SUPER_ADMIN.value,
+                        Role.UNPUBLISH_ENGAGEMENT.value)
         authorization.check_auth(one_of_roles=one_of_roles)
 
         current_env = (
@@ -620,7 +663,8 @@ def delete(cls, engagement_id: int):
         ).strip().lower()
 
         if current_env in ('prod', 'production'):
-            abort(HTTPStatus.FORBIDDEN, 'Cannot delete an engagement in production environment')
+            abort(HTTPStatus.FORBIDDEN,
+                  'Cannot delete an engagement in production environment')
 
         engagement = EngagementModel.find_by_id(engagement_id)
         if not engagement:
@@ -629,11 +673,13 @@ def delete(cls, engagement_id: int):
             raise ValueError('Cannot delete an engagement that is published')
 
         try:
-            for translation in (EngagementTranslation.get_available_translation_languages(engagement.id) or []):
-                EngagementTranslation.delete_engagement_translation(translation.id)
+            for translation in (EngagementTranslation.get_available_translations(engagement.id) or []):
+                EngagementTranslation.delete_engagement_translation(
+                    translation.id)
             deleted = EngagementModel.delete_engagement(engagement_id)
         except ValueError as exc:
             raise ValueError(str(exc)) from exc
         except SQLAlchemyError as e:
-            raise RuntimeError('Database error while deleting engagement', e) from e
+            raise RuntimeError(
+                'Database error while deleting engagement', e) from e
         return {'id': deleted.id if hasattr(deleted, 'id') else engagement_id}