feature: serializable actions

Author: mrnkr

lib/src/action.dart

@@ -1,16 +1,18 @@
+import 'dart:convert';
+
 import 'package:meta/meta.dart';
 
 /// Base abstract class to make your custom actions more uniform
-/// 
+///
 /// ### Examples
-/// 
+///
 /// ```dart
 /// @immutable
 /// class CompleteTodo extends PayloadAction<Todo, void, void> {
 ///   const CompleteTodo(Todo todo) : super(payload: todo);
 /// }
 /// ```
-/// 
+///
 /// ```dart
 /// @immutable
 /// class Fulfilled<T, P, M> extends PayloadAction<P, Meta<M>, dynamic> {
@@ -29,4 +31,10 @@ abstract class PayloadAction<Payload, Meta, Error> {
     this.meta,
     this.error,
   });
+
+  Map<String, dynamic> toJson() => {
+        'payload': jsonDecode(jsonEncode(payload)),
+        'meta': jsonDecode(jsonEncode(meta)),
+        'error': jsonDecode(jsonEncode(error)),
+      };
 }

lib/src/async_thunk.dart

@@ -1,4 +1,5 @@
 import 'dart:async';
+import 'dart:convert';
 import 'package:meta/meta.dart';
 import 'package:redux/redux.dart';
 import 'package:redux_thunk/redux_thunk.dart';
@@ -13,6 +14,9 @@ class Meta<T> {
   final String requestId;
 
   const Meta(this.arg, this.requestId);
+
+  Map<String, dynamic> toJson() =>
+      {'requestId': requestId, 'arg': jsonDecode(jsonEncode(arg))};
 }
 
 /// Action that gets dispatched when an `AsyncThunk`

test/fakes/test_actions.dart

@@ -1,4 +1,5 @@
 import 'package:meta/meta.dart';
+import 'package:redux_toolkit/redux_toolkit.dart';
 
 import '../fakes/test_state.dart';
 
@@ -21,11 +22,17 @@ abstract class ErrorAction<T extends Exception> {
 class RequestItemsAction {}
 
 class FetchItemsSuccessfulAction extends Action<List<Item>> {
-  const FetchItemsSuccessfulAction({ List<Item> payload }) : super(payload: payload);
+  const FetchItemsSuccessfulAction({List<Item> payload})
+      : super(payload: payload);
 }
 
 class FetchItemsErrorAction extends ErrorAction<Exception> {
-  const FetchItemsErrorAction({ error }) : super(error: error);
+  const FetchItemsErrorAction({error}) : super(error: error);
 }
 
 class SomeUnhandledAction {}
+
+class TestPayloadAction extends PayloadAction {
+  const TestPayloadAction({dynamic payload, dynamic meta, dynamic error})
+      : super(payload: payload, meta: meta, error: error);
+}

test/fakes/test_model.dart

@@ -0,0 +1,10 @@
+class TestModel {
+  final String id;
+  final String title;
+  final bool completed;
+
+  const TestModel({this.id, this.title, this.completed});
+
+  Map<String, dynamic> toJson() =>
+      {'id': id, 'title': title, 'completed': completed};
+}

test/redux_toolkit_test.dart

@@ -1,7 +1,9 @@
+import 'tests/action_test.dart' as action_tests;
 import 'tests/async_thunk_test.dart' as async_thunk_tests;
 import 'tests/create_reducer_test.dart' as create_reducer_test;
 
 void main() {
+  action_tests.main();
   async_thunk_tests.main();
   create_reducer_test.main();
 }

test/tests/action_test.dart

@@ -0,0 +1,87 @@
+import 'dart:convert';
+
+import 'package:test/test.dart';
+
+import '../fakes/test_actions.dart';
+import '../fakes/test_model.dart';
+
+void main() {
+  group('payload action', () {
+    test('should be json serializable', () {
+      final action = TestPayloadAction(
+          payload: 'Serializable payload',
+          meta: 'Serializable meta',
+          error: 'Serializable error');
+      final actual = jsonDecode(jsonEncode(action));
+      final expected = {
+        'payload': 'Serializable payload',
+        'meta': 'Serializable meta',
+        'error': 'Serializable error',
+      };
+      expect(actual, equals(expected));
+    });
+
+    test('should serialize nested objects within payload', () {
+      final action = TestPayloadAction(
+          payload: TestModel(
+              id: '9f4772ab-8756-47e1-89a0-69d3e7a056d5',
+              title: 'Lorem ipsum dolor sit amet',
+              completed: false),
+          meta: 'Serializable meta',
+          error: 'Serializable error');
+      final actual = jsonDecode(jsonEncode(action));
+      final expected = {
+        'payload': {
+          'id': '9f4772ab-8756-47e1-89a0-69d3e7a056d5',
+          'title': 'Lorem ipsum dolor sit amet',
+          'completed': false
+        },
+        'meta': 'Serializable meta',
+        'error': 'Serializable error',
+      };
+      expect(actual, equals(expected));
+    });
+
+    test('should serialize nested objects within meta', () {
+      final action = TestPayloadAction(
+          payload: 'Serializable payload',
+          meta: TestModel(
+              id: '9f4772ab-8756-47e1-89a0-69d3e7a056d5',
+              title: 'Lorem ipsum dolor sit amet',
+              completed: false),
+          error: 'Serializable error');
+      final actual = jsonDecode(jsonEncode(action));
+      final expected = {
+        'payload': 'Serializable payload',
+        'meta': {
+          'id': '9f4772ab-8756-47e1-89a0-69d3e7a056d5',
+          'title': 'Lorem ipsum dolor sit amet',
+          'completed': false
+        },
+        'error': 'Serializable error',
+      };
+      expect(actual, equals(expected));
+    });
+
+    test('should serialize nested objects within errors', () {
+      final action = TestPayloadAction(
+          payload: 'Serializable payload',
+          meta: 'Serializable meta',
+          error: TestModel(
+              id: '9f4772ab-8756-47e1-89a0-69d3e7a056d5',
+              title: 'Lorem ipsum dolor sit amet',
+              completed: false));
+      final actual = jsonDecode(jsonEncode(action));
+      final expected = {
+        'payload': 'Serializable payload',
+        'meta': 'Serializable meta',
+        'error': {
+          'id': '9f4772ab-8756-47e1-89a0-69d3e7a056d5',
+          'title': 'Lorem ipsum dolor sit amet',
+          'completed': false
+        },
+      };
+      expect(actual, equals(expected));
+    });
+  });
+}

test/tests/async_thunk_test.dart

@@ -1,3 +1,5 @@
+import 'dart:convert';
+
 import 'package:test/test.dart';
 import 'package:mockito/mockito.dart';
 import 'package:redux/redux.dart';
@@ -52,5 +54,22 @@ void main() {
               .every((element) => element == requestId),
           isTrue);
     });
+
+    test('should dispatch serializable actions', () async {
+      final thunk = StringLength('hello');
+      await thunk.call(store);
+      verify(store.dispatch(argThat(predicate(
+          (arg) => jsonDecode(jsonEncode(arg)) is Map<String, dynamic>))));
+    });
+
+    test('should have serializable metadata', () async {
+      final meta = Meta(null, '3c26a440-d9a7-4fc2-ac2a-8524de6f1f19');
+      final actual = meta.toJson();
+      final expected = {
+        'arg': null,
+        'requestId': '3c26a440-d9a7-4fc2-ac2a-8524de6f1f19',
+      };
+      expect(actual, equals(expected));
+    });
   });
 }