commit 6db062420e61dbd86e7ff54d3f20cf5352952406
author Matt Spinler <spinler@us.ibm.com> Tue Dec 11 11:21:22 2018 -0600
committer Ed Tanous <ed.tanous@intel.com> Thu Dec 13 21:55:48 2018 +0000
tree fdc18ed796560673f1625758102df185ae3f82b9
parent d6091dddfa28afa5fda0bf4175a009d70bfa309a

REST: For /action/<method>, return errors in JSON

This route calls D-Bus methods.  Return any errors
encountered in JSON.

Change-Id: I84c6f4abb7092d86ecbc157c95d6343a0b27b7d0
Signed-off-by: Matt Spinler <spinler@us.ibm.com>

include/openbmc_dbus_rest.hpp

diff --git a/include/openbmc_dbus_rest.hpp b/include/openbmc_dbus_rest.hpp
index a142426..dfa618f 100644
--- a/include/openbmc_dbus_rest.hpp
+++ b/include/openbmc_dbus_rest.hpp
@@ -35,9 +35,13 @@
               std::vector<std::pair<std::string, std::vector<std::string>>>>>;
 
 const std::string notFoundMsg = "404 Not Found";
+const std::string badReqMsg = "400 Bad Request";
+
 const std::string notFoundDesc =
     "org.freedesktop.DBus.Error.FileNotFound: path or object not found";
 const std::string propNotFoundDesc = "The specified property cannot be found";
+const std::string noJsonDesc = "No JSON object could be decoded";
+const std::string methodNotFoundDesc = "The specified method cannot be found";
 
 void setErrorResponse(crow::Response &res, boost::beast::http::status result,
                       const std::string &desc, const std::string &msg)
@@ -390,19 +394,19 @@
     InProgressActionData(crow::Response &res) : res(res){};
     ~InProgressActionData()
     {
-        if (res.result() == boost::beast::http::status::internal_server_error)
+        // If still no JSON filled in, then we never found the method.
+        if (res.jsonValue.is_null())
         {
-            // Reset the json object to clear out any data that made it in
-            // before the error happened todo(ed) handle error condition with
-            // proper code
-            res.jsonValue = nlohmann::json::object();
+            setErrorResponse(res, boost::beast::http::status::not_found,
+                             methodNotFoundDesc, notFoundMsg);
         }
         res.end();
     }
 
-    void setErrorStatus()
+    void setErrorStatus(const std::string &desc)
     {
-        res.result(boost::beast::http::status::internal_server_error);
+        setErrorResponse(res, boost::beast::http::status::internal_server_error,
+                         desc, badReqMsg);
     }
     crow::Response &res;
     std::string path;
@@ -815,14 +819,16 @@
                                         if (argIt ==
                                             transaction->arguments.end())
                                         {
-                                            transaction->setErrorStatus();
+                                            transaction->setErrorStatus(
+                                                "Invalid method args");
                                             return;
                                         }
                                         if (convertJsonToDbus(
                                                 m.get(), std::string(argType),
                                                 *argIt) < 0)
                                         {
-                                            transaction->setErrorStatus();
+                                            transaction->setErrorStatus(
+                                                "Invalid method arg type");
                                             return;
                                         }
 
@@ -838,7 +844,8 @@
                                            sdbusplus::message::message &m) {
                                         if (ec)
                                         {
-                                            transaction->setErrorStatus();
+                                            transaction->setErrorStatus(
+                                                "Method call failed");
                                             return;
                                         }
                                         transaction->res.jsonValue = {
@@ -871,21 +878,24 @@
 
     if (requestDbusData.is_discarded())
     {
-        res.result(boost::beast::http::status::bad_request);
+        setErrorResponse(res, boost::beast::http::status::bad_request,
+                         noJsonDesc, badReqMsg);
         res.end();
         return;
     }
     nlohmann::json::iterator data = requestDbusData.find("data");
     if (data == requestDbusData.end())
     {
-        res.result(boost::beast::http::status::bad_request);
+        setErrorResponse(res, boost::beast::http::status::bad_request,
+                         noJsonDesc, badReqMsg);
         res.end();
         return;
     }
 
     if (!data->is_array())
     {
-        res.result(boost::beast::http::status::bad_request);
+        setErrorResponse(res, boost::beast::http::status::bad_request,
+                         noJsonDesc, badReqMsg);
         res.end();
         return;
     }
@@ -902,7 +912,9 @@
             if (ec || interfaceNames.size() <= 0)
             {
                 BMCWEB_LOG_ERROR << "Can't find object";
-                transaction->setErrorStatus();
+                setErrorResponse(transaction->res,
+                                 boost::beast::http::status::not_found,
+                                 notFoundDesc, notFoundMsg);
                 return;
             }