Merge pull request 0xPolygonID#497 from 0xPolygonID/feature/loggin_update

Updated stacktrace manager to handle logging and etc.

Author: 5eeman

example/pubspec.lock

@@ -53,10 +53,10 @@ packages:
     dependency: transitive
     description:
       name: async
-      sha256: d2872f9c19731c2e5f10444b14686eb7cc85c76274bd6c16e1816bff9a3bab63
+      sha256: "758e6d74e971c3e5aceb4110bfd6698efc7f501675bcfe0c775459a8140750eb"
       url: "https://pub.dev"
     source: hosted
-    version: "2.12.0"
+    version: "2.13.0"
   background_downloader:
     dependency: transitive
     description:
@@ -373,10 +373,10 @@ packages:
     dependency: transitive
     description:
       name: fake_async
-      sha256: "6a95e56b2449df2273fd8c45a662d6947ce1ebb7aafe80e550a3f68297f3cacc"
+      sha256: "5368f224a74523e8d2e7399ea1638b37aecfca824a3cc4dfdf77bf1fa905ac44"
       url: "https://pub.dev"
     source: hosted
-    version: "1.3.2"
+    version: "1.3.3"
   ffi:
     dependency: transitive
     description:
@@ -811,10 +811,10 @@ packages:
     dependency: transitive
     description:
       name: leak_tracker
-      sha256: c35baad643ba394b40aac41080300150a4f08fd0fd6a10378f8f7c6bc161acec
+      sha256: "6bb818ecbdffe216e81182c2f0714a2e62b593f4a4f13098713ff1685dfb6ab0"
       url: "https://pub.dev"
     source: hosted
-    version: "10.0.8"
+    version: "10.0.9"
   leak_tracker_flutter_testing:
     dependency: transitive
     description:
@@ -1295,10 +1295,10 @@ packages:
     dependency: transitive
     description:
       name: vm_service
-      sha256: "0968250880a6c5fe7edc067ed0a13d4bae1577fe2771dcf3010d52c4a9d3ca14"
+      sha256: ddfa8d30d89985b96407efce8acbdd124701f96741f2d981ca860662f1c0dc02
       url: "https://pub.dev"
     source: hosted
-    version: "14.3.1"
+    version: "15.0.0"
   wallet:
     dependency: transitive
     description:
@@ -1351,10 +1351,10 @@ packages:
     dependency: transitive
     description:
       name: webdriver
-      sha256: "3d773670966f02a646319410766d3b5e1037efb7f07cc68f844d5e06cd4d61c8"
+      sha256: "2f3a14ca026957870cfd9c635b83507e0e51d8091568e90129fbf805aba7cade"
       url: "https://pub.dev"
     source: hosted
-    version: "3.0.4"
+    version: "3.1.0"
   win32:
     dependency: transitive
     description:

lib/common/domain/use_cases/get_env_use_case.dart

@@ -20,9 +20,7 @@ class GetEnvUseCase extends FutureUseCase<void, EnvEntity> {
 
       return env;
     }).catchError((error) {
-      logger().e("[GetEnvUseCase] Error: $error");
-      _stacktraceManager.addTrace("[GetEnvUseCase] Error: $error");
-      _stacktraceManager.addError(error.toString());
+      _stacktraceManager.logError("[GetEnvUseCase] Error: $error");
       throw error;
     });
   }

lib/common/infrastructure/stacktrace_stream_manager.dart

