Merge pull request #2793 from DataDog/tvaleev/feature/RUM-10316-properties-ref-support

RUM-10316 - properties referencing support

Author: satween

buildSrc/src/main/kotlin/com/datadog/gradle/plugin/jsonschema/JsonSchemaReader.kt

@@ -62,7 +62,9 @@ class JsonSchemaReader(
             return loadDefinitionFromFileRef(path, localRef, fromFile)
         }
 
-        val name = REF_DEFINITION_REGEX.matchEntire(ref)?.groupValues?.get(1)
+        val fieldGroups = REF_NAME_REGEX.matchEntire(ref)?.groupValues
+        val type = fieldGroups?.get(1)
+        val name = fieldGroups?.get(2)
         val id = REF_ID_REGEX.matchEntire(ref)?.groupValues?.get(0)
         if (name == null && id == null) return null
 
@@ -73,7 +75,10 @@ class JsonSchemaReader(
         }
 
         val match = knownSchemas[fromFile]
-            ?.definitions
+            ?.let {
+                // only explicit properties lookup supported
+                if (type == REF_TYPE_PROPERTIES) it.properties else it.definitions
+            }
             ?.entries
             ?.firstOrNull { matcher(it.key, it.value) } ?: return null
 
@@ -417,8 +422,10 @@ class JsonSchemaReader(
     // endregion
 
     companion object {
+        private const val REF_TYPE_PROPERTIES = "properties"
+        private const val REF_TYPE_DEFINITIONS = "definitions"
 
-        private val REF_DEFINITION_REGEX = Regex("#/definitions/([\\w]+)")
+        private val REF_NAME_REGEX = Regex("#/($REF_TYPE_DEFINITIONS|$REF_TYPE_PROPERTIES)/([\\w]+)")
         private val REF_ID_REGEX = Regex("#[\\w]+")
         private val REF_FILE_REGEX = Regex("(file:)?(([^/]+/)*([^/]+)\\.json)(#(.*))?")
     }

buildSrc/src/test/kotlin/com/datadog/gradle/plugin/jsonschema/JsonSchemaReaderTest.kt

@@ -80,6 +80,7 @@ class JsonSchemaReaderTest(
                 arrayOf("minimal", Person),
                 arrayOf("required", Product),
                 arrayOf("external_nested_description", Shipping),
+                arrayOf("external_nested_description_properties", Shipping),
                 arrayOf("enum", Style),
                 arrayOf("all_of", User),
                 arrayOf("all_of_merged", UserMerged),

buildSrc/src/test/resources/input/external_nested_description_properties.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Shipping",
+  "type": "object",
+  "properties": {
+    "item": {
+      "type": "string"
+    },
+    "destination": {
+      "$ref": "properties.json#/properties/billing_address"
+    }
+  },
+  "required": [
+    "item",
+    "destination"
+  ]
+}

buildSrc/src/test/resources/input/properties.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Customer",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "billing_address": { "$ref": "#/definitions/address" },
+    "shipping_address": { "$ref": "#/definitions/address" }
+  },
+  "definitions": {
+    "address": {
+      "type": "object",
+      "properties": {
+        "street_address": {
+          "type": "string"
+        },
+        "city": {
+          "type": "string"
+        },
+        "state": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "street_address",
+        "city",
+        "state"
+      ]
+    }
+  }
+}