Add stronger analysis, add LoadedAction, error handling

Author: Cretezy

packages/redux_persist/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.5.0] - 2018-03-12
+
+Breaking changes:
+* Change `persistor.load(store)` to `persistor.start(store)` for initial loading.
+* Change `LoadAction<T>` to `LoadedAction<T>`.
+* Add `LoadAction` (action dispatch to start loading).
+* Add `PersistorErrorAction` (action dispatched on save/load error).
+* Add `debug` persistor option, doesn't do anything yet.
+
 ## [0.4.0] - 2018-03-10
 
 * Decouple Flutter and Web into different packages.

packages/redux_persist/README.md

@@ -23,7 +23,7 @@ Storage Engines:
 See [Flutter example](https://github.com/Cretezy/redux_persist/tree/master/packages/redux_persist_flutter/example) for a full overview.
 
 The library creates a middleware that saves on every action.
-It also loads on initial load and sets a `LoadAction` to your store.
+It also loads on initial load and sets a `LoadedAction` to your store.
 
 ### State Setup
 
@@ -75,7 +75,7 @@ var store = new Store<AppState>(
 );
 
 // Load state to store
-persistor.load(store);
+persistor.start(store);
 ```
 
 (the `key` param is used as a key of the save file name.
@@ -85,14 +85,14 @@ an instance of your state class, see the above example)
 ### Load
 
 In your reducer, you must add a check for the
-`LoadAction` action (with the generic type), like so:
+`LoadedAction` action (with the generic type), like so:
 
 ```dart
 class IncrementCounterAction {}
 
 AppState reducer(state, action) {
   // !!!
-  if (action is LoadAction<AppState>) {
+  if (action is LoadedAction<AppState>) {
     return action.state ?? state; // Use existing state if null
   }
   // !!!
@@ -107,6 +107,13 @@ AppState reducer(state, action) {
 }
 ```
 
+### Optional Actions
+
+You can also use the `LoadAction` or `PersistorErrorAction` to follow the lifecycle of the persistor.
+
+* `LoadAction` is dispatched when the store is being loaded
+* `PersistorErrorAction` is dispatched when an error occurs on loading/saving
+
 ## Storage Engines
 
 You can use the [Flutter](https://pub.dartlang.org/packages/redux_persist_flutter)
@@ -198,6 +205,19 @@ persistor = new Persistor<AppState>(
 );
 ```
 
+## Debug
+
+`Persistor` has a `debug` option, which will eventually log debug information.
+
+Use it like so:
+
+```dart
+persistor = new Persistor<AppState>(
+  // ...
+  debug: true
+);
+```
+
 ## Features and bugs
 
 Please file feature requests and bugs at the

packages/redux_persist/analysis_options.yaml

@@ -1,5 +1,7 @@
 analyzer:
-  strong-mode: true
+  strong-mode:
+    implicit-casts: false
+    implicit-dynamic: false
 
 linter:
   rules:

packages/redux_persist/lib/redux_persist.dart

@@ -15,13 +15,19 @@ abstract class StorageEngine {
 /// Decoder of state from [json] to <T>
 typedef T Decoder<T>(dynamic json);
 
-/// Action being dispatched when loading state from disk.
-class LoadAction<T> {
+/// Action being dispatched when done loading the state from disk.
+class LoadedAction<T> {
   final T state;
 
-  LoadAction(this.state);
+  LoadedAction(this.state);
 }
 
+/// Action being dispatched to load the state from disk.
+class LoadAction<T> {}
+
+/// Action being dispatched when error loading/saving to disk
+class PersistorErrorAction {}
+
 /// Persistor class that saves/loads to/from disk.
 class Persistor<T> {
   final StorageEngine storage;
@@ -30,27 +36,51 @@ class Persistor<T> {
   final Transforms<T> transforms;
   final RawTransforms rawTransforms;
 
-  final StreamController loadStreamController =
+  final StreamController<void> loadStreamController =
       new StreamController.broadcast();
 
+  final bool debug;
+
   var loaded = false;
 
-  Persistor({this.storage, this.decoder, this.transforms, this.rawTransforms});
+  Persistor({
+    this.storage,
+    this.decoder,
+    this.transforms,
+    this.rawTransforms,
+    this.debug = false,
+  });
 
   /// Middleware used for Redux which saves on each action.
   Middleware createMiddleware() {
-    return (Store store, action, NextDispatcher next) {
+    return (Store store, dynamic action, NextDispatcher next) {
       next(action);
 
-      // Save on each action
-      save(store.state);
+      // Don't run load/save on error
+      if (action is! PersistorErrorAction) {
+        try {
+          if (action is LoadAction<T>) {
+            // Load and dispatch to state
+            load().then((state) => store.dispatch(new LoadedAction<T>(state)));
+          } else {
+            // Save
+            save(store.state as T);
+          }
+        } catch (error) {
+          store.dispatch(new PersistorErrorAction());
+        }
+      }
     };
   }
 
+  void start(Store<T> store) {
+    store.dispatch(new LoadAction<T>());
+  }
+
   /// Load state from disk and dispatch LoadAction to [store]
-  Future<T> load(Store<T> store) async {
+  Future<T> load() async {
     var json = await storage.load();
-    var state;
+    T state;
 
     if (json != null) {
       rawTransforms?.onLoad?.forEach((transform) {
@@ -66,9 +96,6 @@ class Persistor<T> {
       });
     }
 
-    // Dispatch LoadAction to store
-    store.dispatch(new LoadAction<T>(state));
-
     // Emit
     loadStreamController.add(true);
     loaded = true;

packages/redux_persist/pubspec.yaml

@@ -1,6 +1,6 @@
 name: redux_persist
 description: Persist Redux State
-version: 0.4.0
+version: 0.5.0
 homepage: https://github.com/Cretezy/redux_persist/tree/master/packages/redux_persist
 author: Charles Crete <[email protected]>
 

packages/redux_persist_flutter/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.4.3] - 2018-03-12
+
+* Fix load bug (loaded JSON instead of string)
+
 ## [0.4.2] - 2018-03-10
 
 * Breaking: Change PersistorGate `child` to `builder`.

packages/redux_persist_flutter/analysis_options.yaml

@@ -1,5 +1,7 @@
 analyzer:
-  strong-mode: true
+  strong-mode:
+    implicit-casts: false
+    implicit-dynamic: false
 
 linter:
   rules:

packages/redux_persist_flutter/example/redux_persist_flutter_example.dart

@@ -30,7 +30,7 @@ class IncrementCounterAction {}
 
 AppState reducer(state, action) {
   // Load to state
-  if (action is LoadAction<AppState>) {
+  if (action is LoadedAction<AppState>) {
     return action.state ?? state;
   }
 
@@ -62,7 +62,7 @@ class MyApp extends StatelessWidget {
     );
 
     // Load state and dispatch LoadAction
-    persistor.load(store);
+    persistor.start(store);
   }
 
   @override

packages/redux_persist_flutter/lib/redux_persist_flutter.dart

@@ -1,7 +1,6 @@
 library redux_persist;
 
 import 'dart:async';
-import 'dart:convert';
 import 'dart:io';
 
 import 'package:flutter/widgets.dart';
@@ -17,7 +16,7 @@ class FlutterStorage implements StorageEngine {
   final String key;
   StorageEngine locationEngine;
 
-  FlutterStorage(this.key, {location = FlutterSaveLocation.sharedPreference}) {
+  FlutterStorage(this.key, {FlutterSaveLocation location = FlutterSaveLocation.sharedPreference}) {
     switch (location) {
       case FlutterSaveLocation.sharedPreference:
         locationEngine = new SharedPreferenceEngine(this.key);
@@ -47,8 +46,7 @@ class DocumentFileEngine implements StorageEngine {
 
     if (await file.exists()) {
       // Read to json
-      final string = await file.readAsString();
-      return JSON.decode(string);
+      return await file.readAsString();
     }
     return null;
   }
@@ -110,7 +108,7 @@ class PersistorGateState extends State<PersistorGate> {
 
     // Listen for loads
     widget.persistor.loadStream.listen(
-      (_) {
+      (void _) {
         if (!_loaded) {
           setState(() {
             _loaded = true;

packages/redux_persist_flutter/pubspec.yaml

@@ -1,6 +1,6 @@
 name: redux_persist_flutter
 description: Redux Persist Flutter Integration
-version: 0.4.2
+version: 0.4.3
 homepage: https://github.com/Cretezy/redux_persist/tree/master/packages/redux_persist_flutter
 author: Charles Crete <[email protected]>
 

packages/redux_persist_web/analysis_options.yaml

@@ -1,5 +1,7 @@
 analyzer:
-  strong-mode: true
+  strong-mode:
+    implicit-casts: false
+    implicit-dynamic: false
 
 linter:
   rules: