Merge pull request #9 from CallumTodd7/master

Surface sender peer

README.md

@@ -22,8 +22,8 @@ let transceiver = MultipeerTransceiver()
 transceiver.resume()
 
 // Configure message receivers
-transceiver.receive(SomeCodableThing.self) { payload in
-	print("Got my thing! \(payload)")
+transceiver.receive(SomeCodableThing.self) { payload, sender in
+print("Got my thing from \(sender.name)! \(payload)")
 }
 
 // Broadcast message to peers
@@ -45,4 +45,4 @@ let package = Package(
     ],
     ...
 )
-```
+```

Sources/MultipeerKit/Internal API/MockMultipeerConnection.swift

@@ -1,8 +1,14 @@
 import Foundation
+import MultipeerConnectivity.MCPeerID
 
 final class MockMultipeerConnection: MultipeerProtocol {
 
-    var didReceiveData: ((Data, PeerName) -> Void)?
+    let localPeer: Peer = {
+        let underlyingPeer = MCPeerID(displayName: "MockPeer")
+        return try! Peer(peer: underlyingPeer, discoveryInfo: nil)
+    }()
+
+    var didReceiveData: ((Data, Peer) -> Void)?
     var didFindPeer: ((Peer) -> Void)?
     var didLosePeer: ((Peer) -> Void)?
     var didConnectToPeer: ((Peer) -> Void)?
@@ -19,7 +25,7 @@ final class MockMultipeerConnection: MultipeerProtocol {
     }
 
     func broadcast(_ data: Data) throws {
-        didReceiveData?(data, "MockPeer")
+        didReceiveData?(data, localPeer)
     }
 
     func send(_ data: Data, to peers: [Peer]) throws {
@@ -31,7 +37,7 @@ final class MockMultipeerConnection: MultipeerProtocol {
     }
 
     func getLocalPeerId() -> String? {
-        return "MockId"
+        return localPeer.id
     }
 
 }

Sources/MultipeerKit/Internal API/Models/MultipeerMessage.swift

@@ -27,6 +27,8 @@
 import Foundation
 
 struct MultipeerMessage: Codable {
+    static let senderUserInfoKey = CodingUserInfoKey(rawValue: "sender")!
+
     let type: String
     let payload: Any?
 
@@ -40,17 +42,17 @@ struct MultipeerMessage: Codable {
         case payload
     }
 
-    private typealias MessageDecoder = (KeyedDecodingContainer<CodingKeys>) throws -> Any
+    private typealias MessageDecoder = (KeyedDecodingContainer<CodingKeys>, Peer) throws -> Any
     private typealias MessageEncoder = (Any, inout KeyedEncodingContainer<CodingKeys>) throws -> Void
 
     private static var decoders: [String: MessageDecoder] = [:]
     private static var encoders: [String: MessageEncoder] = [:]
 
-    static func register<T: Codable>(_ type: T.Type, for typeName: String, closure: @escaping (T) -> Void) {
-        decoders[typeName] = { container in
+    static func register<T: Codable>(_ type: T.Type, for typeName: String, closure: @escaping (T, Peer) -> Void) {
+        decoders[typeName] = { container, peer in
             let payload = try container.decode(T.self, forKey: .payload)
 
-            DispatchQueue.main.async { closure(payload) }
+            DispatchQueue.main.async { closure(payload, peer) }
 
             return payload
         }
@@ -67,9 +69,11 @@ struct MultipeerMessage: Codable {
     init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         type = try container.decode(String.self, forKey: .type)
+
+        let sender = decoder.userInfo[MultipeerMessage.senderUserInfoKey]! as! Peer
 
         if let decode = Self.decoders[type] {
-            payload = try decode(container)
+            payload = try decode(container, sender)
         } else {
             payload = nil
         }

Sources/MultipeerKit/Internal API/MultipeerConnection.swift

@@ -27,7 +27,7 @@ final class MultipeerConnection: NSObject, MultipeerProtocol {
         self.me = MCPeerID.fetchOrCreate(with: configuration)
     }
 
-    var didReceiveData: ((Data, PeerName) -> Void)?
+    var didReceiveData: ((Data, Peer) -> Void)?
     var didFindPeer: ((Peer) -> Void)?
     var didLosePeer: ((Peer) -> Void)?
     var didConnectToPeer: ((Peer) -> Void)?
@@ -145,7 +145,11 @@ extension MultipeerConnection: MCSessionDelegate {
     func session(_ session: MCSession, didReceive data: Data, fromPeer peerID: MCPeerID) {
         os_log("%{public}@", log: log, type: .debug, #function)
 
-        didReceiveData?(data, peerID.displayName)
+        if let peer = try? Peer(peer: peerID, discoveryInfo: nil) {
+            didReceiveData?(data, peer)
+        } else {
+            os_log("Received data, but cannot create peer for %s", log: log, type: .error, #function, peerID.displayName)
+        }
     }
 
     func session(_ session: MCSession, didReceive stream: InputStream, withName streamName: String, fromPeer peerID: MCPeerID) {

Sources/MultipeerKit/Internal API/MultipeerProtocol.swift

@@ -4,7 +4,7 @@ typealias PeerName = String
 
 protocol MultipeerProtocol: AnyObject {
 
-    var didReceiveData: ((Data, PeerName) -> Void)? { get set }
+    var didReceiveData: ((Data, Peer) -> Void)? { get set }
     var didFindPeer: ((Peer) -> Void)? { get set }
     var didLosePeer: ((Peer) -> Void)? { get set }
     var didConnectToPeer: ((Peer) -> Void)? { get set }

Sources/MultipeerKit/Public API/MultipeerTransceiver.swift

@@ -74,12 +74,13 @@ public final class MultipeerTransceiver {
     ///   - type: The `Codable` type to receive.
     ///   - closure: The closure that will be called whenever a payload of the specified type is received.
     ///   - payload: The payload decoded from the remote message.
+    ///   - sender: The remote peer who sent the message.
     ///
     /// MultipeerKit communicates data between peers as JSON-encoded payloads which originate with
     /// `Codable` entities. You register a closure to handle each specific type of entity,
     /// and this closure is automatically called by the framework when a remote peer sends
     /// a message containing an entity that decodes to the specified type.
-    public func receive<T: Codable>(_ type: T.Type, using closure: @escaping (_ payload: T) -> Void) {
+    public func receive<T: Codable>(_ type: T.Type, using closure: @escaping (_ payload: T, _ sender: Peer) -> Void) {
         MultipeerMessage.register(type, for: String(describing: type), closure: closure)
     }
 
@@ -127,11 +128,13 @@ public final class MultipeerTransceiver {
         }
     }
 
-    private func handleDataReceived(_ data: Data, from peer: PeerName) {
+    private func handleDataReceived(_ data: Data, from peer: Peer) {
         os_log("%{public}@", log: log, type: .debug, #function)
 
         do {
-            let message = try JSONDecoder().decode(MultipeerMessage.self, from: data)
+            let decoder = JSONDecoder()
+            decoder.userInfo[MultipeerMessage.senderUserInfoKey] = peer
+            let message = try decoder.decode(MultipeerMessage.self, from: data)
 
             os_log("Received message %@", log: self.log, type: .debug, String(describing: message))
         } catch {

Tests/MultipeerKitTests/MultipeerKitTests.swift

@@ -36,8 +36,9 @@ final class MultipeerKitTests: XCTestCase {
 
         let expect = XCTestExpectation(description: "Receive payload")
 
-        mock.receive(TestPayload.self) { p in
-            XCTAssertEqual(p, tsPayload)
+        mock.receive(TestPayload.self) { payload, sender in
+            XCTAssertEqual(payload, tsPayload)
+            XCTAssertEqual(sender.id, mock.localPeerId!)
 
             expect.fulfill()
         }

example/MultipeerKitExample/MultipeerKitExample/SceneDelegate.swift

@@ -24,10 +24,10 @@ class SceneDelegate: UIResponder, UIWindowSceneDelegate {
 
         let t = MultipeerTransceiver(configuration: config)
 
-        t.receive(ExamplePayload.self) { [weak self] payload in
+        t.receive(ExamplePayload.self) { [weak self] payload, peer in
             print("Got payload: \(payload)")
 
-            self?.notify(with: payload)
+            self?.notify(with: payload, peer: peer)
         }
 
         return t
@@ -37,9 +37,9 @@ class SceneDelegate: UIResponder, UIWindowSceneDelegate {
         MultipeerDataSource(transceiver: transceiver)
     }()
 
-    private func notify(with payload: ExamplePayload) {
+    private func notify(with payload: ExamplePayload, peer: Peer) {
         let content = UNMutableNotificationContent()
-        content.body = payload.message
+        content.body = "\"\(payload.message)\" from \(peer.name)"
         let request = UNNotificationRequest(identifier: payload.message, content: content, trigger: nil)
         UNUserNotificationCenter.current().add(request) { _ in