feat(agent): add logging capabilities

add a mediator handler enhance public API
hyperledger · Jan 24, 2023 · 515860c · 515860c
1 parent 0f41471
commit 515860c
Show file tree

Hide file tree

Showing 33 changed files with 476 additions and 283 deletions.
diff --git a/Castor/Sources/CastorImpl+Public.swift b/Castor/Sources/CastorImpl+Public.swift
@@ -48,16 +48,25 @@ extension CastorImpl: Castor {
     }
 
     public func resolveDID(did: DID) async throws -> DIDDocument {
+        logger.info(message: "Trying to resolve DID", metadata: [
+            .maskedMetadataByLevel(key: "DID", value: did.string, level: .debug)
+        ])
         guard
             let resolver = resolvers.first(where: { $0.method == did.method })
         else {
+            logger.error(message: "No resolvers for DID method \(did.method)", metadata: [
+                .maskedMetadataByLevel(key: "DID", value: did.string, level: .debug)
+            ])
             throw CastorError.notPossibleToResolveDID
         }
         return try await resolver.resolve(did: did)
     }
 
     public func getEcnumbasis(did: DID, keyPair: KeyPair) throws -> String {
-        try CreatePeerDIDOperation(
+        logger.debug(message: "Getting ecnumbasis", metadata: [
+            .maskedMetadataByLevel(key: "DID", value: did.string, level: .debug)
+        ])
+        return try CreatePeerDIDOperation(
             autenticationKeyPair: keyPair,
             agreementKeyPair: keyPair,
             services: []

diff --git a/Castor/Sources/CastorImpl.swift b/Castor/Sources/CastorImpl.swift
@@ -5,11 +5,13 @@ import Foundation
 public struct CastorImpl {
     let apollo: Apollo
     let resolvers: [DIDResolverDomain]
+    let logger: PrismLogger
 
     public init(apollo: Apollo, resolvers: [DIDResolverDomain] = []) {
+        self.logger = PrismLogger(category: .castor)
         self.apollo = apollo
         self.resolvers = resolvers + [
-            LongFormPrismDIDResolver(apollo: apollo),
+            LongFormPrismDIDResolver(apollo: apollo, logger: logger),
             PeerDIDResolver()
         ]
     }

diff --git a/Castor/Sources/Operations/CreatePeerDIDOperation.swift b/Castor/Sources/Operations/CreatePeerDIDOperation.swift
@@ -28,7 +28,7 @@ struct CreatePeerDIDOperation {
     let services: [DIDDocument.Service]
 
     func compute() throws -> DID {
-        try createPeerDID(
+        return try createPeerDID(
             encryptionKeys: [try keyAgreementFromKeyPair(keyPair: agreementKeyPair)],
             signingKeys: [try authenticationFromKeyPair(keyPair: autenticationKeyPair)],
             services: services

diff --git a/Castor/Sources/Operations/VerifySignatureOperation.swift b/Castor/Sources/Operations/VerifySignatureOperation.swift
@@ -1,3 +1,4 @@
+import Core
 import Domain
 import Foundation
 

diff --git a/Castor/Sources/Resolvers/LongFormPrismDIDResolver.swift b/Castor/Sources/Resolvers/LongFormPrismDIDResolver.swift
@@ -4,14 +4,20 @@ import Foundation
 
 struct LongFormPrismDIDResolver: DIDResolverDomain {
     let apollo: Apollo
+    let logger: PrismLogger
 
     var method = "prism"
 
     func resolve(did: DID) throws -> DIDDocument {
         let prismDID = try LongFormPrismDID(did: did)
         guard
             let data = Data(fromBase64URL: prismDID.encodedState)
-        else { throw CastorError.initialStateOfDIDChanged }
+        else {
+            logger.error(message: "The DID state hash doesn't match the state", metadata: [
+                .maskedMetadataByLevel(key: "DID", value: did.string, level: .debug)
+            ])
+            throw CastorError.initialStateOfDIDChanged
+        }
 
         let (verificationMethods, services) = try decodeState(
             did: did,
@@ -48,7 +54,14 @@ struct LongFormPrismDIDResolver: DIDResolverDomain {
         guard stateHash == verifyEncodedState else { throw CastorError.initialStateOfDIDChanged }
         let operation = try Io_Iohk_Atala_Prism_Protos_AtalaOperation(serializedData: encodedData)
         let publicKeys = try operation.createDid.didData.publicKeys.map {
-            try PrismDIDPublicKey(apollo: apollo, proto: $0)
+            do {
+                return try PrismDIDPublicKey(apollo: apollo, proto: $0)
+            } catch {
+                logger.error(message: "Failed to decode public key from document", metadata: [
+                    .maskedMetadataByLevel(key: "DID", value: did.string, level: .debug)
+                ])
+                throw error
+            }
         }
         let services = operation.createDid.didData.services.map {
             DIDDocument.Service(

diff --git a/Core/Sources/Logger/PrismLogger.swift b/Core/Sources/Logger/PrismLogger.swift
@@ -43,7 +43,7 @@ private let METADATA_PRIVACY_STR = "------"
 // MARK: Prism Logger
 
 public struct PrismLogger {
-    static var logLevels = [LogComponent: LogLevel]()
+    public static var logLevels = [LogComponent: LogLevel]()
     private static let hashingLog = UUID().uuidString
     private let logLevel: LogLevel
 

diff --git a/Mercury/Sources/DIDCommWrappers/DIDCommDIDResolverWrapper.swift b/Mercury/Sources/DIDCommWrappers/DIDCommDIDResolverWrapper.swift
@@ -5,12 +5,14 @@ import Domain
 import Foundation
 
 class DIDCommDIDResolverWrapper {
+    let logger: PrismLogger
     let castor: Castor
     var publisher = PassthroughSubject<DIDDocument, Error>()
     var cancellables = [AnyCancellable]()
 
-    init(castor: Castor) {
+    init(castor: Castor, logger: PrismLogger) {
         self.castor = castor
+        self.logger = logger
     }
 
     fileprivate func resolve(did: String) {
@@ -25,20 +27,29 @@ extension DIDCommDIDResolverWrapper: DidResolver {
     func resolve(did: String, cb: OnDidResolverResult) -> ErrorCode {
         publisher
             .first()
-            .sink {
+            .sink { [weak self] in
                 switch $0 {
                 case .finished:
                     break
                 case let .failure(error):
+                    self?.logger.error(message: "Error trying to resolve DID", metadata: [
+                        .publicMetadata(key: "Error", value: error.localizedDescription)
+                    ])
                     try? cb.error(
                         err: ErrorKind.DidNotResolved(message: error.localizedDescription),
                         msg: error.localizedDescription
                     )
                 }
-            } receiveValue: {
+            } receiveValue: { [weak self] in
                 do {
+                    self?.logger.debug(message: "Success resolving DID", metadata: [
+                        .maskedMetadataByLevel(key: "DID", value: did, level: .debug)
+                    ])
                     try cb.success(result: try DidDoc(from: $0))
                 } catch {
+                    self?.logger.error(message: "Error trying to resolve DID", metadata: [
+                        .publicMetadata(key: "Error", value: error.localizedDescription)
+                    ])
                     try? cb.error(
                         err: ErrorKind.DidNotResolved(message: error.localizedDescription),
                         msg: error.localizedDescription

diff --git a/Mercury/Sources/DIDCommWrappers/DIDCommSecretsResolverWrapper.swift b/Mercury/Sources/DIDCommWrappers/DIDCommSecretsResolverWrapper.swift
@@ -1,4 +1,5 @@
 import Combine
+import Core
 import DIDCommxSwift
 import Domain
 import Foundation
@@ -9,13 +10,15 @@ class DIDCommSecretsResolverWrapper {
     let apollo: Apollo
     let pluto: Pluto
     let castor: Castor
+    let logger: PrismLogger
     @Published var availableSecrets = [Domain.Secret]()
     var cancellables = [AnyCancellable]()
 
-    init(apollo: Apollo, pluto: Pluto, castor: Castor) {
+    init(apollo: Apollo, pluto: Pluto, castor: Castor, logger: PrismLogger) {
         self.apollo = apollo
         self.pluto = pluto
         self.castor = castor
+        self.logger = logger
 
         startUpdating()
     }
@@ -68,11 +71,14 @@ extension DIDCommSecretsResolverWrapper: SecretsResolver {
         $availableSecrets
             .first()
             .map { $0.first { $0.id == secretid } }
-            .sink {
+            .sink { [weak self] in
                 do {
                     try cb.success(result: $0.map { DIDCommxSwift.Secret(from: $0) })
                 } catch {
-                    print(error.localizedDescription)
+                    self?.logger.error(message: "Could not find secret", metadata: [
+                        .publicMetadata(key: "SecretId", value: secretid),
+                        .publicMetadata(key: "Error", value: error.localizedDescription)
+                    ])
                 }
             }
             .store(in: &cancellables)
@@ -90,11 +96,14 @@ extension DIDCommSecretsResolverWrapper: SecretsResolver {
                 .filter { secretids.contains($0.id) }
                 .map { $0.id }
             }
-            .sink {
+            .sink { [weak self] in
                 do {
                     try cb.success(result: $0)
                 } catch {
-                    print(error.localizedDescription)
+                    self?.logger.error(message: "Could not find secrets", metadata: [
+                        .publicMetadata(key: "SecretsIds", value: secretids.description),
+                        .publicMetadata(key: "Error", value: error.localizedDescription)
+                    ])
                 }
             }
             .store(in: &cancellables)

diff --git a/Mercury/Sources/DIDCommWrappers/PackEncryptedOperation.swift b/Mercury/Sources/DIDCommWrappers/PackEncryptedOperation.swift
@@ -1,15 +1,18 @@
 import Combine
+import Core
 import DIDCommxSwift
 import Domain
 import Foundation
 
 final class PackEncryptedOperation: OnPackEncryptedResult {
     private let didcomm: DIDCommProtocol
+    private let logger: PrismLogger
     private var published = CurrentValueSubject<String?, Error>(nil)
     private var cancellable: AnyCancellable?
 
-    init(didcomm: DIDCommProtocol) {
+    init(didcomm: DIDCommProtocol, logger: PrismLogger) {
         self.didcomm = didcomm
+        self.logger = logger
     }
 
     func packEncrypted(msg: Domain.Message) async throws -> String {
@@ -22,11 +25,17 @@ final class PackEncryptedOperation: OnPackEncryptedResult {
             self.cancellable = self.published
                 .drop(while: { $0 == nil })
                 .first()
-                .sink(receiveCompletion: {
+                .sink(receiveCompletion: { [weak self] in
                     switch $0 {
                     case .finished:
                         break
                     case let .failure(error):
+                        self?.logger.error(
+                            message: "Could not pack message",
+                            metadata: [
+                                .publicMetadata(key: "Error", value: error.localizedDescription)
+                            ]
+                        )
                         continuation.resume(throwing: error)
                     }
                 }, receiveValue: {
@@ -68,6 +77,17 @@ final class PackEncryptedOperation: OnPackEncryptedResult {
     }
 
     func error(err: DIDCommxSwift.ErrorKind, msg: String) {
+        logger.error(
+            message: "Could not pack message",
+            metadata: [
+                .publicMetadata(
+                    key: "Error",
+                    value: MercuryError
+                        .didcommError(msg: msg)
+                        .localizedDescription
+                )
+            ]
+        )
         published.send(completion: .failure(MercuryError.didcommError(msg: msg)))
     }
 }
diff --git a/Mercury/Sources/DIDCommWrappers/UnpackOperation.swift b/Mercury/Sources/DIDCommWrappers/UnpackOperation.swift
@@ -1,17 +1,20 @@
 import Combine
+import Core
 import DIDCommxSwift
 import Domain
 import Foundation
 
 final class UnpackOperation: OnUnpackResult {
     private let didcomm: DIDCommProtocol
     private let castor: Castor
+    private let logger: PrismLogger
     private var published = CurrentValueSubject<Domain.Message?, Error>(nil)
     private var cancellable: AnyCancellable?
 
-    init(didcomm: DIDCommProtocol, castor: Castor) {
+    init(didcomm: DIDCommProtocol, castor: Castor, logger: PrismLogger) {
         self.didcomm = didcomm
         self.castor = castor
+        self.logger = logger
     }
 
     func unpackEncrypted(messageString: String) async throws -> Domain.Message {
@@ -28,11 +31,17 @@ final class UnpackOperation: OnUnpackResult {
                 self.cancellable = self.published
                     .drop(while: { $0 == nil })
                     .first()
-                    .sink(receiveCompletion: {
+                    .sink(receiveCompletion: { [weak self] in
                         switch $0 {
                         case .finished:
                             break
                         case let .failure(error):
+                            self?.logger.error(
+                                message: "Could not unpack message",
+                                metadata: [
+                                    .publicMetadata(key: "Error", value: error.localizedDescription)
+                                ]
+                            )
                             continuation.resume(throwing: error)
                         }
                     }, receiveValue: {
@@ -50,6 +59,12 @@ final class UnpackOperation: OnUnpackResult {
             let message: Domain.Message = try result.toDomain(castor: castor)
             published.send(message)
         } catch {
+            logger.error(
+                message: "Could not unpack message",
+                metadata: [
+                    .publicMetadata(key: "Error", value: error.localizedDescription)
+                ]
+            )
             published.send(completion: .failure(error))
         }
     }

diff --git a/Mercury/Sources/MercuryImpl+Public.swift b/Mercury/Sources/MercuryImpl+Public.swift
@@ -5,11 +5,11 @@ import Foundation
 
 extension MercuryImpl: Mercury {
     public func packMessage(msg: Domain.Message) async throws -> String {
-        try await PackEncryptedOperation(didcomm: didcomm).packEncrypted(msg: msg)
+        try await PackEncryptedOperation(didcomm: didcomm, logger: logger).packEncrypted(msg: msg)
     }
 
     public func unpackMessage(msg: String) async throws -> Domain.Message {
-        try await UnpackOperation(didcomm: didcomm, castor: castor).unpackEncrypted(messageString: msg)
+        try await UnpackOperation(didcomm: didcomm, castor: castor, logger: logger).unpackEncrypted(messageString: msg)
     }
 
     public func sendMessage(msg: Domain.Message) async throws -> Data? {
@@ -18,7 +18,10 @@ extension MercuryImpl: Mercury {
         guard
             let urlString = document.services.first?.serviceEndpoint.uri,
             let url = URL(string: urlString)
-        else { throw MercuryError.noValidServiceFoundError }
+        else {
+            logger.error(message: "Could not find a valid service on the DID to send message")
+            throw MercuryError.noValidServiceFoundError
+        }
         let packedMessage = try await packMessage(msg: msg)
         return try await session.post(
             url: url,

diff --git a/Mercury/Sources/MercuryImpl.swift b/Mercury/Sources/MercuryImpl.swift
@@ -1,3 +1,4 @@
+import Core
 import DIDCommxSwift
 import Domain
 import Foundation
@@ -8,6 +9,7 @@ public struct MercuryImpl {
     let apollo: Apollo
     let pluto: Pluto
     let didcomm: DidComm
+    let logger: PrismLogger
 
     public init(
         session: URLSession = .shared,
@@ -16,15 +18,18 @@ public struct MercuryImpl {
         castor: Castor,
         pluto: Pluto
     ) {
+        let logger = PrismLogger(category: .mercury)
+        self.logger = logger
         self.session = SessionManager(session: session, timeout: timeout)
         self.castor = castor
         self.apollo = apollo
         self.pluto = pluto
-        let didResolver = DIDCommDIDResolverWrapper(castor: castor)
+        let didResolver = DIDCommDIDResolverWrapper(castor: castor, logger: logger)
         let secretsResolver = DIDCommSecretsResolverWrapper(
             apollo: apollo,
             pluto: pluto,
-            castor: castor
+            castor: castor,
+            logger: logger
         )
         self.didcomm = DidComm(
             didResolver: didResolver,