commit f80a87f2c458a4d8092aae91249aec1adcec6cd5
author Ed Tanous <etanous@nvidia.com> Sun Jun 16 12:10:33 2024 -0700
committer Ed Tanous <etanous@nvidia.com> Mon Jul 29 15:00:42 2024 -0700
tree 6c62fbd2d9dad8f8c45cfe87da878854d7ef26f2
parent 2d57219665f47c7fd9c2cdbc31a588f1da51ea72

Add SSE filter param support

The Redfish spec require filtering of SSE entries to be supported.
This commit rearranges the code, and implements SSE sorting as well
as support for Last-Event-Id.  To do this it adds a dependency on
boost circular_buffer.

Tested:

SSE connections succeed.  Show filtered results.

Change-Id: I7aeb266fc40471519674c7b65cd5cc4625019e68
Signed-off-by: Ed Tanous <etanous@nvidia.com>

redfish-core/lib/eventservice_sse.hpp

diff --git a/redfish-core/lib/eventservice_sse.hpp b/redfish-core/lib/eventservice_sse.hpp
index 3cbca3b..c0a9527 100644
--- a/redfish-core/lib/eventservice_sse.hpp
+++ b/redfish-core/lib/eventservice_sse.hpp
@@ -1,5 +1,6 @@
 #pragma once
 
+#include "filter_expr_executor.hpp"
 #include "privileges.hpp"
 #include "registries/privilege_registry.hpp"
 
@@ -12,7 +13,8 @@
 namespace redfish
 {
 
-inline void createSubscription(crow::sse_socket::Connection& conn)
+inline void createSubscription(crow::sse_socket::Connection& conn,
+                               const crow::Request& req)
 {
     EventServiceManager& manager =
         EventServiceManager::getInstance(&conn.getIoContext());
@@ -23,6 +25,25 @@
         conn.close("Max SSE subscriptions reached");
         return;
     }
+
+    std::optional<filter_ast::LogicalAnd> filter;
+
+    boost::urls::params_base::iterator filterIt =
+        req.url().params().find("$filter");
+
+    if (filterIt != req.url().params().end())
+    {
+        std::string_view filterValue = (*filterIt).value;
+        filter = parseFilter(filterValue);
+        if (!filter)
+        {
+            conn.close(std::format("Bad $filter param: {}", filterValue));
+            return;
+        }
+    }
+
+    std::string lastEventId(req.getHeaderValue("Last-Event-Id"));
+
     std::shared_ptr<redfish::Subscription> subValue =
         std::make_shared<redfish::Subscription>(conn);
 
@@ -32,8 +53,9 @@
     subValue->protocol = "Redfish";
     subValue->retryPolicy = "TerminateAfterRetries";
     subValue->eventFormatType = "Event";
+    subValue->filter = filter;
 
-    std::string id = manager.addSubscription(subValue, false);
+    std::string id = manager.addSSESubscription(subValue, lastEventId);
     if (id.empty())
     {
         conn.close("Internal Error");