Feat(error-handler): Add stacktrace to the ErrorHandler (#66)

* feat(error-handler): Updated handleError method Added optional stackTrace argument * chore(error-handler): edited docs Eddited documentation of handleError method * fix(error-handler): added curly braces Added curly braces for making stackTrace argument actually optional
Elementary-team · Aug 14, 2022 · 6286525 · 6286525
1 parent 02e647c
commit 6286525
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 15 deletions.
diff --git a/packages/elementary/example/lib/main.dart b/packages/elementary/example/lib/main.dart
@@ -29,9 +29,10 @@ class MyApp extends StatelessWidget {
 /// Error handler that print info to console
 class TestErrorHandler implements ErrorHandler {
   @override
-  void handleError(Object error) {
+  void handleError(Object error, {StackTrace? stackTrace}) {
     if (kDebugMode) {
       print(error);
+      print(stackTrace);
     }
   }
 }
diff --git a/packages/elementary/lib/src/core.dart b/packages/elementary/lib/src/core.dart
@@ -294,8 +294,8 @@ abstract class ElementaryModel {
   @protected
   @mustCallSuper
   @visibleForTesting
-  void handleError(Object error) {
-    _errorHandler?.handleError(error);
+  void handleError(Object error, {StackTrace? stackTrace}) {
+    _errorHandler?.handleError(error, stackTrace: stackTrace);
     _wmHandler?.call(error);
   }
 

diff --git a/packages/elementary/lib/src/error/error_handler.dart b/packages/elementary/lib/src/error/error_handler.dart
@@ -3,6 +3,6 @@
 ///
 /// !!! This not for Presentation Layer handling.
 abstract class ErrorHandler {
-  /// This method have to handle of passed error.
-  void handleError(Object error);
+  /// This method have to handle of passed error and optional [StackTrace].
+  void handleError(Object error, {StackTrace? stackTrace});
 }
diff --git a/packages/elementary/test/core/elementary_model_test.dart b/packages/elementary/test/core/elementary_model_test.dart
@@ -21,38 +21,46 @@ void main() {
   test('ErrorHandler should get every error from handleError', () {
     final error = Exception('Test');
     final error2 = Exception('Test2');
+    final stackTrace = StackTrace.fromString('Test stackTrace');
+    final stackTrace2 = StackTrace.fromString('Test2 stackTrace');
 
     testModel
-      ..handleError(error)
-      ..handleError(error2);
+      ..handleError(error, stackTrace: stackTrace)
+      ..handleError(error2, stackTrace: stackTrace2);
 
-    verify(() => errorHandler.handleError(error)).called(1);
-    verify(() => errorHandler.handleError(error2)).called(1);
+    verify(() => errorHandler.handleError(error, stackTrace: stackTrace))
+        .called(1);
+    verify(() => errorHandler.handleError(error2, stackTrace: stackTrace2))
+        .called(1);
   });
 
   test('ErrorHandler should get error in order', () {
     final error = Exception('Test');
     final error2 = Exception('Test2');
+    final stackTrace = StackTrace.fromString('Test stackTrace');
+    final stackTrace2 = StackTrace.fromString('Test2 stackTrace');
 
     testModel
-      ..handleError(error)
-      ..handleError(error2);
+      ..handleError(error, stackTrace: stackTrace)
+      ..handleError(error2, stackTrace: stackTrace2);
 
     verifyInOrder([
-      () => errorHandler.handleError(error),
-      () => errorHandler.handleError(error2),
+      () => errorHandler.handleError(error, stackTrace: stackTrace),
+      () => errorHandler.handleError(error2, stackTrace: stackTrace2),
     ]);
   });
 
   test('WidgetModel should get every error from handleError', () {
     testModel.setupWmHandler(_fakeWmHandler);
     final error = Exception('Test');
     final error2 = Exception('Test2');
+    final stackTrace = StackTrace.fromString('Test stackTrace');
+    final stackTrace2 = StackTrace.fromString('Test2 stackTrace');
 
-    testModel.handleError(error);
+    testModel.handleError(error, stackTrace: stackTrace);
     expect(fakeHandlerHub, same(error));
 
-    testModel.handleError(error2);
+    testModel.handleError(error2, stackTrace: stackTrace2);
     expect(fakeHandlerHub, same(error2));
   });