Added better support for readOnly and writeOnly path via usage of json-pointer

Author: VShingala

libV2/schemaUtils.js

@@ -269,16 +269,16 @@ let QUERYPARAM = 'query',
    * @param {Object} context - Global context object
    * @param {Object} readOnlyPropCache - readOnly properties cache to be merged
    * @param {Object} writeOnlyPropCache - writeOnly properties cache to be merged
-   * @param {Object} currentPath - Current path being resolved relative to original schema
+   * @param {Object} currentPath - Current path (json-pointer) being resolved relative to original schema
    * @returns {void}
    */
   mergeReadWritePropCache = (context, readOnlyPropCache, writeOnlyPropCache, currentPath = '') => {
     _.forOwn(readOnlyPropCache, (value, key) => {
-      context.readOnlyPropCache[`${currentPath}${key}`] = true;
+      context.readOnlyPropCache[utils.mergeJsonPath(currentPath, key)] = true;
     });
 
     _.forOwn(writeOnlyPropCache, (value, key) => {
-      context.writeOnlyPropCache[`${currentPath}${key}`] = true;
+      context.writeOnlyPropCache[utils.mergeJsonPath(currentPath, key)] = true;
     });
   },
 
@@ -487,7 +487,7 @@ let QUERYPARAM = 'query',
    * @param {Number} [stack] - Current recursion depth
    * @param {*} resolveFor - resolve refs for flow validation/conversion (value to be one of VALIDATION/CONVERSION)
    * @param {Object} seenRef - Map of all the references that have been resolved
-   * @param {String} currentPath - Current path being resolved relative to original schema
+   * @param {String} currentPath - Current path (json-pointer) being resolved relative to original schema
    *
    * @returns {Object} Resolved schema
    */
@@ -524,7 +524,7 @@ let QUERYPARAM = 'query',
    * @param {Number} [stack] - Current recursion depth
    * @param {String} resolveFor - For which action this resolution is to be done
    * @param {Object} seenRef - Map of all the references that have been resolved
-   * @param {String} currentPath - Current path being resolved relative to original schema
+   * @param {String} currentPath - Current path (json-pointer) being resolved relative to original schema
    * @todo: Explore using a directed graph/tree for maintaining seen ref
    *
    * @returns {Object} Returns the object that satisfies the schema
@@ -569,9 +569,9 @@ let QUERYPARAM = 'query',
         return _resolveSchema(context, compositeSchema[0], stack, resolveFor, _.cloneDeep(seenRef), currentPath);
       }
 
-      return { [compositeKeyword]: _.map(compositeSchema, (schemaElement) => {
+      return { [compositeKeyword]: _.map(compositeSchema, (schemaElement, index) => {
         return _resolveSchema(context, schemaElement, stack, resolveFor, _.cloneDeep(seenRef),
-          `${currentPath}.${compositeKeyword}`);
+          utils.addToJsonPath(currentPath, [compositeKeyword, index]));
       }) };
     }
 
@@ -664,16 +664,7 @@ let QUERYPARAM = 'query',
           return;
         }
 
-        const currentPropPath = `${currentPath}.properties.${propertyName}`;
-
-        // Keep track of readOnly and writeOnly properties to resolve request and responses accordingly later.
-        if (property.readOnly) {
-          context.readOnlyPropCache[currentPropPath] = true;
-        }
-
-        if (property.writeOnly) {
-          context.writeOnlyPropCache[currentPropPath] = true;
-        }
+        const currentPropPath = utils.addToJsonPath(currentPath, ['properties', propertyName]);
 
         resolvedSchemaProps[propertyName] = _resolveSchema(context, property, stack, resolveFor,
           _.cloneDeep(seenRef), currentPropPath);
@@ -685,7 +676,7 @@ let QUERYPARAM = 'query',
     // If schema is of type array
     else if (concreteUtils.compareTypes(schema.type, SCHEMA_TYPES.array) && schema.items) {
       schema.items = _resolveSchema(context, schema.items, stack, resolveFor, _.cloneDeep(seenRef),
-        `${currentPath}.items`);
+        utils.addToJsonPath(currentPath, ['items']));
     }
     // Any properties to ignored should not be available in schema
     else if (_.every(SCHEMA_PROPERTIES_TO_EXCLUDE, (schemaKey) => { return !schema.hasOwnProperty(schemaKey); })) {
@@ -718,7 +709,7 @@ let QUERYPARAM = 'query',
     if (schema.hasOwnProperty('additionalProperties')) {
       schema.additionalProperties = _.isBoolean(schema.additionalProperties) ? schema.additionalProperties :
         _resolveSchema(context, schema.additionalProperties, stack, resolveFor, _.cloneDeep(seenRef),
-          `${currentPath}.additionalProperties`);
+          utils.addToJsonPath(currentPath, ['additionalProperties']));
       schema.type = schema.type || SCHEMA_TYPES.object;
     }
 
