howler-api 4.0.0.dev1084__tar.gz → 4.0.0.dev1087__tar.gz

{howler_api-4.0.0.dev1084 → howler_api-4.0.0.dev1087}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: howler-api
-Version: 4.0.0.dev1084
+Version: 4.0.0.dev1087
 Summary: Howler - API server
 License: MIT
 Keywords: howler,alerting,gc,canada,cse-cst,cse,cst,cyber,cccs
@@ -29,7 +29,7 @@ Requires-Dist: elasticsearch (==8.19.3)
 Requires-Dist: flasgger (>=0.9.7.1,<0.10.0.0)
 Requires-Dist: flask (==3.1.3)
 Requires-Dist: flask-caching (==2.4.0)
-Requires-Dist: gevent (>=25.9.1,<26.0.0)
+Requires-Dist: gevent (==23.9.1)
 Requires-Dist: gunicorn (==23.0.0)
 Requires-Dist: luqum (>=1.0.0,<2.0.0)
 Requires-Dist: mergedeep (>=1.3.4,<2.0.0)
@@ -50,7 +50,7 @@ Requires-Dist: python-datemath (==3.0.3)
 Requires-Dist: python-dotenv (>=1.1.0,<2.0.0)
 Requires-Dist: pytz (>=2025.2,<2026.0)
 Requires-Dist: pyyaml (==6.0.3)
-Requires-Dist: redis (==4.6.0)
+Requires-Dist: redis (==8.0.1)
 Requires-Dist: requests (==2.34.2)
 Requires-Dist: tzdata (>=2026.1,<2027.0)
 Requires-Dist: validators (>=0.34,<0.36)

howler_api-4.0.0.dev1087/howler/actions/add_to_bundle.py

