Use shared strategy plugin alert dispatcher (#84)

Author: Pigbibi

main.py

@@ -31,14 +31,10 @@
     load_configured_strategy_plugin_signals,
     parse_strategy_plugin_mounts,
 )
-from quant_platform_kit.notifications.strategy_plugin_email import (
-    StrategyPluginEmailAlertMarkerStore,
-    build_strategy_plugin_alert_context_label as build_email_alert_context_label,
-    publish_strategy_plugin_email_alerts,
-)
-from quant_platform_kit.notifications.strategy_plugin_sms import (
-    StrategyPluginSmsAlertMarkerStore,
-    publish_strategy_plugin_sms_alerts,
+from quant_platform_kit.notifications.strategy_plugin_alerts import (
+    StrategyPluginAlertStateSettings,
+    build_strategy_plugin_alert_context_label as build_alert_context_label,
+    publish_strategy_plugin_alerts as dispatch_strategy_plugin_alerts,
 )
 from quant_platform_kit.strategy_contracts import build_strategy_evaluation_inputs
 from runtime_logging import build_run_id, emit_runtime_log
@@ -221,24 +217,14 @@ def build_strategy_plugin_alert_messages(signals):
     return STRATEGY_ADAPTERS.build_strategy_plugin_alert_messages(signals)
 
 
-def build_strategy_plugin_alert_store():
-    return StrategyPluginEmailAlertMarkerStore(
-        local_dir=os.getenv("STRATEGY_PLUGIN_ALERT_STATE_DIR") or "/tmp/quant_strategy_plugin_alerts",
-        gcs_prefix_uri=os.getenv("STRATEGY_PLUGIN_ALERT_STATE_GCS_URI") or os.getenv("EXECUTION_REPORT_GCS_URI"),
-        gcp_project_id=PROJECT_ID,
-    )
-
-
-def build_strategy_plugin_sms_alert_store():
-    return StrategyPluginSmsAlertMarkerStore(
-        local_dir=os.getenv("STRATEGY_PLUGIN_ALERT_STATE_DIR") or "/tmp/quant_strategy_plugin_alerts",
-        gcs_prefix_uri=os.getenv("STRATEGY_PLUGIN_ALERT_STATE_GCS_URI") or os.getenv("EXECUTION_REPORT_GCS_URI"),
+def build_strategy_plugin_alert_state_settings():
+    return StrategyPluginAlertStateSettings.from_env(
         gcp_project_id=PROJECT_ID,
     )
 
 
 def build_strategy_plugin_alert_context_label() -> str:
-    return build_email_alert_context_label(
+    return build_alert_context_label(
         platform_id="longbridge",
         strategy_profile=STRATEGY_PROFILE,
         account_scope=ACCOUNT_REGION,
@@ -247,39 +233,19 @@ def build_strategy_plugin_alert_context_label() -> str:
     )
 
 
-def attach_strategy_plugin_alert_email_result(report, result) -> None:
-    report.setdefault("summary", {})["strategy_plugin_alert_email_sent_count"] = result.sent_count
-    report.setdefault("diagnostics", {}).update(result.to_report_fields())
-
-
-def attach_strategy_plugin_alert_sms_result(report, result) -> None:
-    report.setdefault("summary", {})["strategy_plugin_alert_sms_sent_count"] = result.sent_count
-    report.setdefault("diagnostics", {}).update(result.to_report_fields())
-
-
 def publish_strategy_plugin_alerts(signals, *, report=None):
-    email_result = publish_strategy_plugin_email_alerts(
-        signals,
-        email_settings=RUNTIME_SETTINGS,
-        translator=t,
-        strategy_label=STRATEGY_PROFILE,
-        context_label=build_strategy_plugin_alert_context_label(),
-        alert_store=build_strategy_plugin_alert_store(),
-        log_message=print,
-    )
-    sms_result = publish_strategy_plugin_sms_alerts(
+    result = dispatch_strategy_plugin_alerts(
         signals,
-        sms_settings=RUNTIME_SETTINGS,
+        notification_settings=RUNTIME_SETTINGS,
         translator=t,
         strategy_label=STRATEGY_PROFILE,
         context_label=build_strategy_plugin_alert_context_label(),
-        alert_store=build_strategy_plugin_sms_alert_store(),
+        state_settings=build_strategy_plugin_alert_state_settings(),
         log_message=print,
     )
     if report is not None:
-        attach_strategy_plugin_alert_email_result(report, email_result)
-        attach_strategy_plugin_alert_sms_result(report, sms_result)
-    return email_result
+        result.attach_to_report(report)
+    return result
 
 
 def run_strategy(*, force_run: bool = False, validation_only: bool = False, validation_label: str = "backfill"):

requirements.txt

@@ -1,7 +1,7 @@
 flask
 gunicorn
-quant-platform-kit @ git+https://github.com/QuantStrategyLab/QuantPlatformKit.git@d43800180aae1c7fe7051496a6af5d76f2c65879
-us-equity-strategies @ git+https://github.com/QuantStrategyLab/UsEquityStrategies.git@9661d8bb74e33466fa0ec1efef168b1d1bae8875
+quant-platform-kit @ git+https://github.com/QuantStrategyLab/QuantPlatformKit.git@532346b6e22d9f9c0a25c5e859f29084d7b27f6c
+us-equity-strategies @ git+https://github.com/QuantStrategyLab/UsEquityStrategies.git@7ccc46038e6f0fe84a6910a6fa0515252bf15b79
 pandas
 requests
 pytz

tests/test_request_handling.py

@@ -423,41 +423,20 @@ def build_rebalance_config(self, *, strategy_plugin_signals=()):
         module.is_market_open_now = lambda: True
         module.run_rebalance_cycle = lambda **_kwargs: None
 
-        def fake_email_publish(signals, **kwargs):
-            observed["email_alerts"].append((tuple(signals), kwargs))
-            return types.SimpleNamespace(
-                sent_count=1,
-                to_report_fields=lambda: {
-                    "strategy_plugin_alert_email_attempted_count": 1,
-                    "strategy_plugin_alert_email_sent_count": 1,
-                    "strategy_plugin_alert_email_skipped_count": 0,
-                    "strategy_plugin_alert_email_failed_count": 0,
-                    "strategy_plugin_alert_email_deliveries": [],
-                },
-            )
+        observed["alerts"] = []
 
-        def fake_sms_publish(signals, **kwargs):
-            observed["sms_alerts"].append((tuple(signals), kwargs))
-            return types.SimpleNamespace(
-                sent_count=1,
-                to_report_fields=lambda: {
-                    "strategy_plugin_alert_sms_attempted_count": 1,
-                    "strategy_plugin_alert_sms_sent_count": 1,
-                    "strategy_plugin_alert_sms_skipped_count": 0,
-                    "strategy_plugin_alert_sms_failed_count": 0,
-                    "strategy_plugin_alert_sms_deliveries": [],
-                },
-            )
+        def fake_dispatch(signals, **kwargs):
+            observed["alerts"].append((tuple(signals), kwargs))
+            return types.SimpleNamespace(attach_to_report=lambda _report: None)
 
-        module.publish_strategy_plugin_email_alerts = fake_email_publish
-        module.publish_strategy_plugin_sms_alerts = fake_sms_publish
+        module.dispatch_strategy_plugin_alerts = fake_dispatch
 
         module.run_strategy()
 
-        self.assertEqual(observed["email_alerts"][0][0], (signal,))
-        self.assertEqual(observed["sms_alerts"][0][0], (signal,))
-        self.assertIn("longbridge", observed["email_alerts"][0][1]["context_label"])
-        self.assertIn("longbridge", observed["sms_alerts"][0][1]["context_label"])
+        self.assertEqual(observed["alerts"][0][0], (signal,))
+        self.assertIn("longbridge", observed["alerts"][0][1]["context_label"])
+        self.assertIs(observed["alerts"][0][1]["notification_settings"], module.RUNTIME_SETTINGS)
+        self.assertIsNotNone(observed["alerts"][0][1]["state_settings"])
 
     def test_run_strategy_force_runs_when_market_closed(self):
         module = load_module()