Skip to content

Fix JsonEx::Merge to handle chunked properties #7490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ortogonal wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix JsonEx::Merge to handle chunked properties #7490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
21032fe
Fix JsonEx::Merge to handle chunked properties (#7489)
ortogonal Dec 9, 2025
02258c1
Merge branch 'main' into handle-chucked-json-properties-in-merge
vadim-kovalyov Dec 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion edge-agent/src/Microsoft.Azure.Devices.Edge.Agent.IoTHub/EdgeAgentConnection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,8 +403,9 @@ async Task<Twin> GetTwinFunc()
async Task ApplyPatchAsync(TwinCollection desiredProperties, TwinCollection patch)
{
try

{
string mergedJson = JsonEx.Merge(desiredProperties, patch, true);
string mergedJson = JsonEx.Merge(desiredProperties, patch, true, "createOptions");
desiredProperties = new TwinCollection(mergedJson);
Events.LogDesiredPropertiesAfterPatch(desiredProperties);
this.desiredProperties = Option.Some(desiredProperties);
Expand Down
51 changes: 47 additions & 4 deletions edge-util/src/Microsoft.Azure.Devices.Edge.Util/JsonEx.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@ public static T Get<T>(this JObject obj, string key)
return token.Value<T>();
}

public static string Merge(object baseline, object patch, bool treatNullAsDelete)
public static string Merge(object baseline, object patch, bool treatNullAsDelete, string chunkedProperty = "")
{
JToken baselineToken = JToken.FromObject(baseline);
JToken patchToken = JToken.FromObject(patch);
JToken mergedToken = Merge(baselineToken, patchToken, treatNullAsDelete);
JToken mergedToken = Merge(baselineToken, patchToken, treatNullAsDelete, chunkedProperty);
return mergedToken.ToString();
}

public static JToken Merge(JToken baselineToken, JToken patchToken, bool treatNullAsDelete)
public static JToken Merge(JToken baselineToken, JToken patchToken, bool treatNullAsDelete, string chunkedProperty = "")
{
// Reached the leaf JValue
if (patchToken.Type != JTokenType.Object || baselineToken.Type != JTokenType.Object)
Expand All @@ -55,14 +55,24 @@ public static JToken Merge(JToken baselineToken, JToken patchToken, bool treatNu
var baseline = (JObject)baselineToken;
var result = new JObject(baseline);

// Collect the chunked (for example createOptionsXX) keys that exist in the patch
HashSet<string> patchChunkedNames = new HashSet<string>();

if (!string.IsNullOrEmpty(chunkedProperty)) {
patchChunkedNames = patch.Properties()
.Where(p => IsChunkedName(chunkedProperty, p.Name))
.Select(p => p.Name)
.ToHashSet(StringComparer.Ordinal);
}

foreach (JProperty patchProp in patch.Properties())
{
if (IsValidToken(patchProp.Value))
{
JProperty baselineProp = baseline.Property(patchProp.Name);
if (baselineProp != null && patchProp.Value.Type != JTokenType.Null)
{
JToken nestedResult = Merge(baselineProp.Value, patchProp.Value, treatNullAsDelete);
JToken nestedResult = Merge(baselineProp.Value, patchProp.Value, treatNullAsDelete, chunkedProperty);
result[patchProp.Name] = nestedResult;
}
else // decide whether to remove or add the patch key
Expand All @@ -83,9 +93,42 @@ public static JToken Merge(JToken baselineToken, JToken patchToken, bool treatNu
}
}

// Clean up result from non-existing chunked properties.
if (!string.IsNullOrEmpty(chunkedProperty)) {
var resultToRemove = result.Properties()
.Where(p =>
IsChunkedName(chunkedProperty, p.Name) &&
(patchChunkedNames.Count == 0 ||
!patchChunkedNames.Contains(p.Name)))
.Select(p => p.Name)
.ToList();

foreach (var name in resultToRemove)
{
result.Remove(name);
}
}
return result;
}

private static bool IsChunkedName(string chunkedName, string propertyName)
{
if (!propertyName.StartsWith(chunkedName, StringComparison.Ordinal))
{
return false;
}

// Require exactly two digits after chunked property (for example "createOptionsXX")
if (propertyName.Length != chunkedName.Length + 2)
{
return false;
}

string suffix = propertyName.Substring(chunkedName.Length); // e.g. "01", "15"

return int.TryParse(suffix, out int n) && n >= 0 && n <= 99;
}

public static bool IsValidToken(JToken token) => ValidDiffTypes.Any(t => t == token.Type);

public static string Diff(object from, object to)
Expand Down
159 changes: 159 additions & 0 deletions edge-util/test/Microsoft.Azure.Devices.Edge.Util.Test/JsonExTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,165 @@ public void TestMergeAllCases()
Assert.True(JToken.DeepEquals(resultCollection, JToken.FromObject(nestedEmptyBaseline)));
}

[Fact]
public void TestMergeCreateOptions_remove_unused()
{
// Arrange
var baseline = new
{
module = new
{
level0 = "nochange",
level1 = "value1",
settings = new
{
createOptions = "some-create",
createOptions01 = "-options"
}
},
};

var patch = new
{
module = new
{
level0 = "nochange",
level1 = "value2",
settings = new
{
createOptions = "some-create-option-that-is-not-chucked"
}
},
};

var merged = new
{
module = new
{
level0 = "nochange",
level1 = "value2",
settings = new
{
createOptions = "some-create-option-that-is-not-chucked"
}
},
};
// Assert
JToken resultCollection = JsonEx.Merge(JToken.FromObject(baseline), JToken.FromObject(patch), true, "createOptions");

// Assert
Assert.True(JToken.DeepEquals(JToken.FromObject(resultCollection), JToken.FromObject(merged)), resultCollection.ToString());
}

[Fact]
public void TestMergeCreateOptions_remove_02_kepp_01()
{
// Arrange
var baseline = new
{
module = new
{
level0 = "nochange",
level1 = "value1",
settings = new
{
createOptions = "some-create",
createOptions01 = "-options",
createOptions02 = "-that-is-old"
}
},
};

var patch = new
{
module = new
{
level0 = "nochange",
level1 = "value2",
settings = new
{
createOptions = "some-create",
createOptions01 = "-options-that-is-new"
}
},
};

var merged = new
{
module = new
{
level0 = "nochange",
level1 = "value2",
settings = new
{
createOptions = "some-create",
createOptions01 = "-options-that-is-new"
}
},
};
// Assert
JToken resultCollection = JsonEx.Merge(JToken.FromObject(baseline), JToken.FromObject(patch), true, "createOptions");

// Assert
Assert.True(JToken.DeepEquals(JToken.FromObject(resultCollection), JToken.FromObject(merged)), resultCollection.ToString());
}

[Fact]
public void TestMergeCreateOptions3_do_not_remove_since_both_have_01_02()
{
// Arrange
var baseline = new
{
module = new
{
level0 = "nochange",
level1 = "value1",
settings = new
{
createOptions = "some-create",
createOptions01 = "-options",
createOptions02 = "-that-is-old"
}
},
};

var patch = new
{
module = new
{
level0 = "nochange",
level1 = "value2",
settings = new
{
createOptions = "some-create",
createOptions01 = "-options-that-is-new",
createOptions02 = "-and-even-longer"
}
},
};

var merged = new
{
module = new
{
level0 = "nochange",
level1 = "value2",
settings = new
{
createOptions = "some-create",
createOptions01 = "-options-that-is-new",
createOptions02 = "-and-even-longer"
}
},
};
// Assert
JToken resultCollection = JsonEx.Merge(JToken.FromObject(baseline), JToken.FromObject(patch), true, "createOptions");

// Assert
Assert.True(JToken.DeepEquals(JToken.FromObject(resultCollection), JToken.FromObject(merged)), resultCollection.ToString());
}


[Fact]
public void TestDiffAllCases()
{
Expand Down