@@ -733,6 +724,15 @@ let QUERYPARAM = 'query',
       });
     }
 
+    // Keep track of readOnly and writeOnly properties to resolve request and responses accordingly later.
+    if (schema.readOnly) {
+      context.readOnlyPropCache[currentPath] = true;
+    }
+
+    if (schema.writeOnly) {
+      context.writeOnlyPropCache[currentPath] = true;
+    }
+
     return schema;
   },
 
@@ -769,12 +769,14 @@ let QUERYPARAM = 'query',
 
     if (isResponseSchema) {
       _.forOwn(context.writeOnlyPropCache, (value, key) => {
-        _.unset(resolvedSchema, key.substring(1));
+        // We need to make sure to remove empty strings via _.compact that are added while forming json-pointer
+        _.unset(resolvedSchema, utils.getJsonPathArray(key));
       });
     }
     else {
       _.forOwn(context.readOnlyPropCache, (value, key) => {
-        _.unset(resolvedSchema, key.substring(1));
+        // We need to make sure to remove empty strings via _.compact that are added while forming json-pointer
+        _.unset(resolvedSchema, utils.getJsonPathArray(key));
       });
     }
 

libV2/utils.js

@@ -1,4 +1,5 @@
 const _ = require('lodash'),
+  jsonPointer = require('json-pointer'),
   { Item } = require('postman-collection/lib/collection/item'),
   { Response } = require('postman-collection/lib/collection/response'),
 
@@ -200,6 +201,48 @@ module.exports = {
     return title;
   },
 
+  /**
+   * Adds provided property array to the given JSON path
+   *
+   * @param {string} jsonPath - JSON path to which properties should be added
+   * @param {array} propArray - Array of properties to be added to JSON path
+   * @returns {string} - Combined JSON path
+   */
+  addToJsonPath: function (jsonPath, propArray) {
+    const jsonPathArray = jsonPointer.parse(jsonPath),
+      escapedPropArray = _.map(propArray, (prop) => {
+        return jsonPointer.escape(prop);
+      });
+
+    return jsonPointer.compile(jsonPathArray.concat(escapedPropArray));
+  },
+
+  /**
+   * Merges two JSON paths. i.e. Parent JSON path and Child JSON path
+   *
+   * @param {string} parentJsonPath - Parent JSON path
+   * @param {string} childJsonPath - Child JSON path
+   * @returns {string} - Merged JSON path
+   */
+  mergeJsonPath: function (parentJsonPath, childJsonPath) {
+    let jsonPathArray = jsonPointer.parse(parentJsonPath);
+
+    // Merges childJsonPath with parentJsonPath
+    jsonPathArray = jsonPathArray.concat(jsonPointer.parse(childJsonPath));
+
+    return jsonPointer.compile(jsonPathArray);
+  },
+
+  /**
+   * Gets JSON path in array from string JSON path
+   *
+   * @param {string} jsonPath - input JSON path
+   * @returns {array} - Parsed JSON path (each part is distributed in an array)
+   */
+  getJsonPathArray: function (jsonPath) {
+    return jsonPointer.parse(jsonPointer.unescape(jsonPath));
+  },
+
   generatePmResponseObject,
   generateRequestItemObject
 };

package-lock.json

@@ -122,6 +122,7 @@
     "async": "3.2.4",
     "commander": "2.20.3",
     "js-yaml": "4.1.0",
+    "json-pointer": "0.6.2",
     "json-schema-merge-allof": "0.8.1",
     "lodash": "4.17.21",
     "oas-resolver-browser": "2.5.6",

package.json

@@ -20,7 +20,21 @@
 								"schema": {
 									"type": "array",
 									"items": {
-										"$ref": "#/components/schemas/Pet"
+										"type": "object",
+                    "properties": {
+                      "id": {
+                        "type": "integer",
+                        "format": "int64",
+                        "readOnly": true
+                      },
+                      "name": {
+                        "type": "string"
+                      },
+                      "tag": {
+                        "type": "string",
+                        "writeOnly": true
+                      }
+                    }
 									}
 								}
 							}
@@ -33,7 +47,20 @@
 					"content": {
 						"application/json": {
 							"schema": {
-								"$ref": "#/components/schemas/Pet"
+								"properties": {
+									"id": {
+										"type": "integer",
+										"format": "int64",
+										"readOnly": true
+									},
+									"name": {
+										"type": "string"
+									},
+									"tag": {
+										"type": "string",
+										"writeOnly": true
+									}
+								}
 							}
 						}
 					}
@@ -45,25 +72,5 @@
 				}
 			}
 		}
-	},
-	"components": {
-		"schemas": {
-			"Pet": {
-				"properties": {
-					"id": {
-						"type": "integer",
-						"format": "int64",
-						"readOnly": true
-					},
-					"name": {
-						"type": "string"
-					},
-					"tag": {
-						"type": "string",
-						"writeOnly": true
-					}
-				}
-			}
-		}
 	}
 }