Added Notify message filter for queued event existence and status using parsed criteria format; included parser utility for criteria string decomposition

Author: Andyg79

classes/notify_event_status.py

@@ -0,0 +1,14 @@
+class NotifyEventStatus:
+    _label_to_id = {
+        "S1": 9901,
+        "S2": 9902,
+        "M1": 9903,
+        # Extend as needed
+    }
+
+    @classmethod
+    def get_id(cls, description: str) -> int:
+        key = description.strip().upper()
+        if key not in cls._label_to_id:
+            raise ValueError(f"Unknown Notify event type: '{description}'")
+        return cls._label_to_id[key]

utils/notify_criteria_parser.py

@@ -0,0 +1,20 @@
+import re
+
+def parse_notify_criteria(criteria: str) -> dict:
+    """
+    Parses criteria strings like 'S1 - new' or 'S1 (S1w) - sending' into parts.
+    """
+    criteria = criteria.strip()
+    if criteria.lower() == "none":
+        return {"status": "none"}
+
+    pattern = r"^(?P<type>[^\s(]+)(?:\s+\((?P<code>[^)]+)\))?\s*-\s*(?P<status>\w+)$"
+    match = re.match(pattern, criteria, re.IGNORECASE)
+    if not match:
+        raise ValueError(f"Invalid Notify criteria format: '{criteria}'")
+
+    return {
+        "type": match.group("type"),
+        "code": match.group("code"),
+        "status": match.group("status").lower(),
+    }

utils/oracle/mock_selection_builder.py

@@ -1,6 +1,7 @@
 # mock_selection_builder.py — Development-only testing harness for criteria logic
 import sys
 import os
+import re
 from typing import Optional
 
 sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "../..")))
@@ -14,23 +15,40 @@ def __init__(self, lynch_due_date_change_reason_id):
         self.lynch_due_date_change_reason_id = lynch_due_date_change_reason_id
 
 
-class PrevalentIncidentStatusType:
-    """
-    Maps symbolic values for FOBT prevalent/incident episode classification.
-    """
+class NotifyEventStatus:
+    _label_to_id = {
+        "S1": 9901,
+        "S2": 9902,
+        "M1": 9903,
+        # Extend as needed
+    }
 
-    PREVALENT = "prevalent"
-    INCIDENT = "incident"
+    @classmethod
+    def get_id(cls, description: str) -> int:
+        key = description.strip().upper()
+        if key not in cls._label_to_id:
+            raise ValueError(f"Unknown Notify event type: '{description}'")
+        return cls._label_to_id[key]
 
-    _valid_values = {PREVALENT, INCIDENT}
 
-    @classmethod
-    def from_description(cls, description: str) -> str:
-        key = description.strip().lower()
-        if key not in cls._valid_values:
-            raise ValueError(f"Unknown FOBT episode status: '{description}'")
-        return key
+def parse_notify_criteria(criteria: str) -> dict:
+    """
+    Parses criteria strings like 'S1 - new' or 'S1 (S1w) - sending' into parts.
+    """
+    criteria = criteria.strip()
+    if criteria.lower() == "none":
+        return {"status": "none"}
+
+    pattern = r"^(?P<type>[^\s(]+)(?:\s+\((?P<code>[^)]+)\))?\s*-\s*(?P<status>\w+)$"
+    match = re.match(pattern, criteria, re.IGNORECASE)
+    if not match:
+        raise ValueError(f"Invalid Notify criteria format: '{criteria}'")
 
+    return {
+        "type": match.group("type"),
+        "code": match.group("code"),
+        "status": match.group("status").lower(),
+    }
 
 class MockSelectionBuilder:
     """
@@ -98,22 +116,42 @@ def _dataset_source_for_criteria_key(self) -> dict:
     def _add_join_to_surveillance_review(self):
         self.sql_from.append("-- JOIN to surveillance review placeholder")
 
+
     # === Example testable method below ===
     # Replace this with the one you want to test,
     # then use utils/oracle/test_subject_criteria_dev.py to run your scenarios
 
-    def _add_criteria_fobt_prevalent_incident_status(self) -> None:
+    def _add_criteria_notify_queued_message_status(self) -> None:
         """
