feat: 'JsonCacheTry' throws 'JsonCacheException' with stack trace (#110)

Author: rafamizes

CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- made class `JsonCacheTry` to throw `JsonCacheException` with associated
+  stack trace — [109](https://github.com/dartoos-dev/json_cache/issues/109).
+
+- `JsonCacheException` prefixes error messages with 'JsonCacheException: '.
+
+- bump up dependencies.
+
 ## [1.4.2] - 2022-09-10
 
 ### Fixed

lib/src/json_cache_exception.dart

@@ -1,6 +1,6 @@
 /// An exception to indicate cache operation failures.
 class JsonCacheException<T extends Object> implements Exception {
-  /// Sets [extra] as aditional information and [exception] as the original
+  /// Sets [extra] as the aditional information and [exception] as the original
   /// exception.
   const JsonCacheException({required this.extra, this.exception});
 
@@ -15,7 +15,8 @@ class JsonCacheException<T extends Object> implements Exception {
 
   /// Returns [extra] along with the original exception message.
   @override
-  String toString() => '$extra$_separator$_originalExceptionMessage';
+  String toString() =>
+      'JsonCacheException: $extra$_separator$_originalExceptionMessage';
 
   /// Returns '\n' if [exception] is set; otherwise, the empty string ''.
   String get _separator => exception != null ? '\n' : '';

lib/src/json_cache_try.dart

@@ -21,10 +21,13 @@ class JsonCacheTry implements JsonCache {
   Future<void> clear() async {
     try {
       await _wrapped.clear();
-    } on Exception catch (ex) {
-      throw JsonCacheException(
-        extra: 'Error clearing cached data.',
-        exception: ex,
+    } on Exception catch (ex, st) {
+      Error.throwWithStackTrace(
+        JsonCacheException(
+          extra: 'Error clearing cached data.',
+          exception: ex,
+        ),
+        st,
       );
     }
   }
@@ -36,10 +39,13 @@ class JsonCacheTry implements JsonCache {
   Future<void> refresh(String key, Map<String, dynamic> value) async {
     try {
       await _wrapped.refresh(key, value);
-    } on Exception catch (ex) {
-      throw JsonCacheException(
-        extra: "Error refreshing cached data at index '$key'.",
-        exception: ex,
+    } on Exception catch (ex, st) {
+      Error.throwWithStackTrace(
+        JsonCacheException(
+          extra: "Error refreshing cached data at index '$key'.",
+          exception: ex,
+        ),
+        st,
       );
     }
   }
@@ -51,10 +57,13 @@ class JsonCacheTry implements JsonCache {
   Future<void> remove(String key) async {
     try {
       await _wrapped.remove(key);
-    } on Exception catch (ex) {
-      throw JsonCacheException(
-        extra: "Error removing cached data at index '$key'.",
-        exception: ex,
+    } on Exception catch (ex, st) {
+      Error.throwWithStackTrace(
+        JsonCacheException(
+          extra: "Error removing cached data at index '$key'.",
+          exception: ex,
+        ),
+        st,
       );
     }
   }
@@ -66,10 +75,13 @@ class JsonCacheTry implements JsonCache {
   Future<Map<String, dynamic>?> value(String key) async {
     try {
       return await _wrapped.value(key);
-    } on Exception catch (ex) {
-      throw JsonCacheException(
-        extra: "Error retrieving cached data at index '$key'.",
-        exception: ex,
+    } on Exception catch (ex, st) {
+      Error.throwWithStackTrace(
+        JsonCacheException(
+          extra: "Error retrieving cached data at index '$key'.",
+          exception: ex,
+        ),
+        st,
       );
     }
   }
@@ -81,10 +93,13 @@ class JsonCacheTry implements JsonCache {
   Future<bool> contains(String key) async {
     try {
       return await _wrapped.contains(key);
-    } on Exception catch (ex) {
-      throw JsonCacheException(
-        extra: "Error checking for cached data at index '$key'.",
-        exception: ex,
+    } on Exception catch (ex, st) {
+      Error.throwWithStackTrace(
+        JsonCacheException(
+          extra: "Error checking for cached data at index '$key'.",
+          exception: ex,
+        ),
+        st,
       );
     }
   }

pubspec.lock

@@ -145,42 +145,42 @@ packages:
       name: flutter_secure_storage
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "6.0.0"
+    version: "6.1.0"
   flutter_secure_storage_linux:
     dependency: transitive
     description:
       name: flutter_secure_storage_linux
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.1.1"
+    version: "1.1.2"
   flutter_secure_storage_macos:
     dependency: transitive
     description:
       name: flutter_secure_storage_macos
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.1.1"
+    version: "1.1.2"
   flutter_secure_storage_platform_interface:
     dependency: transitive
     description:
       name: flutter_secure_storage_platform_interface
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.0.0"
+    version: "1.0.1"
   flutter_secure_storage_web:
     dependency: transitive
     description:
       name: flutter_secure_storage_web
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.0.2"
+    version: "1.1.1"
   flutter_secure_storage_windows:
     dependency: transitive
     description:
       name: flutter_secure_storage_windows
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.1.2"
+    version: "1.1.3"
   flutter_test:
     dependency: "direct dev"
     description: flutter
@@ -212,6 +212,13 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "2.2.3"
+  hive_test:
+    dependency: "direct dev"
+    description:
+      name: hive_test
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.0.1"
   http_multi_server:
     dependency: transitive
     description:
@@ -302,7 +309,7 @@ packages:
       name: mutex
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "3.0.0"
+    version: "3.0.1"
   node_preamble:
     dependency: transitive
     description:

pubspec.yaml

@@ -13,15 +13,16 @@ dependencies:
   encrypted_shared_preferences: ^3.0.1
   flutter:
     sdk: flutter
-  flutter_secure_storage: ^6.0.0
+  flutter_secure_storage: ^6.1.0
   hive: ^2.2.3
   localstorage: ^4.0.0+1
-  mutex: ^3.0.0
+  mutex: ^3.0.1
   shared_preferences: ^2.0.15
 
 dev_dependencies:
   flutter_test:
     sdk: flutter
+  hive_test: ^1.0.1
   lint: ^1.8.2
   mocktail: ^0.3.0
   test: ^1.18.2

test/json_cache_exception_test.dart

@@ -3,25 +3,43 @@ import 'package:json_cache/json_cache.dart';
 
 void main() {
   group('JsonCacheException', () {
-    test('Defined Original Exception', () {
-      const errorMessage = 'A caching operation failure has occurred';
-      final originalException = Exception(errorMessage);
-      const extraInfo = 'Error while reading from cache';
+    group('with original exception:', () {
+      const errorMsg = 'A caching operation failure has occurred';
+      final exception = Exception(errorMsg);
+      const extra = 'Error while reading from cache';
       final jsonCacheException = JsonCacheException(
-        extra: extraInfo,
-        exception: originalException,
+        extra: extra,
+        exception: exception,
       );
-      expect(identical(jsonCacheException.extra, extraInfo), true);
-      expect(identical(jsonCacheException.exception, originalException), true);
-      expect(jsonCacheException.toString(), '$extraInfo\n$originalException');
+      test('must keep "extra" instance', () {
+        expect(jsonCacheException.extra, same(extra));
+      });
+      test('must keep original exception instance', () {
+        expect(jsonCacheException.exception, same(exception));
+      });
+      test('"toString()" must produce a prettily formated message', () {
+        expect(
+          jsonCacheException.toString(),
+          'JsonCacheException: $extra\n$exception',
+        );
+      });
     });
+  });
 
-    test('Undefined Original Exception', () {
-      const extraInfo = 'Error while writing to cache';
-      const jsonCacheException = JsonCacheException(extra: extraInfo);
-      expect(identical(jsonCacheException.extra, extraInfo), true);
-      expect(jsonCacheException.exception, null);
-      expect(jsonCacheException.toString(), extraInfo);
+  group('without original exception:', () {
+    const extra = 'Error while writing to cache';
+    const jsonCacheException = JsonCacheException(extra: extra);
+    test('must keep "extra" instance', () {
+      expect(jsonCacheException.extra, same(extra));
+    });
+    test('original exception instance must be "null"', () {
+      expect(jsonCacheException.exception, isNull);
+    });
+    test('"toString()" must prefix "extra" with "JsonCacheException: "', () {
+      expect(
+        jsonCacheException.toString(),
+        equals('JsonCacheException: $extra'),
+      );
     });
   });
 }

test/json_cache_hive_test.dart

@@ -1,14 +1,14 @@
 import 'package:flutter_test/flutter_test.dart';
 import 'package:hive/hive.dart';
+import 'package:hive_test/hive_test.dart';
 import 'package:json_cache/src/json_cache_hive.dart';
 
 void main() {
-  setUp(() {
-    Hive.init('test');
+  setUp(() async {
+    await setUpTestHive();
   });
   tearDown(() async {
-    await Hive.deleteFromDisk();
-    await Hive.close();
+    await tearDownTestHive();
   });
   group('JsonCacheHive', () {
     test('clear, value, refresh', () async {

test/json_cache_try_test.dart

@@ -13,7 +13,7 @@ void main() {
         throwsAssertionError,
       );
     });
-    test('clear', () async {
+    test('clear should throw "JsonCacheException"', () async {
       final JsonCacheTry jsonCacheTry = JsonCacheTry(jsonCacheMock);
       // Stub the 'clear' method.
       when(() => jsonCacheMock.clear()).thenThrow(Exception('Cache Failure'));
@@ -27,7 +27,7 @@ void main() {
       // Check if the interaction occurred only once.
       verify(() => jsonCacheMock.clear()).called(1);
     });
-    test('contains', () async {
+    test('contains should throw "JsonCacheException"', () async {
       final JsonCacheTry jsonCacheTry = JsonCacheTry(jsonCacheMock);
       // Stub the 'contains' method.
       when(() => jsonCacheMock.contains('aKey'))
@@ -42,7 +42,7 @@ void main() {
       // Check if the interaction occurred only once.
       verify(() => jsonCacheMock.contains('aKey')).called(1);
     });
-    test('refresh', () async {
+    test('refresh should throw "JsonCacheException"', () async {
       final JsonCacheTry jsonCacheTry = JsonCacheTry(jsonCacheMock);
       // Stub the 'refresh' method.
       when(() => jsonCacheMock.refresh('aKey', {}))
@@ -57,7 +57,7 @@ void main() {
       // Check if the interaction occurred only once.
       verify(() => jsonCacheMock.refresh('aKey', {})).called(1);
     });
-    test('remove', () async {
+    test('remove should throw "JsonCacheException"', () async {
       final JsonCacheTry jsonCacheTry = JsonCacheTry(jsonCacheMock);
       // Stub the 'remove' method.
       when(() => jsonCacheMock.remove('aKey'))
@@ -72,7 +72,7 @@ void main() {
       // Check if the interaction occurred only once.
       verify(() => jsonCacheMock.remove('aKey')).called(1);
     });
-    test('value', () async {
+    test('value should throw "JsonCacheException"', () async {
       final JsonCacheTry jsonCacheTry = JsonCacheTry(jsonCacheMock);
       // Stub the 'value' method.
       when(() => jsonCacheMock.value('aKey'))