| | | 1 | | // ----------------------------------------------------------------------- |
| | | 2 | | // <copyright file="NavigationService.cs" company="Stéphane ANDRE"> |
| | | 3 | | // Copyright (c) Stéphane ANDRE. All rights reserved. |
| | | 4 | | // </copyright> |
| | | 5 | | // ----------------------------------------------------------------------- |
| | | 6 | | |
| | | 7 | | using System; |
| | | 8 | | using System.Collections.Generic; |
| | | 9 | | using System.Linq; |
| | | 10 | | using System.Threading; |
| | | 11 | | using System.Threading.Tasks; |
| | | 12 | | using MyNet.UI.Navigation.Models; |
| | | 13 | | |
| | | 14 | | namespace MyNet.UI.Navigation; |
| | | 15 | | |
| | | 16 | | public sealed class NavigationService( |
| | | 17 | | INavigationJournal journal, |
| | | 18 | | INavigationLifecycle lifecycle, |
| | | 19 | | IEnumerable<INavigationGuard> guards, |
| | | 20 | | IEnumerable<INavigationMiddleware> middlewares) |
| | | 21 | | : INavigationService, IDisposable |
| | | 22 | | { |
| | 42 | 23 | | private readonly IReadOnlyList<INavigationMiddleware> _middlewares = [.. middlewares]; |
| | 42 | 24 | | private readonly SemaphoreSlim _navigationLock = new(1, 1); |
| | | 25 | | |
| | | 26 | | /// <inheritdoc /> |
| | | 27 | | public event EventHandler<NavigationStateChangedEventArgs>? StateChanged; |
| | | 28 | | |
| | | 29 | | /// <inheritdoc /> |
| | | 30 | | public NavigationContext? CurrentContext { get; private set; } |
| | | 31 | | |
| | | 32 | | /// <inheritdoc /> |
| | 21 | 33 | | public bool CanGoBack => journal.BackStack.Any(); |
| | | 34 | | |
| | | 35 | | /// <inheritdoc /> |
| | 18 | 36 | | public bool CanGoForward => journal.ForwardStack.Any(); |
| | | 37 | | |
| | | 38 | | #region Public API |
| | | 39 | | |
| | | 40 | | /// <inheritdoc /> |
| | | 41 | | public async Task<NavigationResult> NavigateToAsync(INavigationPage page, INavigationParameters? parameters = null, |
| | | 42 | | { |
| | 51 | 43 | | ArgumentNullException.ThrowIfNull(page); |
| | | 44 | | |
| | 51 | 45 | | await _navigationLock.WaitAsync(cancellationToken).ConfigureAwait(false); |
| | | 46 | | |
| | | 47 | | try |
| | | 48 | | { |
| | 51 | 49 | | return await NavigateInternalAsync(page, NavigationMode.Normal, parameters, cancellationToken).ConfigureAwai |
| | | 50 | | } |
| | | 51 | | finally |
| | | 52 | | { |
| | 51 | 53 | | _navigationLock.Release(); |
| | | 54 | | } |
| | 51 | 55 | | } |
| | | 56 | | |
| | | 57 | | /// <inheritdoc /> |
| | | 58 | | public async Task<NavigationResult> GoBackAsync(CancellationToken cancellationToken = default) |
| | | 59 | | { |
| | 12 | 60 | | await _navigationLock.WaitAsync(cancellationToken).ConfigureAwait(false); |
| | | 61 | | |
| | | 62 | | try |
| | | 63 | | { |
| | 12 | 64 | | var context = journal.PeekBack(); |
| | | 65 | | |
| | 12 | 66 | | return context is null |
| | 12 | 67 | | ? new(NavigationStatus.NotFound) |
| | 12 | 68 | | : await NavigateInternalAsync(context.To, NavigationMode.Back, context.Parameters, cancellationToken).Co |
| | | 69 | | } |
| | | 70 | | finally |
| | | 71 | | { |
| | 12 | 72 | | _navigationLock.Release(); |
| | | 73 | | } |
| | 12 | 74 | | } |
| | | 75 | | |
| | | 76 | | /// <inheritdoc /> |
| | | 77 | | public async Task<NavigationResult> GoForwardAsync(CancellationToken cancellationToken = default) |
| | | 78 | | { |
| | 9 | 79 | | await _navigationLock.WaitAsync(cancellationToken).ConfigureAwait(false); |
| | | 80 | | |
| | | 81 | | try |
| | | 82 | | { |
| | 9 | 83 | | var context = journal.PeekForward(); |
| | | 84 | | |
| | 9 | 85 | | return context is null |
| | 9 | 86 | | ? new(NavigationStatus.NotFound) |
| | 9 | 87 | | : await NavigateInternalAsync(context.To, NavigationMode.Forward, context.Parameters, cancellationToken) |
| | | 88 | | } |
| | | 89 | | finally |
| | | 90 | | { |
| | 9 | 91 | | _navigationLock.Release(); |
| | | 92 | | } |
| | 9 | 93 | | } |
| | | 94 | | |
| | | 95 | | /// <inheritdoc /> |
| | | 96 | | public async Task ResetAsync() |
| | | 97 | | { |
| | 6 | 98 | | await _navigationLock.WaitAsync().ConfigureAwait(false); |
| | | 99 | | |
| | | 100 | | try |
| | | 101 | | { |
| | 6 | 102 | | CurrentContext = null; |
| | 6 | 103 | | journal.Clear(); |
| | 6 | 104 | | RaiseStateChanged(); |
| | 6 | 105 | | } |
| | | 106 | | finally |
| | | 107 | | { |
| | 6 | 108 | | _navigationLock.Release(); |
| | | 109 | | } |
| | 6 | 110 | | } |
| | | 111 | | |
| | | 112 | | #endregion |
| | | 113 | | |
| | | 114 | | #region Core Navigation Pipeline |
| | | 115 | | |
| | | 116 | | private async Task<NavigationResult> NavigateInternalAsync( |
| | | 117 | | INavigationPage to, |
| | | 118 | | NavigationMode mode, |
| | | 119 | | INavigationParameters? parameters, |
| | | 120 | | CancellationToken cancellationToken) |
| | | 121 | | { |
| | 72 | 122 | | ArgumentNullException.ThrowIfNull(to); |
| | | 123 | | |
| | 72 | 124 | | var previousContext = CurrentContext; |
| | 72 | 125 | | var context = NavigationContext.Create(previousContext?.To, to, mode, parameters); |
| | | 126 | | |
| | | 127 | | try |
| | | 128 | | { |
| | | 129 | | // 1. Guards (decision layer) |
| | 72 | 130 | | var guardResult = await ExecuteGuardsAsync(previousContext, context, cancellationToken).ConfigureAwait(false |
| | 72 | 131 | | if (!guardResult) |
| | | 132 | | { |
| | 6 | 133 | | return new(NavigationStatus.Cancelled, "Navigation blocked by guard."); |
| | | 134 | | } |
| | | 135 | | |
| | | 136 | | // 2. Lifecycle: leaving the current page (source only) |
| | 66 | 137 | | if (previousContext is not null) |
| | | 138 | | { |
| | 33 | 139 | | await lifecycle.OnNavigatingFromAsync(context, cancellationToken).ConfigureAwait(false); |
| | | 140 | | } |
| | | 141 | | |
| | 66 | 142 | | cancellationToken.ThrowIfCancellationRequested(); |
| | | 143 | | |
| | | 144 | | // 3. Middleware pipeline (includes core execution; no target lifecycle yet) |
| | 66 | 145 | | var pipeline = BuildMiddlewarePipeline(previousContext, context, core, cancellationToken); |
| | | 146 | | |
| | 66 | 147 | | var result = await pipeline().ConfigureAwait(false); |
| | | 148 | | |
| | 66 | 149 | | if (result.Status != NavigationStatus.Succeeded) |
| | 3 | 150 | | return result; |
| | | 151 | | |
| | | 152 | | // 4. Lifecycle: entering the target page (after a successful pipeline) |
| | 63 | 153 | | await lifecycle.OnNavigatingToAsync(context, cancellationToken).ConfigureAwait(false); |
| | | 154 | | |
| | | 155 | | // 5. Commit navigation atomically |
| | 63 | 156 | | UpdateJournal(mode, previousContext); |
| | 63 | 157 | | CurrentContext = context; |
| | | 158 | | |
| | | 159 | | // 6. Lifecycle: navigation committed |
| | 63 | 160 | | await lifecycle.OnNavigatedAsync(context, cancellationToken).ConfigureAwait(false); |
| | | 161 | | |
| | 63 | 162 | | RaiseStateChanged(); |
| | | 163 | | |
| | 63 | 164 | | return result; |
| | | 165 | | } |
| | 0 | 166 | | catch (OperationCanceledException) when (cancellationToken.IsCancellationRequested) |
| | | 167 | | { |
| | 0 | 168 | | return new(NavigationStatus.Cancelled); |
| | | 169 | | } |
| | 0 | 170 | | catch (Exception exception) |
| | | 171 | | { |
| | 0 | 172 | | return new(NavigationStatus.Failed, exception.Message, exception); |
| | | 173 | | } |
| | | 174 | | |
| | | 175 | | static Task<NavigationResult> core() => Task.FromResult(new NavigationResult(NavigationStatus.Succeeded)); |
| | 72 | 176 | | } |
| | | 177 | | |
| | | 178 | | #endregion |
| | | 179 | | |
| | | 180 | | #region Guards |
| | | 181 | | |
| | | 182 | | private async Task<bool> ExecuteGuardsAsync(NavigationContext? previousContext, NavigationContext context, Cancellat |
| | | 183 | | { |
| | 162 | 184 | | foreach (var guard in guards) |
| | | 185 | | { |
| | 12 | 186 | | var canNavigate = await guard.CanNavigateAsync(previousContext, context, cancellationToken).ConfigureAwait(f |
| | | 187 | | |
| | 12 | 188 | | if (!canNavigate) |
| | 6 | 189 | | return false; |
| | | 190 | | } |
| | | 191 | | |
| | 66 | 192 | | return true; |
| | 72 | 193 | | } |
| | | 194 | | |
| | | 195 | | #endregion |
| | | 196 | | |
| | | 197 | | #region Middleware Pipeline |
| | | 198 | | |
| | | 199 | | private Func<Task<NavigationResult>> BuildMiddlewarePipeline( |
| | | 200 | | NavigationContext? from, |
| | | 201 | | NavigationContext to, |
| | | 202 | | Func<Task<NavigationResult>> core, |
| | | 203 | | CancellationToken cancellationToken) |
| | | 204 | | { |
| | 66 | 205 | | var pipeline = core; |
| | | 206 | | |
| | 150 | 207 | | foreach (var middleware in _middlewares.Reverse()) |
| | | 208 | | { |
| | 9 | 209 | | var next = pipeline; |
| | | 210 | | |
| | 9 | 211 | | pipeline = () => middleware.InvokeAsync( |
| | 9 | 212 | | from, |
| | 9 | 213 | | to, |
| | 9 | 214 | | next, |
| | 9 | 215 | | cancellationToken); |
| | | 216 | | } |
| | | 217 | | |
| | 66 | 218 | | return pipeline; |
| | | 219 | | } |
| | | 220 | | |
| | | 221 | | #endregion |
| | | 222 | | |
| | | 223 | | #region Journal |
| | | 224 | | |
| | | 225 | | private void UpdateJournal(NavigationMode mode, NavigationContext? previousContext) |
| | | 226 | | { |
| | | 227 | | switch (mode) |
| | | 228 | | { |
| | | 229 | | case NavigationMode.Normal: |
| | 45 | 230 | | if (previousContext is not null) |
| | 15 | 231 | | journal.PushBack(previousContext); |
| | 45 | 232 | | journal.ClearForward(); |
| | 45 | 233 | | break; |
| | | 234 | | |
| | | 235 | | case NavigationMode.Back: |
| | 9 | 236 | | _ = journal.PopBack(); |
| | 9 | 237 | | if (previousContext is not null) |
| | 9 | 238 | | journal.PushForward(previousContext); |
| | 9 | 239 | | break; |
| | | 240 | | |
| | | 241 | | case NavigationMode.Forward: |
| | 9 | 242 | | _ = journal.PopForward(); |
| | 9 | 243 | | if (previousContext is not null) |
| | 9 | 244 | | journal.PushBack(previousContext); |
| | | 245 | | break; |
| | | 246 | | } |
| | 9 | 247 | | } |
| | | 248 | | |
| | | 249 | | private void RaiseStateChanged() |
| | 69 | 250 | | => StateChanged?.Invoke( |
| | 69 | 251 | | this, |
| | 69 | 252 | | new(CurrentContext, CanGoBack, CanGoForward)); |
| | | 253 | | |
| | | 254 | | /// <inheritdoc /> |
| | 21 | 255 | | public void Dispose() => _navigationLock.Dispose(); |
| | | 256 | | |
| | | 257 | | #endregion |
| | | 258 | | } |
| | | 259 | | |