Merge to Master for 2.0.6 release (#32)

* Small change to what triggers a Sitecore field value to be reset (to std value). Rainbow would skip this, for fields that already were .NullOrEmpty - but an unchecked checkbox field is empty and a reset one is null. Now it resets correctly for any value not null.

* Added constructor overload to the DefaultDeserializer, to remain compatible with SideKick and other potential projects that have not yet been updated.

* The ItemComparer will no longer attempt to find a Field Comparer for null/null values, it will now assume them to be identical. This should help untangle Unicorn Issue 319.

* 2.0.6-pre3

* Fixes Unicorn Issue #334 - Changes in Sitecore's internal handling of shared/versioned/unversioned field values conflicted with Rainbow's handling of same

* Ticked version to 2.0.6-pre4

* Another fix for Unicorn Issue #319 - Empty field values would not get written back to Sitecore if no field value existed (e.g. field contained standard value)

* Ticked version to 2.0.6-pre5

* Fixes Unicorn issue #324

* Ticked version to 2.0.6-pre6

* #30 - Do not reset fields which are excluded in the fieldFilter (#31)

* Changed 2 tests related to what should happen, when a field is in target only or source only

* Fixed some line endings to deal with some LF/CRLF inconsistency. We probably need a .gitsettings to nail this down

* Ticked version to 2.0.6-pre7

Author: cassidydotdk

src/Rainbow.Storage.Sc.Tests/Deserialization/DefaultDeserializerTests.cs

@@ -233,6 +233,45 @@ public void Deserialize_IgnoresField_ExcludedWithFieldFilter()
 			}
 		}
 
