From 234927559118e1b87183a250129f73e7527a8665 Mon Sep 17 00:00:00 2001 From: Kevin Jump Date: Mon, 9 Dec 2019 16:21:42 +0000 Subject: [PATCH] tidy up report view, improve Json change detection. --- .../App_Plugins/uSync8/changeDialog.html | 85 ++++++++++--------- .../uSync8/components/uSyncReportView.html | 4 +- .../App_Plugins/uSync8/usync.css | 8 ++ uSync8.BackOffice/Config/uSync8.config | 3 +- .../SyncHandlers/SyncHandlerBase.cs | 6 +- uSync8.Core/Tracking/SyncBaseTracker.cs | 59 ++++++++++--- .../App_Plugins/uSync8/changeDialog.html | 85 ++++++++++--------- .../uSync8/components/uSyncReportView.html | 4 +- uSync8.Site/App_Plugins/uSync8/usync.css | 8 ++ 9 files changed, 159 insertions(+), 103 deletions(-) diff --git a/uSync8.BackOffice/App_Plugins/uSync8/changeDialog.html b/uSync8.BackOffice/App_Plugins/uSync8/changeDialog.html index ab9dc5f2..0c5b5dd3 100644 --- a/uSync8.BackOffice/App_Plugins/uSync8/changeDialog.html +++ b/uSync8.BackOffice/App_Plugins/uSync8/changeDialog.html @@ -7,57 +7,60 @@ hide-description="true"> - - - uSync Beta We are working on making the change report better, for now you might see blank change reports. - - + description="{{vm.getTypeName(vm.item.ItemType)}} {{vm.item.Message}}"> -

- {{vm.item.Message}} -

- -
-
-
-
-
-
Action
-
Item
-
Old Value
-
New Value
-
-
-
-
-
- - - - -
-
- {{detail.Change}} +
+
Detected changes
+
+
+
+
+
+
Action
+
Item
+
Old Value
+
New Value
-
- {{detail.Name}} -
-
- {{detail.OldValue}} -
-
- {{detail.NewValue}} +
+
+
+
+ + + + +
+
+ {{detail.Change}} +
+
+ {{detail.Name}} +
+
+ {{detail.OldValue}} +
+
+ {{detail.NewValue}} +
+ +
+

No Changes detected

+

+ It is possible that the .config file is diffrent, because it contains extra information + (such as xml comments) but no properties or values on this item will change when the file + is processed. +

