DevTools Client - Serialize lists of DevToolsDomainEntityBase (#3487)

Author: campersau

CefSharp.Test/DevTools/DevToolsClientFacts.cs

@@ -3,8 +3,10 @@
 // Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
 
 using System;
+using System.Collections.Generic;
 using System.Threading.Tasks;
 using CefSharp.DevTools.Browser;
+using CefSharp.DevTools.Emulation;
 using CefSharp.DevTools.Network;
 using CefSharp.Example;
 using CefSharp.OffScreen;
@@ -156,5 +158,68 @@ public async Task CanUseMultipleDevToolsClientInstancesPerBrowser()
                 }
             }
         }
+
+        [Fact]
+        public async Task CanSetUserAgentOverride()
+        {
+            using (var browser = new ChromiumWebBrowser("www.google.com"))
+            {
+                await browser.LoadPageAsync();
+
+                using (var devToolsClient = browser.GetDevToolsClient())
+                {
+                    var brandsList = new List<UserAgentBrandVersion>();
+                    var uab = new UserAgentBrandVersion();
+                    uab.Brand = "Google Chrome";
+                    uab.Version = "89";
+                    brandsList.Add(uab);
+
+                    var uab2 = new UserAgentBrandVersion();
+                    uab2.Brand = "Chromium";
+                    uab2.Version = "89";
+                    brandsList.Add(uab2);
+
+                    var ua = new UserAgentMetadata();
+                    ua.Brands = brandsList;
+                    ua.Architecture = "arm";
+                    ua.Model = "Nexus 7";
+                    ua.Platform = "Android";
+                    ua.PlatformVersion = "6.0.1";
+                    ua.FullVersion = "89.0.4389.114";
+                    ua.Mobile = true;
+
+                    await devToolsClient.Emulation.SetUserAgentOverrideAsync("Mozilla/5.0 (Linux; Android 6.0.1; Nexus 7 Build/MOB30X) AppleWebKit/5(KHTML,likeGeckoChrome/89.0.4389.114Safari/537.36", null, null, ua);
+                }
+
+                var userAgent = await browser.EvaluateScriptAsync("navigator.userAgent");
+                Assert.True(userAgent.Success);
+                Assert.Contains("Mozilla/5.0 (Linux; Android 6.0.1; Nexus 7 Build/MOB30X) AppleWebKit/5(KHTML,likeGeckoChrome/89.0.4389.114Safari/537.36", Assert.IsType<string>(userAgent.Result));
+
+                var brands = await browser.EvaluateScriptAsync("navigator.userAgentData.brands");
+                Assert.True(brands.Success);
+                dynamic brandsResult = brands.Result;
+                Assert.Collection((IEnumerable<dynamic>)brandsResult,
+                    (dynamic d) =>
+                    {
+                        Assert.Equal("Google Chrome", d.brand);
+                        Assert.Equal("89", d.version);
+                    },
+                    (dynamic d) =>
+                    {
+                        Assert.Equal("Chromium", d.brand);
+                        Assert.Equal("89", d.version);
+                    }
+                );
+
+                var highEntropyValues = await browser.EvaluateScriptAsPromiseAsync("return navigator.userAgentData.getHighEntropyValues(['architecture','model','platform','platformVersion','uaFullVersion'])");
+                Assert.True(highEntropyValues.Success);
+                dynamic highEntropyValuesResult = highEntropyValues.Result;
+                Assert.Equal("arm", highEntropyValuesResult.architecture);
+                Assert.Equal("Nexus 7", highEntropyValuesResult.model);
+                Assert.Equal("Android", highEntropyValuesResult.platform);
+                Assert.Equal("6.0.1", highEntropyValuesResult.platformVersion);
+                Assert.Equal("89.0.4389.114", highEntropyValuesResult.uaFullVersion);
+            }
+        }
     }
 }

CefSharp/DevTools/DevToolsDomainEntityBase.cs

@@ -3,6 +3,7 @@
 // Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
 
 using System;
+using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
@@ -166,19 +167,28 @@ public IDictionary<string, object> ToDictionary()
                 {
                     propertyValue = ((DevToolsDomainEntityBase)(propertyValue)).ToDictionary();
                 }
+                else if (prop.PropertyType.IsGenericType && prop.PropertyType.GetGenericTypeDefinition() == typeof(IList<>) && typeof(DevToolsDomainEntityBase).IsAssignableFrom(prop.PropertyType.GetGenericArguments()[0]))
+                {
+                    var values = new List<IDictionary<string, object>>();
+                    foreach (var value in (IEnumerable)propertyValue)
+                    {
+                        values.Add(((DevToolsDomainEntityBase)value).ToDictionary());
+                    }
+                    propertyValue = values;
+                }
                 else if (propertyValueType.IsEnum)
                 {
                     propertyValue = EnumToString((Enum)propertyValue);
                 }
-                else if(propertyValueType.IsGenericType)
+                else if (propertyValueType.IsGenericType)
                 {
                     var nullableType = Nullable.GetUnderlyingType(propertyValueType);
                     if(nullableType != null && nullableType.IsEnum)
                     {
                         propertyValue = EnumToString((Enum)propertyValue);
                     }
                 }
-                else if(propertyValueType.IsArray && propertyValueType.GetElementType().IsEnum)
+                else if (propertyValueType.IsArray && propertyValueType.GetElementType().IsEnum)
                 {
                     propertyValue = EnumToString((Array)propertyValue);
                 }
@@ -226,6 +236,15 @@ public IDictionary<string, object> ToDictionary()
                 {
                     propertyValue = ((DevToolsDomainEntityBase)(propertyValue)).ToDictionary();
                 }
+                else if (prop.PropertyType.IsGenericType && prop.PropertyType.GetGenericTypeDefinition() == typeof(IList<>) && typeof(DevToolsDomainEntityBase).IsAssignableFrom(prop.PropertyType.GetGenericArguments()[0]))
+                {
+                    var values = new List<IDictionary<string, object>>();
+                    foreach (var value in (IEnumerable)propertyValue)
+                    {
+                        values.Add(((DevToolsDomainEntityBase)value).ToDictionary());
+                    }
+                    propertyValue = values;
+                }
 
                 dict.Add(propertyName, propertyValue);
             }