Make SSE pass
Redfish protocol validator is failing SSE. This is due to a clause in
the Redfish specification that requires a "json" error to be returned
when the SSE URI is hit with a standard request.
In what exists today, we return 4XX (method not allowed) but because
this is handled by the HTTP layer, it's not possible to return the
correct Redfish payloads for when that 4XX happens within the Redfish
tree, because there is in fact a route that matches, that route just
doesn't support the type that we need.
This commit rearranges the router such that there are now 4 classes of
rules.
1. "verb" rules. These are GET/POST/PATCH type, and they are stored
using the existing PerMethod array index.
2. "upgrade" rules. These are for websocket or SSE routes that we
expect to upgrade to another route
3. 404 routes. These are called in the case where no route exists with
that given URI pattern, and no routes exist in the table for any
verb.
4. 405 method not allowed. These are called in the case where routes
exist in the tree for some method, but not for the method the user
requested.
To accomplish this, some minor refactors are implemented to separate out
the 4xx handlers to be their own variables, rather than just existing at
an index at the end of the verb table. This in turn means that
getRouteByIndex now changes to allow getting the route by PerMethod
instance, rather than index.
Tested:
unit tests pass (okish coverage)
Redfish protocol validator passes (with the exception of #277, which
fails identically before and after). SSE tests now pass.
Redfish service validator passes.
Change-Id: I555c50f392cb12ecbc39fbadbae6a3d50f4d1b23
Signed-off-by: Ed Tanous <etanous@nvidia.com>
diff --git a/http/routing/websocketrule.hpp b/http/routing/websocketrule.hpp
index 0905b08..e62943f 100644
--- a/http/routing/websocketrule.hpp
+++ b/http/routing/websocketrule.hpp
@@ -16,7 +16,12 @@
using self_t = WebSocketRule;
public:
- explicit WebSocketRule(const std::string& ruleIn) : BaseRule(ruleIn) {}
+ explicit WebSocketRule(const std::string& ruleIn) : BaseRule(ruleIn)
+ {
+ isUpgrade = true;
+ // Clear GET handler
+ methodsBitfield = 0;
+ }
void validate() override {}
@@ -24,7 +29,10 @@
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const std::vector<std::string>& /*params*/) override
{
- asyncResp->res.result(boost::beast::http::status::not_found);
+ BMCWEB_LOG_ERROR(
+ "Handle called on websocket rule. This should never happen");
+ asyncResp->res.result(
+ boost::beast::http::status::internal_server_error);
}
void handleUpgrade(const Request& req,