Refactoring NavRouter

dyatlov-a · Sep 24, 2024 · 2b339a5 · 2b339a5
1 parent 3fd08f8
commit 2b339a5
Show file tree

Hide file tree

Showing 18 changed files with 86 additions and 63 deletions.
diff --git a/src/Inc.TeamAssistant.WebUI/Extensions/JsFunctions.cs b/src/Inc.TeamAssistant.WebUI/Extensions/JsFunctions.cs
@@ -9,12 +9,15 @@ public static IJsFunction<int> GetTimezone()
         return new JsFunction<int>("window.browserJsFunctions.getTimezone", postAction: null, args: null);
     }
 
-    public static IJsFunction<dynamic> ChangeUrl(this NavRouter navRouter, string url)
+    public static IJsFunction<dynamic> ChangeUrl(this NavRouter navRouter, NavRoute route)
     {
         ArgumentNullException.ThrowIfNull(navRouter);
-        ArgumentException.ThrowIfNullOrWhiteSpace(url);
+        ArgumentNullException.ThrowIfNull(route);
 
-        return new JsFunction<dynamic>("window.browserJsFunctions.changeUrl", () => navRouter.ChangeRoute(url), url);
+        return new JsFunction<dynamic>(
+            "window.browserJsFunctions.changeUrl",
+            () => navRouter.ChangeRoute(route),
+            route.ToString());
     }
 
     private sealed record JsFunction<TResult> : IJsFunction<TResult>

diff --git a/src/Inc.TeamAssistant.WebUI/Features/AssessmentSession/AssessmentSessionHistory.razor b/src/Inc.TeamAssistant.WebUI/Features/AssessmentSession/AssessmentSessionHistory.razor
@@ -10,7 +10,7 @@
         <div class="history__body">
             @foreach (var item in _items)
             {
-                <a href="@MoveToItem(item)" class="link link_dark history__item">
+                <a href="@CreateMoveToHistoryLink(item)" class="link link_dark history__item">
                     @item.AssessmentDate.ToString("dd-MM-yyyy") - @item.StoriesCount @Resources[Messages.GUI_Tasks]
                 </a>
             }
@@ -24,13 +24,8 @@
 
     private IReadOnlyCollection<AssessmentHistoryDto> _items = Array.Empty<AssessmentHistoryDto>();
 
-    private string MoveToItem(AssessmentHistoryDto historyItem)
-    {
-        if (historyItem is null)
-            throw new ArgumentNullException(nameof(historyItem));
-
-        return NavRouter.CreateRoute($"assessment-history/{TeamId:N}/{historyItem.AssessmentDate:yyyy-MM-dd}");
-    }
+    private string CreateMoveToHistoryLink(AssessmentHistoryDto historyItem)
+        => NavRouter.CreateRoute($"assessment-history/{TeamId:N}/{historyItem.AssessmentDate:yyyy-MM-dd}");
 
     protected override Task OnParametersSetAsync() => Load();
 

diff --git a/src/Inc.TeamAssistant.WebUI/Features/AssessmentSession/AssessmentSessionHistoryPage.razor b/src/Inc.TeamAssistant.WebUI/Features/AssessmentSession/AssessmentSessionHistoryPage.razor
@@ -62,7 +62,7 @@
     };
 
     private LoadingState _state = LoadingState.Done();
-    private IReadOnlyCollection<SelectItem<string>> _breadcrumbs = Array.Empty<SelectItem<string>>();
+    private IReadOnlyCollection<SelectItem<NavRoute>> _breadcrumbs = Array.Empty<SelectItem<NavRoute>>();
     private IReadOnlyCollection<StoryDto> _items = Array.Empty<StoryDto>();
 
     protected override async Task OnParametersSetAsync()

diff --git a/src/Inc.TeamAssistant.WebUI/Features/AssessmentSession/AssessmentSessionPage.razor b/src/Inc.TeamAssistant.WebUI/Features/AssessmentSession/AssessmentSessionPage.razor
@@ -87,7 +87,7 @@
     };
 
     private LoadingState _state = LoadingState.Done();
