refactor: simplify logger implementation and LogComponent to selfcont…

…ain log level Signed-off-by: Cristian G <cristian.castro@iohk.io>
hyperledger · Sep 16, 2024 · 81dd24e · 81dd24e
1 parent 6b5ebf8
commit 81dd24e
Show file tree

Hide file tree

Showing 15 changed files with 97 additions and 97 deletions.
diff --git a/...roidInstrumentedTest/kotlin/org/hyperledger/identus/walletsdk/edgeagent/AnoncredsTests.kt b/...roidInstrumentedTest/kotlin/org/hyperledger/identus/walletsdk/edgeagent/AnoncredsTests.kt
@@ -40,7 +40,7 @@ import org.hyperledger.identus.walletsdk.edgeagent.protocols.issueCredential.Off
 import org.hyperledger.identus.walletsdk.edgeagent.protocols.proofOfPresentation.PresentationSubmission
 import org.hyperledger.identus.walletsdk.edgeagent.protocols.proofOfPresentation.RequestPresentation
 import org.hyperledger.identus.walletsdk.domain.models.KeyValue
-import org.hyperledger.identus.walletsdk.logger.EdgeAgentLoggerMock
+import org.hyperledger.identus.walletsdk.logger.LoggerMock
 import org.hyperledger.identus.walletsdk.mercury.ApiMock
 import org.hyperledger.identus.walletsdk.pollux.PolluxImpl
 import org.hyperledger.identus.walletsdk.pollux.models.AnonCredential
@@ -114,7 +114,7 @@ class AnoncredsTests {
             connectionManager = connectionManager,
             seed = null,
             api = ApiMock(statusCode = HttpStatusCode.OK, response = "{\"success\":\"true\"}"),
-            logger = EdgeAgentLoggerMock()
+            logger = LoggerMock()
         )
 
         val attachmentDescriptor =
@@ -192,7 +192,7 @@ class AnoncredsTests {
             connectionManager = connectionManager,
             seed = null,
             api = ApiMock(HttpStatusCode.OK, "{\"success\":\"true\"}"),
-            logger = EdgeAgentLoggerMock()
+            logger = LoggerMock()
         )
 
         val attachmentDescriptor =
@@ -263,7 +263,7 @@ class AnoncredsTests {
             connectionManager = connectionManagerMock,
             seed = seed,
             api = apiMock,
-            logger = EdgeAgentLoggerMock()
+            logger = LoggerMock()
         )
 
         val credential = AnonCredential.fromStorableData(
@@ -355,7 +355,7 @@ class AnoncredsTests {
                     connectionManager = connectionManagerMock,
                     seed = seed,
                     api = apiMock,
-                    logger = EdgeAgentLoggerMock()
+                    logger = LoggerMock()
                 )
             )
 

diff --git a/edge-agent-sdk/src/commonMain/kotlin/org/hyperledger/identus/walletsdk/apollo/ApolloImpl.kt b/edge-agent-sdk/src/commonMain/kotlin/org/hyperledger/identus/walletsdk/apollo/ApolloImpl.kt
@@ -40,15 +40,17 @@ import org.hyperledger.identus.walletsdk.domain.models.keyManagement.SeedKey
 import org.hyperledger.identus.walletsdk.domain.models.keyManagement.StorableKey
 import org.hyperledger.identus.walletsdk.domain.models.keyManagement.StorablePrivateKey
 import org.hyperledger.identus.walletsdk.domain.models.keyManagement.TypeKey
-import org.hyperledger.identus.walletsdk.logger.EdgeAgentLogger
-import org.hyperledger.identus.walletsdk.logger.EdgeAgentLoggerImpl
+import org.hyperledger.identus.walletsdk.logger.Logger
+import org.hyperledger.identus.walletsdk.logger.LoggerImpl
 import org.hyperledger.identus.walletsdk.logger.LogComponent
