OpenRPC Validator: Not always returning method result schema (#679)

rdkcentral · Nov 14, 2024 · e16b2ed · e16b2ed
1 parent 03bd06a
commit e16b2ed
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 3 deletions.
diff --git a/.github/workflows/Build.yml b/.github/workflows/Build.yml
@@ -4,7 +4,7 @@ on:
   push:
     branches: [ "main" ]
   pull_request:
-    branches: [ "main", "1.14.rc" ]
+    branches: [ "main", "1.16.rc" ]
 
 env:
   CARGO_TERM_COLOR: always

diff --git a/openrpc_validator/src/lib.rs b/openrpc_validator/src/lib.rs
@@ -115,10 +115,24 @@ impl FireboltOpenRpc {
         None
     }
 
+    fn get_result_property(
+        &self,
+        result_schema_map: &Map<String, Value>,
+        rpc_method: &RpcMethod,
+    ) -> Map<String, Value> {
+        let mut result_map = Map::new();
+        let result_value = result_schema_map.get("type").unwrap_or(&Value::Null);
+        result_map.insert(rpc_method.result.name.clone(), result_value.clone());
+        result_map
+    }
+
     pub fn get_result_properties_schema_by_name(&self, name: &str) -> Option<Map<String, Value>> {
         if let Some(method) = self.get_method_by_name(name) {
             if let Some(result_schema_map) = method.result.schema.as_object() {
                 if let Some(any_of_map) = result_schema_map.get("anyOf") {
+                    // Iterate the anyOf type array and get the first one that matches. With the current firebolt APIs it will happen
+                    // to be the correct type, but this is extremely fragile and should be addressed in a future firebolt revision.
+                    // Ripple needs a way to determine the explicit result type.
                     if let Some(any_of_array) = any_of_map.as_array() {
                         for value in any_of_array.iter() {
                             if let Some(result_properties_map) =
@@ -128,11 +142,18 @@ impl FireboltOpenRpc {
                             }
                         }
                     } else {
+                        // This should never happen as it indicates a schema error.
                         return None;
                     }
-                } else {
-                    return self.get_result_ref_schemas(result_schema_map);
+                } else if let Some(result_properties_map) =
+                    self.get_result_ref_schemas(result_schema_map)
+                {
+                    // Return the resolved $ref properites.
+                    return Some(result_properties_map);
                 }
+
+                // The type is a non-object, just return it.
+                return Some(self.get_result_property(result_schema_map, &method));
             }
         }
         None