Add Page.EmulateTimezoneAsync (#1323)

* Add Page.EmulateTimezoneAsync

* Update lib/PuppeteerSharp/Page.cs

Co-Authored-By: Lucas G. Devescovi <[email protected]>

* cr

Author: kblok

lib/PuppeteerSharp.Tests/PageTests/EmulateTimezoneTests.cs

@@ -0,0 +1,52 @@
+using System.Threading.Tasks;
+using PuppeteerSharp.Media;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace PuppeteerSharp.Tests.PageTests
+{
+    [Collection(TestConstants.TestFixtureCollectionName)]
+    public class EmulateTimezoneTests : PuppeteerPageBaseTest
+    {
+        public EmulateTimezoneTests(ITestOutputHelper output) : base(output)
+        {
+        }
+
+        [Fact]
+        public async Task ShouldWork()
+        {
+            await Page.EvaluateExpressionAsync("globalThis.date = new Date(1479579154987);");
+            await Page.EmulateTimezoneAsync("America/Jamaica");
+            Assert.Equal(
+                "Sat Nov 19 2016 13:12:34 GMT-0500 (Eastern Standard Time)",
+                await Page.EvaluateExpressionAsync<string>("date.toString()"));
+
+            await Page.EmulateTimezoneAsync("Pacific/Honolulu");
+            Assert.Equal(
+                "Sat Nov 19 2016 08:12:34 GMT-1000 (Hawaii-Aleutian Standard Time)",
+                await Page.EvaluateExpressionAsync<string>("date.toString()"));
+
+            await Page.EmulateTimezoneAsync("America/Buenos_Aires");
+            Assert.Equal(
+                "Sat Nov 19 2016 15:12:34 GMT-0300 (Argentina Standard Time)",
+                await Page.EvaluateExpressionAsync<string>("date.toString()"));
+
+            await Page.EmulateTimezoneAsync("Europe/Berlin");
+            Assert.Equal(
+                "Sat Nov 19 2016 19:12:34 GMT+0100 (Central European Standard Time)",
+                await Page.EvaluateExpressionAsync<string>("date.toString()"));
+        }
+
+        [Fact]
+        public async Task ShouldThrowForInvalidTimezoneId()
+        {
+            var exception = await Assert.ThrowsAnyAsync<PuppeteerException>(
+                () => Page.EmulateTimezoneAsync("Foo/Bar"));
+            Assert.Contains("Invalid timezone ID: Foo/Bar", exception.Message);
+
+            exception = await Assert.ThrowsAnyAsync<PuppeteerException>(
+                () => Page.EmulateTimezoneAsync("Baz/Qux"));
+            Assert.Contains("Invalid timezone ID: Baz/Qux", exception.Message);
+        }
+    }
+}

lib/PuppeteerSharp/Messaging/EmulateTimezoneRequest.cs

@@ -0,0 +1,9 @@
+using Newtonsoft.Json;
+
+namespace PuppeteerSharp.Messaging
+{
+    internal class EmulateTimezoneRequest
+    {
+        public string TimezoneId { get; set; }
+    }
+}

lib/PuppeteerSharp/Page.cs

@@ -1694,6 +1694,27 @@ 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>
+        /// Changes the timezone of the page.
+        /// </summary>
+        /// <param name="timezoneId">Timezone to set. See <seealso href="https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1" >ICU’s `metaZones.txt`</seealso>
+        /// for a list of supported timezone IDs. Passing `null` disables timezone emulation.</param>
+        /// <returns>The viewport task.</returns>
+        public async Task EmulateTimezoneAsync(string timezoneId)
+        {
+            try
+            {
+                await Client.SendAsync("Emulation.setTimezoneOverride", new EmulateTimezoneRequest
+                {
+                    TimezoneId = timezoneId ?? string.Empty
+                }).ConfigureAwait(false);
+            }
+            catch (Exception ex) when (ex.Message.Contains("Invalid timezone"))
+            {
+                throw new PuppeteerException($"Invalid timezone ID: { timezoneId }");
+            }
+        }
+
         #endregion
 
         internal void OnPopup(Page popupPage) => Popup?.Invoke(this, new PopupEventArgs { PopupPage = popupPage });