-    private IReadOnlyCollection<SelectItem<string>> _breadcrumbs = Array.Empty<SelectItem<string>>();
+    private IReadOnlyCollection<SelectItem<NavRoute>> _breadcrumbs = Array.Empty<SelectItem<NavRoute>>();
     private GetActiveStoryResult _item = new(string.Empty, string.Empty, Story: null);
     private IAsyncDisposable? _eventListener;
 

diff --git a/src/Inc.TeamAssistant.WebUI/Features/AssessmentSession/Breadcrumbs.razor b/src/Inc.TeamAssistant.WebUI/Features/AssessmentSession/Breadcrumbs.razor
@@ -9,5 +9,5 @@
 
 @code {
     [Parameter, EditorRequired]
-    public IReadOnlyCollection<SelectItem<string>> Items { get; set; } = Array.Empty<SelectItem<string>>();
+    public IReadOnlyCollection<SelectItem<NavRoute>> Items { get; set; } = Array.Empty<SelectItem<NavRoute>>();
 }
diff --git a/src/Inc.TeamAssistant.WebUI/Features/Auth/RedirectToLogin.razor b/src/Inc.TeamAssistant.WebUI/Features/Auth/RedirectToLogin.razor
@@ -3,6 +3,6 @@
 @code {
     protected override void OnInitialized()
     {
-        NavRouter.NavigateTo($"/login?returnUrl={NavRouter.CurrentUrl}");
+        NavRouter.NavigateToRouteSegment($"login?returnUrl={NavRouter.CurrentUrl}");
     }
 }
diff --git a/src/Inc.TeamAssistant.WebUI/Features/Constructor/BotSelector.razor b/src/Inc.TeamAssistant.WebUI/Features/Constructor/BotSelector.razor
@@ -24,7 +24,7 @@
             {
                 <BotCard Icon="@typeof(BotIcon)" Name="@bot.Name">
                     <Content>
-                        <a href="@MoveToDashboardLink(bot)" class="link link_dark">
+                        <a href="@CreateMoveToDashboardLink(bot)" class="link link_dark">
                             @Resources[Messages.Dashboard_MoveToDashboard]
                         </a>
                     </Content>
@@ -78,11 +78,11 @@
     private void MoveToEdit(Guid? botId)
     {
         var stage = Stage.CheckBot.ToString().ToLowerInvariant();
-        var link = botId.HasValue
+        var routeSegment = botId.HasValue
             ? $"constructor/{botId.Value:N}/{stage}"
             : $"constructor/{stage}";
 
-        NavRouter.NavigateToRoute(link);
+        NavRouter.NavigateToRouteSegment(routeSegment);
     }
 
     private void MoveToRemove(BotDto bot)
@@ -92,7 +92,7 @@
         _confirmDialog?.Open();
     }
 
