Changeset 86681 in vbox for trunk/src/VBox/Runtime/common/rest

Timestamp:

Oct 22, 2020 11:36:16 PM (4 years ago)

Author:

vboxsync

Message:

IPRT/rest: bugref:9167 - Add release logging for REST operations.
Request are logged at level 5, and responses at level 7, so they are
not on by default. The format is a bit ad-hoc, but all the essential
information should be there. It's mostly done in base classes except
for request bodies (it can probably be done in the base class too, but
would require more runtime logic, while here we can only generate them
as needed).

Location:

trunk/src/VBox/Runtime/common/rest

Files:

• RTCRestClientRequestBase.cpp (modified) (9 diffs)
• RTCRestClientResponseBase.cpp (modified) (5 diffs)

trunk/src/VBox/Runtime/common/rest/RTCRestClientRequestBase.cpp

@@ -34 +34 @@
 #include <iprt/assert.h>
 #include <iprt/err.h>
+#include <iprt/log.h>
 #include <iprt/cpp/restarray.h>
 #include <iprt/cpp/reststringmap.h>
@@ -100 +101 @@
                      VERR_INTERNAL_ERROR_3);
         AssertMsgReturn(a_paPathParamStates[i].pObj != NULL,
-                        ("Path parameter '%s' is not set!\n", a_paPathParams[i].pszName),
+                        ("%s: Path parameter '%s' is not set!\n",
+                         getOperationName(), a_paPathParams[i].pszName),
                         VERR_REST_PATH_PARAMETER_NOT_SET);
         AssertMsgReturn(m_fIsSet & RT_BIT_64(a_paPathParams[i].iBitNo),
-                        ("Path parameter '%s' is not set!\n", a_paPathParams[i].pszName),
+                        ("%s: Path parameter '%s' is not set!\n",
+                         getOperationName(), a_paPathParams[i].pszName),
                         VERR_REST_PATH_PARAMETER_NOT_SET);
 
@@ -109 +112 @@
         rc = a_paPathParamStates[i].pObj->toString(&strPathParam, a_paPathParams[i].fFlags);
         AssertRCReturn(rc, rc);
+
+        LogRel5(("> %s: /%s = %s\n",
+                 getOperationName(), a_paPathParams[i].pszName, strPathParam.c_str()));
 
         RTCString strTmpVal;
@@ -141 +147 @@
         {
             AssertMsgReturn(a_papQueryParamObjs[i] != NULL,
-                            ("Required query parameter '%s' is not set!\n", a_paQueryParams[i].pszName),
+                            ("%s: Required query parameter '%s' is not set!\n",
+                             getOperationName(), a_paQueryParams[i].pszName),
                             VERR_REST_REQUIRED_QUERY_PARAMETER_NOT_SET);
             AssertMsgReturn(m_fIsSet & RT_BIT_64(a_paQueryParams[i].iBitNo),
-                            ("Required query parameter '%s' is not set!\n", a_paQueryParams[i].pszName),
+                            ("%s: Required query parameter '%s' is not set!\n",
+                             getOperationName(), a_paQueryParams[i].pszName),
                             VERR_REST_REQUIRED_QUERY_PARAMETER_NOT_SET);
 
@@ -155 +163 @@
                 rc = a_pStrQuery->appendPrintfNoThrow("%c%RMpa=%RMpa", chSep, a_paQueryParams[i].pszName, strTmpVal.c_str());
                 AssertRCReturn(rc, rc);
+
+                LogRel5(("> %s: ?%s = %s\n",
+                         getOperationName(), a_paQueryParams[i].pszName, strTmpVal.c_str()));
 
                 chSep = '&';
@@ -175 +186 @@
                     AssertRCReturn(rc, rc);
 
+                    LogRel5(("> %s: ?%s[%d] = %s\n",
+                             getOperationName(), a_paQueryParams[i].pszName, j, strTmpVal.c_str()));
+
                     chSep = '&';
                 }
@@ -198 +212 @@
         {
             AssertMsgReturn(m_fIsSet & RT_BIT_64(a_paHeaderParams[i].iBitNo),
-                            ("Required header parameter '%s' is not set!\n", a_paHeaderParams[i].pszName),
+                            ("%s: Required header parameter '%s' is not set!\n",
+                             getOperationName(), a_paHeaderParams[i].pszName),
                             VERR_REST_REQUIRED_HEADER_PARAMETER_NOT_SET);
             AssertMsgReturn(a_papHeaderParamObjs[i] != NULL,
-                            ("Required header parameter '%s' is not set!\n", a_paHeaderParams[i].pszName),
+                            ("Required header parameter '%s' is not set!\n",
+                             getOperationName(), a_paHeaderParams[i].pszName),
                             VERR_REST_REQUIRED_HEADER_PARAMETER_NOT_SET);
 
@@ -212 +228 @@
                                      RTHTTPADDHDR_F_BACK);
                 AssertRCReturn(rc, rc);
+
+                LogRel5(("> %s: :%s = %s\n",
+                         getOperationName(), a_paHeaderParams[i].pszName, strTmpVal.c_str()));
             }
             else if (!a_papHeaderParamObjs[i]->isNull())
@@ -238 +257 @@
                                          RTHTTPADDHDR_F_BACK);
                     AssertRCReturn(rc, rc);
+
+                    LogRel5(("> %s: :%s = %s\n",
+                             getOperationName(), strTmpName.c_str(), strTmpVal.c_str()));
                 }
             }

trunk/src/VBox/Runtime/common/rest/RTCRestClientResponseBase.cpp

@@ -34 +34 @@
 #include <iprt/ctype.h>
 #include <iprt/err.h>
+#include <iprt/log.h>
 #include <iprt/cpp/reststringmap.h>
 
@@ -255 +256 @@
         if (RT_SUCCESS(rc))
         {
+            LogRel7(("< %s: :%s = %s\n",
+                     getOperationName(), a_pszErrorTag, strValue.c_str()));
+
             /*
              * Try deserialize it.
@@ -270 +274 @@
     else
     {
-        addError(rc, "Error %Rrc validating value necoding of header field '%s': %.*Rhxs",
+        addError(rc, "Error %Rrc validating value encoding of header field '%s': %.*Rhxs",
                  rc, a_pszErrorTag, a_cchValue, a_pchValue);
         rc = VINF_SUCCESS; /* ignore */
@@ -303 +307 @@
                 if (RT_SUCCESS(rc))
                 {
+                    LogRel7(("< %s: :%s%.*s = %s\n",
+                             getOperationName(), a_pszErrorTag, a_cchField, a_pchField,  strValue.c_str()));
+
                     /*
                      * Try deserialize the value.
@@ -343 +350 @@
         if (RT_SUCCESS(rc))
         {
+            if (LogRelIs7Enabled())
+            {
+                /* skip m_ or m_p prefix */
+                const char *pszName = a_pszBodyName;
+                if (pszName[0] == 'm' && pszName[1] == '_')
+                {
+                    if (pszName[2] == 'p')
+                        pszName += 3;
+                    else
+                        pszName += 2;
+                }
+
+                LogRel7(("< %s: %d: %s = %.*s\n",
+                         getOperationName(), m_rcHttp, pszName, a_cbData, a_pchData));
+            }
+
             RTERRINFOSTATIC ErrInfo;
             RTJSONVAL hValue;