@@ -10,6 +10,8 @@ const _stacktraceBoxName = 'stacktrace';
 class StacktraceManager {
   bool isEnabled = false;
 
+  bool logAll = false;
+
   String _errorTrace = '';
   String _stacktrace = '';
 
@@ -33,7 +35,7 @@ class StacktraceManager {
 
   /// Add new trace to the stacktrace
   void addTrace(String stepDescription, {bool log = false}) {
-    if (log) {
+    if (log || logAll) {
       logger().i(stepDescription);
     }
 
@@ -47,11 +49,19 @@ class StacktraceManager {
     _stacktraceStreamController.add(stepDescription);
   }
 
-  void addError(String error) {
+  void logTrace(String stepDescription) => addTrace(stepDescription, log: true);
+
+  void addError(String error, {bool log = false}) {
+    if (log || logAll) {
+      logger().e(error);
+    }
+    addTrace(error, log: false);
     _errorTrace += '\n***' + error + '\n***';
     _errorStreamController.add(error);
   }
 
+  void logError(String error) => addError(error, log: true);
+
   /// we reset the stream
   /// so we can use it again
   void reset() {

lib/credential/domain/use_cases/cache_credentials_use_case.dart

@@ -1,4 +1,3 @@
-import 'package:polygonid_flutter_sdk/common/domain/domain_logger.dart';
 import 'package:polygonid_flutter_sdk/common/domain/entities/env_config_entity.dart';
 import 'package:polygonid_flutter_sdk/common/domain/use_cases/get_env_use_case.dart';
 import 'package:polygonid_flutter_sdk/common/infrastructure/stacktrace_stream_manager.dart';
@@ -35,9 +34,7 @@ class CacheCredentialsUseCase {
           ),
         );
       } catch (e) {
-        logger().e(
-            "[FetchAndSaveClaimsUseCase] Error while caching credential: $e");
-        _stacktraceManager.addTrace(
+        _stacktraceManager.logError(
             "[FetchAndSaveClaimsUseCase] Error while caching credential: $e");
       }
     }

lib/credential/domain/use_cases/generate_non_rev_proof_use_case.dart

@@ -1,4 +1,3 @@
-import 'package:polygonid_flutter_sdk/common/domain/domain_logger.dart';
 import 'package:polygonid_flutter_sdk/common/domain/use_case.dart';
 import 'package:polygonid_flutter_sdk/common/infrastructure/stacktrace_stream_manager.dart';
 import 'package:polygonid_flutter_sdk/credential/domain/entities/claim_entity.dart';
@@ -62,15 +61,11 @@ class GenerateNonRevProofUseCase
         baseUrl: baseUrl,
         cachedNonRevProof: param.nonRevProof,
       );
-
-      _stacktraceManager.addTrace("[GenerateNonRevProofUseCase] Non rev proof");
-      logger().i("[GenerateNonRevProofUseCase] Non rev proof: $nonRevProof");
+      _stacktraceManager.logTrace("[GenerateNonRevProofUseCase] Non rev proof");
 
       return nonRevProof;
     } catch (error) {
-      _stacktraceManager.addTrace("[GenerateNonRevProofUseCase] Error: $error");
-      logger().e("[GenerateNonRevProofUseCase] Error: $error");
-      _stacktraceManager.addError("[GenerateNonRevProofUseCase] Error: $error");
+      _stacktraceManager.logError("[GenerateNonRevProofUseCase] Error: $error");
       rethrow;
     }
   }

lib/credential/domain/use_cases/get_claim_revocation_status_use_case.dart

@@ -1,7 +1,6 @@
 import 'package:polygonid_flutter_sdk/common/infrastructure/stacktrace_stream_manager.dart';
 import 'package:polygonid_flutter_sdk/credential/domain/use_cases/generate_non_rev_proof_use_case.dart';
 
-import '../../../common/domain/domain_logger.dart';
 import '../../../common/domain/use_case.dart';
 import '../entities/claim_entity.dart';
 import '../repositories/credential_repository.dart';
@@ -37,10 +36,7 @@ class GetClaimRevocationStatusUseCase
       useRHS = await _credentialRepository.isUsingRHS(claim: param.claim);
     } catch (error) {
       _stacktraceManager
-          .addTrace("[GetClaimRevocationStatusUseCase] Error: $error");
-      _stacktraceManager
-          .addError("[GetClaimRevocationStatusUseCase] Error: $error");
-      logger().e("[GetClaimRevocationStatusUseCase] Error: $error");
+          .logError("[GetClaimRevocationStatusUseCase] Error: $error");
       rethrow;
     }
 