-        Filters subjects by whether their FOBT episode is prevalent or incident.
+        Filters subjects based on Notify queued message status, e.g. 'S1 (S1w) - new'.
         """
         try:
-            value = PrevalentIncidentStatusType.from_description(self.criteria_value)
-            column = "ss.fobt_incident_subject_epis_id"
+            parts = parse_notify_criteria(self.criteria_value)
+            status = parts["status"]
+
+            if status == "none":
+                clause = "NOT EXISTS"
+            else:
+                clause = "EXISTS"
+
+            self.sql_where.append(f"AND {clause} (")
+            self.sql_where.append(
+                "SELECT 1 FROM notify_message_queue nmq "
+                "INNER JOIN notify_message_definition nmd ON nmd.message_definition_id = nmq.message_definition_id "
+                "WHERE nmq.nhs_number = c.nhs_number "
+            )
+
+            # Simulate getNotifyMessageEventStatusIdFromCriteria()
+            event_status_id = NotifyEventStatus.get_id(parts["type"])
+            self.sql_where.append(f"AND nmd.event_status_id = {event_status_id} ")
+
+            if status != "none":
+                self.sql_where.append(f"AND nmq.message_status = '{status}' ")
+
+            if "code" in parts and parts["code"]:
+                self.sql_where.append(f"AND nmd.message_code = '{parts['code']}' ")
 
-            if value == PrevalentIncidentStatusType.PREVALENT:
-                self.sql_where.append(f"AND {column} IS NULL")
-            elif value == PrevalentIncidentStatusType.INCIDENT:
-                self.sql_where.append(f"AND {column} IS NOT NULL")
+            self.sql_where.append(")")
 
         except Exception:
             raise SelectionBuilderException(self.criteria_key_name, self.criteria_value)

utils/oracle/subject_selection_query_builder.py

@@ -1,6 +1,7 @@
 from typing import Dict, Union, Tuple, Optional
 import logging
 from datetime import datetime, date
+from utils.notify_criteria_parser import parse_notify_criteria
 from classes.bowel_scope_dd_reason_for_change_type import (
     BowelScopeDDReasonForChangeType,
 )
@@ -54,6 +55,7 @@
     LynchIncidentEpisodeType,
 )
 from classes.prevalent_incident_status_type import PrevalentIncidentStatusType
+from classes.notify_event_status import NotifyEventStatus
 
 
 class SubjectSelectionQueryBuilder:
@@ -2247,6 +2249,41 @@ def _add_criteria_fobt_prevalent_incident_status(self) -> None:
         except Exception:
             raise SelectionBuilderException(self.criteria_key_name, self.criteria_value)
 
+    def _add_criteria_notify_queued_message_status(self) -> None:
+        """
+        Filters subjects based on Notify queued message status, e.g. 'S1 (S1w) - new'.
+        """
+        try:
+            parts = parse_notify_criteria(self.criteria_value)
+            status = parts["status"]
+
+            if status == "none":
+                clause = "NOT EXISTS"
+            else:
+                clause = "EXISTS"
+
+            self.sql_where.append(f"AND {clause} (")
+            self.sql_where.append(
+                "SELECT 1 FROM notify_message_queue nmq "
+                "INNER JOIN notify_message_definition nmd ON nmd.message_definition_id = nmq.message_definition_id "
+                "WHERE nmq.nhs_number = c.nhs_number "
+            )
+
+            # Simulate getNotifyMessageEventStatusIdFromCriteria()
+            event_status_id = NotifyEventStatus.get_id(parts["type"])
+            self.sql_where.append(f"AND nmd.event_status_id = {event_status_id} ")
+
+            if status != "none":
+                self.sql_where.append(f"AND nmq.message_status = '{status}' ")
+
+            if "code" in parts and parts["code"]:
+                self.sql_where.append(f"AND nmd.message_code = '{parts['code']}' ")
+
+            self.sql_where.append(")")
+
+        except Exception:
+            raise SelectionBuilderException(self.criteria_key_name, self.criteria_value)
+
     # ------------------------------------------------------------------------
     # 🧬 CADS Clinical Dataset Filters
     # ------------------------------------------------------------------------

utils/oracle/test_subject_criteria_dev.py

@@ -41,8 +41,7 @@ def make_builder(key, value, index=0, comparator="="):
     return b
 
 
-# === Test: FOBT_PREVALENT_INCIDENT_STATUS (incident) ===
-b = make_builder(SubjectSelectionCriteriaKey.FOBT_PREVALENT_INCIDENT_STATUS, "incident")
-b._add_criteria_fobt_prevalent_incident_status()
-print("=== FOBT_PREVALENT_INCIDENT_STATUS (incident) ===")
-print(b.dump_sql(), end="\n\n")
+# === Test: Notify message (S1 - new) ===
+b = make_builder(SubjectSelectionCriteriaKey.NOTIFY_QUEUED_MESSAGE_STATUS, "S1 - new")
+b._add_criteria_notify_queued_message_status()
+print(b.dump_sql())