PR Incidents Filtering for better CFR and MTTR Reporting (#656) -> Backend

* Added Incident PRs Setting

* Exclude Revert PR from Incident types based on IncidentPRsSetting and added tests

* Core logic for Incident PR filtering

* Updated Incident types setting tests

* modify core logic for efficiency and add tests for incident prs

* Set Include revert PRs default to True

* Improved type safety and better variable naming

Author: Kamlesh72

backend/analytics_server/mhq/api/incidents.py

@@ -1,5 +1,5 @@
 import json
-from typing import Dict, List
+from typing import Dict, List, Optional as typeOptional
 
 from datetime import datetime
 
@@ -23,10 +23,10 @@
     adapt_mean_time_to_recovery_metrics,
 )
 from mhq.store.models.incidents import Incident
-
 from mhq.api.request_utils import coerce_workflow_filter, queryschema
 from mhq.service.query_validator import get_query_validator
 
+
 app = Blueprint("incidents", __name__)
 
 
@@ -36,19 +36,29 @@
         {
             Required("from_time"): All(str, Coerce(datetime.fromisoformat)),
             Required("to_time"): All(str, Coerce(datetime.fromisoformat)),
+            Optional("pr_filter"): All(str, Coerce(json.loads)),
         }
     ),
 )
-def get_resolved_incidents(team_id: str, from_time: datetime, to_time: datetime):
+def get_resolved_incidents(
+    team_id: str,
+    from_time: datetime,
+    to_time: datetime,
+    pr_filter: typeOptional[Dict] = None,
+):
 
     query_validator = get_query_validator()
     interval = query_validator.interval_validator(from_time, to_time)
     query_validator.team_validator(team_id)
 
+    pr_filter: PRFilter = apply_pr_filter(
+        pr_filter, EntityType.TEAM, team_id, [SettingType.EXCLUDED_PRS_SETTING]
+    )
+
     incident_service = get_incident_service()
 
     resolved_incidents: List[Incident] = incident_service.get_resolved_team_incidents(
-        team_id, interval
+        team_id, interval, pr_filter
     )
 
     # ToDo: Generate a user map
@@ -71,7 +81,7 @@ def get_deployments_with_related_incidents(
     team_id: str,
     from_time: datetime,
     to_time: datetime,
-    pr_filter: dict = None,
+    pr_filter: typeOptional[Dict] = None,
     workflow_filter: WorkflowFilter = None,
 ):
     query_validator = get_query_validator()
@@ -90,7 +100,9 @@ def get_deployments_with_related_incidents(
 
     incident_service = get_incident_service()
 
-    incidents: List[Incident] = incident_service.get_team_incidents(team_id, interval)
+    incidents: List[Incident] = incident_service.get_team_incidents(
+        team_id, interval, pr_filter
+    )
 
     deployment_incidents_map: Dict[Deployment, List[Incident]] = (
         incident_service.get_deployment_incidents_map(deployments, incidents)
@@ -112,18 +124,28 @@ def get_deployments_with_related_incidents(
         {
             Required("from_time"): All(str, Coerce(datetime.fromisoformat)),
             Required("to_time"): All(str, Coerce(datetime.fromisoformat)),
+            Optional("pr_filter"): All(str, Coerce(json.loads)),
         }
     ),
 )
-def get_team_mttr(team_id: str, from_time: datetime, to_time: datetime):
+def get_team_mttr(
+    team_id: str,
+    from_time: datetime,
+    to_time: datetime,
+    pr_filter: typeOptional[Dict] = None,
+):
     query_validator = get_query_validator()
     interval = query_validator.interval_validator(from_time, to_time)
     query_validator.team_validator(team_id)
 
+    pr_filter: PRFilter = apply_pr_filter(
+        pr_filter, EntityType.TEAM, team_id, [SettingType.EXCLUDED_PRS_SETTING]
+    )
+
     incident_service = get_incident_service()
 
     team_mean_time_to_recovery_metrics = (
-        incident_service.get_team_mean_time_to_recovery(team_id, interval)
+        incident_service.get_team_mean_time_to_recovery(team_id, interval, pr_filter)
     )
 
     return adapt_mean_time_to_recovery_metrics(team_mean_time_to_recovery_metrics)
@@ -135,18 +157,30 @@ def get_team_mttr(team_id: str, from_time: datetime, to_time: datetime):
         {
             Required("from_time"): All(str, Coerce(datetime.fromisoformat)),
             Required("to_time"): All(str, Coerce(datetime.fromisoformat)),
+            Optional("pr_filter"): All(str, Coerce(json.loads)),
         }
     ),
 )
-def get_team_mttr_trends(team_id: str, from_time: datetime, to_time: datetime):
+def get_team_mttr_trends(
+    team_id: str,
+    from_time: datetime,
+    to_time: datetime,
+    pr_filter: typeOptional[Dict] = None,
+):
     query_validator = get_query_validator()
     interval = query_validator.interval_validator(from_time, to_time)
     query_validator.team_validator(team_id)
 