+
@@ -65,7 +68,7 @@ diff --git a/uSync8.BackOffice/App_Plugins/uSync8/components/uSyncReportView.html b/uSync8.BackOffice/App_Plugins/uSync8/components/uSyncReportView.html index e3109918..82a335bd 100644 --- a/uSync8.BackOffice/App_Plugins/uSync8/components/uSyncReportView.html +++ b/uSync8.BackOffice/App_Plugins/uSync8/components/uSyncReportView.html @@ -30,7 +30,7 @@
-
+
@@ -56,7 +56,7 @@
{{result.Message}}
-
+
False False - + False diff --git a/uSync8.BackOffice/SyncHandlers/SyncHandlerBase.cs b/uSync8.BackOffice/SyncHandlers/SyncHandlerBase.cs index 61b6db9f..35584891 100644 --- a/uSync8.BackOffice/SyncHandlers/SyncHandlerBase.cs +++ b/uSync8.BackOffice/SyncHandlers/SyncHandlerBase.cs @@ -513,8 +513,10 @@ private IEnumerable ReportElement(XElement node, string filename) { action.Message = "Change details cannot be calculated"; } - - action.Message = $"{action.Change.ToString()}"; + else + { + action.Message = $"{action.Change.ToString()}"; + } actions.Add(action); } else diff --git a/uSync8.Core/Tracking/SyncBaseTracker.cs b/uSync8.Core/Tracking/SyncBaseTracker.cs index b89d1366..d3e8a4ef 100644 --- a/uSync8.Core/Tracking/SyncBaseTracker.cs +++ b/uSync8.Core/Tracking/SyncBaseTracker.cs @@ -4,6 +4,8 @@ using System.Linq; using System.Xml.Linq; using System.Xml.XPath; +using Newtonsoft.Json; +using Newtonsoft.Json.Linq; using Umbraco.Core; using Umbraco.Core.IO; using Umbraco.Core.Models.Entities; @@ -35,10 +37,11 @@ public virtual IEnumerable GetChanges(XElement node) if (!serializer.IsValid(node)) { // not valid - return new uSyncChange() { - Change = ChangeDetailType.Error, - Name = "Invalid File", - OldValue = node.Name.LocalName + return new uSyncChange() + { + Change = ChangeDetailType.Error, + Name = "Invalid File", + OldValue = node.Name.LocalName }.AsEnumerableOfOne(); ; } @@ -77,7 +80,7 @@ private uSyncChange GetEmptyFileChanges(XElement node) var action = node.Attribute("Change").ValueOrDefault(SyncActionType.None); - switch(action) + switch (action) { case SyncActionType.Delete: return uSyncChange.Delete(node.GetAlias(), "Delete", node.GetAlias()); @@ -85,7 +88,7 @@ private uSyncChange GetEmptyFileChanges(XElement node) return uSyncChange.Update(node.GetAlias(), "Rename", node.GetAlias(), "new name"); default: return uSyncChange.NoChange("", node.GetAlias()); - } + } } private IEnumerable CalculateChanges(TrackedItem change, XElement current, XElement target, string name, string path) @@ -211,7 +214,7 @@ private IEnumerable CalculateRepeatingChanges(TrackedItem change, X // if the value is diffrent in this case we will consider this a delete targetNode = targetItems.FirstOrDefault(x => x.Value == currentNode.Value); } - + } else { @@ -259,7 +262,7 @@ private IEnumerable CalculateRepeatingChanges(TrackedItem change, X else { // if there are no children, they we are comparing the actual text of the nodes - updates.AddNotNull(Compare(currentNodePath, currentNodeName, + updates.AddNotNull(Compare(currentNodePath, currentNodeName, currentNode.ValueOrDefault(string.Empty), targetNode.ValueOrDefault(string.Empty), change.MaskValue)); @@ -280,7 +283,7 @@ private IEnumerable CalculateRepeatingChanges(TrackedItem change, X } else { - foreach(var targetItem in targetItems) + foreach (var targetItem in targetItems) { var targetNodePath = path; @@ -362,7 +365,7 @@ private IEnumerable CalculatePropertyChanges(TrackedItem change, XE } // missing from current (so new) - foreach(var targetChild in targetNode.Elements()) + foreach (var targetChild in targetNode.Elements()) { var currentChildNode = currentNode.Element(targetChild.Name.LocalName); if (currentChildNode == null) @@ -390,10 +393,38 @@ private string GetElementValues(XElement node) protected uSyncChange Compare(string path, string name, string current, string target, bool maskValue) { - if (current.Equals(target)) return null; - return uSyncChange.Update(path, name, - maskValue ? "*******" : current, - maskValue ? "*******" : target); + if (current.DetectIsJson()) + { + return JsonChange(current, target, path, name); + } + else + { + if (current.Equals(target)) return null; + + return uSyncChange.Update(path, name, + maskValue ? "*******" : current, + maskValue ? "*******" : target); + } + + } + + private uSyncChange JsonChange(string current, string target, string path, string name) + { + try + { + // jsoncompare. for sanity, we serialize and deserialize into + var currentJson = JsonConvert.DeserializeObject(current); + var targetJson = JsonConvert.DeserializeObject(target); + + if (JToken.DeepEquals(currentJson, targetJson)) return null; + + return uSyncChange.Update(path, name, currentJson, targetJson); + } + catch + { + // malformed json etc, shouldn't make a details check fail. + return null; + } } private uSyncChange Compare(string path, string name, TValue current, TValue target, bool maskValue) diff --git a/uSync8.Site/App_Plugins/uSync8/changeDialog.html b/uSync8.Site/App_Plugins/uSync8/changeDialog.html index b222ad16..1e2431ce 100644 --- a/uSync8.Site/App_Plugins/uSync8/changeDialog.html +++ b/uSync8.Site/App_Plugins/uSync8/changeDialog.html @@ -7,57 +7,60 @@ hide-description="true"> - - - uSync Beta We are working on making the change report better, for now you might see blank change reports. - - + description="{{vm.getTypeName(vm.item.ItemType)}} {{vm.item.Message}}"> -

- {{vm.item.Message}} -

- -
-
-
-
-
-
Action
-
Item
-
Old Value
-
New Value
-
-
-
-
-
- - - - -
-
- {{detail.Change}} +
+
Detected changes
+
+
+
+
+
+
Action
+
Item
+
Old Value
+
New Value
-
- {{detail.Name}} -
-
- {{detail.OldValue}} -
-
- {{detail.NewValue}} +
+
+
+
+ + + + +
+
+ {{detail.Change}} +
+
+ {{detail.Name}} +
+
+ {{detail.OldValue}} +
+
+ {{detail.NewValue}} +
+ +
+

No Changes detected

+

+ It is possible that the .config file is diffrent, because it contains extra information + (such as xml comments) but no properties or values on this item will change when the file + is processed. +

+
@@ -65,7 +68,7 @@ diff --git a/uSync8.Site/App_Plugins/uSync8/components/uSyncReportView.html b/uSync8.Site/App_Plugins/uSync8/components/uSyncReportView.html index 616a2342..6b9dfe77 100644 --- a/uSync8.Site/App_Plugins/uSync8/components/uSyncReportView.html +++ b/uSync8.Site/App_Plugins/uSync8/components/uSyncReportView.html @@ -30,7 +30,7 @@
-
+
@@ -56,7 +56,7 @@
{{result.Message}}
-
+