Fixing the build

Author: javiercn

src/Components/Components/src/PersistentComponentState.cs

@@ -17,8 +17,7 @@ public class PersistentComponentState
 
     private readonly List<PersistComponentStateRegistration> _registeredCallbacks;
     private readonly List<RestoreComponentStateRegistration> _registeredRestoringCallbacks;
-    private IPersistentComponentStateScenario? _currentScenario;
-    private RestoreContext? _currentContext = null;
+    private RestoreContext? _currentContext;
 
     internal PersistentComponentState(
         IDictionary<string, byte[]> currentState,
@@ -33,15 +32,14 @@ internal PersistentComponentState(
     internal bool PersistingState { get; set; }
 
     // TODO: Replace IPersistentComponentStateScenario with RestoreContext
-    internal void InitializeExistingState(IDictionary<string, byte[]> existingState, IPersistentComponentStateScenario? scenario = null)
+    internal void InitializeExistingState(IDictionary<string, byte[]> existingState, RestoreContext context)
     {
         if (_existingState != null)
         {
             throw new InvalidOperationException("PersistentComponentState already initialized.");
         }
         _existingState = existingState ?? throw new ArgumentNullException(nameof(existingState));
-        _currentScenario = scenario;
-        _currentContext = null!;
+        _currentContext = context;
     }
 
     /// <summary>
@@ -76,6 +74,12 @@ public PersistingComponentStateSubscription RegisterOnPersisting(Func<Task> call
         return new PersistingComponentStateSubscription(_registeredCallbacks, persistenceCallback);
     }
 
+    /// <summary>
+    /// Register a callback to restore the state when the application state is being restored.
+    /// </summary>
+    /// <param name="callback"> The callback to invoke when the application state is being restored.</param>
+    /// <param name="options">Options that control the restoration behavior.</param>
+    /// <returns>A subscription that can be used to unregister the callback when disposed.</returns>
     public RestoringComponentStateSubscription RegisterOnRestoring(Action callback, RestoreOptions options)
     {
         if (_currentContext!.ShouldRestore(options))
@@ -86,34 +90,12 @@ public RestoringComponentStateSubscription RegisterOnRestoring(Action callback,
         if (options.AllowUpdates)
         {
             // TODO: Remove the filter from registration
-            var registration = new RestoreComponentStateRegistration(null, callback);
+            var registration = new RestoreComponentStateRegistration(callback);
             _registeredRestoringCallbacks.Add(registration);
             return new RestoringComponentStateSubscription(_registeredRestoringCallbacks, registration);
         }
-    }
-
-    /// <summary>
-    /// Register a callback to restore the component state during specific scenarios.
-    /// The callback will only be invoked if the filter supports the current restoration scenario.
-    /// </summary>
-    /// <param name="filter">The filter that determines when this callback should be invoked.</param>
-    /// <param name="callback">The callback to invoke during state restoration.</param>
-    /// <returns>A subscription that can be used to unregister the callback when disposed.</returns>
-    // TODO: Remove this method.
-    public RestoringComponentStateSubscription RegisterOnRestoring(IPersistentStateFilter? filter, Action callback)
-    {
-        ArgumentNullException.ThrowIfNull(callback);
-
-        if (_currentScenario == null || filter == null ||
-            (filter != null && (!filter.SupportsScenario(_currentScenario) ||
-            filter.ShouldRestore(_currentScenario))))
-        {
-            callback();
-        }
 
-        var registration = new RestoreComponentStateRegistration(filter, callback);
-        _registeredRestoringCallbacks.Add(registration);
-        return new RestoringComponentStateSubscription(_registeredRestoringCallbacks, registration);
+        return default;
     }
 
     /// <summary>
@@ -263,13 +245,7 @@ private bool TryTake(string key, out byte[]? value)
         }
     }
 
-    /// <summary>
-    /// Updates the existing state with the given <paramref name="state"/> dictionary.
-    /// </summary>
-    /// <param name="state">The new state to apply.</param>
-    /// <param name="scenario">The scenario for which the state is being updated.</param>
-    // TODO: Replace scenario with context.
-    internal void UpdateExistingState(IDictionary<string, byte[]> state, IPersistentComponentStateScenario? scenario)
+    internal void UpdateExistingState(IDictionary<string, byte[]> state, RestoreContext context)
     {
         ArgumentNullException.ThrowIfNull(state);
 
@@ -279,6 +255,6 @@ internal void UpdateExistingState(IDictionary<string, byte[]> state, IPersistent
         }
 
         _existingState = state;
-        _currentScenario = scenario;
+        _currentContext = context;
     }
 }

src/Components/Components/src/PersistentState/ComponentStatePersistenceManager.cs