@@ -0,0 +1,171 @@
+from typing import Optional
+
+from howler.actions import check_hit_limit
+from howler.common.loader import datastore
+from howler.datastore.operations import OdmHelper
+from howler.odm.models.action import VALID_TRIGGERS
+from howler.odm.models.hit import Hit
+from howler.odm.models.user import User
+from howler.services import hit_service
+from howler.utils.str_utils import sanitize_lucene_query
+
+hit_helper = OdmHelper(Hit)
+
+OPERATION_ID = "add_to_bundle"
+MAX_HITS_BASIC = 10
+MAX_HITS_ADVANCED = 1000
+SKIP_CENTRAL_LIMIT = True  # This operation transforms the query, handles limit check locally
+
+
+def execute(query: str, bundle_id: Optional[str] = None, user: Optional[User] = None, **kwargs):
+    """Add a set of hits matching the query to the specified bundle.
+
+    Args:
+        query (str): The query containing the matching hits
+        bundle_id (str): The `howler.id` of the bundle to add the hits to.
+    """
+    report = []
+
+    if not bundle_id:
+        return [
+            {
+                "query": query,
+                "outcome": "error",
+                "title": "Invalid Bundle ID",
+                "message": "Bundle ID cannot be empty.",
+            }
+        ]
+
+    try:
+        bundle_hit = hit_service.get_hit(bundle_id, as_odm=True)
+        if not bundle_hit or not bundle_hit.howler.is_bundle:
+            report.append(
+                {
+                    "query": query,
+                    "outcome": "error",
+                    "title": "Invalid Bundle",
+                    "message": f"Either a hit with ID {bundle_id} does not exist, or it is not a bundle.",
+                }
+            )
+            return report
+
+        ds = datastore()
+
+        skipped_hits_bundles = ds.hit.search(
+            f"({query}) AND howler.is_bundle:true",
+            fl="howler.id",
+        )["items"]
+
+        if len(skipped_hits_bundles) > 0:
+            report.append(
+                {
+                    "query": f"({query}) AND howler.is_bundle:true",
+                    "outcome": "skipped",
+                    "title": "Skipped Bundles",
+                    "message": "Bundles cannot be added to a bundle.",
+                }
+            )
+
+        skipped_hits_already_added = ds.hit.search(
+            f"({query}) AND (howler.bundles:{sanitize_lucene_query(bundle_id)})",
+            fl="howler.id",
+        )["items"]
+
+        if len(skipped_hits_already_added) > 0:
+            report.append(
+                {
+                    "query": f"({query}) AND (howler.bundles:{sanitize_lucene_query(bundle_id)})",
+                    "outcome": "skipped",
+                    "title": "Skipped Hits",
+                    "message": "These hits have already been added to the specified bundle.",
+                }
+            )
+
+        safe_query = f"({query}) AND (-howler.bundles:({sanitize_lucene_query(bundle_id)}) AND howler.is_bundle:false)"
+
+        # Check hit limit against the effective query (not raw query)
+        if user:
+            limit_error = check_hit_limit(safe_query, user, MAX_HITS_BASIC, MAX_HITS_ADVANCED)
+            if limit_error:
+                return [limit_error]
+
+        matching_hits = ds.hit.search(safe_query, rows=MAX_HITS_ADVANCED, fl="howler.id")["items"]
+        if len(matching_hits) < 1:
+            report.append(
+                {
+                    "query": safe_query,
+                    "outcome": "skipped",
+                    "title": "No Matching Hits",
+                    "message": "There were no hits matching this query.",
+                }
+            )
+            return report
+
+        ds.hit.update_by_query(
+            safe_query,
+            [hit_helper.list_add("howler.bundles", sanitize_lucene_query(bundle_id), if_missing=True)],
+        )
+
+        operations = [
+            hit_helper.list_add(
+                "howler.hits",
+                hit["howler"]["id"],
+                if_missing=True,
+            )
+            for hit in matching_hits
+        ]
+
+        operations.append(hit_helper.update("howler.bundle_size", len(operations)))
+        hit_service.update_hit(
+            bundle_id,
+            operations,
+        )
+        bundle_hit = hit_service.get_hit(bundle_id, as_odm=True)
+        report.append(
+            {
+                "query": safe_query.replace("-howler.bundles", "howler.bundles"),
+                "outcome": "success",
+                "title": "Executed Successfully",
+                "message": "The specified bundle has had all matching hits added.",
+            }
+        )
+    except Exception as e:
+        report.append(
+            {
+                "query": query,
+                "outcome": "error",
+                "title": "Failed to Execute",
+                "message": f"Unknown exception occurred: {str(e)}",
+            }
+        )
+
+    return report
+
+
+def specification():
+    """Specify various properties of the action, such as title, descriptions, permissions and input steps."""
+    return {
+        "id": OPERATION_ID,
+        "title": "Add to Bundle",
+        "priority": 6,
+        "i18nKey": f"operations.{OPERATION_ID}",
+        "description": {
+            "short": "Add a set of hits to a bundle",
+            "long": execute.__doc__,
+        },
+        "roles": ["automation_basic", "actionrunner_basic"],
+        "steps": [
+            {
+                "args": {"bundle_id": []},
+                "options": {},
+                "validation": {
+                    "warn": {"query": "howler.bundles:($bundle_id) OR howler.is_bundle:true"},
+                    "error": {
+                        "query": "howler.id:$bundle_id AND howler.is_bundle:false",
+                        "message": "The bundle id given must be a bundle.",
+                    },
+                },
+            }
+        ],
+        "triggers": VALID_TRIGGERS,
+    }

{howler_api-4.0.0.dev1084 → howler_api-4.0.0.dev1087}/howler/actions/demote.py

@@ -9,7 +9,7 @@ from howler.odm.models.howler_data import (
     Assessment,
     AssessmentEscalationMap,
     Escalation,
-    Status,
+    HitStatus,
 )
 from howler.odm.models.user import User
 from howler.utils.str_utils import sanitize_lucene_query
@@ -99,7 +99,7 @@ def execute(
                         "howler.assignment",
                         user.get("uname", "automation") if user else "automation",
                     ),
-                    odm_helper.update("howler.status", Status.RESOLVED),
+                    odm_helper.update("howler.status", HitStatus.RESOLVED),
                 ],
             )
 

{howler_api-4.0.0.dev1084 → howler_api-4.0.0.dev1087}/howler/actions/remove_from_bundle.py

@@ -1,27 +1,29 @@
-"""Deprecated remove_from_bundle action — delegates to case_service for item removal."""
-
 from typing import Optional
 
 from howler.actions import check_hit_limit
-from howler.common.exceptions import NotFoundException
+from howler.common.exceptions import HowlerException
 from howler.common.loader import datastore
+from howler.datastore.operations import OdmHelper
 from howler.odm.models.action import VALID_TRIGGERS
+from howler.odm.models.hit import Hit
 from howler.odm.models.user import User