-    private string MoveToDashboardLink(BotDto bot)
+    private string CreateMoveToDashboardLink(BotDto bot)
     {
         var teamId = bot.Teams.FirstOrDefault()?.Id;
 

diff --git a/src/Inc.TeamAssistant.WebUI/Features/Constructor/Stages/Stage1/CheckBot.razor b/src/Inc.TeamAssistant.WebUI/Features/Constructor/Stages/Stage1/CheckBot.razor
@@ -47,7 +47,7 @@
     public StagesState StagesState { get; set; } = default!;
 
     [Parameter, EditorRequired]
-    public Func<Stage, string> LinkFactory { get; set; } = default!;
+    public Func<Stage, NavRoute> LinkFactory { get; set; } = default!;
 
     [Parameter, EditorRequired]
     public Func<Stage?, Task> MoveToNext { get; set; } = default!;

diff --git a/src/Inc.TeamAssistant.WebUI/Features/Constructor/Stages/Stage2/SelectFeatures.razor b/src/Inc.TeamAssistant.WebUI/Features/Constructor/Stages/Stage2/SelectFeatures.razor
@@ -37,7 +37,7 @@
     public StagesState StagesState { get; set; } = default!;
 
     [Parameter, EditorRequired]
-    public Func<Stage, string> LinkFactory { get; set; } = default!;
+    public Func<Stage, NavRoute> LinkFactory { get; set; } = default!;
 
     [Parameter, EditorRequired]
     public Func<Stage?, Task> MoveToNext { get; set; } = default!;

diff --git a/src/Inc.TeamAssistant.WebUI/Features/Constructor/Stages/Stage3/SetSettings.razor b/src/Inc.TeamAssistant.WebUI/Features/Constructor/Stages/Stage3/SetSettings.razor
@@ -82,7 +82,7 @@
     public StagesState StagesState { get; set; } = default!;
 
     [Parameter, EditorRequired]
-    public Func<Stage, string> LinkFactory { get; set; } = default!;
+    public Func<Stage, NavRoute> LinkFactory { get; set; } = default!;
 
     [Parameter, EditorRequired]
     public Func<Stage?, Task> MoveToNext { get; set; } = default!;

diff --git a/src/Inc.TeamAssistant.WebUI/Features/Constructor/Stages/Stage4/Complete.razor b/src/Inc.TeamAssistant.WebUI/Features/Constructor/Stages/Stage4/Complete.razor
@@ -152,7 +152,7 @@
     public StagesState StagesState { get; set; } = default!;
 
     [Parameter, EditorRequired]
-    public Func<Stage, string> LinkFactory { get; set; } = default!;
+    public Func<Stage, NavRoute> LinkFactory { get; set; } = default!;
 
     [Parameter, EditorRequired]
     public Func<Stage?, Task> MoveToNext { get; set; } = default!;

diff --git a/src/Inc.TeamAssistant.WebUI/Features/Constructor/Stages/StagesPage.razor b/src/Inc.TeamAssistant.WebUI/Features/Constructor/Stages/StagesPage.razor
@@ -112,28 +112,28 @@
     {
         if (stage.HasValue)
         {
-            var url = LinkFactory(stage.Value);
+            var route = LinkFactory(stage.Value);
 
             _currentState = stage.Value;
             StateHasChanged();
 
-            await JsRuntime.Execute(NavRouter.ChangeUrl(url));
+            await JsRuntime.Execute(NavRouter.ChangeUrl(route));
             return;
         }
 
         var notificationsService = ServiceProvider.GetRequiredService<INotificationsService>();
 
         notificationsService.Publish(Notification.Info(Resources[Messages.GUI_DataRefreshed]));
 
-        NavRouter.NavigateToRoute("constructor");
+        NavRouter.NavigateToRouteSegment("constructor");
     }
 
-    private string LinkFactory(Stage stage)
+    private NavRoute LinkFactory(Stage stage)
     {
-        var link = _stagesState.Id.HasValue
+        var routeSegment = _stagesState.Id.HasValue
             ? $"constructor/{_stagesState.Id.Value:N}/{stage}"
             : $"constructor/{stage}";
 
-        return NavRouter.CreateRoute(link.ToLowerInvariant());
+        return NavRouter.CreateRoute(routeSegment.ToLowerInvariant());
     }
 }
diff --git a/src/Inc.TeamAssistant.WebUI/Features/Dashboard/Appraiser/AppraiserHistoryWidget.razor b/src/Inc.TeamAssistant.WebUI/Features/Dashboard/Appraiser/AppraiserHistoryWidget.razor
@@ -21,7 +21,7 @@
                                     Title="@Resources[Messages.Dashboard_AssessmentDate]"
                                     Sortable="true"
                                     SortBy="GridSort<AssessmentHistoryDto>.ByAscending(t => t.AssessmentDate)">
-                                    <a href="@MoveToItem(context.AssessmentDate)" class="link link_light">
+                                    <a href="@CreateMoveToHistoryLink(context.AssessmentDate)" class="link link_light">
                                         @context.AssessmentDate.ToString("dd-MM-yyyy")
                                     </a>
                                 </TemplateColumn>
@@ -42,7 +42,7 @@
                         }
                     </div>
                     <div class="component-actions">
-                        <a href="@GetAssessmentSessionUrl()" class="button button_dark">
+                        <a href="@CreateAssessmentSessionLink()" class="button button_dark">
                             @Resources[Messages.Dashboard_GoToCurrentSessionButtonText]
                         </a>
                     </div>