@@ -59,17 +55,12 @@ class GetClaimRevocationStatusUseCase
         try {
           final nonRevProof = await _credentialRepository.getRevocationStatus(
               claim: param.claim);
-          _stacktraceManager.addTrace(
-              "[GetClaimRevocationStatusUseCase] Revocation status: $nonRevProof");
-          logger().i(
+          _stacktraceManager.logTrace(
               "[GetClaimRevocationStatusUseCase] Revocation status: $nonRevProof");
           return nonRevProof;
         } catch (error) {
           _stacktraceManager
-              .addTrace("[GetClaimRevocationStatusUseCase] Error: $error");
-          _stacktraceManager
-              .addError("[GetClaimRevocationStatusUseCase] Error: $error");
-          logger().e("[GetClaimRevocationStatusUseCase] Error: $error");
+              .logError("[GetClaimRevocationStatusUseCase] Error: $error");
           rethrow;
         }
       }
@@ -80,17 +71,13 @@ class GetClaimRevocationStatusUseCase
       try {
         final nonRevProof =
             await _credentialRepository.getRevocationStatus(claim: param.claim);
-        _stacktraceManager.addTrace(
-            "[GetClaimRevocationStatusUseCase] Revocation status: $nonRevProof");
-        logger().i(
+        _stacktraceManager.logTrace(
             "[GetClaimRevocationStatusUseCase] Revocation status: $nonRevProof");
+
         return nonRevProof;
       } catch (error) {
         _stacktraceManager
-            .addTrace("[GetClaimRevocationStatusUseCase] Error: $error");
-        _stacktraceManager
-            .addError("[GetClaimRevocationStatusUseCase] Error: $error");
-        logger().e("[GetClaimRevocationStatusUseCase] Error: $error");
+            .logError("[GetClaimRevocationStatusUseCase] Error: $error");
         rethrow;
       }
     }

lib/credential/domain/use_cases/get_claims_use_case.dart

@@ -1,5 +1,4 @@
 import 'package:polygonid_flutter_sdk/common/domain/domain_constants.dart';
-import 'package:polygonid_flutter_sdk/common/domain/domain_logger.dart';
 import 'package:polygonid_flutter_sdk/common/domain/entities/filter_entity.dart';
 import 'package:polygonid_flutter_sdk/common/domain/error_exception.dart';
 import 'package:polygonid_flutter_sdk/common/domain/use_case.dart';