@@ -58,26 +58,26 @@ public ComponentStatePersistenceManager(ILogger<ComponentStatePersistenceManager
     /// <returns>A <see cref="Task"/> that will complete when the state has been restored.</returns>
     public async Task RestoreStateAsync(IPersistentComponentStateStore store)
     {
-        await RestoreStateAsync(store, scenario: null);
+        await RestoreStateAsync(store, RestoreContext.InitialValue);
     }
 
     /// <summary>
-    /// Restores the component application state from the given <see cref="IPersistentComponentStateStore"/> using the specified scenario.
+    /// Restores the application state.
     /// </summary>
-    /// <param name="store">The <see cref="IPersistentComponentStateStore"/> to restore the application state from.</param>
-    /// <param name="scenario">The restoration scenario that determines which filters should be applied.</param>
+    /// <param name="store"> The <see cref="IPersistentComponentStateStore"/> to restore the application state from.</param>
+    /// <param name="context">The <see cref="RestoreContext"/> that provides additional context for the restoration.</param>
     /// <returns>A <see cref="Task"/> that will complete when the state has been restored.</returns>
-    public async Task RestoreStateAsync(IPersistentComponentStateStore store, IPersistentComponentStateScenario? scenario)
+    public async Task RestoreStateAsync(IPersistentComponentStateStore store, RestoreContext context)
     {
         var data = await store.GetPersistedStateAsync();
 
         if (_stateIsInitialized)
         {
-            State.UpdateExistingState(data, scenario);
+            State.UpdateExistingState(data, context);
         }
         else
         {
-            State.InitializeExistingState(data, scenario);
+            State.InitializeExistingState(data, context);
             _servicesRegistry?.Restore(State);
             _stateIsInitialized = true;
         }

src/Components/Components/src/PublicAPI.Unshipped.txt

@@ -1,5 +1,6 @@
 #nullable enable
 *REMOVED*Microsoft.AspNetCore.Components.ResourceAsset.ResourceAsset(string! url, System.Collections.Generic.IReadOnlyList<Microsoft.AspNetCore.Components.ResourceAssetProperty!>? properties) -> void
+Microsoft.AspNetCore.Components.Infrastructure.ComponentStatePersistenceManager.RestoreStateAsync(Microsoft.AspNetCore.Components.IPersistentComponentStateStore! store, Microsoft.AspNetCore.Components.RestoreContext! context) -> System.Threading.Tasks.Task!
 Microsoft.AspNetCore.Components.PersistentComponentState.RegisterOnRestoring(System.Action! callback, Microsoft.AspNetCore.Components.RestoreOptions options) -> Microsoft.AspNetCore.Components.RestoringComponentStateSubscription
 Microsoft.AspNetCore.Components.PersistentStateAttribute.AllowUpdates.get -> bool
 Microsoft.AspNetCore.Components.PersistentStateAttribute.AllowUpdates.set -> void
@@ -18,6 +19,9 @@ Microsoft.AspNetCore.Components.RestoreOptions.AllowUpdates.init -> void
 Microsoft.AspNetCore.Components.RestoreOptions.RestoreBehavior.get -> Microsoft.AspNetCore.Components.RestoreBehavior
 Microsoft.AspNetCore.Components.RestoreOptions.RestoreBehavior.init -> void
 Microsoft.AspNetCore.Components.RestoreOptions.RestoreOptions() -> void
+Microsoft.AspNetCore.Components.RestoringComponentStateSubscription
+Microsoft.AspNetCore.Components.RestoringComponentStateSubscription.Dispose() -> void
+Microsoft.AspNetCore.Components.RestoringComponentStateSubscription.RestoringComponentStateSubscription() -> void
 Microsoft.AspNetCore.Components.Routing.Router.NotFoundPage.get -> System.Type!
 Microsoft.AspNetCore.Components.Routing.Router.NotFoundPage.set -> void
 Microsoft.AspNetCore.Components.Infrastructure.ComponentsMetricsServiceCollectionExtensions
@@ -37,39 +41,12 @@ Microsoft.AspNetCore.Components.PersistentComponentStateSerializer<T>
 Microsoft.AspNetCore.Components.PersistentComponentStateSerializer<T>.PersistentComponentStateSerializer() -> void
 abstract Microsoft.AspNetCore.Components.PersistentComponentStateSerializer<T>.Persist(T value, System.Buffers.IBufferWriter<byte>! writer) -> void
 abstract Microsoft.AspNetCore.Components.PersistentComponentStateSerializer<T>.Restore(System.Buffers.ReadOnlySequence<byte> data) -> T
-Microsoft.AspNetCore.Components.UpdateStateOnEnhancedNavigation
-Microsoft.AspNetCore.Components.UpdateStateOnEnhancedNavigation.UpdateStateOnEnhancedNavigation(bool enable = false) -> void
 static Microsoft.AspNetCore.Components.Infrastructure.RegisterPersistentComponentStateServiceCollectionExtensions.AddPersistentServiceRegistration<TService>(Microsoft.Extensions.DependencyInjection.IServiceCollection! services, Microsoft.AspNetCore.Components.IComponentRenderMode! componentRenderMode) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
 static Microsoft.AspNetCore.Components.Infrastructure.ComponentsMetricsServiceCollectionExtensions.AddComponentsMetrics(Microsoft.Extensions.DependencyInjection.IServiceCollection! services) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
 static Microsoft.AspNetCore.Components.Infrastructure.ComponentsMetricsServiceCollectionExtensions.AddComponentsTracing(Microsoft.Extensions.DependencyInjection.IServiceCollection! services) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
 static Microsoft.AspNetCore.Components.RestoreContext.InitialValue.get -> Microsoft.AspNetCore.Components.RestoreContext!
 static Microsoft.AspNetCore.Components.RestoreContext.LastSnapshot.get -> Microsoft.AspNetCore.Components.RestoreContext!
 static Microsoft.AspNetCore.Components.RestoreContext.ValueUpdate.get -> Microsoft.AspNetCore.Components.RestoreContext!
-static Microsoft.AspNetCore.Components.WebPersistenceFilter.EnhancedNavigation.get -> Microsoft.AspNetCore.Components.WebPersistenceFilter!
-static Microsoft.AspNetCore.Components.WebPersistenceScenario.EnhancedNavigation.get -> Microsoft.AspNetCore.Components.WebPersistenceScenario!
 virtual Microsoft.AspNetCore.Components.OwningComponentBase.DisposeAsyncCore() -> System.Threading.Tasks.ValueTask
 static Microsoft.AspNetCore.Components.Infrastructure.PersistentStateProviderServiceCollectionExtensions.AddSupplyValueFromPersistentComponentStateProvider(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
 virtual Microsoft.AspNetCore.Components.Rendering.ComponentState.GetComponentKey() -> object?
-Microsoft.AspNetCore.Components.IPersistentComponentStateScenario
-Microsoft.AspNetCore.Components.IPersistentComponentStateScenario.IsRecurring.get -> bool
-Microsoft.AspNetCore.Components.IPersistentStateFilter
-Microsoft.AspNetCore.Components.IPersistentStateFilter.ShouldRestore(Microsoft.AspNetCore.Components.IPersistentComponentStateScenario! scenario) -> bool
-Microsoft.AspNetCore.Components.IPersistentStateFilter.SupportsScenario(Microsoft.AspNetCore.Components.IPersistentComponentStateScenario! scenario) -> bool
-Microsoft.AspNetCore.Components.PersistentComponentState.RegisterOnRestoring(Microsoft.AspNetCore.Components.IPersistentStateFilter? filter, System.Action! callback) -> Microsoft.AspNetCore.Components.RestoringComponentStateSubscription
-Microsoft.AspNetCore.Components.Infrastructure.ComponentStatePersistenceManager.RestoreStateAsync(Microsoft.AspNetCore.Components.IPersistentComponentStateStore! store, Microsoft.AspNetCore.Components.IPersistentComponentStateScenario? scenario) -> System.Threading.Tasks.Task!
-Microsoft.AspNetCore.Components.RestoreStateOnPrerenderingAttribute
-Microsoft.AspNetCore.Components.RestoreStateOnPrerenderingAttribute.RestoreStateOnPrerenderingAttribute(bool enable = true) -> void
-Microsoft.AspNetCore.Components.RestoreStateOnReconnectionAttribute
-Microsoft.AspNetCore.Components.RestoreStateOnReconnectionAttribute.RestoreStateOnReconnectionAttribute(bool enabled = true) -> void
-Microsoft.AspNetCore.Components.RestoringComponentStateSubscription
-Microsoft.AspNetCore.Components.RestoringComponentStateSubscription.Dispose() -> void
-Microsoft.AspNetCore.Components.RestoringComponentStateSubscription.RestoringComponentStateSubscription() -> void
-Microsoft.AspNetCore.Components.WebPersistenceFilter
-static Microsoft.AspNetCore.Components.WebPersistenceFilter.Prerendering.get -> Microsoft.AspNetCore.Components.WebPersistenceFilter!
-static Microsoft.AspNetCore.Components.WebPersistenceFilter.Reconnection.get -> Microsoft.AspNetCore.Components.WebPersistenceFilter!
-Microsoft.AspNetCore.Components.WebPersistenceFilter.ShouldRestore(Microsoft.AspNetCore.Components.IPersistentComponentStateScenario! scenario) -> bool
-Microsoft.AspNetCore.Components.WebPersistenceFilter.SupportsScenario(Microsoft.AspNetCore.Components.IPersistentComponentStateScenario! scenario) -> bool
-Microsoft.AspNetCore.Components.WebPersistenceScenario
-Microsoft.AspNetCore.Components.WebPersistenceScenario.IsRecurring.get -> bool
-static Microsoft.AspNetCore.Components.WebPersistenceScenario.Prerendering.get -> Microsoft.AspNetCore.Components.WebPersistenceScenario!
-static Microsoft.AspNetCore.Components.WebPersistenceScenario.Reconnection.get -> Microsoft.AspNetCore.Components.WebPersistenceScenario!

src/Components/Components/src/RestoreComponentStateRegistration.cs

@@ -3,11 +3,7 @@
 
 namespace Microsoft.AspNetCore.Components;
 
-internal readonly struct RestoreComponentStateRegistration(
-    IPersistentStateFilter? filter,
-    Action callback)
+internal readonly struct RestoreComponentStateRegistration(Action callback)
 {
-    public IPersistentStateFilter? Filter { get; } = filter;
-
     public Action Callback { get; } = callback;
 }