@@ -90,13 +90,15 @@
             });
     }
 
-    private string GetAssessmentSessionUrl() => NavRouter.CreateRoute($"assessment-session/{TeamId:N}");
-
-    private string MoveToItem(DateOnly date) => NavRouter.CreateRoute($"assessment-history/{TeamId:N}/{date:yyyy-MM-dd}");
+    private string CreateAssessmentSessionLink() => NavRouter.CreateRoute($"assessment-session/{TeamId:N}");
+
+    private string CreateMoveToHistoryLink(DateOnly date)
+        => NavRouter.CreateRoute($"assessment-history/{TeamId:N}/{date:yyyy-MM-dd}");
 
     private async Task Changed(DateOnly date)
     {
         _date = date;
+
         await Load();
     }
 }
diff --git a/src/Inc.TeamAssistant.WebUI/Features/Dashboard/DashboardPage.razor b/src/Inc.TeamAssistant.WebUI/Features/Dashboard/DashboardPage.razor
@@ -15,7 +15,6 @@
 @inject IBotService BotService
 @inject ResourcesManager Resources
 @inject RequestProcessor RequestProcessor
-@inject IJSRuntime JsRuntime
 @inject NavRouter NavRouter
 
 <MetaDataModule
@@ -117,18 +116,18 @@
 
     private Type ToWidgetType(string type) => _widgetsLookup[type];
 
-    private async Task ChangeTeamContext((Guid? BotId, Guid? TeamId) botContext)
+    private void ChangeTeamContext((Guid? BotId, Guid? TeamId) botContext)
     {
-        var url = (botContext.BotId.HasValue, botContext.TeamId.HasValue) switch
+        var routeSegment = (botContext.BotId.HasValue, botContext.TeamId.HasValue) switch
         {
             (true, true) => $"dashboard/{botContext.BotId:N}/{botContext.TeamId:N}",
             (true, false) => $"dashboard/{botContext.BotId:N}",
             _ => "dashboard"
         };
-        
+
         _botId = botContext.BotId;
         _teamId = botContext.TeamId;
-
-        await JsRuntime.Execute(NavRouter.ChangeUrl(url));
+        
+        NavRouter.NavigateToRouteSegment(routeSegment);
     }
 }
diff --git a/src/Inc.TeamAssistant.WebUI/Features/Layouts/CultureSelector.razor b/src/Inc.TeamAssistant.WebUI/Features/Layouts/CultureSelector.razor
@@ -37,7 +37,7 @@
         StateHasChanged();
     }
 
-    private void MoveTo(string path) => NavRouter.NavigateTo(path, forceLoad: true);
+    private void MoveTo(string path) => NavRouter.NavigateToPath(path);
 
     public void Dispose() => _routerScope?.Dispose();
 }
diff --git a/src/Inc.TeamAssistant.WebUI/Features/Layouts/MainNavbar.razor b/src/Inc.TeamAssistant.WebUI/Features/Layouts/MainNavbar.razor
@@ -26,10 +26,10 @@
                 <a href="@MainUrl" class="link navbar__item"><HomeIcon Size="40px" /></a>
                 <CultureSelector/>
                 <div class="navbar__divider"></div>
