commit 37b1f7be361defba093e1aca69490c47496c174b
author Ed Tanous <edtanous@google.com> Mon Jun 26 11:07:45 2023 -0700
committer Ed Tanous <ed@tanous.net> Mon Jun 26 21:00:47 2023 +0000
tree e029d86f68de7bb420537cb193965f7d090f3262
parent c59e338c6757883fb85e84fdff9365c171e9e5d0

FindNavigationReferences rename p->jsonPtr

It was pointed out in a prior review that single character variable
names were not very descriptive.  Rename p to jsonPtr to be more
descriptive.

Tested: Pretty good unit test coverage here.

Change-Id: I9583d52dd6cc7f5e6a8eabe42bbe8da9efa44ee0
Signed-off-by: Ed Tanous <edtanous@google.com>

redfish-core/include/utils/query_param.hpp

diff --git a/redfish-core/include/utils/query_param.hpp b/redfish-core/include/utils/query_param.hpp
index 53ef262..4ba521b 100644
--- a/redfish-core/include/utils/query_param.hpp
+++ b/redfish-core/include/utils/query_param.hpp
@@ -527,12 +527,12 @@
 
 inline void findNavigationReferencesInArrayRecursive(
     ExpandType eType, nlohmann::json::array_t& array,
-    const nlohmann::json::json_pointer& p, int depth, int skipDepth,
+    const nlohmann::json::json_pointer& jsonPtr, int depth, int skipDepth,
     bool inLinks, std::vector<ExpandNode>& out);
 
 inline void findNavigationReferencesInObjectRecursive(
     ExpandType eType, nlohmann::json::object_t& obj,
-    const nlohmann::json::json_pointer& p, int depth, int skipDepth,
+    const nlohmann::json::json_pointer& jsonPtr, int depth, int skipDepth,
     bool inLinks, std::vector<ExpandNode>& out);
 
 // Walks a json object looking for Redfish NavigationReference entries that
@@ -543,7 +543,7 @@
 // with the keys from the jsonResponse object
 inline void findNavigationReferencesRecursive(
     ExpandType eType, nlohmann::json& jsonResponse,
-    const nlohmann::json::json_pointer& p, int depth, int skipDepth,
+    const nlohmann::json::json_pointer& jsonPtr, int depth, int skipDepth,
     bool inLinks, std::vector<ExpandNode>& out)
 {
     // If no expand is needed, return early
@@ -556,7 +556,7 @@
         jsonResponse.get_ptr<nlohmann::json::array_t*>();
     if (array != nullptr)
     {
-        findNavigationReferencesInArrayRecursive(eType, *array, p, depth,
+        findNavigationReferencesInArrayRecursive(eType, *array, jsonPtr, depth,
                                                  skipDepth, inLinks, out);
     }
     nlohmann::json::object_t* obj =
@@ -565,20 +565,20 @@
     {
         return;
     }
-    findNavigationReferencesInObjectRecursive(eType, *obj, p, depth, skipDepth,
-                                              inLinks, out);
+    findNavigationReferencesInObjectRecursive(eType, *obj, jsonPtr, depth,
+                                              skipDepth, inLinks, out);
 }
 
 inline void findNavigationReferencesInArrayRecursive(
     ExpandType eType, nlohmann::json::array_t& array,
-    const nlohmann::json::json_pointer& p, int depth, int skipDepth,
+    const nlohmann::json::json_pointer& jsonPtr, int depth, int skipDepth,
     bool inLinks, std::vector<ExpandNode>& out)
 {
     size_t index = 0;
     // For arrays, walk every element in the array
     for (auto& element : array)
     {
-        nlohmann::json::json_pointer newPtr = p / index;
+        nlohmann::json::json_pointer newPtr = jsonPtr / index;
         BMCWEB_LOG_DEBUG << "Traversing response at " << newPtr.to_string();
         findNavigationReferencesRecursive(eType, element, newPtr, depth,
                                           skipDepth, inLinks, out);
@@ -588,7 +588,7 @@
 
 inline void findNavigationReferencesInObjectRecursive(
     ExpandType eType, nlohmann::json::object_t& obj,
-    const nlohmann::json::json_pointer& p, int depth, int skipDepth,
+    const nlohmann::json::json_pointer& jsonPtr, int depth, int skipDepth,
     bool inLinks, std::vector<ExpandNode>& out)
 {
     // Navigation References only ever have a single element
@@ -600,10 +600,11 @@
                 obj.begin()->second.get_ptr<const std::string*>();
             if (uri != nullptr)
             {
-                BMCWEB_LOG_DEBUG << "Found " << *uri << " at " << p.to_string();
+                BMCWEB_LOG_DEBUG << "Found " << *uri << " at "
+                                 << jsonPtr.to_string();
                 if (skipDepth == 0)
                 {
-                    out.push_back({p, *uri});
+                    out.push_back({jsonPtr, *uri});
                 }
                 return;
             }
@@ -656,7 +657,7 @@
         {
             continue;
         }
-        nlohmann::json::json_pointer newPtr = p / element.first;
+        nlohmann::json::json_pointer newPtr = jsonPtr / element.first;
         BMCWEB_LOG_DEBUG << "Traversing response at " << newPtr;
 
         findNavigationReferencesRecursive(eType, element.second, newPtr,