weichch / system-text-json-jsondiffpatch

High-performance, low-allocating JSON object diff and patch extension for System.Text.Json. Support generating patch document in RFC 6902 JSON Patch format.
MIT License
104 stars 13 forks source link

How to preserve missing values in diff #28

Open GFoley83 opened 2 years ago

GFoley83 commented 2 years ago

I'm confused about how to preserve missing values from when diffing two objects.

Take for example these two json blocks:

{
  "Name": "John",
  "Age": 34,
  "Origin": "Scotland",  
  "Pets": [
    {
      "Type": "Cat",
      "Name": "MooMoo",
      "Age": 3.4
    },
    {
      "Type": "Squirrel",
      "Name": "Sandy",
      "Age": 7
    }
  ]
}
{
  "Origin": "Ireland"
}

When I run a patch, I would like to end up with:

{
  "Name": "John",
  "Age": 34,
  "Origin": "Ireland",   // UPDATED HERE  
  "Pets": [
    {
      "Type": "Cat",
      "Name": "MooMoo",
      "Age": 3.4
    },
    {
      "Type": "Squirrel",
      "Name": "Sandy",
      "Age": 7
    }
  ]
}

Basically all the missing values are preserved and only the values that conflict are updated, but I can seem to achieve this.

weichch commented 2 years ago

I think your example is merge patch (e.g. JSON Merge Patch) which is currently not supported. The patch document generated through diffing is equivalent to JSON Patch, which contains all operations required to fully transform JSON A to B. If you use the Live Demo provided by jsondiffpatch, you can visualize the document/operations.

I say currently not supported because I did plan to add some support for it at some stage.

jannikbuschke commented 1 year ago

It would be awesome to have this feature.