Fixes DTGE connector to handle complex property editors such as nested content. (#49)

* Fixes DTGE connector to handle complex property editors such as nested content.

* Handled necesssary conversion between string and JToken in converting to and from artifacts for nested content complex properties.

* Ensured serialziation with none formatting.

* Used string.Empty.

Author: AndyButland

src/Umbraco.Deploy.Contrib.Connectors/GridCellValueConnectors/DocTypeGridEditorCellValueConnector.cs

@@ -66,7 +66,7 @@ public string GetValue(GridValue.GridControl gridControl, ICollection<ArtifactDe
                 _logger.Debug<DocTypeGridEditorCellValueConnector>($"GetValue - PropertyTypeAlias - {propertyType.Alias}");
 
                 // test if there's a value for the given property
-                if (IsValueNull(docTypeGridEditorContent, propertyType, out var value))
+                if (!TryGetValue(docTypeGridEditorContent, propertyType, out var value))
                 {
                     continue;
                 }
@@ -77,46 +77,21 @@ public string GetValue(GridValue.GridControl gridControl, ICollection<ArtifactDe
                     continue;
                 }
 
-                JToken jtokenValue = null;
-                var parsedValue = string.Empty;
-
                 // throws if not found - no need for a null check
                 var propValueConnector = ValueConnectors.Get(propertyType);
 
-                _logger.Debug<DocTypeGridEditorCellValueConnector>($"GetValue - PropertyValueConnectorAlias - {propValueConnector.PropertyEditorAliases}");
+                _logger.Debug<DocTypeGridEditorCellValueConnector>($"GetValue - PropertyValueConnectorAlias - {string.Join(", ", propValueConnector.PropertyEditorAliases)}");
                 _logger.Debug<DocTypeGridEditorCellValueConnector>($"GetValue - propertyTypeValue - {value}");
 
-                //properties like MUP / Nested Content seems to be in json and it breaks, so pass it back as jtokenValue right away
-                if (IsJson(value))
-                {
-                    jtokenValue = GetJTokenValue(value);
-                    _logger.Debug<DocTypeGridEditorCellValueConnector>($"GetValue - Inner JtokenValue - Eg MUP/NestedContent {jtokenValue}");
-                }
-                else
-                {
-                    parsedValue = propValueConnector.ToArtifact(value, propertyType, dependencies);
-
-                    _logger.Debug<DocTypeGridEditorCellValueConnector>($"GetValue - ParsedValue - {parsedValue}");
+                //properties like MUP / Nested Content are JSON, we need to convert to string for the conversion to artifact
+                string parsedValue = propValueConnector.ToArtifact(IsJson(value) ? value.ToString() : value, propertyType, dependencies);
 
-                    if (IsJson(parsedValue))
-                    {
-                        // if that's the case we'll need to add it as a json object instead of string to avoid it being escaped
-                        jtokenValue = GetJTokenValue(parsedValue);
-                    }
-                }
+                _logger.Debug<DocTypeGridEditorCellValueConnector>($"GetValue - ParsedValue - {parsedValue}");
 
-                if (jtokenValue != null)
-                {
-                    _logger.Debug<DocTypeGridEditorCellValueConnector>($"GetValue - JtokenValue - {jtokenValue}");
-                    docTypeGridEditorContent.Value[propertyType.Alias] = jtokenValue;
-                }
-                else
-                {
-                    docTypeGridEditorContent.Value[propertyType.Alias] = parsedValue;
-                }
+                docTypeGridEditorContent.Value[propertyType.Alias] = parsedValue;
             }
 
-            var resolvedValue = JsonConvert.SerializeObject(docTypeGridEditorContent);
+            var resolvedValue = JsonConvert.SerializeObject(docTypeGridEditorContent, Formatting.None);
 
             _logger.Debug<DocTypeGridEditorCellValueConnector>($"GetValue - ResolvedValue - {resolvedValue}");
 
@@ -160,8 +135,6 @@ public void SetValue(GridValue.GridControl gridControl)
 
             foreach (var propertyType in propertyTypes)
             {
-                JToken jtokenValue = null;
-
                 _logger.Debug<DocTypeGridEditorCellValueConnector>($"SetValue - PropertyEditorAlias -- {propertyType.PropertyEditorAlias}");
 
                 if (!docTypeGridEditorContent.Value.TryGetValue(propertyType.Alias, out object value) || value == null)
@@ -172,59 +145,25 @@ public void SetValue(GridValue.GridControl gridControl)
 
                 // throws if not found - no need for a null check
                 var propValueConnector = ValueConnectors.Get(propertyType);
-                propValueConnector.FromArtifact(value.ToString(), propertyType, "");
-
-                _logger.Debug<DocTypeGridEditorCellValueConnector>($"SetValue - PropertyValueConnecterType - {propValueConnector.GetType()}");
-                _logger.Debug<DocTypeGridEditorCellValueConnector>($"SetValue - Value - {value}");
+                var convertedValue = propValueConnector.FromArtifact(value.ToString(), propertyType, string.Empty);
 
-                // test if there's a value for the given property
-                object convertedValue;
-                //don't convert if it's json (MUP/Nested) / udi (Content/Media/Multi Pickers) / guid (form picker) / rte / textstring values
-                if (IsJson(value) || IsUdi(value) || IsGuid(value) || IsText(propertyType.PropertyEditorAlias))
-                {
-                    _logger.Debug<DocTypeGridEditorCellValueConnector>($"SetValue - IsJsonValue / IsUdiValue / IsGuidValue / IsTextValue - {value}");
-                    convertedValue = CleanValue(propertyType.PropertyEditorAlias, value);
-                }
-                else
+                JToken jtokenValue = null;
+                if (IsJson(convertedValue))
                 {
-                    //using mockContent to get the converted values
-                    var mockProperty = new Property(propertyType);
-                    var mockContent = new Content("mockContentGrid", -1, new ContentType(-1), new PropertyCollection(new List<Property> { mockProperty }));
-                    convertedValue = mockContent.GetValue(mockProperty.Alias);
-                    _logger.Debug<DocTypeGridEditorCellValueConnector>($"SetValue - ConvertedValue - Before - {convertedValue}");
+                    // test if the value is a json object (thus could be a nested complex editor)
+                    // if that's the case we'll need to add it as a json object instead of string to avoid it being escaped
+                    jtokenValue = GetJTokenValue(convertedValue);
                 }
 
-                // integers needs to be converted into strings for DTGE to work
-                if (convertedValue is int)
-                {
-                    docTypeGridEditorContent.Value[propertyType.Alias] = convertedValue.ToString();
-                }
-                else if (convertedValue == null)
+                if (jtokenValue != null)
                 {
-                    //Assign the null back - otherwise the check for JSON will fail as we cant convert a null to a string
-                    //NOTE: LinkPicker2 for example if no link set is returning a null as opposed to empty string
-                    docTypeGridEditorContent.Value[propertyType.Alias] = null;
+                    _logger.Debug<DocTypeGridEditorCellValueConnector>($"SetValue - jtokenValue - {jtokenValue}");
+                    docTypeGridEditorContent.Value[propertyType.Alias] = jtokenValue;
                 }
                 else
                 {
-                    _logger.Debug<DocTypeGridEditorCellValueConnector>($"SetValue - ConvertedValue - After - {convertedValue}");
-
-                    if (IsJson(convertedValue))
-                    {
-                        // test if the value is a json object (thus could be a nested complex editor)
-                        // if that's the case we'll need to add it as a json object instead of string to avoid it being escaped
-                        jtokenValue = GetJTokenValue(convertedValue);
-                    }
-
-                    if (jtokenValue != null)
-                    {
-                        _logger.Debug<DocTypeGridEditorCellValueConnector>($"SetValue - jtokenValue - {jtokenValue}");
-                        docTypeGridEditorContent.Value[propertyType.Alias] = jtokenValue;
-                    }
-                    else
-                    {
-                        docTypeGridEditorContent.Value[propertyType.Alias] = convertedValue;
-                    }
+                    _logger.Debug<DocTypeGridEditorCellValueConnector>($"SetValue - convertedValue - {convertedValue}");
+                    docTypeGridEditorContent.Value[propertyType.Alias] = convertedValue;
                 }
             }
 
@@ -237,24 +176,6 @@ public void SetValue(GridValue.GridControl gridControl)
 
         private bool IsJson(object value) => value != null && value.ToString().DetectIsJson();
 
-        private bool IsGuid(object value) => Guid.TryParse(value.ToString(), out _);
-
-        private bool IsUdi(object value) =>
-            //for picker like content/media either single or multi, it comes with udi values
-            value.ToString().Contains("umb://");
-
-        private bool IsText(string editorAlias) =>
-            //if it's either RTE / Textstring data type
-            IsRichtext(editorAlias) || IsTextstring(editorAlias);
-
-        private bool IsRichtext(string editorAlias) => editorAlias.InvariantEquals("Umbraco.TinyMCE");
-
-        private bool IsTextstring(string editorAlias) => editorAlias.InvariantEquals("Umbraco.TextBox");
-
-        private string CleanValue(string editorAlias, object value) =>
-            //can't tell why textstring have got a weird character 's' in front coming from deploy? so removing first char if that's the case
-            IsTextstring(editorAlias) ? value.ToString().Substring(1) : value.ToString();
-
         private bool AddUdiDependency(ICollection<ArtifactDependency> dependencies, object value)
         {
             if (Udi.TryParse(value.ToString(), out var udi))
@@ -267,15 +188,15 @@ private bool AddUdiDependency(ICollection<ArtifactDependency> dependencies, obje
             return false;
         }
 
-        private bool IsValueNull(DocTypeGridEditorValue docTypeGridEditorContent, PropertyType propertyType, out object objVal)
+        private bool TryGetValue(DocTypeGridEditorValue docTypeGridEditorContent, PropertyType propertyType, out object objVal)
         {
             if (!docTypeGridEditorContent.Value.TryGetValue(propertyType.Alias, out objVal) || objVal == null)
             {
                 _logger.Debug<DocTypeGridEditorCellValueConnector>("GetValue - Value is null");
-                return true;
+                return false;
             }
 
-            return false;
+            return true;
         }
 
         private class DocTypeGridEditorValue

src/Umbraco.Deploy.Contrib.Connectors/ValueConnectors/NestedContentValueConnector.cs

@@ -114,7 +114,12 @@ public string ToArtifact(object value, PropertyType propertyType, ICollection<Ar
 
                     // pass the value, property type and the dependencies collection to the connector to get a "artifact" value
                     var innerValue = row.PropertyValues[key];
-                    object parsedValue = propertyValueConnector.ToArtifact(innerValue, innerPropertyType, dependencies);
+
+                    // connectors are expecting strings, not JTokens
+                    object preparedValue = innerValue is JToken
+                        ? innerValue?.ToString()
+                        : innerValue;
+                    object parsedValue = propertyValueConnector.ToArtifact(preparedValue, innerPropertyType, dependencies);
 
                     // getting Map image value umb://media/43e7401fb3cd48ceaa421df511ec703c to (nothing) - why?!
                     _logger.Debug<NestedContentValueConnector>("Mapped {Key} value '{PropertyValue}' to '{ParsedValue}' using {PropertyValueConnectorType} for {PropertyType}.", key, row.PropertyValues[key], parsedValue, propertyValueConnector.GetType(), innerPropertyType.Alias);
@@ -202,6 +207,11 @@ public object FromArtifact(string value, PropertyType propertyType, object curre
                         {
                             row.PropertyValues[key] = convertedValue.ToString();
                         }
+                        // json strings need to be converted into JTokens
+                        else if (convertedValue is string convertedStringValue && convertedStringValue.DetectIsJson())
+                        {
+                            row.PropertyValues[key] = JToken.Parse(convertedStringValue);
+                        }
                         else
                         {
                             row.PropertyValues[key] = convertedValue;