Fix Ensure the appState is loaded only once and GetAppState always returns (#3193)

tomasfil · Tomáš Filip · web-flow · commit 65105e5d511b · 2022-04-11T03:19:24.000Z
* Ensure the appState is loaded only once and GetAppState always returns fixes #3192 * Interlocked.Exchange with func Using Interlocked.Exchange to prevent dead lock and Threading issues. Co-authored-by: Tomáš Filip <tomas.filip@meac.cz>
diff --git a/src/ReactiveUI/Suspension/SuspensionHostExtensions.cs b/src/ReactiveUI/Suspension/SuspensionHostExtensions.cs
@@ -4,8 +4,10 @@
 // See the LICENSE file in the project root for full license information.
 
 using System;
+using System.Reactive;
 using System.Reactive.Disposables;
 using System.Reactive.Linq;
+using System.Threading;
 using Splat;
 
 namespace ReactiveUI;
@@ -16,38 +18,50 @@ namespace ReactiveUI;
 public static class SuspensionHostExtensions
 {
     /// <summary>
-    /// Observe changes to the AppState of a class derived from ISuspensionHost.
+    /// Func used to load app state exactly once.
     /// </summary>
-    /// <typeparam name="T">The observable type.</typeparam>
+    private static Func<IObservable<Unit>>? ensureLoadAppStateFunc;
+
+    /// <summary>
+    /// Supsension driver reference field to prevent introducing breaking change.
+    /// </summary>
+    private static ISuspensionDriver? suspensionDriver;
+
+    /// <summary>
+    /// Get the current App State of a class derived from ISuspensionHost.
+    /// </summary>
+    /// <typeparam name="T">The app state type.</typeparam>
     /// <param name="item">The suspension host.</param>
-    /// <returns>An observable of the app state.</returns>
-    public static IObservable<T> ObserveAppState<T>(this ISuspensionHost item)
-        where T : class
+    /// <returns>The app state.</returns>
+    public static T GetAppState<T>(this ISuspensionHost item)
     {
         if (item is null)
         {
             throw new ArgumentNullException(nameof(item));
         }
 
-        return item.WhenAny(suspensionHost => suspensionHost.AppState, observedChange => observedChange.Value)
-                   .WhereNotNull()
-                   .Cast<T>();
+        Interlocked.Exchange(ref ensureLoadAppStateFunc, null)?.Invoke();
+
+        return (T)item.AppState!;
     }
 
     /// <summary>
-    /// Get the current App State of a class derived from ISuspensionHost.
+    /// Observe changes to the AppState of a class derived from ISuspensionHost.
     /// </summary>
-    /// <typeparam name="T">The app state type.</typeparam>
+    /// <typeparam name="T">The observable type.</typeparam>
     /// <param name="item">The suspension host.</param>
-    /// <returns>The app state.</returns>
-    public static T GetAppState<T>(this ISuspensionHost item)
+    /// <returns>An observable of the app state.</returns>
+    public static IObservable<T> ObserveAppState<T>(this ISuspensionHost item)
+        where T : class
     {
         if (item is null)
         {
             throw new ArgumentNullException(nameof(item));
         }
 
-        return (T)item.AppState!;
+        return item.WhenAny(suspensionHost => suspensionHost.AppState, observedChange => observedChange.Value)
+                   .WhereNotNull()
+                   .Cast<T>();
     }
 
     /// <summary>
@@ -65,32 +79,64 @@ public static IDisposable SetupDefaultSuspendResume(this ISuspensionHost item, I
         }
 
         var ret = new CompositeDisposable();
-        driver ??= Locator.Current.GetService<ISuspensionDriver>();
+        suspensionDriver ??= driver ?? Locator.Current.GetService<ISuspensionDriver>();
 
-        if (driver is null)
+        if (suspensionDriver is null)
         {
             item.Log().Error("Could not find a valid driver and therefore cannot setup Suspend/Resume.");
             return Disposable.Empty;
         }
 
+        ensureLoadAppStateFunc = () => EnsureLoadAppState(item, suspensionDriver);
+
         ret.Add(item.ShouldInvalidateState
-                    .SelectMany(_ => driver.InvalidateState())
+                    .SelectMany(_ => suspensionDriver.InvalidateState())
                     .LoggedCatch(item, Observables.Unit, "Tried to invalidate app state")
                     .Subscribe(_ => item.Log().Info("Invalidated app state")));
 
         ret.Add(item.ShouldPersistState
-                    .SelectMany(x => driver.SaveState(item.AppState!).Finally(x.Dispose))
+                    .SelectMany(x => suspensionDriver.SaveState(item.AppState!).Finally(x.Dispose))
                     .LoggedCatch(item, Observables.Unit, "Tried to persist app state")
                     .Subscribe(_ => item.Log().Info("Persisted application state")));
 
         ret.Add(item.IsResuming.Merge(item.IsLaunchingNew)
-                    .SelectMany(_ => driver.LoadState())
-                    .LoggedCatch(
-                                 item,
-                                 Observable.Defer(() => Observable.Return(item.CreateNewAppState?.Invoke())),
-                                 "Failed to restore app state from storage, creating from scratch")
-                    .Subscribe(x => item.AppState = x ?? item.CreateNewAppState?.Invoke()));
+                    .Do(_ => Interlocked.Exchange(ref ensureLoadAppStateFunc, null)?.Invoke())
+                    .Subscribe());
 
         return ret;
     }
-}
+
+    /// <summary>
+    /// Ensures one time app state load from storage.
+    /// </summary>
+    /// <param name="item">The suspension host.</param>
+    /// <param name="driver">The suspension driver.</param>
+    /// <returns>A completed observable.</returns>
+    private static IObservable<Unit> EnsureLoadAppState(this ISuspensionHost item, ISuspensionDriver? driver = null)
+    {
+        if (item.AppState is not null)
+        {
+            return Observable.Return(Unit.Default);
+        }
+
+        suspensionDriver ??= driver ?? Locator.Current.GetService<ISuspensionDriver>();
+
+        if (suspensionDriver is null)
+        {
+            item.Log().Error("Could not find a valid driver and therefore cannot load app state.");
+            return Observable.Return(Unit.Default);
+        }
+
+        try
+        {
+            item.AppState = suspensionDriver.LoadState().Wait();
+        }
+        catch (Exception ex)
+        {
+            item.Log().Warn(ex, "Failed to restore app state from storage, creating from scratch");
+            item.AppState = item.CreateNewAppState?.Invoke();
+        }
+
+        return Observable.Return(Unit.Default);
+    }
+}