@@ -42,7 +41,6 @@ class GetClaimsUseCase
     // if profileNonce is less than GENESIS_PROFILE_NONCE is invalid
     // because the profileNonce should be greater than or equal to GENESIS_PROFILE_NONCE
     if (param.profileNonce < GENESIS_PROFILE_NONCE) {
-      _stacktraceManager.addTrace("[GetClaimsUseCase] Invalid profile nonce");
       _stacktraceManager.addError(
           "[GetClaimsUseCase] Invalid profile nonce, less than $GENESIS_PROFILE_NONCE");
       throw InvalidProfileException(
@@ -62,10 +60,8 @@ class GetClaimsUseCase
     } on PolygonIdSDKException catch (_) {
       rethrow;
     } catch (error) {
-      _stacktraceManager.addTrace("[GetClaimsUseCase] Error: $error");
-      _stacktraceManager.addError(
+      _stacktraceManager.logError(
           "[GetClaimsUseCase] Error while getting claims from the DB\n${error.toString()}");
-      logger().e("[GetClaimsUseCase] Error: $error");
       throw GetClaimsException(
         errorMessage:
             'Error while getting claims from the DB\n${error.toString()}',

lib/credential/domain/use_cases/remove_all_claims_use_case.dart

@@ -1,6 +1,5 @@
 import 'package:polygonid_flutter_sdk/common/infrastructure/stacktrace_stream_manager.dart';
 
-import '../../../common/domain/domain_logger.dart';
 import '../../../common/domain/use_case.dart';
 import '../repositories/credential_repository.dart';
 
@@ -30,13 +29,10 @@ class RemoveAllClaimsUseCase extends FutureUseCase<RemoveAllClaimsParam, void> {
         genesisDid: param.did,
         encryptionKey: param.encryptionKey,
       );
-      logger().i("[RemoveAllClaimsUseCase] Claims have been removed: $param");
-      _stacktraceManager.addTrace(
+      _stacktraceManager.logTrace(
           "[RemoveAllClaimsUseCase] Claims have been removed: $param");
     } catch (error) {
-      logger().e("[RemoveAllClaimsUseCase] Error: $error");
-      _stacktraceManager.addTrace("[RemoveAllClaimsUseCase] Error: $error");
-      _stacktraceManager.addError("[RemoveAllClaimsUseCase] Error: $error");
+      _stacktraceManager.logError("[RemoveAllClaimsUseCase] Error: $error");
       rethrow;
     }
   }

lib/credential/domain/use_cases/remove_claims_use_case.dart

@@ -1,6 +1,5 @@
 import 'package:polygonid_flutter_sdk/common/infrastructure/stacktrace_stream_manager.dart';
 
-import '../../../common/domain/domain_logger.dart';
 import '../../../common/domain/use_case.dart';
 import '../repositories/credential_repository.dart';
 
@@ -33,13 +32,10 @@ class RemoveClaimsUseCase extends FutureUseCase<RemoveClaimsParam, void> {
         genesisDid: param.genesisDid,
         encryptionKey: param.encryptionKey,
       );
-      logger().i(
-          "[RemoveClaimsUseCase] Claims with those ids have been removed: $param");
-      _stacktraceManager.addTrace(
+
+      _stacktraceManager.logTrace(
           "[RemoveClaimsUseCase] Claims with those ids have been removed: $param");
     } catch (error) {
-      logger().e("[RemoveClaimsUseCase] Error: $error");
-      _stacktraceManager.addTrace("[RemoveClaimsUseCase] Error: $error");
       _stacktraceManager.addError("[RemoveClaimsUseCase] Error: $error");
       rethrow;
     }

lib/credential/domain/use_cases/save_claims_use_case.dart

@@ -1,8 +1,7 @@
-import 'package:polygonid_flutter_sdk/common/domain/domain_logger.dart';
 import 'package:polygonid_flutter_sdk/common/domain/use_case.dart';
 import 'package:polygonid_flutter_sdk/common/infrastructure/stacktrace_stream_manager.dart';
-import 'package:polygonid_flutter_sdk/credential/domain/repositories/credential_repository.dart';
 import 'package:polygonid_flutter_sdk/credential/domain/entities/claim_entity.dart';
+import 'package:polygonid_flutter_sdk/credential/domain/repositories/credential_repository.dart';
 
 class SaveClaimsParam {
   final List<ClaimEntity> claims;
@@ -34,15 +33,11 @@ class SaveClaimsUseCase
         genesisDid: param.genesisDid,
         encryptionKey: param.encryptionKey,
       );
-      logger()
-          .i("[SaveClaimsUseCase] All claims have been saved: ${param.claims}");
-      _stacktraceManager
-          .addTrace("[SaveClaimsUseCase] All claims have been saved");
+      _stacktraceManager.logTrace(
+          "[SaveClaimsUseCase] All claims have been saved: ${param.claims}");
       return param.claims;
     } catch (error) {
-      logger().e("[SaveClaimsUseCase] Error: $error");
-      _stacktraceManager.addTrace("[SaveClaimsUseCase] Error: $error");
-      _stacktraceManager.addError("[SaveClaimsUseCase] Error: $error");
+      _stacktraceManager.logError("[SaveClaimsUseCase] Error: $error");
       rethrow;
     }
   }