Version 1.0.5 (#2)

* Add target_commitish to release action for better versioning control

(cherry picked from commit d266d06)

* Add support for .razor files in GitHub Actions workflow paths

(cherry picked from commit 79a33db)

* Refactor ILocalTimeService to use SetTimeZoneInfo method for setting time zone information

(cherry picked from commit 7b591f3)

* Update GetBrowserTimeZone method to check IsTimeZoneInfoAvailable before accessing TimeZoneInfo

(cherry picked from commit 7ed2b09)

* Add LocalTimeTotal components and tests for time zone handling

(cherry picked from commit 292a7a9)

Author: arika0093

.github/workflows/release-github.yaml

@@ -9,6 +9,7 @@ on:
     paths:
       - '**.csproj'
       - '**.cs'
+      - '**.razor'
       - '**.yaml'
 
 permissions:
@@ -52,6 +53,7 @@ jobs:
         with:
           name: ${{ steps.nbgv.outputs.SemVer2 }}
           tag_name: ${{ steps.nbgv.outputs.SemVer2 }}
+          target_commitish: ${{ github.ref }}
           generate_release_notes: true
           files: ./artifacts/*.nupkg
           # if hyphen contains in the tag name, it will be prerelease

.github/workflows/test.yaml

@@ -6,6 +6,7 @@ on:
     paths:
       - '**.csproj'
       - '**.cs'
+      - '**.razor'
       - '**.yaml'
 
 jobs:

src/BlazorLocalTime/Components/BlazorLocalTimeProvider.razor.cs

@@ -30,7 +30,7 @@ protected override async Task OnAfterRenderAsync(bool firstRender)
                 );
                 var timeZoneString = await module.InvokeAsync<string>("getBrowserTimeZone");
                 var timeZone = TimeZoneInfo.FindSystemTimeZoneById(timeZoneString);
-                LocalTimeService.TimeZoneInfo = timeZone;
+                LocalTimeService.SetTimeZoneInfo(timeZone);
             }
             catch (JSDisconnectedException)
             {

src/BlazorLocalTime/LocalTimeService.cs

@@ -8,7 +8,7 @@ public interface ILocalTimeService
     /// <summary>
     /// Browser's time zone information.
     /// </summary>
-    TimeZoneInfo? TimeZoneInfo { get; set; }
+    TimeZoneInfo? TimeZoneInfo { get; }
 
     /// <summary>
     /// Gets the current browser's local time as a <see cref="DateTimeOffset"/>.
@@ -25,6 +25,12 @@ public interface ILocalTimeService
     /// </summary>
     public bool IsTimeZoneInfoAvailable => TimeZoneInfo != null;
 
+    /// <summary>
+    /// Sets the browser's time zone information.
+    /// this method is only for internal use.
+    /// </summary>
+    internal void SetTimeZoneInfo(TimeZoneInfo timeZoneInfo);
+
     /// <summary>
     /// Converts the specified UTC <see cref="DateTime"/> to local time.
     /// </summary>
@@ -71,7 +77,7 @@ public DateTimeOffset ToLocalTimeOffset(DateTimeOffset dateTimeOffset)
     /// <returns>The <see cref="TimeZoneInfo"/> representing the browser's time zone.</returns>
     public TimeZoneInfo GetBrowserTimeZone()
     {
-        if (TimeZoneInfo == null)
+        if (TimeZoneInfo == null || !IsTimeZoneInfoAvailable)
         {
             throw new InvalidOperationException(
                 """
@@ -85,7 +91,6 @@ and perform processing after the time zone information has been set.
                 """
             );
         }
-
         return TimeZoneInfo;
     }
 }
@@ -95,27 +100,24 @@ and perform processing after the time zone information has been set.
 /// </summary>
 internal class LocalTimeService(TimeProvider timeProvider) : ILocalTimeService
 {
-    private TimeZoneInfo? _timeZoneInfo;
-
     /// <inheritdoc />
-    public TimeZoneInfo? TimeZoneInfo
-    {
-        get => _timeZoneInfo;
-        set
-        {
-            if (_timeZoneInfo != null && _timeZoneInfo.Equals(value))
-            {
-                return;
-            }
-            _timeZoneInfo = value;
-            LocalTimeZoneChanged.Invoke(this, EventArgs.Empty);
-        }
-    }
+    public TimeZoneInfo? TimeZoneInfo { get; internal set; }
 
     /// <inheritdoc />
     public event EventHandler LocalTimeZoneChanged = delegate { };
 
     /// <inheritdoc />
     public DateTimeOffset Now =>
         ((ILocalTimeService)this).ToLocalTimeOffset(timeProvider.GetUtcNow());
+
+    /// <inheritdoc />
+    public void SetTimeZoneInfo(TimeZoneInfo timeZoneInfo)
+    {
+        if (TimeZoneInfo != null && TimeZoneInfo.Equals(timeZoneInfo))
+        {
+            return;
+        }
+        TimeZoneInfo = timeZoneInfo;
+        LocalTimeZoneChanged.Invoke(this, EventArgs.Empty);
+    }
 }

tests/BlazorLocalTimeTest/BlazorLocalTimeProviderTest.razor

@@ -11,14 +11,19 @@
         };
 
         Services.AddScoped<ILocalTimeService, LocalTimeMockService>(_ => tms);
-        var module = JSInterop.SetupModule("./_content/BlazorLocalTime/Components/BlazorLocalTimeProvider.razor.js");
-        module.Setup<string>("getBrowserTimeZone").SetResult("Asia/Tokyo");
+        JavaScriptInitializer(JSInterop);
 
-        var cut = Render(
+        Render(
             @<BlazorLocalTimeProvider />
         );
 
         // timezone should be set to Asia/Tokyo
         tms.TimeZoneInfo!.Id.ShouldBe("Asia/Tokyo");
     }
+    
+    internal static void JavaScriptInitializer(BunitJSInterop jsInterop)
+    {
+        var module = jsInterop.SetupModule("./_content/BlazorLocalTime/Components/BlazorLocalTimeProvider.razor.js");
+        module.Setup<string>("getBrowserTimeZone").SetResult("Asia/Tokyo");
+    }
 }

tests/BlazorLocalTimeTest/Component/LocalTimeTotal1.razor

@@ -0,0 +1,7 @@
+@inject ILocalTimeService LocalTimeService
+@inject TimeProvider TimeProvider
+
+<p>
+    <LocalTimeText Value="TimeProvider.GetUtcNow()" Format="yyyy-MM-dd HH:mm:ss" />
+</p>
+<BlazorLocalTimeProvider />

tests/BlazorLocalTimeTest/Component/LocalTimeTotalFailed1.razor

@@ -0,0 +1,11 @@
+@inject ILocalTimeService LocalTimeService
+
+<BlazorLocalTimeProvider />
+
+@code {
+    protected override void OnInitialized()
+    { 
+        // that will be failed because the time zone is not available
+        var _ = LocalTimeService.Now;
+    }
+}

tests/BlazorLocalTimeTest/LocalTimeTotalTest.razor

@@ -0,0 +1,29 @@
+@using BlazorLocalTimeTest.Component
+@using Shouldly
+@inherits TestContext
+@code {
+    [Fact]
+    public void TestTotal1()
+    {
+        var timeProvider = new MockTimeProvider(new(2023, 10, 1, 12, 34, 56, TimeSpan.Zero));
+        Services.AddBlazorLocalTimeService(timeProvider);
+        BlazorLocalTimeProviderTest.JavaScriptInitializer(JSInterop);
+
+        var cut = RenderComponent<LocalTimeTotal1>();
+        // 12:34+09:00 -> 2023-10-01 21:34:56
+        cut.MarkupMatches("<p>2023-10-01 21:34:56</p>");
+    }
+    
+    [Fact]
+    public void TestTotalFailed1()
+    {
+        Services.AddBlazorLocalTimeService();
+        BlazorLocalTimeProviderTest.JavaScriptInitializer(JSInterop);
+
+        Should.Throw<InvalidOperationException>(() =>
+        {
+            // This test is expected to fail because BlazorLocalTimeProvider is not initialized
+            RenderComponent<LocalTimeTotalFailed1>();
+        });
+    }
+}