-from howler.services import bundle_compat_service, case_service
+from howler.services import hit_service
 from howler.utils.str_utils import sanitize_lucene_query
 
+hit_helper = OdmHelper(Hit)
+
 OPERATION_ID = "remove_from_bundle"
 MAX_HITS_BASIC = 10
 MAX_HITS_ADVANCED = 1000
 SKIP_CENTRAL_LIMIT = True  # This operation transforms the query, handles limit check locally
 
 
-def execute(query: str, bundle_id: Optional[str] = None, user: Optional[User] = None, **kwargs):  # noqa: C901
-    """Remove a set of hits matching the query from the specified bundle (deprecated — uses cases).
+def execute(query: str, bundle_id: Optional[str] = None, user: Optional[User] = None, **kwargs):
+    """Remove a set of hits matching the query from the specified bundle.
 
     Args:
         query (str): The query containing the matching hits
-        bundle_id (str): The ``howler.id`` of the bundle to remove the hits from.
+        bundle_id (str): The `howler.id` of the bundle to remove the hits from.
     """
     report = []
 
@@ -36,78 +38,67 @@ def execute(query: str, bundle_id: Optional[str] = None, user: Optional[User] =
         ]
 
     try:
-        case_id = bundle_compat_service.find_case_for_bundle(bundle_id)
-        if case_id is None:
+        bundle_hit = hit_service.get_hit(bundle_id, as_odm=True)
+        if not bundle_hit or not bundle_hit.howler.is_bundle:
             report.append(
                 {
                     "query": query,
                     "outcome": "error",
                     "title": "Invalid Bundle",
-                    "message": f"Either a hit with ID {bundle_id} does not exist, or it has no associated case.",
+                    "message": f"Either a hit with ID {bundle_id} does not exist, or it is not a bundle.",
                 }
             )
             return report
 
         ds = datastore()
 
-        # Check hit limit against the query before searching
-        if user:
-            limit_error = check_hit_limit(query, user, MAX_HITS_BASIC, MAX_HITS_ADVANCED)
-            if limit_error:
-                return [limit_error]
-
-        matching_hits = ds.hit.search(query, rows=MAX_HITS_ADVANCED)["items"]
+        skipped_hits = ds.hit.search(
+            f"({query}) AND -howler.bundles:{sanitize_lucene_query(bundle_id)}",
+            fl="howler.id",
+        )["items"]
 
-        if not matching_hits:
+        if len(skipped_hits) > 0:
             report.append(
                 {
-                    "query": query,
+                    "query": f"howler.id:({' OR '.join(h.howler.id for h in skipped_hits)})",
                     "outcome": "skipped",
-                    "title": "No Matching Hits",
-                    "message": "There were no hits matching this query.",
-                }
-            )
-            return report
-
-        # Get the case to check which hits are actually in it
-        case = ds.case.get(case_id)
-        if case is None:
-            report.append(
-                {
-                    "query": query,
-                    "outcome": "error",
-                    "title": "Case Not Found",
-                    "message": f"Associated case {case_id} no longer exists.",
+                    "title": "Skipped Hit not in Bundle",
+                    "message": "These hits already are not in the bundle.",
                 }
             )
-            return report
 
-        case_item_values = {item.value for item in case.items}
-        values_to_remove = [h.howler.id for h in matching_hits if h.howler.id in case_item_values]
-        skipped_ids = [h.howler.id for h in matching_hits if h.howler.id not in case_item_values]
+        safe_query = f"{query} AND (howler.bundles:{sanitize_lucene_query(bundle_id)})"
 
-        if skipped_ids:
-            report.append(
-                {
-                    "query": f"howler.id:({' OR '.join(sanitize_lucene_query(h) for h in skipped_ids)})",
-                    "outcome": "skipped",
-                    "title": "Skipped Hits Not in Bundle",
-                    "message": "These hits are not in the bundle.",
-                }
-            )
+        # Check hit limit against the effective query (not raw query)
+        if user:
+            limit_error = check_hit_limit(safe_query, user, MAX_HITS_BASIC, MAX_HITS_ADVANCED)
+            if limit_error:
+                return [limit_error]
 
-        if not values_to_remove:
+        matching_hits = ds.hit.search(safe_query, rows=MAX_HITS_ADVANCED, fl="howler.id")["items"]
+        if len(matching_hits) < 1:
             report.append(
                 {
-                    "query": query,
+                    "query": safe_query,
                     "outcome": "skipped",
                     "title": "No Matching Hits",
-                    "message": "None of the matching hits were found in the bundle.",
+                    "message": "There were no hits matching this query.",
                 }
             )
             return report
 
-        case_service.remove_case_items(case_id, values_to_remove)
+        ds.hit.update_by_query(
+            safe_query,
+            [hit_helper.list_remove("howler.bundles", bundle_id)],
+        )
+
+        hit_service.update_hit(
+            bundle_id,
+            [hit_helper.list_remove("howler.hits", h["howler"]["id"]) for h in matching_hits],
+        )
+
+        if len(ds.hit.get(bundle_id).howler.hits) < 1:
+            hit_service.update_hit(bundle_id, [hit_helper.update("howler.is_bundle", False)])
 
         report.append(
             {
@@ -117,17 +108,7 @@ def execute(query: str, bundle_id: Optional[str] = None, user: Optional[User] =
                 "message": f"Matching hits removed from bundle with id {bundle_id}",
             }
         )
-
-    except NotFoundException as e:
-        report.append(
-            {
-                "query": query,
-                "outcome": "error",
-                "title": "Failed to Execute",
-                "message": str(e),
-            }
-        )
-    except Exception as e:
+    except HowlerException as e:
         report.append(
             {
                 "query": query,
@@ -144,11 +125,11 @@ def specification():
     """Specify various properties of the action, such as title, descriptions, permissions and input steps."""
     return {
         "id": OPERATION_ID,
-        "title": "Remove from Bundle (Deprecated)",
+        "title": "Remove from Bundle",
         "priority": 5,
         "i18nKey": f"operations.{OPERATION_ID}",
         "description": {
-            "short": "Remove a set of hits from a bundle (deprecated — uses cases)",
+            "short": "Remove a set of hits from a bundle",
             "long": execute.__doc__,
         },
         "roles": ["automation_basic", "actionrunner_basic"],
@@ -156,6 +137,7 @@ def specification():
             {
                 "args": {"bundle_id": []},
                 "options": {},
+                "validation": {"error": {"query": "-howler.bundles:$bundle_id"}},
             }
         ],
         "triggers": VALID_TRIGGERS,

{howler_api-4.0.0.dev1084 → howler_api-4.0.0.dev1087}/howler/actions/transition.py

@@ -9,12 +9,12 @@ from howler.helper.workflow import Workflow, WorkflowException
 from howler.odm.models.action import VALID_TRIGGERS
 from howler.odm.models.howler_data import (
     Assessment,
+    HitStatus,
     HitStatusTransition,
-    Status,
     Vote,
 )
 from howler.odm.models.user import User
-from howler.services import comms_service, hit_service
+from howler.services import event_service, hit_service
 from howler.utils.list_utils import flatten_list
 
 OPERATION_ID = "transition"
@@ -147,7 +147,7 @@ def execute(
         if total_processed % 10 == 0:
             log.debug("Transition executed on %s hits", total_processed)
             if request_id is not None:
-                comms_service.emit(
+                event_service.emit(
                     "automation",
                     {
                         "request_id": request_id,
@@ -193,13 +193,15 @@ def specification():
         "steps": [
             {
                 "args": {"status": []},
-                "options": {"status": Status.list()},
+                "options": {"status": HitStatus.list()},
                 "validation": {"error": {"query": "-howler.status:$status"}},
             },
             {
                 "args": {"transition": []},
                 "options": {
-                    "transition": {f"status:{status}": hit_service.get_transitions(status) for status in Status.list()},
+                    "transition": {
+                        f"status:{status}": hit_service.get_transitions(status) for status in HitStatus.list()
+                    },
                 },
             },
             {

{howler_api-4.0.0.dev1084 → howler_api-4.0.0.dev1087}/howler/api/__init__.py

@@ -25,8 +25,7 @@ logger = get_logger(__file__)
 
 def make_subapi_blueprint(name, api_version=1):
     """Create a flask Blueprint for a subapi in a standard way."""
-    full_name = f"v{api_version}_{name}"
-    return Blueprint(full_name, full_name, url_prefix="/".join([API_PREFIX, f"v{api_version}", name]))
+    return Blueprint(name, name, url_prefix="/".join([API_PREFIX, f"v{api_version}", name]))
 
 
 def _make_api_response(

{howler_api-4.0.0.dev1084 → howler_api-4.0.0.dev1087}/howler/api/socket.py

@@ -6,12 +6,12 @@ from typing import Any
 from flask import Blueprint, request
 from opentelemetry import trace
 
-import howler.services.comms_service as comms_service
-import howler.services.viewer_service as viewer_service
+import howler.services.event_service as event_service
 from howler.api import ok, unauthorized
 from howler.common.logging import get_logger
+from howler.datastore.operations import OdmHelper
 from howler.helper.ws import ConnectionClosed, Server
-from howler.security import api_login
+from howler.odm.models.hit import Hit
 from howler.security.socket import websocket_auth, ws_response
 from howler.utils.socket_utils import check_action
 
@@ -24,16 +24,13 @@ socket_api._doc = "Endpoints concerning websocket connectivity between the clien
 logger = get_logger(__file__)
 tracer = trace.get_tracer(__name__)
 
+hit_helper = OdmHelper(Hit)
+
 
 @tracer.start_as_current_span(f"{__name__}.emit")
 @socket_api.route("/emit/<event>", methods=["POST"])
 def emit(event: str):
-    """Emit an event to all listening websockets.
-
-    .. deprecated::
-        This endpoint is deprecated. Events are now propagated via Redis pubsub
-        and no longer require a dedicated websocket pod.
-    """
+    """Emit an event to all listening websockets"""
     if "Authorization" not in request.headers:
         return unauthorized(err="Missing authorization header")
 
@@ -47,30 +44,15 @@ def emit(event: str):
 
         return unauthorized(err="Invalid auth data")
 
-    comms_service.emit(event, request.json)
+    event_service.emit(event, request.json)
 
     return ok()
 
 
-@tracer.start_as_current_span(f"{__name__}.get_viewers")
-@socket_api.route("/viewers/<entity_id>", methods=["GET"])
-@api_login(audit=False, required_priv=["R"])
-def get_viewers(entity_id: str, **kwargs):
-    """Get the list of users currently viewing the specified entity
-
-    Variables:
-    entity_id       => The ID of the entity to get viewers for
-
-    Result Example:
-    ["user1", "user2"]
-    """
-    return ok(viewer_service.get_viewers(entity_id))
-
-
 @tracer.start_as_current_span(f"{__name__}.connect")
 @socket_api.route("/connect", websocket=True)  # type: ignore
 @websocket_auth(required_priv=["R"])
-def connect(ws: Server, *args: Any, ws_id: str, **kwargs):  # noqa: C901
+def connect(ws: Server, *args: Any, ws_id: str, **kwargs):
     """Connect to the server to monitor for updates via websocket
 
     Variables:
@@ -96,20 +78,10 @@ def connect(ws: Server, *args: Any, ws_id: str, **kwargs):  # noqa: C901
         logger.debug("Sending action: %s", data)
         ws.send(ws_response("action", data))
 
-    def send_case(data: dict[str, Any]):
-        logger.debug("Sending case update: %s", data.get("case", {}).get("case_id", "unknown"))
-        ws.send(ws_response("cases", data))
-
-    def send_viewers_update(data: dict[str, Any]):
-        logger.debug("Sending viewers update: %s", data.get("id", "unknown"))
-        ws.send(ws_response("viewers_update", data))
-
     try:
-        comms_service.on("hits", send_hit)
-        comms_service.on("broadcast", send_broadcast)
-        comms_service.on("action", send_action)
-        comms_service.on("cases", send_case)
-        comms_service.on("viewers_update", send_viewers_update)
+        event_service.on("hits", send_hit)
+        event_service.on("broadcast", send_broadcast)
+        event_service.on("action", send_action)
         while ws.connected:
             data = ws.receive(10)
             if data:
@@ -138,11 +110,9 @@ def connect(ws: Server, *args: Any, ws_id: str, **kwargs):  # noqa: C901
         else:
             logger.exception("Exception on connect.")
     finally:
-        comms_service.off("hits", send_hit)
-        comms_service.off("broadcast", send_broadcast)
-        comms_service.off("action", send_action)
-        comms_service.off("cases", send_case)
-        comms_service.off("viewers_update", send_viewers_update)
+        event_service.off("hits", send_hit)
+        event_service.off("broadcast", send_broadcast)
+        event_service.off("action", send_action)
 
         for id, action, broadcast in outstanding_actions:
             outstanding_actions = check_action(id, action, broadcast, outstanding_actions=outstanding_actions, **kwargs)