+		[Fact]
+		public void Deserialize_IgnoresField_ExcludedWithFieldFilterNotSerialized()
+		{
+			var ignoredFieldId = ID.NewID;
+			var ignoredSharedFieldId = ID.NewID;
+
+			var fieldFilter = Substitute.For<IFieldFilter>();
+			fieldFilter.Includes(Arg.Any<Guid>()).Returns(true);
+			fieldFilter.Includes(ignoredFieldId.Guid).Returns(false);
+			fieldFilter.Includes(ignoredSharedFieldId.Guid).Returns(false);
+
+			var deserializer = new DefaultDeserializer(false, Substitute.For<IDefaultDeserializerLogger>(), fieldFilter);
+			deserializer.ParentDataStore = new SitecoreDataStore(deserializer);
+
+			using (var db = new Db())
+			{
+				var itemId = ID.NewID;
+
+				db.Add(new DbItem("Test Item", itemId)
+				{
+					new DbField(ignoredFieldId) { Value = "Test Value", Shared = false },
+					new DbField(ignoredSharedFieldId) { Value = "Shared Test Value", Shared = true }
+				});
+
+				var itemData = new ProxyItem(new ItemData(db.GetItem(itemId)));
+
+				var fields = new List<IItemFieldValue>();
+				((ProxyItemVersion)itemData.Versions.First()).Fields = fields;
+				itemData.SharedFields = fields;
+
+				deserializer.Deserialize(itemData);
+
+				var fromDb = db.GetItem(itemId);
+
+				Assert.Equal(fromDb[ignoredFieldId], "Test Value");
+				Assert.Equal(fromDb[ignoredSharedFieldId], "Shared Test Value");
+			}
+		}
+
 		protected IDeserializer CreateTestDeserializer(Db db)
 		{
 			var fieldFilter = Substitute.For<IFieldFilter>();

src/Rainbow.Storage.Sc/Deserialization/DefaultDeserializer.cs

@@ -37,6 +37,10 @@ public class DefaultDeserializer : IDeserializer
 
 		public bool IgnoreBranchId { get; }
 
+		// Overload constructor, implemented for keeping compatibility with external tools that may not yet have updated their codebase to support the branchId switch (e.g. SideKick)
+		// ReSharper disable once UnusedMember.Global
+		public DefaultDeserializer(IDefaultDeserializerLogger logger, IFieldFilter fieldFilter) : this(true, logger, fieldFilter) { }
+
 		public DefaultDeserializer(bool ignoreBranchId, IDefaultDeserializerLogger logger, IFieldFilter fieldFilter)
 		{
 			Assert.ArgumentNotNull(logger, "logger");
@@ -77,14 +81,14 @@ public IItemData Deserialize(IItemData serializedItemData)
 
 					ResetTemplateEngineIfItemIsTemplate(targetItem);
 
-					UpdateFieldSharingIfNeeded(serializedItemData, targetItem);
-
 					PasteSharedFields(serializedItemData, targetItem, newItemWasCreated, softErrors);
 
-					PasteVersions(serializedItemData, targetItem, newItemWasCreated, softErrors);
-
 					PasteUnversionedFields(serializedItemData, targetItem, newItemWasCreated, softErrors);
 
+					UpdateFieldSharingIfNeeded(serializedItemData, targetItem);
+
+					PasteVersions(serializedItemData, targetItem, newItemWasCreated, softErrors);
+
 					if (softErrors.Count > 0) throw TemplateMissingFieldException.Merge(softErrors);
 
 					return new ItemData(targetItem, ParentDataStore);
@@ -279,6 +283,11 @@ protected void ChangeTemplateIfNeeded(IItemData serializedItemData, Item targetI
 		/// </summary>
 		protected void UpdateFieldSharingIfNeeded(IItemData serializedItemData, Item targetItem)
 		{
+			// This is what Sitecore's internal deserializer does instead. Will investigate if this is a better option. Also depends on which Sitecore version introduced this.
+			//if (EventDisabler.IsActive)
+			//	ReflectionUtil.CallMethod(targetItem.Database.Engines.TemplateEngine, "HandleItemSaved", new object[] {targetItem, (ItemChanges) ReflectionUtil.CallMethod(targetItem, "GetFullChanges"), false});
+			//return;
+
 			Assert.ArgumentNotNull(serializedItemData, nameof(serializedItemData));
 			Assert.ArgumentNotNull(targetItem, nameof(targetItem));
 
@@ -353,7 +362,7 @@ protected virtual void PasteSharedFields(IItemData serializedItemData, Item targ
 
 				foreach (Field field in targetItem.Fields)
 				{
-					if (field.Shared && !allTargetSharedFields.Contains(field.ID.Guid))
+					if (field.Shared && !allTargetSharedFields.Contains(field.ID.Guid) && _fieldFilter.Includes(field.ID.Guid))
 					{
 						_logger.ResetFieldThatDidNotExistInSerialized(field);
 
@@ -472,6 +481,9 @@ protected virtual Item PasteVersion(Item item, IItemVersion serializedVersion, b
 				// (we do all these checks so we can back out of the edit context and avoid a DB write if we don't need one)
 				foreach (Field field in languageVersionItem.Fields)
 				{
+					// if the field is excluded by the fieldFilter
+					if (!_fieldFilter.Includes(field.ID.Guid)) continue;
+
 					// shared/unversioned fields = ignore, those are handled in their own paste methods
 					if (field.Shared || field.Unversioned) continue;
 
@@ -587,7 +599,8 @@ protected virtual void PasteUnversionedLanguage(Item item, IItemLanguage seriali
 				foreach (Field field in targetItem.Fields)
 				{
 					// field was not serialized. Which means the field is either blank or has its standard value, so let's reset it
-					if (field.Unversioned && !field.Shared && !allTargetUnversionedFields.Contains(field.ID.Guid))
+					if (field.Unversioned && !field.Shared && !allTargetUnversionedFields.Contains(field.ID.Guid) &&
+					    _fieldFilter.Includes(field.ID.Guid))
 					{
 						_logger.ResetFieldThatDidNotExistInSerialized(field);