Merge pull request #23 from donaldjarmstrong/master

Update to latest fast-json-patch
ajv-validator · Jun 25, 2018 · f1e8831 · f1e8831
2 parents 4094556 + 5708ba9
commit f1e8831
Show file tree

Hide file tree

Showing 9 changed files with 50 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -75,7 +75,7 @@ The same schema extension using `$patch` keyword:
 `$patch` is implemented as a [custom macro keyword](https://github.com/epoberezkin/ajv/blob/master/CUSTOM.md#define-keyword-with-macro-function) using [fast-json-patch](https://github.com/Starcounter-Jack/JSON-Patch) package.
 
 
-In the majority of cases `$merge` format is easier to understand and to maintain. `$patch` can be used for extensions and changes that cannot be expressed using `$merge`.
+In the majority of cases `$merge` format is easier to understand and to maintain. `$patch` can be used for extensions and changes that cannot be expressed using `$merge`, e.g. [Adding an array value](https://tools.ietf.org/html/rfc6902#page-18).
 
 `with` property in keywords can also be a reference to a part of some schema, in which case the resolved value will be used rather than the actual object with property `$ref`.
 

diff --git a/keywords/add_keyword.js b/keywords/add_keyword.js
@@ -9,7 +9,7 @@ module.exports = function (ajv, keyword, jsonPatch, patchSchema) {
       var patch = schema.with;
       if (source.$ref) source = JSON.parse(JSON.stringify(getSchema(source.$ref)));
       if (patch.$ref) patch = getSchema(patch.$ref);
-      jsonPatch.apply(source, patch, true);
+      jsonPatch.call(null, source, patch, true);
       return source;
 
       function getSchema($ref) {

diff --git a/keywords/merge.js b/keywords/merge.js
@@ -4,5 +4,5 @@ var addKeyword = require('./add_keyword');
 var jsonMergePatch = require('json-merge-patch');
 
 module.exports = function(ajv) {
-  addKeyword(ajv, '$merge', jsonMergePatch, { "type": "object" });
+  addKeyword(ajv, '$merge', jsonMergePatch.apply, { "type": "object" });
 };
diff --git a/keywords/patch.js b/keywords/patch.js
@@ -1,10 +1,10 @@
 'use strict';
 
 var addKeyword = require('./add_keyword');
-var jsonPatch = require('fast-json-patch/src/json-patch');
+var jsonPatch = require('fast-json-patch');
 
 module.exports = function(ajv) {
-  addKeyword(ajv, '$patch', jsonPatch, {
+  addKeyword(ajv, '$patch', jsonPatch.applyPatch, {
     "type": "array",
     "items": {
       "type": "object",

diff --git a/package.json b/package.json
@@ -33,7 +33,7 @@
   },
   "homepage": "https://github.com/epoberezkin/ajv-merge-patch#readme",
   "dependencies": {
-    "fast-json-patch": "^1.0.0",
+    "fast-json-patch": "^2.0.6",
     "json-merge-patch": "^0.2.3"
   },
   "devDependencies": {

diff --git a/spec/async.spec.js b/spec/async.spec.js
@@ -20,7 +20,8 @@ describe('async schema loading', function() {
         "$merge": {
           "source": { "$ref": "obj.json#" },
           "with": {
-            "properties": { "q": { "type": "number" } }
+            "properties": { "q": { "type": "number" } },
+            "required": [ "q" ]
           }
         }
       };
@@ -35,7 +36,8 @@ describe('async schema loading', function() {
         "$patch": {
           "source": { "$ref": "obj.json#" },
           "with": [
-            { "op": "add", "path": "/properties/q", "value": { "type": "number" } }
+            { "op": "add", "path": "/properties/q", "value": { "type": "number" } },
+            { "op": "add", "path": "/required/-", "value": "q" }
           ]
         }
       };
@@ -59,7 +61,8 @@ describe('async schema loading', function() {
         "id": "obj.json#",
         "type": "object",
         "properties": { "p": { "type": "string" } },
-        "additionalProperties": false
+        "additionalProperties": false,
+        "required": [ "p" ]
       };
       return Promise.resolve(schema);
     }

diff --git a/spec/merge.spec.js b/spec/merge.spec.js
@@ -26,7 +26,8 @@ describe('keyword $merge', function() {
             "additionalProperties": false
           },
           "with": {
-            "properties": { "q": { "type": "number" } }
+            "properties": { "q": { "type": "number" } },
+            "required": [ "q" ]
           }
         }
       };
@@ -53,7 +54,8 @@ describe('keyword $merge', function() {
         "$merge": {
           "source": { "$ref": "obj.json#" },
           "with": {
-            "properties": { "q": { "type": "number" } }
+            "properties": { "q": { "type": "number" } },
+            "required": [ "q" ]
           }
         }
       };
@@ -79,7 +81,8 @@ describe('keyword $merge', function() {
         "$merge": {
           "source": { "$ref": "#/definitions/source" },
           "with": {
-            "properties": { "q": { "type": "number" } }
+            "properties": { "q": { "type": "number" } },
+            "required": [ "q" ]
           }
         }
       };
@@ -96,13 +99,15 @@ describe('keyword $merge', function() {
       var sourceSchema = {
         "type": "object",
         "properties": { "p": { "type": "string" } },
-        "additionalProperties": false
+        "additionalProperties": false,
+        "required": [ "p" ]
       };
 
       var patchSchema = {
         "type": "object",
         "properties": { "q": { "type": "number" } },
-        "additionalProperties": false
+        "additionalProperties": false,
+        "required": [ "q" ]
       };
 
       ajv.addSchema(sourceSchema, "obj1.json#");
@@ -138,7 +143,8 @@ describe('keyword $merge', function() {
           "patch":{
             "type": "object",
             "properties": { "q": { "type": "number" } },
-            "additionalProperties": false
+            "additionalProperties": false,
+            "required" : [ "q" ]
           }
         },
         "$merge": {

diff --git a/spec/patch.spec.js b/spec/patch.spec.js
@@ -23,10 +23,12 @@ describe('keyword $patch', function() {
           "source": {
             "type": "object",
             "properties": { "p": { "type": "string" } },
-            "additionalProperties": false
+            "additionalProperties": false,
+            "required": [ "p" ]
           },
           "with": [
-            { "op": "add", "path": "/properties/q", "value": { "type": "number" } }
+            { "op": "add", "path": "/properties/q", "value": { "type": "number" } },
+            { "op": "add", "path": "/required/-", "value": "q" }
           ]
         }
       };
@@ -44,7 +46,8 @@ describe('keyword $patch', function() {
         "$id": "obj.json#",
         "type": "object",
         "properties": { "p": { "type": "string" } },
-        "additionalProperties": false
+        "additionalProperties": false,
+        "required": [ "p" ]
       };
 
       ajv.addSchema(sourceSchema);
@@ -53,7 +56,8 @@ describe('keyword $patch', function() {
         "$patch": {
           "source": { "$ref": "obj.json#" },
           "with": [
-            { "op": "add", "path": "/properties/q", "value": { "type": "number" } }
+            { "op": "add", "path": "/properties/q", "value": { "type": "number" } },
+            { "op": "add", "path": "/required/-", "value": "q" }
           ]
         }
       };
@@ -73,13 +77,15 @@ describe('keyword $patch', function() {
           "source": {
             "type": "object",
             "properties": { "p": { "type": "string" } },
-            "additionalProperties": false
+            "additionalProperties": false,
+            "required": [ "p" ]
           }
         },
         "$patch": {
           "source": { "$ref": "#/definitions/source" },
           "with": [
-            { "op": "add", "path": "/properties/q", "value": { "type": "number" } }
+            { "op": "add", "path": "/properties/q", "value": { "type": "number" } },
+            { "op": "add", "path": "/required/-", "value": "q" }
           ]
         }
       };

diff --git a/spec/test_validate.js b/spec/test_validate.js
@@ -4,6 +4,8 @@ var assert = require('assert');
 
 module.exports = function (validate, keyword) {
   assert.strictEqual(validate({ p: 'abc', q: 1 }), true);
+
+  // property q should be a number
   assert.strictEqual(validate({ p: 'foo', q: 'bar' }), false);
   var errs = validate.errors;
   assert.equal(errs.length, 2);
@@ -13,4 +15,16 @@ module.exports = function (validate, keyword) {
   assert.equal(errs[1].keyword, keyword);
   assert.equal(errs[1].dataPath, '');
   assert.equal(errs[1].schemaPath, '#/' + keyword);
+
+  // an object without q should fail
+  assert.strictEqual(validate({ p: 'foo' }), false);
+  errs = validate.errors;
+  assert.equal(errs.length, 2);
+  assert.equal(errs[0].keyword, 'required');
+  assert.equal(errs[0].dataPath, '');
+  assert.equal(errs[0].schemaPath, '#/required');
+  assert.deepEqual(errs[0].params, { missingProperty: 'q' });
+  assert.equal(errs[1].keyword, keyword);
+  assert.equal(errs[1].dataPath, '');
+  assert.equal(errs[1].schemaPath, '#/' + keyword);
 };