-                @if (!CurrentUrl.Contains("/login"))
+                @if (!NavRouter.CurrentUrl.Contains("/login"))
                 {
                     <a
-                        href="@NavRouter.CreateRoute($"login?returnUrl={CurrentUrl}")"
+                        href="@NavRouter.CreateRoute($"login?returnUrl={NavRouter.CurrentUrl}")"
                         class="link link_light navbar__item">
                         @Resources[Messages.Navigation_Login]
                     </a>
@@ -42,10 +42,8 @@
 @code {
     private IDisposable? _routerScope;
 
-    private string CurrentUrl => NavRouter.CurrentUrl;
-
     private string MainUrl => NavRouter.CreateRoute(null);
-    private string LogoutUrl => $"accounts/logout?returnUrl={CurrentUrl}";
+    private string LogoutUrl => $"accounts/logout?returnUrl={NavRouter.CurrentUrl}";
 
     protected override void OnInitialized()
     {

diff --git a/src/Inc.TeamAssistant.WebUI/Services/ClientCore/NavRoute.cs b/src/Inc.TeamAssistant.WebUI/Services/ClientCore/NavRoute.cs
@@ -0,0 +1,21 @@
+using Inc.TeamAssistant.Primitives.Languages;
+
+namespace Inc.TeamAssistant.WebUI.Services.ClientCore;
+
+public sealed record NavRoute(
+    LanguageId? LanguageId,
+    string RouteSegment)
+{
+    public override string ToString()
+    {
+        var languageSegment = LanguageId is null
+            ? string.Empty
+            : $"/{LanguageId.Value}";
+
+        return RouteSegment.StartsWith('/')
+            ? $"{languageSegment}{RouteSegment}"
+            : $"{languageSegment}/{RouteSegment}";
+    }
+
+    public static implicit operator string(NavRoute counter) => counter.ToString();
+}
diff --git a/src/Inc.TeamAssistant.WebUI/Services/ClientCore/NavRouter.cs b/src/Inc.TeamAssistant.WebUI/Services/ClientCore/NavRouter.cs
@@ -31,28 +31,36 @@ public string GetRouteWithoutLanguage()
         return routeWithoutLanguage;
     }
 
-    public string CreateRoute(string? relativeUrl)
+    public NavRoute CreateRoute(string? routeSegment)
     {
-        var link = string.IsNullOrWhiteSpace(relativeUrl) ? "/" : $"/{relativeUrl}";
+        var link = string.IsNullOrWhiteSpace(routeSegment) ? "/" : routeSegment;
         var languageContext = _renderContext.GetLanguageContext();
+        var selectedLanguage = languageContext.Selected ? languageContext.CurrentLanguage : null;
 
-        return languageContext.Selected
-            ? $"/{languageContext.CurrentLanguage.Value}{link}"
-            : link;
+        return new NavRoute(selectedLanguage, link);
     }
 
-    public void NavigateTo(string uri, bool forceLoad = false, bool replace = false)
+    public void NavigateToPath(string uri)
     {
         ArgumentException.ThrowIfNullOrWhiteSpace(uri);
 
-        _navigationManager.NavigateTo(uri, forceLoad, replace);
+        _navigationManager.NavigateTo(uri, forceLoad: true);
     }
 
-    public void NavigateToRoute(string uri, bool forceLoad = false, bool replace = false)
+    public void NavigateToRouteSegment(string routeSegment)
     {
-        ArgumentException.ThrowIfNullOrWhiteSpace(uri);
+        ArgumentException.ThrowIfNullOrWhiteSpace(routeSegment);
+
+        var route = CreateRoute(routeSegment);
 
-        _navigationManager.NavigateTo(CreateRoute(uri), forceLoad, replace);
+        NavigateToRoute(route);
+    }
+
+    public void NavigateToRoute(NavRoute route)
+    {
+        ArgumentNullException.ThrowIfNull(route);
+
+        _navigationManager.NavigateTo(route);
     }
 
     public IDisposable OnRouteChanged(Action onRouteChanged)
@@ -62,11 +70,11 @@ public IDisposable OnRouteChanged(Action onRouteChanged)
         return new RouterScope(() => _onRouteChanged -= onRouteChanged);
     }
 
-    public void ChangeRoute(string uri)
+    public void ChangeRoute(NavRoute route)
     {
-        ArgumentNullException.ThrowIfNull(uri);
+        ArgumentNullException.ThrowIfNull(route);
 
-        ChangeRouteCore(_navigationManager.ToAbsoluteUri(uri).ToString());
+        ChangeRouteCore(_navigationManager.ToAbsoluteUri(route).ToString());
     }
 
     private void ChangeRouteCore(string uri)
@@ -79,8 +87,5 @@ private void ChangeRouteCore(string uri)
 
     private void OnLocationChanged(object? sender, LocationChangedEventArgs e) => ChangeRouteCore(e.Location);
 
-    public void Dispose()
-    {
-        _navigationManager.LocationChanged -= OnLocationChanged;
-    }
+    public void Dispose() => _navigationManager.LocationChanged -= OnLocationChanged;
 }