+import org.hyperledger.identus.walletsdk.logger.LogLevel
+import kotlin.math.log
 
 /**
  * Apollo defines the set of cryptographic operations that are used in the Atala PRISM.
  */
 class ApolloImpl(
-    private val logger: EdgeAgentLogger = EdgeAgentLoggerImpl(LogComponent.APOLLO)
+    val logger: Logger = LoggerImpl(LogComponent.APOLLO)
 ) : Apollo {
 
     /**
@@ -57,6 +59,7 @@ class ApolloImpl(
      * @return An array of mnemonic phrases.
      */
     override fun createRandomMnemonics(): Array<String> {
+        LogComponent.APOLLO.logLevel = LogLevel.INFO
         return MnemonicHelper.createRandomMnemonics().toTypedArray()
     }
 

diff --git a/edge-agent-sdk/src/commonMain/kotlin/org/hyperledger/identus/walletsdk/castor/CastorImpl.kt b/edge-agent-sdk/src/commonMain/kotlin/org/hyperledger/identus/walletsdk/castor/CastorImpl.kt
@@ -24,8 +24,8 @@ import org.hyperledger.identus.walletsdk.domain.models.keyManagement.PublicKey
 import org.hyperledger.identus.walletsdk.logger.LogComponent
 import org.hyperledger.identus.walletsdk.logger.LogLevel
 import org.hyperledger.identus.walletsdk.logger.Metadata
-import org.hyperledger.identus.walletsdk.logger.EdgeAgentLogger
-import org.hyperledger.identus.walletsdk.logger.EdgeAgentLoggerImpl
+import org.hyperledger.identus.walletsdk.logger.Logger
+import org.hyperledger.identus.walletsdk.logger.LoggerImpl
 
 /**
  * Castor is a powerful and flexible library for working with DIDs. Whether you are building a decentralised application
@@ -36,7 +36,7 @@ class CastorImpl
 @JvmOverloads
 constructor(
     val apollo: Apollo,
-    private val logger: EdgeAgentLogger = EdgeAgentLoggerImpl(LogComponent.CASTOR)
+    private val logger: Logger = LoggerImpl(LogComponent.CASTOR)
 ) : Castor {
     var resolvers: Array<DIDResolver> = arrayOf(
         LongFormPrismDIDResolver(this.apollo),

diff --git a/...sdk/src/commonMain/kotlin/org/hyperledger/identus/walletsdk/castor/shared/CastorShared.kt b/...sdk/src/commonMain/kotlin/org/hyperledger/identus/walletsdk/castor/shared/CastorShared.kt
@@ -42,7 +42,7 @@ import org.hyperledger.identus.walletsdk.domain.models.DIDUrl
 import org.hyperledger.identus.walletsdk.domain.models.OctetPublicKey
 import org.hyperledger.identus.walletsdk.domain.models.keyManagement.KeyPair
 import org.hyperledger.identus.walletsdk.domain.models.keyManagement.PublicKey
-import org.hyperledger.identus.walletsdk.logger.EdgeAgentLoggerImpl
+import org.hyperledger.identus.walletsdk.logger.LoggerImpl
 import org.hyperledger.identus.walletsdk.logger.LogComponent
 import org.hyperledger.identus.walletsdk.logger.LogLevel
 import org.hyperledger.identus.walletsdk.logger.Metadata
@@ -64,7 +64,7 @@ internal class CastorShared {
          *
          * @property logger The logger instance.
          */
-        private val logger = EdgeAgentLoggerImpl(LogComponent.CASTOR)
+        private val logger = LoggerImpl(LogComponent.CASTOR)
 
         /**
          * parseDID parses a string representation of a Decentralized Identifier (DID) into a DID object.

diff --git a/...-agent-sdk/src/commonMain/kotlin/org/hyperledger/identus/walletsdk/edgeagent/EdgeAgent.kt b/...-agent-sdk/src/commonMain/kotlin/org/hyperledger/identus/walletsdk/edgeagent/EdgeAgent.kt
@@ -107,8 +107,8 @@ import org.hyperledger.identus.walletsdk.edgeagent.protocols.proofOfPresentation
 import org.hyperledger.identus.walletsdk.edgeagent.protocols.proofOfPresentation.RequestPresentation
 import org.hyperledger.identus.walletsdk.logger.LogComponent
 import org.hyperledger.identus.walletsdk.logger.Metadata
-import org.hyperledger.identus.walletsdk.logger.EdgeAgentLogger
-import org.hyperledger.identus.walletsdk.logger.EdgeAgentLoggerImpl
+import org.hyperledger.identus.walletsdk.logger.Logger
+import org.hyperledger.identus.walletsdk.logger.LoggerImpl
 import org.hyperledger.identus.walletsdk.pluto.PlutoBackupTask
 import org.hyperledger.identus.walletsdk.pluto.PlutoRestoreTask
 import org.hyperledger.identus.walletsdk.pluto.models.backup.BackupV0_0_1
@@ -153,7 +153,7 @@ open class EdgeAgent {
     private val edgeAgentScope: CoroutineScope = CoroutineScope(Dispatchers.Default)
     private val api: Api
     internal var connectionManager: ConnectionManager
-    private var logger: EdgeAgentLogger
+    private var logger: Logger
     private val agentOptions: AgentOptions
 
     /**
@@ -181,7 +181,7 @@ open class EdgeAgent {
         connectionManager: ConnectionManager,
         seed: Seed?,
         api: Api?,
-        logger: EdgeAgentLogger = EdgeAgentLoggerImpl(LogComponent.EDGE_AGENT),
+        logger: Logger = LoggerImpl(LogComponent.EDGE_AGENT),
         agentOptions: AgentOptions = AgentOptions()
     ) {
         edgeAgentScope.launch {
@@ -235,7 +235,7 @@ open class EdgeAgent {
         seed: Seed? = null,
         api: Api? = null,
         mediatorHandler: MediationHandler,
-        logger: EdgeAgentLogger = EdgeAgentLoggerImpl(LogComponent.EDGE_AGENT),
+        logger: Logger = LoggerImpl(LogComponent.EDGE_AGENT),
         agentOptions: AgentOptions = AgentOptions()
     ) {
         edgeAgentScope.launch {

diff --git a/...entus/walletsdk/logger/EdgeAgentLogger.kt → ...ledger/identus/walletsdk/logger/Logger.kt b/...entus/walletsdk/logger/EdgeAgentLogger.kt → ...ledger/identus/walletsdk/logger/Logger.kt
@@ -24,10 +24,10 @@ private const val METADATA_PRIVACY_STR = "------"
 private val hashingLog = UUID.randomUUID().toString()
 
 /**
- * EdgeAgentLogger is an interface that defines methods for logging messages
+ * Logger is an interface that defines methods for logging messages
  * with different log levels and metadata.
  */
-interface EdgeAgentLogger {
+interface Logger {
     /**
      * Logs a debug message with optional metadata.
      *
@@ -66,26 +66,23 @@ interface EdgeAgentLogger {
      * @param error The error to be logged.
      * @param metadata An array of metadata objects to be included in the log message. Defaults to an empty array if not provided.
      *
-     * @see EdgeAgentLogger.error
+     * @see Logger.error
      * @see Metadata
      */
     fun error(error: Error, metadata: Array<Metadata> = arrayOf())
 }
 
 /**
- * Implementation of the EdgeAgentLogger interface.
+ * Implementation of the Logger interface.
  *
  * @property category the LogComponent category for this logger
  */
-class EdgeAgentLoggerImpl(category: LogComponent, private var logLevel: LogLevel = LogLevel.INFO, tag: String? = null) :
-    EdgeAgentLogger {
+class LoggerImpl(private val category: LogComponent) :
+    Logger {
 
     private val log = logging(
-        if (tag != null) {
-            "$tag.$category"
-        } else {
-            "[org.hyperledger.identus.walletsdk.$category]"
-        }
+        "[${category::class.qualifiedName}.$category]"
+
     )
 
     /**
@@ -95,7 +92,7 @@ class EdgeAgentLoggerImpl(category: LogComponent, private var logLevel: LogLevel
      * @param metadata An array of metadata objects associated with the message (optional).
      */
     override fun debug(message: String, metadata: Array<Metadata>) {
-        if (logLevel != LogLevel.NONE) {
+        if (category.logLevel != LogLevel.NONE) {
             log.debug { message }
             if (metadata.isNotEmpty()) {
                 log.debug { "Metadata: ${arrayToString(metadata)}" }
@@ -110,7 +107,7 @@ class EdgeAgentLoggerImpl(category: LogComponent, private var logLevel: LogLevel
      * @param metadata An array of metadata objects to be associated with the information message.
      */
     override fun info(message: String, metadata: Array<Metadata>) {
-        if (logLevel != LogLevel.NONE) {
+        if (category.logLevel != LogLevel.NONE) {
             log.info { message }
             if (metadata.isNotEmpty()) {
                 log.info { "Metadata: ${arrayToString(metadata)}" }
@@ -125,7 +122,7 @@ class EdgeAgentLoggerImpl(category: LogComponent, private var logLevel: LogLevel
      * @param metadata An array of metadata objects associated with the warning message.
      */
     override fun warning(message: String, metadata: Array<Metadata>) {
-        if (logLevel != LogLevel.NONE) {
+        if (category.logLevel != LogLevel.NONE) {
             log.warn { message }
             if (metadata.isNotEmpty()) {
                 log.warn { "Metadata: ${arrayToString(metadata)}" }
@@ -140,7 +137,7 @@ class EdgeAgentLoggerImpl(category: LogComponent, private var logLevel: LogLevel
      * @param metadata An array of metadata objects to be associated with the error message (optional).
      */
     override fun error(message: String, metadata: Array<Metadata>) {
-        if (logLevel != LogLevel.NONE) {
+        if (category.logLevel != LogLevel.NONE) {
             log.error { message }
             if (metadata.isNotEmpty()) {
                 log.error { "Metadata: ${arrayToString(metadata)}" }
@@ -155,7 +152,7 @@ class EdgeAgentLoggerImpl(category: LogComponent, private var logLevel: LogLevel
      * @param metadata An array of metadata objects associated with the error (optional).
      */
     override fun error(error: Error, metadata: Array<Metadata>) {
-        if (logLevel != LogLevel.NONE) {
+        if (category.logLevel != LogLevel.NONE) {
             log.error { error.message }
             if (metadata.isNotEmpty()) {
                 log.error { "Metadata: ${arrayToString(metadata)}" }
@@ -170,7 +167,7 @@ class EdgeAgentLoggerImpl(category: LogComponent, private var logLevel: LogLevel
      * @return The converted String representation of the Metadata objects, with each object's value separated by a new line.
      */
     private fun arrayToString(array: Array<Metadata>): String {
-        return array.joinToString { "${it.getValue(logLevel)}\n" }
+        return array.joinToString { "${it.getValue(category.logLevel)}\n" }
     }
 }
 
@@ -340,11 +337,11 @@ enum class LogLevel(val value: Int) {
  * - POLLUX
  * - EDGE_AGENT
  */
-enum class LogComponent {
-    APOLLO,
-    CASTOR,
-    MERCURY,
-    PLUTO,
-    POLLUX,
-    EDGE_AGENT
+enum class LogComponent(var logLevel: LogLevel) {
+    APOLLO(LogLevel.DEBUG),
+    CASTOR(LogLevel.DEBUG),
+    MERCURY(LogLevel.DEBUG),
+    PLUTO(LogLevel.DEBUG),
+    POLLUX(LogLevel.DEBUG),
+    EDGE_AGENT(LogLevel.DEBUG)
 }
diff --git a/...-agent-sdk/src/commonMain/kotlin/org/hyperledger/identus/walletsdk/mercury/MercuryImpl.kt b/...-agent-sdk/src/commonMain/kotlin/org/hyperledger/identus/walletsdk/mercury/MercuryImpl.kt
@@ -13,8 +13,8 @@ import org.hyperledger.identus.walletsdk.domain.models.DIDDocument
 import org.hyperledger.identus.walletsdk.domain.models.KeyValue
 import org.hyperledger.identus.walletsdk.domain.models.MercuryError
 import org.hyperledger.identus.walletsdk.domain.models.Message
-import org.hyperledger.identus.walletsdk.logger.EdgeAgentLogger
-import org.hyperledger.identus.walletsdk.logger.EdgeAgentLoggerImpl
+import org.hyperledger.identus.walletsdk.logger.Logger
+import org.hyperledger.identus.walletsdk.logger.LoggerImpl
 import org.hyperledger.identus.walletsdk.logger.LogComponent
 import org.hyperledger.identus.walletsdk.logger.LogLevel
 import org.hyperledger.identus.walletsdk.logger.Metadata
@@ -55,7 +55,7 @@ constructor(
     private val castor: Castor,
     private val protocol: DIDCommProtocol,
     private val api: Api,
-    private val logger: EdgeAgentLogger = EdgeAgentLoggerImpl(LogComponent.MERCURY)
+    private val logger: Logger = LoggerImpl(LogComponent.MERCURY)
 ) : Mercury {
 
     /**

diff --git a/...c/commonMain/kotlin/org/hyperledger/identus/walletsdk/mercury/resolvers/DIDCommWrapper.kt b/...c/commonMain/kotlin/org/hyperledger/identus/walletsdk/mercury/resolvers/DIDCommWrapper.kt
@@ -33,7 +33,7 @@ import org.hyperledger.identus.walletsdk.domain.models.AttachmentDescriptor
 import org.hyperledger.identus.walletsdk.domain.models.DID
 import org.hyperledger.identus.walletsdk.domain.models.MercuryError
 import org.hyperledger.identus.walletsdk.domain.models.Message
-import org.hyperledger.identus.walletsdk.logger.EdgeAgentLoggerImpl
+import org.hyperledger.identus.walletsdk.logger.LoggerImpl
 import org.hyperledger.identus.walletsdk.logger.LogComponent
 import org.hyperledger.identus.walletsdk.logger.LogLevel
 import org.hyperledger.identus.walletsdk.logger.Metadata
@@ -56,7 +56,7 @@ class DIDCommWrapper(castor: Castor, pluto: Pluto, apollo: Apollo) : DIDCommProt
     private val didDocResolver = DIDCommDIDResolver(castor)
     private val secretsResolver = DIDCommSecretsResolver(pluto, apollo)
     private val didComm = DIDComm(didDocResolver, secretsResolver)
-    private val logger = EdgeAgentLoggerImpl(LogComponent.MERCURY)
+    private val logger = LoggerImpl(LogComponent.MERCURY)
 
     /**
      * Converts a JSON element to a map.

diff --git a/edge-agent-sdk/src/commonMain/kotlin/org/hyperledger/identus/walletsdk/pluto/PlutoImpl.kt b/edge-agent-sdk/src/commonMain/kotlin/org/hyperledger/identus/walletsdk/pluto/PlutoImpl.kt
@@ -35,8 +35,8 @@ import org.hyperledger.identus.walletsdk.domain.models.keyManagement.JWK
 import org.hyperledger.identus.walletsdk.domain.models.keyManagement.PrivateKey
 import org.hyperledger.identus.walletsdk.domain.models.keyManagement.StorableKey
 import org.hyperledger.identus.walletsdk.domain.models.keyManagement.StorablePrivateKey
-import org.hyperledger.identus.walletsdk.logger.EdgeAgentLogger
-import org.hyperledger.identus.walletsdk.logger.EdgeAgentLoggerImpl
+import org.hyperledger.identus.walletsdk.logger.Logger
+import org.hyperledger.identus.walletsdk.logger.LoggerImpl
 import org.hyperledger.identus.walletsdk.logger.LogComponent
 import org.hyperledger.identus.walletsdk.pluto.models.backup.BackupV0_0_1
 import org.hyperledger.identus.walletsdk.pluto.data.DbConnection
@@ -60,7 +60,7 @@ import org.hyperledger.identus.walletsdk.pluto.data.StorableCredential as Storab
  */
 class PlutoImpl(
     private val connection: DbConnection,
-    private val logger: EdgeAgentLogger = EdgeAgentLoggerImpl(LogComponent.PLUTO)
+    private val logger: Logger = LoggerImpl(LogComponent.PLUTO)
 ) : Pluto {
     private var db: SdkPlutoDb? = null
 

diff --git a/edge-agent-sdk/src/commonMain/kotlin/org/hyperledger/identus/walletsdk/pollux/PolluxImpl.kt b/edge-agent-sdk/src/commonMain/kotlin/org/hyperledger/identus/walletsdk/pollux/PolluxImpl.kt
@@ -92,8 +92,8 @@ import org.hyperledger.identus.walletsdk.edgeagent.protocols.proofOfPresentation
 import org.hyperledger.identus.walletsdk.edgeagent.protocols.proofOfPresentation.PresentationSubmissionOptions
 import org.hyperledger.identus.walletsdk.edgeagent.protocols.proofOfPresentation.PresentationSubmissionOptionsAnoncreds
 import org.hyperledger.identus.walletsdk.edgeagent.protocols.proofOfPresentation.PresentationSubmissionOptionsJWT
-import org.hyperledger.identus.walletsdk.logger.EdgeAgentLogger
-import org.hyperledger.identus.walletsdk.logger.EdgeAgentLoggerImpl
+import org.hyperledger.identus.walletsdk.logger.Logger
+import org.hyperledger.identus.walletsdk.logger.LoggerImpl
 import org.hyperledger.identus.walletsdk.logger.LogComponent
 import org.hyperledger.identus.walletsdk.pluto.RestorationID
 import org.hyperledger.identus.walletsdk.pollux.models.AnonCredential
@@ -118,7 +118,7 @@ open class PolluxImpl(
     val apollo: Apollo,
     val castor: Castor,
     private val api: Api = ApiImpl(httpClient()),
-    private val logger: EdgeAgentLogger = EdgeAgentLoggerImpl(LogComponent.POLLUX)
+    private val logger: Logger = LoggerImpl(LogComponent.POLLUX)
 ) : Pollux {
 
     /**