+    pr_filter: PRFilter = apply_pr_filter(
+        pr_filter, EntityType.TEAM, team_id, [SettingType.EXCLUDED_PRS_SETTING]
+    )
+
     incident_service = get_incident_service()
 
     weekly_mean_time_to_recovery_metrics = (
-        incident_service.get_team_mean_time_to_recovery_trends(team_id, interval)
+        incident_service.get_team_mean_time_to_recovery_trends(
+            team_id, interval, pr_filter
+        )
     )
 
     return {
@@ -172,7 +206,7 @@ def get_team_cfr(
     team_id: str,
     from_time: datetime,
     to_time: datetime,
-    pr_filter: dict = None,
+    pr_filter: typeOptional[Dict] = None,
     workflow_filter: WorkflowFilter = None,
 ):
 
@@ -192,7 +226,9 @@ def get_team_cfr(
 
     incident_service = get_incident_service()
 
-    incidents: List[Incident] = incident_service.get_team_incidents(team_id, interval)
+    incidents: List[Incident] = incident_service.get_team_incidents(
+        team_id, interval, pr_filter
+    )
 
     team_change_failure_rate: ChangeFailureRateMetrics = (
         incident_service.get_change_failure_rate_metrics(deployments, incidents)
@@ -216,7 +252,7 @@ def get_team_cfr_trends(
     team_id: str,
     from_time: datetime,
     to_time: datetime,
-    pr_filter: dict = None,
+    pr_filter: typeOptional[Dict] = None,
     workflow_filter: WorkflowFilter = None,
 ):
 
@@ -236,7 +272,9 @@ def get_team_cfr_trends(
 
     incident_service = get_incident_service()
 
-    incidents: List[Incident] = incident_service.get_team_incidents(team_id, interval)
+    incidents: List[Incident] = incident_service.get_team_incidents(
+        team_id, interval, pr_filter
+    )
 
     team_weekly_change_failure_rate: Dict[datetime, ChangeFailureRateMetrics] = (
         incident_service.get_weekly_change_failure_rate(

backend/analytics_server/mhq/api/resources/settings_resource.py

@@ -5,6 +5,7 @@
     ExcludedPRsSetting,
     IncidentTypesSetting,
     IncidentSourcesSetting,
+    IncidentPRsSetting,
 )
 from mhq.store.models import EntityType
 
@@ -55,6 +56,12 @@ def _add_setting_data(config_settings: ConfigurationSettings, response):
                 "default_sync_days": config_settings.specific_settings.default_sync_days
             }
 
+        if isinstance(config_settings.specific_settings, IncidentPRsSetting):
+            response["setting"] = {
+                "include_revert_prs": config_settings.specific_settings.include_revert_prs,
+                "filters": config_settings.specific_settings.filters,
+            }
+
         # ADD NEW API ADAPTER HERE
 
         return response

backend/analytics_server/mhq/service/code/pr_filter.py

@@ -1,7 +1,7 @@
 from typing import List, Dict, Any
 
 from mhq.service.settings.configuration_settings import get_settings_service
-from mhq.service.settings.models import ExcludedPRsSetting
+from mhq.service.settings.models import ExcludedPRsSetting, IncidentPRsSetting
 from mhq.store.models.code import PRFilter
 from mhq.store.models.settings.configuration_settings import SettingType
 from mhq.store.models.settings.enums import EntityType
@@ -103,6 +103,8 @@ def apply(self) -> PRFilter:
             )
             if setting_type == SettingType.EXCLUDED_PRS_SETTING:
                 self._apply_excluded_pr_ids_setting(setting=setting)
+            if setting_type == SettingType.INCIDENT_PRS_SETTING:
+                self._apply_incident_prs_setting(setting=setting)
 
         return self.pr_filter
 
@@ -111,3 +113,8 @@ def _apply_excluded_pr_ids_setting(self, setting: ExcludedPRsSetting):
         self.pr_filter.excluded_pr_ids = (
             self.pr_filter.excluded_pr_ids or []
         ) + setting.excluded_pr_ids
+
+    def _apply_incident_prs_setting(self, setting: IncidentPRsSetting):
+        self.pr_filter.incident_pr_filters = (
+            self.pr_filter.incident_pr_filters or []
+        ) + setting.filters

backend/analytics_server/mhq/service/incidents/incident_filter.py

@@ -4,8 +4,10 @@
     get_settings_service,
     IncidentSettings,
     IncidentTypesSetting,
+    IncidentPRsSetting,
 )
 from mhq.store.models.incidents import IncidentFilter
+from mhq.store.models.incidents.enums import IncidentType
 
 from mhq.store.models.settings import EntityType
 
@@ -106,4 +108,19 @@ def __incident_type_setting(self) -> List[str]:
         incident_types = []
         if setting and isinstance(setting, IncidentTypesSetting):
             incident_types = setting.incident_types
+
+        if SettingType.INCIDENT_PRS_SETTING in self.setting_types:
+            incident_prs_setting: Optional[IncidentPRsSetting] = (
+                self.setting_type_to_settings_map.get(SettingType.INCIDENT_PRS_SETTING)
+            )
+            if (
+                isinstance(incident_prs_setting, IncidentPRsSetting)
+                and not incident_prs_setting.include_revert_prs
+            ):
+                incident_types = [
+                    incident_type
+                    for incident_type in incident_types
+                    if incident_type != IncidentType.REVERT_PR
+                ]
+
         return incident_types