Harden Flask health endpoint registration

Author: Pigbibi

src/quant_platform_kit/common/health.py

@@ -180,13 +180,26 @@ def read(self) -> Heartbeat | None:
 
     def _register_flask(self) -> None:
         from flask import jsonify
-        monitor = self
 
-        @self._app.route("/health", methods=["GET"])
-        @self._app.route("/healthz", methods=["GET"])
-        def health():
+        def qpk_health():
             return jsonify({"status": "ok", "timestamp": datetime.now(timezone.utc).isoformat()})
 
+        existing_rules = {getattr(rule, "rule", "") for rule in self._app.url_map.iter_rules()}
+        if "/health" not in existing_rules:
+            self._app.add_url_rule(
+                "/health",
+                endpoint="qpk_health",
+                view_func=qpk_health,
+                methods=["GET"],
+            )
+        if "/healthz" not in existing_rules:
+            self._app.add_url_rule(
+                "/healthz",
+                endpoint="qpk_healthz",
+                view_func=qpk_health,
+                methods=["GET"],
+            )
+
     def _start_http_server(self) -> None:
         import http.server
         port = self._http_port

tests/test_common_health.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from flask import Flask
+
+from quant_platform_kit.common.health import register_health_endpoint
+
+
+def test_register_health_endpoint_uses_non_colliding_endpoint_names():
+    app = Flask(__name__)
+    register_health_endpoint(app)
+
+    @app.get("/")
+    def health():
+        return "service-info"
+
+    assert app.test_client().get("/").text == "service-info"
+    assert app.test_client().get("/health").status_code == 200
+    assert app.test_client().get("/healthz").status_code == 200
+
+
+def test_register_health_endpoint_preserves_existing_health_route():
+    app = Flask(__name__)
+
+    @app.get("/health")
+    def platform_health():
+        return "platform-ok"
+
+    register_health_endpoint(app)
+
+    assert app.test_client().get("/health").text == "platform-ok"
+    assert app.test_client().get("/healthz").status_code == 200