sparkling-method 2.1.0-rc.3 → 2.1.0-rc.31

package/ios/Sources/Core/DI/DIContainerProtocol.swift

@@ -20,7 +20,7 @@ extension DIContainerProtocol {
     public func register<Service>(_ serviceType: Service.Type, name: AnyHashable? = nil, scope: ServiceScope = .container, factory: @escaping Factory<Service>) {
         self.register(serviceType, name: name, scope: scope, factory: factory)
     }
-    
+
     public func resolve<Service>(_ serviceType: Service.Type, name: AnyHashable? = nil) -> Service? {
         return self.resolve(serviceType, name: name)
     }

package/ios/Sources/Core/DI/DIProviderRegistry.swift

@@ -6,7 +6,7 @@ import Foundation
 
 public enum DIProviderRegistry {
     private static var _provider: DIContainerProvider?
-    
+
     public static var provider: DIContainerProvider! {
         get {
             guard let instance = _provider else {

package/ios/Sources/Core/Examples/SampleMethod+impl.swift

@@ -13,12 +13,12 @@ import Foundation
             completionHandler.handleCompletion(status: .invalidParameter(message: "Invalid parameter model type"), result: nil)
             return
         }
-        
+
         // Simulate processing logic
         let result = SampleMethodResultModel()
         result.sampleResult = "Processed: \(params.sampleParam ?? "")"
-        
+
         // Return success result
         completionHandler.handleCompletion(status: MethodStatus.succeeded(), result: result)
     }
-}
+}

package/ios/Sources/Core/Examples/SampleMethod.swift

@@ -13,7 +13,7 @@ class SampleMethodParamModel: SPKMethodModel {
     @objc public static func requiredKeyPaths() -> Set<String>? {
         return ["sampleParam"]
     }
-    
+
     override class func jsonKeyPathsByPropertyKey() -> [AnyHashable: Any] {
         return ["sampleParam": "sample_param"]
     }
@@ -23,12 +23,12 @@ class SampleMethodParamModel: SPKMethodModel {
 @objc(SampleMethodResultModel)
 public final class SampleMethodResultModel: SPKMethodModel {
     var sampleResult: String?
-    
+
     // Required parameter key paths
     @objc public static func requiredKeyPaths() -> Set<String>? {
         return ["sampleResult"]
     }
-    
+
     override class func jsonKeyPathsByPropertyKey() -> [AnyHashable: Any] {
         return ["sampleResult": "sample_result"]
     }
@@ -41,18 +41,18 @@ public final class SampleMethod: PipeMethod {
     public override var methodName: String {
         return "sample_method"
     }
-    
+
     public override class func methodName() -> String {
         return "sample_method"
     }
-    
+
     /// Parameter model type
     @objc override var paramsModelType: AnyClass {
         return SampleMethodParamModel.self
     }
-    
+
     /// Result model type
     @objc override var resultModelType: AnyClass {
         return SampleMethodResultModel.self
     }
-}
+}

package/ios/Sources/Core/Models/MethodContext.swift

@@ -6,7 +6,7 @@ import Foundation
 
 final class WeakWrap {
     weak var value: AnyObject?
-    
+
     init(_ value: AnyObject) {
         self.value = value
     }
@@ -19,7 +19,7 @@ enum ValueWrap {
 
 public class MethodContext {
     private var storage: [String: ValueWrap] = [:]
-    
+
     public func set(_ value: Any, forKey key: String, weak: Bool = false) {
         if weak, let obj = value as? AnyObject {
             storage[key] = .weak(WeakWrap(obj))
@@ -27,7 +27,7 @@ public class MethodContext {
             storage[key] = .strong(value)
         }
     }
-    
+
     public func get<T>(_ key: String, as type: T.Type = T.self) -> T? {
         guard let valueWrap = storage[key] else { return nil }
         switch valueWrap {
@@ -35,11 +35,11 @@ public class MethodContext {
         case .weak(let weakWrap): return weakWrap.value as? T
         }
     }
-    
+
     public func removeValue(forKey key: String) {
         storage.removeValue(forKey: key)
     }
-    
+
     public subscript<T>(key: String) -> T? {
         get { get(key, as: T.self) }
         set {

package/ios/Sources/Core/Models/MethodStatus.swift

@@ -30,97 +30,97 @@ import Foundation
 @objc public class MethodStatus: NSObject {
     @objc public let code: MethodStatusCode
     @objc public let message: String?
-    
+
     // Convenience constructor
     @objc public init(code: MethodStatusCode, message: String? = nil) {
         self.code = code
         self.message = message
     }
-    
+
     // Convenience factory method
     @objc public static func succeeded() -> MethodStatus {
         return MethodStatus(code: .succeeded)
     }
-    
+
     @objc public static func failed(message: String? = nil) -> MethodStatus {
         return MethodStatus(code: .failed, message: message)
     }
-    
+
     @objc public static func invalidParameter(message: String? = nil) -> MethodStatus {
         return MethodStatus(code: .invalidInputParameter, message: message)
     }
-    
+
     @objc public static func notImplemented(message: String? = nil) -> MethodStatus {
         return MethodStatus(code: .notImplemented, message: message)
     }
-    
+
     // Convenience methods for other common statuses
     @objc public static func unregisteredMethod(message: String? = nil) -> MethodStatus {
         return MethodStatus(code: .unregisteredMethod, message: message)
     }
-    
+
     @objc public static func invalidNamespace(message: String? = nil) -> MethodStatus {
         return MethodStatus(code: .invalidNamespace, message: message)
     }
-    
+
     @objc public static func invalidResult(message: String? = nil) -> MethodStatus {
         return MethodStatus(code: .invalidResult, message: message)
     }
-    
+
     @objc public static func unauthorizedAccess(message: String? = nil) -> MethodStatus {
         return MethodStatus(code: .unauthorizedAccess, message: message)
     }
-    
+
     @objc public static func operationCancelled(message: String? = nil) -> MethodStatus {
         return MethodStatus(code: .operationCancelled, message: message)
     }
-    
+
     @objc public static func operationTimeout(message: String? = nil) -> MethodStatus {
         return MethodStatus(code: .operationTimeout, message: message)
     }
-    
+
     @objc public static func notFound(message: String? = nil) -> MethodStatus {
         return MethodStatus(code: .notFound, message: message)
     }
-    
+
     @objc public static func alreadyExists(message: String? = nil) -> MethodStatus {
         return MethodStatus(code: .alreadyExists, message: message)
     }
-    
+
     @objc public static func paramModelTypeWrong(message: String? = nil) -> MethodStatus {
         return MethodStatus(code: .paramModelTypeWrong, message: message)
     }
-    
+
     @objc public static func resultModelTypeWrong(message: String? = nil) -> MethodStatus {
         return MethodStatus(code: .resultModelTypeWrong, message: message)
     }
-    
+
     @objc public static func unknown(message: String? = nil) -> MethodStatus {
         return MethodStatus(code: .unknown, message: message)
     }
-    
+
     @objc public static func networkUnreachable(message: String? = nil) -> MethodStatus {
         return MethodStatus(code: .networkUnreachable, message: message)
     }
-    
+
     @objc public static func networkTimeout(message: String? = nil) -> MethodStatus {
         return MethodStatus(code: .networkTimeout, message: message)
     }
-    
+
     @objc public static func malformedResponse(message: String? = nil) -> MethodStatus {
         return MethodStatus(code: .malformedResponse, message: message)
     }
-    
+
     // For compatibility with original Int type code access
     @objc public var rawCode: Int {
         return code.rawValue
     }
-    
+
     // Whether it's successful
     @objc public var isSuccess: Bool {
         return code == .succeeded
     }
-    
+
     // Already have instance variable message, no need for duplicate computed property
 }
 
@@ -129,11 +129,11 @@ extension MethodStatus {
         let msg = self.message ?? ""
         return "<MethodStatus - code: \(self.code), message: \"\(msg)\">"
     }
-    
+
     public static func == (lhs: MethodStatus, rhs: MethodStatus) -> Bool {
         return lhs.code == rhs.code
     }
-    
+
     public static func === (lhs: MethodStatus, rhs: MethodStatus) -> Bool {
         return lhs.code == rhs.code && lhs.message == rhs.message
     }

package/ios/Sources/Core/Pipe/MethodPipe+Internal.swift

@@ -4,13 +4,72 @@
 
 import Foundation
 
+private enum MethodInvocationPayloadKeys {
+    static let code = "code"
+    static let data = "data"
+    static let message = "message"
+    static let msg = "msg"
+    static let containerID = "containerID"
+    static let protocolVersion = "protocolVersion"
+}
+
+private func methodInvocationStatusCode(_ status: MethodStatus) -> Int {
+    status.code == .notFound ? MethodStatusCode.unregisteredMethod.rawValue : status.rawCode
+}
+
 extension MethodPipe {
     func executeMethod(methodName: String, params: [String: Any]?, thread: MethodThread = .mainThread, completion: CommonPipeCompletion?) {
+        let invocationId = UUID().uuidString
+        let invocationStart = Date()
+        let invocationCenter = SparklingMethodInvocationCenter.shared
+        let invocationNamespace: String? = "method-pipe"
+        let callbackPayload: (MethodStatus, [String: Any]?) -> [String: Any] = { status, data in
+            var payload: [String: Any] = [
+                MethodInvocationPayloadKeys.code: methodInvocationStatusCode(status),
+                MethodInvocationPayloadKeys.data: data ?? NSNull(),
+                MethodInvocationPayloadKeys.protocolVersion: "1.1.0",
+            ]
+            payload[MethodInvocationPayloadKeys.msg] = status.message ?? NSNull()
+            if let containerID = params?[MethodInvocationPayloadKeys.containerID] as? String {
+                payload[MethodInvocationPayloadKeys.containerID] = containerID
+            }
+            return payload
+        }
+
+        invocationCenter.notifyStart(
+            SparklingMethodInvocationEvent(
+                id: invocationId,
+                name: methodName,
+                namespace: invocationNamespace,
+                platform: "core",
+                params: params,
+                result: nil,
+                statusCode: nil,
+                statusMessage: nil,
+                startTime: invocationStart,
+                endTime: nil
+            )
+        )
+
         guard let method = self.method(forName: methodName) else {
-            completion?(.notFound(), nil)
+            let status = MethodStatus.notFound()
+            let notFound = SparklingMethodInvocationEvent(
+                id: invocationId,
+                name: methodName,
+                namespace: invocationNamespace,
+                platform: "core",
+                params: params,
+                result: callbackPayload(status, nil),
+                statusCode: methodInvocationStatusCode(status),
+                statusMessage: status.message ?? "notFound",
+                startTime: invocationStart,
+                endTime: Date()
+            )
+            invocationCenter.notifyEnd(notFound)
+            completion?(status, nil)
             return
         }
-        
+
         let resultModelType = method.resultModelClass
         let resultBlk: PipeMethod.CompletionBlock = { status, result in
             if let result = result, type(of: result) != EmptyMethodModel.self {
@@ -20,7 +79,7 @@ extension MethodPipe {
                     return
                 }
             }
-            
+
             var fStatus = status
             var resultDict: [String: Any] = [:]
             do {
@@ -30,27 +89,67 @@ extension MethodPipe {
             } catch {
                 fStatus = .invalidResult(message: error.localizedDescription)
             }
-            
+
             resultDict[DictKeys.statusMessage] = fStatus.message
+            let callbackResult = callbackPayload(fStatus, resultDict)
+
+            invocationCenter.notifyEnd(
+                SparklingMethodInvocationEvent(
+                    id: invocationId,
+                    name: methodName,
+                    namespace: invocationNamespace,
+                    platform: "core",
+                    params: params,
+                    result: callbackResult,
+                    statusCode: methodInvocationStatusCode(fStatus),
+                    statusMessage: fStatus.message,
+                    startTime: invocationStart,
+                    endTime: Date()
+                )
+            )
+
             completion?(fStatus, resultDict)
         }
+
+        // Notify observers of an early-out failure (mirrors `resultBlk`).
+        let notifyEarlyFailure: (String) -> Void = { message in
+            let status = MethodStatus.invalidParameter(message: message)
+            invocationCenter.notifyEnd(
+                SparklingMethodInvocationEvent(
+                    id: invocationId,
+                    name: methodName,
+                    namespace: invocationNamespace,
+                    platform: "core",
+                    params: params,
+                    result: callbackPayload(status, [MethodInvocationPayloadKeys.message: message]),
+                    statusCode: methodInvocationStatusCode(status),
+                    statusMessage: message,
+                    startTime: invocationStart,
+                    endTime: Date()
+                )
+            )
+        }
+
         let paramsModelType = method.paramsModelClass
         guard var params = params else {
+            notifyEarlyFailure("Pipe inner error: empty params")
             completion?(.invalidParameter(message: "Pipe inner error: empty params"), nil)
             return
         }
-        
+
         // Safely get requiredKeyPaths
-        if let methodModelType = paramsModelType as? MethodModel.Type, 
-           let requiredKeyPaths = methodModelType.requiredKeyPaths {
+        if let methodModelType = paramsModelType as? MethodModel.Type,
+            let requiredKeyPaths = methodModelType.requiredKeyPaths
+        {
             let paramsKeys: Set<String> = Set(params.keys)
             let missingKeys = requiredKeyPaths.subtracting(paramsKeys).sorted().joined(separator: ", ")
             if missingKeys.count > 0 {
+                notifyEarlyFailure("Missing required parameter(s): \(missingKeys)")
                 completion?(.invalidParameter(message: "Missing required parameter(s): \(missingKeys)"), nil)
                 return
             }
         }
-        
+
         var paramModel: MethodModel?
         do {
             if let methodModelType = paramsModelType as? MethodModel.Type {
@@ -59,10 +158,12 @@ extension MethodPipe {
                 throw NSError(domain: "MethodPipe", code: -1, userInfo: [NSLocalizedDescriptionKey: "Invalid params model type: \(paramsModelType)"])
             }
         } catch {
+            notifyEarlyFailure(error.localizedDescription)
             completion?(.invalidParameter(message: error.localizedDescription), nil)
             return
         }
         guard var paramModel = paramModel else {
+            notifyEarlyFailure("Param model conversion failed")
             completion?(.invalidParameter(message: "Param model conversion failed: \(type(of: paramsModelType)) from dict: \(params)"), nil)
             return
         }
@@ -71,7 +172,7 @@ extension MethodPipe {
             context.pipeContainer = self.engine?.pipeContainer
             return context
         }()
-        
+
         let invokeBlk: () -> Void = {
             method.invokeErased(withParams: paramModel, completion: resultBlk)
         }

package/ios/Sources/Core/Pipe/MethodPipe.swift

@@ -7,38 +7,38 @@ import Foundation
 public class MethodPipe: MethodPipeFacade {
     var engine: PipeEngine?
     public private(set) lazy var registry = MethodRegistry()
-    
+
     public func register(localMethod method: PipeMethod) {
         registry.register(method: method)
     }
-    
+
     public func register(localMethods methods: [PipeMethod]) {
         registry.register(methods: methods)
     }
-    
+
     public func register(globalMethod method: PipeMethod) {
         MethodRegistry.global.register(method: method)
     }
     public func unregister(localMethodName name: String) {
         registry.unregister(methodName: name)
     }
-    
+
     public func unregister(globalMethodName name: String) {
         MethodRegistry.global.unregister(methodName: name)
     }
-    
+
     public func respondTo(methodName name: String) -> Bool {
         return registry.respondTo(methodName: name) || MethodRegistry.global.respondTo(methodName: name)
     }
-    
+
     public func method(forName name: String) -> PipeMethod? {
         return registry.method(forName: name) ?? MethodRegistry.global.method(forName: name)
     }
-    
+
     public func method<T: PipeMethod>(forName name: String) -> T? {
         return method(forName: name) as? T
     }
-    
+
     public func fireEvent(name: String, params: [String: Any]?) {
         engine?.fireEvent(name: name, params: params)
     }

package/ios/Sources/Core/Pipe/MethodRegistry.swift

@@ -7,37 +7,37 @@ import ObjectiveC.runtime
 
 public final class MethodRegistry {
     public static let global = MethodRegistry()
-    
+
     private var methodTypeMap: [String: PipeMethod.Type] = [:]
     private var methodMap: [String: PipeMethod] = [:]
     private var lock = ReadWriteLock()
-    
+
     init() {}
-    
+
     public func register(methodType: PipeMethod.Type) {
         lock.write {
             methodTypeMap[methodType.methodName()] = methodType
         }
     }
-    
+
     public func register(method: PipeMethod) {
         let methodName = type(of: method).methodName()
         lock.write {
             methodMap[methodName] = method
         }
     }
-    
+
     public func register(methods: [PipeMethod]) {
-        if (methods.isEmpty) { return }
+        if methods.isEmpty { return }
         lock.write {
             for method in methods {
                 methodMap[type(of: method).methodName()] = method
             }
         }
     }
-    
+
     public func register(methodTypes: [PipeMethod.Type]) {
-        if (methodTypes.isEmpty) { return }
+        if methodTypes.isEmpty { return }
         let validMap: [String: PipeMethod.Type] = methodTypes.reduce(into: [String: PipeMethod.Type]()) { result, type in
             result[type.methodName()] = type
         }
@@ -45,47 +45,48 @@ public final class MethodRegistry {
             methodTypeMap.merge(validMap) { (_, new) in new }
         }
     }
-    
+
     public func unregister(methodName name: String) {
         lock.write {
             methodMap[name] = nil
             methodTypeMap[name] = nil
         }
     }
-    
+
     public func respondTo(methodName name: String) -> Bool {
         return lock.read {
             methodMap[name] != nil || methodTypeMap[name] != nil
         }
     }
-    
+
     public func method(forName name: String) -> PipeMethod? {
-        return lock.read { methodMap[name] } ?? lock.write {
-            if let method = methodMap[name] {
-                return method
+        return lock.read { methodMap[name] }
+            ?? lock.write {
+                if let method = methodMap[name] {
+                    return method
+                }
+                guard let methodType = methodTypeMap[name] else {
+                    return nil
+                }
+                let newMethod = methodType.init()
+                methodMap[name] = newMethod
+                return newMethod
             }
-            guard let methodType = methodTypeMap[name] else {
-                return nil
-            }
-            let newMethod = methodType.init()
-            methodMap[name] = newMethod
-            return newMethod
-        }
     }
-    
+
     public func method<T: PipeMethod>(forName name: String) -> T? {
         return method(forName: name) as? T
     }
-    
+
     public static func autoRegisterGlobalMethods() {
         var count: UInt32 = 0
         let classList = objc_copyClassList(&count)!
         defer {
             free(UnsafeMutableRawPointer(classList))
         }
-        
+
         let classes = UnsafeBufferPointer(start: classList, count: Int(count))
-        var methodTypes:[PipeMethod.Type] = []
+        var methodTypes: [PipeMethod.Type] = []
         for i in 0..<Int(count) {
             let cls: AnyClass = classes[i]
             if class_getSuperclass(cls) == PipeMethod.self, let type = cls as? PipeMethod.Type {