Introduce Page.EmulateVisionDeficiencyAsync and Page.EmulateCPUThrott…

…lingAsync (hardkoded#1839) closes hardkoded#1764
drawcode · Oct 5, 2021 · f388b5e · f388b5e
1 parent e5230b4
commit f388b5e
Show file tree

Hide file tree

Showing 10 changed files with 178 additions and 5 deletions.
diff --git a/lib/PuppeteerSharp.Tests/EmulationTests/EmulateMediaFeaturesTests.cs b/lib/PuppeteerSharp.Tests/EmulationTests/EmulateMediaFeaturesTests.cs
@@ -1,5 +1,4 @@
 using System.Threading.Tasks;
-using PuppeteerSharp.Media;
 using PuppeteerSharp.Tests.Attributes;
 using PuppeteerSharp.Xunit;
 using Xunit;

diff --git a/lib/PuppeteerSharp.Tests/EmulationTests/PageEmulateCPUThrottlingTests.cs b/lib/PuppeteerSharp.Tests/EmulationTests/PageEmulateCPUThrottlingTests.cs
@@ -0,0 +1,24 @@
+using System.Threading.Tasks;
+using PuppeteerSharp.Tests.Attributes;
+using PuppeteerSharp.Xunit;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace PuppeteerSharp.Tests.EmulationTests
+{
+    [Collection(TestConstants.TestFixtureCollectionName)]
+    public class PageEmulateCPUThrottlingTests : PuppeteerPageBaseTest
+    {
+        public PageEmulateCPUThrottlingTests(ITestOutputHelper output) : base(output)
+        {
+        }
+
+        [PuppeteerTest("emulation.spec.ts", "Page.emulateCPUThrottling", "should change the CPU throttling rate successfully")]
+        [SkipBrowserFact(skipFirefox: true)]
+        public async Task ShouldChangeTheCPUThrottlingRateSuccessfully()
+        {
+            await Page.EmulateCPUThrottlingAsync(100);
+            await Page.EmulateCPUThrottlingAsync();
+        }
+    }
+}
diff --git a/...mulationTests/EmulateNetworkConditions.cs → ...ests/PageEmulateNetworkConditionsTests.cs b/...mulationTests/EmulateNetworkConditions.cs → ...ests/PageEmulateNetworkConditionsTests.cs
@@ -1,16 +1,15 @@
-using System.Net;
 using System.Threading.Tasks;
 using PuppeteerSharp.Tests.Attributes;
 using PuppeteerSharp.Xunit;
 using Xunit;
 using Xunit.Abstractions;
 
-namespace PuppeteerSharp.Tests.PageTests
+namespace PuppeteerSharp.Tests.EmulationTests
 {
     [Collection(TestConstants.TestFixtureCollectionName)]
-    public class EmulateNetworkConditionsTests : PuppeteerPageBaseTest
+    public class PageEmulateNetworkConditionsTests : PuppeteerPageBaseTest
     {
-        public EmulateNetworkConditionsTests(ITestOutputHelper output) : base(output)
+        public PageEmulateNetworkConditionsTests(ITestOutputHelper output) : base(output)
         {
         }
 

diff --git a/lib/PuppeteerSharp.Tests/EmulationTests/PageEmulateVisionDeficiencyTests.cs b/lib/PuppeteerSharp.Tests/EmulationTests/PageEmulateVisionDeficiencyTests.cs
@@ -0,0 +1,52 @@
+using System.Threading.Tasks;
+using PuppeteerSharp.Tests.Attributes;
+using PuppeteerSharp.Xunit;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace PuppeteerSharp.Tests.EmulationTests
+{
+    [Collection(TestConstants.TestFixtureCollectionName)]
+    public class PageEmulateVisionDeficiencyTests : PuppeteerPageBaseTest
+    {
+        public PageEmulateVisionDeficiencyTests(ITestOutputHelper output) : base(output)
+        {
+        }
+
+        [PuppeteerTest("emulation.spec.ts", "Page.emulateVisionDeficiency", "should work")]
+        [SkipBrowserFact(skipFirefox: true)]
+        public async Task ShouldWork()
+        {
+            await Page.SetViewportAsync(new ViewPortOptions { Width = 500, Height = 500 });
+            await Page.GoToAsync(TestConstants.ServerUrl + "/grid.html");
+
+            await Page.EmulateVisionDeficiencyAsync(VisionDeficiency.None);
+            var screenshot = await Page.ScreenshotDataAsync();
+            Assert.True(ScreenshotHelper.PixelMatch("screenshot-sanity.png", screenshot));
+
+            await Page.EmulateVisionDeficiencyAsync(VisionDeficiency.Achromatopsia);
+            screenshot = await Page.ScreenshotDataAsync();
+            Assert.True(ScreenshotHelper.PixelMatch("vision-deficiency-achromatopsia.png", screenshot));
+
+            await Page.EmulateVisionDeficiencyAsync(VisionDeficiency.BlurredVision);
+            screenshot = await Page.ScreenshotDataAsync();
+            Assert.True(ScreenshotHelper.PixelMatch("vision-deficiency-blurredVision.png", screenshot));
+
+            await Page.EmulateVisionDeficiencyAsync(VisionDeficiency.Deuteranopia);
+            screenshot = await Page.ScreenshotDataAsync();
+            Assert.True(ScreenshotHelper.PixelMatch("vision-deficiency-deuteranopia.png", screenshot));
+
+            await Page.EmulateVisionDeficiencyAsync(VisionDeficiency.Protanopia);
+            screenshot = await Page.ScreenshotDataAsync();
+            Assert.True(ScreenshotHelper.PixelMatch("vision-deficiency-protanopia.png", screenshot));
+
+            await Page.EmulateVisionDeficiencyAsync(VisionDeficiency.Tritanopia);
+            screenshot = await Page.ScreenshotDataAsync();
+            Assert.True(ScreenshotHelper.PixelMatch("vision-deficiency-tritanopia.png", screenshot));
+
+            await Page.EmulateVisionDeficiencyAsync(VisionDeficiency.None);
+            screenshot = await Page.ScreenshotDataAsync();
+            Assert.True(ScreenshotHelper.PixelMatch("screenshot-sanity.png", screenshot));
+        }
+    }
+}
diff --git a/lib/PuppeteerSharp.Tests/Screenshots/golden-chromium/test.png b/lib/PuppeteerSharp.Tests/Screenshots/golden-chromium/test.png
diff --git a/lib/PuppeteerSharp.Tests/WontImplementTests.cs b/lib/PuppeteerSharp.Tests/WontImplementTests.cs
@@ -37,6 +37,9 @@ public WontImplementTests(ITestOutputHelper output) : base(output)
         [PuppeteerTest("EventEmitter.spec.ts", "removeAllListeners", "removes every listener from all events by default")]
         [PuppeteerTest("EventEmitter.spec.ts", "removeAllListeners", "returns the emitter for chaining")]
         [PuppeteerTest("EventEmitter.spec.ts", "removeAllListeners", "can filter to remove only listeners for a given event name")]
+        [PuppeteerTest("emulation.spec.ts", "Page.emulateMediaType", "should throw in case of bad argument")]
+        [PuppeteerTest("emulation.spec.ts", "Page.emulateMediaFeatures", "should throw in case of bad argument")]
+        [PuppeteerTest("emulation.spec.ts", "Page.emulateVisionDeficiency", "should throw for invalid vision deficiencies")]
         [PuppeteerFact]
         public void TheseTesstWontBeImplemented()
         {

diff --git a/lib/PuppeteerSharp/Messaging/EmulationSetCPUThrottlingRateRequest.cs b/lib/PuppeteerSharp/Messaging/EmulationSetCPUThrottlingRateRequest.cs
@@ -0,0 +1,7 @@
+namespace PuppeteerSharp.Messaging
+{
+    internal class EmulationSetCPUThrottlingRateRequest
+    {
+        public decimal Rate{ get; set; }
+    }
+}
diff --git a/lib/PuppeteerSharp/Messaging/EmulationSetEmulatedVisionDeficiencyRequest.cs b/lib/PuppeteerSharp/Messaging/EmulationSetEmulatedVisionDeficiencyRequest.cs
@@ -0,0 +1,7 @@
+namespace PuppeteerSharp.Messaging
+{
+    internal class EmulationSetEmulatedVisionDeficiencyRequest
+    {
+        public VisionDeficiency Type { get; set; }
+    }
+}
diff --git a/lib/PuppeteerSharp/Page.cs b/lib/PuppeteerSharp/Page.cs
@@ -1895,6 +1895,21 @@ public Task SetBurstModeOffAsync()
         /// <returns>A task that resolves when the message has been sent to Chromium.</returns>
         public Task BringToFrontAsync() => Client.SendAsync("Page.bringToFront");
 
+        /// <summary>
+        /// Simulates the given vision deficiency on the page.
+        /// </summary>
+        /// <example>
+        /// await Page.EmulateVisionDeficiencyAsync(VisionDeficiency.Achromatopsia);
+        /// await Page.ScreenshotAsync("Achromatopsia.png");
+        /// </example>
+        /// <param name="type">The type of deficiency to simulate, or <see cref="VisionDeficiency.None"/> to reset.</param>
+        /// <returns>A task that resolves when the message has been sent to the browser.</returns>
+        public Task EmulateVisionDeficiencyAsync(VisionDeficiency type)
+            => Client.SendAsync("Emulation.setEmulatedVisionDeficiency", new EmulationSetEmulatedVisionDeficiencyRequest
+            {
+                Type = type,
+            });
+
         /// <summary>
         /// Changes the timezone of the page.
         /// </summary>
@@ -1916,6 +1931,24 @@ public async Task EmulateTimezoneAsync(string timezoneId)
             }
         }
 
+        /// <summary>
+        /// Enables CPU throttling to emulate slow CPUs.
+        /// </summary>
+        /// <param name="factor">Throttling rate as a slowdown factor (1 is no throttle, 2 is 2x slowdown, etc).</param>
+        /// <returns>A task that resolves when the message has been sent to the browser.</returns>
+        internal Task EmulateCPUThrottlingAsync(decimal? factor = null)
+        {
+            if (factor != null && factor < 1)
+            {
+                throw new ArgumentException("Throttling rate should be greater or equal to 1", nameof(factor));
+            }
+
+            return Client.SendAsync("Emulation.setCPUThrottlingRate", new EmulationSetCPUThrottlingRateRequest
+            {
+                Rate = factor ?? 1
+            });
+        }
+
         internal void OnPopup(Page popupPage) => Popup?.Invoke(this, new PopupEventArgs { PopupPage = popupPage });
 
         internal static async Task<Page> CreateAsync(

diff --git a/lib/PuppeteerSharp/VisionDeficiency.cs b/lib/PuppeteerSharp/VisionDeficiency.cs
@@ -0,0 +1,49 @@
+using System.Runtime.Serialization;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
+
+namespace PuppeteerSharp
+{
+    /// <summary>
+    /// Types of vision deficiency to emulate using <see cref="Page.EmulateVisionDeficiencyAsync(VisionDeficiency)"/>
+    /// </summary>
+    [JsonConverter(typeof(StringEnumConverter))]
+    public enum VisionDeficiency
+    {
+        /// <summary>
+        /// None
+        /// </summary>
+        [EnumMember(Value = "none")]
+        None,
+
+        /// <summary>
+        /// Achromatopsia
+        /// </summary>
+        [EnumMember(Value = "achromatopsia")]
+        Achromatopsia,
+
+        /// <summary>
+        /// BlurredVision
+        /// </summary>
+        [EnumMember(Value = "blurredVision")]
+        BlurredVision,
+
+        /// <summary>
+        /// Deuteranopia
+        /// </summary>
+        [EnumMember(Value = "deuteranopia")]
+        Deuteranopia,
+
+        /// <summary>
+        /// Protanopia
+        /// </summary>
+        [EnumMember(Value = "protanopia")]
+        Protanopia,
+
+        /// <summary>
+        /// Tritanopia
+        /// </summary>
+        [EnumMember(Value = "tritanopia")]
+        Tritanopia,
+    }
+}