Merge pull request #9 from maxxfrazer/ios14-fixes

Fix iOS 14 compatibility, using `MultipeerHelperDelegate.checkPeerToken()`

Author: maxxfrazer

.github/workflows/swift-build.yml

@@ -13,13 +13,16 @@ on:
 jobs:
   build:
     runs-on: macOS-latest
+    strategy:
+        matrix:
+          SDK: [iphoneos, macosx, appletvos]
     steps:
     - uses: actions/checkout@v1
     - name: build
       run: |
         swift package generate-xcodeproj
-        xcodebuild clean build -project $PROJECT -scheme $SCHEME -sdk $SDK CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO ONLY_ACTIVE_ARCH=NO
+        xcodebuild clean build -project $PROJECT -scheme $SCHEME -sdk $SDK CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO ONLY_ACTIVE_ARCH=NO | xcpretty
       env:
         PROJECT: MultipeerHelper.xcodeproj
         SCHEME: MultipeerHelper-Package
-        SDK: iphoneos
+        SDK: ${{ matrix.SDK }}

.swiftlint.yml

@@ -0,0 +1,4 @@
+line_length:
+  ignores_comments: true
+cyclomatic_complexity:
+  ignores_case_statements: true

MultipeerHelper+Example/MultipeerHelper+Example/Info.plist

@@ -22,6 +22,8 @@
 	<true/>
 	<key>NSCameraUsageDescription</key>
 	<string></string>
+	<key>NSLocalNetworkUsageDescription</key>
+	<string>This application synchronises with other iOS devices on the same network.</string>
 	<key>UILaunchStoryboardName</key>
 	<string>LaunchScreen</string>
 	<key>UIRequiredDeviceCapabilities</key>
@@ -31,6 +33,11 @@
 	</array>
 	<key>UIStatusBarHidden</key>
 	<true/>
+	<key>NSBonjourServices</key>
+	<array>
+		<string>_helper-test._tcp</string>
+		<string>_helper-test._udp</string>
+	</array>
 	<key>UISupportedInterfaceOrientations</key>
 	<array>
 		<string>UIInterfaceOrientationPortrait</string>

MultipeerHelper+Example/MultipeerHelper+Example/RealityViewController.swift

@@ -46,6 +46,18 @@ class RealityViewController: UIViewController, ARSessionDelegate {
 }
 
 extension RealityViewController: MultipeerHelperDelegate {
+
+  func shouldSendJoinRequest(
+    _ peer: MCPeerID,
+    with discoveryInfo: [String: String]?
+  ) -> Bool {
+    if RealityViewController.checkPeerToken(with: discoveryInfo) {
+      return true
+    }
+    print("incompatible peer!")
+    return false
+  }
+
   func setupMultipeer() {
     multipeerHelp = MultipeerHelper(
       serviceName: "helper-test",

README.md

@@ -8,7 +8,7 @@
   <img src="https://github.com/maxxfrazer/MultipeerHelper/workflows/swiftlint/badge.svg?branch=main"/>
 </p>
 
-![Path Example 1](https://github.com/maxxfrazer/MultipeerHelper/blob/main/media/MultipeerHelper-Header.png?raw=true)
+![MultipeerHelper Header](https://github.com/maxxfrazer/MultipeerHelper/blob/main/media/MultipeerHelper-Header.png?raw=true)
 
 # MultipeerHelper
 
@@ -33,6 +33,17 @@ self.multipeerHelp = MultipeerHelper(
 )
 ```
 
+Because MultipeerConnectivity looks over your local network to find other devices to connect with, there are a few new things to include since iOS 14.
+
+The first thing, is to include the key `NSLocalNetworkUsageDescription` in your app's Info.plist, along with a short text explaining why you need to use the local network. For example "This application needs access to the local network to find opponents.".
+
+As well as the above, you also need to add another key, `NSBonjourServices`. Bonjour services is an array of Bonjour service types.
+For example, if your serviceName is "helper-test", you will need to add `_helper-test._tcp` and `_helper-test._udp`.
+
+The two above keys are included in [the Example Project](MultipeerHelper+Example).
+
+### RealityKit
+
 To extend this to RealityKit's synchronization service, simply add the following:
 
 ```swift
@@ -41,6 +52,24 @@ self.arView.scene.synchronizationService = self.multipeerHelp.syncService
 
 And also make sure that your ARConfiguration's isCollaborationEnabled property is set to true.
 
+To make sure RealityKit's synchronizationService runs properly, you must ensure that the RealityKit version installed on any two devices are compatible.
+
+By default, any OS using MultipeerHelper that can install RealityKit (iOS, iPadOS and macOS) will have a key added to the discoveryInfo.
+To use this easily, you can add the `shouldSendJoinRequest` method to your `MultipeerHelperDelegate`, and make use of the `checkPeerToken` which is accessible to any class which inherits the `MultipeerHelperDelegate`. Here's an example:
+
+```swift
+extension RealityViewController: MultipeerHelperDelegate {
+  func shouldSendJoinRequest(
+    _ peer: MCPeerID,
+    with discoveryInfo: [String: String]?
+  ) -> Bool {
+    self.checkPeerToken(with: discoveryInfo)
+  }
+}
+```
+
+This method is used in [the Example Project](MultipeerHelper+Example).
+
 ### Initializer Parameters
 
 #### serviceName
@@ -51,8 +80,14 @@ This is the type of service to advertise or search for. Due to how MultipeerConn
  - Must not begin or end with a hyphen
  - Must not contain hyphens adjacent to other hyphens.
 
-#### sessionType (default: .both)
+#### sessionType (default: `.both`)
 This lets the service know if it should be acting as a service `host` (advertiser), `peer` (browser), or in a scenario where it doesn't matter, `both`. The default for this parameter is `both`, which is the scenario where all devices want to just connect to each other with no questions asked.
 
-#### delegate (default: nil)
+#### peerName (default: `UIDevice.current.name`)
+String name of your device on the network.
+
+#### encryptionPreference (default: `.required`)
+encryptionPreference is how data sent over the network are encrypted.
+
+#### delegate (default: `nil`)
 This delegate object will inherit the `MultipeerHelperDelegate` protocol, which can be used for all the handling of transferring data round the network and seeing when others join and leave.

Sources/MultipeerHelper/MultipeerHelper.swift

@@ -6,7 +6,7 @@
 //
 
 import MultipeerConnectivity
-#if !os(tvOS)
+#if canImport(RealityKit)
 import RealityKit
 #endif
 
@@ -15,6 +15,7 @@ public class MultipeerHelper: NSObject {
   ///
   /// `both` creates a session where all users are equal
   /// Otherwise if you want one specific user to be the host, choose `host` and `peer`
+  /// A `host` will create a service advertiser, and a `peer` will create a service browser.
   public enum SessionType: Int {
     case host = 1
     case peer = 2
@@ -25,8 +26,7 @@ public class MultipeerHelper: NSObject {
   public let sessionType: SessionType
   public let serviceName: String
 
-
-  #if !os(tvOS)
+  #if canImport(RealityKit)
   /// Used for RealityKit, set this as your scene's synchronizationService
   @available(iOS 13.0, macOS 10.15, *)
   public var syncService: MultipeerConnectivityService? {
@@ -44,7 +44,6 @@ public class MultipeerHelper: NSObject {
   public private(set) var serviceAdvertiser: MCNearbyServiceAdvertiser?
   public private(set) var serviceBrowser: MCNearbyServiceBrowser?
 
-
   public weak var delegate: MultipeerHelperDelegate?
   /// Initializes a Multipeer Helper.
   /// Pass your own peerName to avoid exceptions, as there are restrictions set by Apple on what is allowed.
@@ -89,7 +88,23 @@ public class MultipeerHelper: NSObject {
     session.delegate = self
 
     if (self.sessionType.rawValue & SessionType.host.rawValue) != 0 {
-      serviceAdvertiser = MCNearbyServiceAdvertiser(peer: myPeerID, discoveryInfo: nil, serviceType: self.serviceName)
+      var discoveryInfo = self.delegate?.setDiscoveryInfo?()
+        ?? [String: String]()
+
+      #if canImport(RealityKit)
+      if #available(iOS 13.4, macOS 10.15.4, *) {
+        let networkLoc = NetworkCompatibilityToken.local
+        let jsonData = try? JSONEncoder().encode(networkLoc)
+        if let encodedToken = String(data: jsonData!, encoding: .utf8) {
+          discoveryInfo["compatibility_token"] = encodedToken
+        }
+      }
+      #endif
+      serviceAdvertiser = MCNearbyServiceAdvertiser(
+        peer: myPeerID,
+        discoveryInfo: discoveryInfo,
+        serviceType: self.serviceName
+      )
       serviceAdvertiser?.delegate = self
       serviceAdvertiser?.startAdvertisingPeer()
     }
@@ -158,6 +173,16 @@ public class MultipeerHelper: NSObject {
     }
     return connectedPeers.first { $0.displayName == name }
   }
+
+  /// Method used for disconnecting all services. Once completed,
+  /// create a new MultipeerHelper if you want to connect to sessions again.
+  func disconnectAll() {
+    self.serviceAdvertiser?.stopAdvertisingPeer()
+    self.serviceBrowser?.stopBrowsingForPeers()
+    self.serviceAdvertiser = nil
+    self.serviceBrowser = nil
+    self.session.disconnect()
+  }
 }
 
 extension MultipeerHelper: MCSessionDelegate {
@@ -170,6 +195,7 @@ extension MultipeerHelper: MCSessionDelegate {
     if state == .connected {
       peerIDLookup[peerID.displayName] = peerID
       delegate?.peerJoined?(peerID)
+      self.serviceBrowser?.stopBrowsingForPeers()
     } else if state == .notConnected {
       peerIDLookup.removeValue(forKey: peerID.displayName)
       delegate?.peerLeft?(peerID)
@@ -229,11 +255,10 @@ extension MultipeerHelper: MCNearbyServiceBrowserDelegate {
   public func browser(
     _ browser: MCNearbyServiceBrowser,
     foundPeer peerID: MCPeerID,
-    withDiscoveryInfo _: [String: String]?
+    withDiscoveryInfo info: [String: String]?
   ) {
     // Ask the handler whether we should invite this peer or not
-    if delegate?.shouldSendJoinRequest == nil || (delegate?.shouldSendJoinRequest?(peerID) ?? false) {
-      print("BrowserDelegate \(peerID)")
+    if delegate?.shouldSendJoinRequest == nil || (delegate?.shouldSendJoinRequest?(peerID, with: info) ?? false) {
       browser.invitePeer(peerID, to: session, withContext: nil, timeout: 10)
     }
   }
@@ -246,7 +271,7 @@ extension MultipeerHelper: MCNearbyServiceBrowserDelegate {
 extension MultipeerHelper: MCNearbyServiceAdvertiserDelegate {
   /// - Tag: AcceptInvite
   public func advertiser(
-    _: MCNearbyServiceAdvertiser,
+    _ advo: MCNearbyServiceAdvertiser,
     didReceiveInvitationFromPeer peerID: MCPeerID,
     withContext data: Data?,
     invitationHandler: @escaping (Bool, MCSession?) -> Void

Sources/MultipeerHelper/MultipeerHelperDelegate.swift

@@ -24,8 +24,10 @@ import MultipeerConnectivity
 
   /// Callback for when a new peer has been found. will default to accept all peers
   /// - Parameter peer: the   `MCPeerID` of the peer who wants to join the network
+  /// - Parameter discoveryInfo: The info dictionary advertised by the discovered peer. For more information on the contents of this dictionary, see the documentation for
+  ///  [init(peer:discoveryInfo:serviceType:)](apple-reference-documentation://ls%2Fdocumentation%2Fmultipeerconnectivity%2Fmcnearbyserviceadvertiser%2F1407102-init) in [MCNearbyServiceAdvertiser](apple-reference-documentation://ls%2Fdocumentation%2Fmultipeerconnectivity%2Fmcnearbyserviceadvertiser).
   /// - Returns: Bool if the peer request to join the network or not
-  @objc optional func shouldSendJoinRequest(_ peer: MCPeerID) -> Bool
+  @objc optional func shouldSendJoinRequest(_ peer: MCPeerID, with discoveryInfo: [String: String]?) -> Bool
 
   /// Handle when a peer has requested to join the network
   /// - Parameters:
@@ -34,6 +36,11 @@ import MultipeerConnectivity
   /// - Returns: Bool if the peer's join request should be accepted
   @objc optional func shouldAcceptJoinRequest(peerID: MCPeerID, context: Data?) -> Bool
 
+  /// This will be set as the base for the discoveryInfo, which is sent out by the advertiser (host).
+  /// The key "compatibility_token" is in use by MultipeerHelper, for checking the
+  /// compatibility of RealityKit versions.
+  @objc optional func setDiscoveryInfo() -> [String: String]
+
   /// Peer can no longer be found on the network, and thus cannot receive data
   /// - Parameter peer: If a peer has left the network in a non typical way
   @objc optional func peerLost(_ peer: MCPeerID)
@@ -42,3 +49,31 @@ import MultipeerConnectivity
   @objc optional func receivedResource(_ resourceName: String, _ peer: MCPeerID, _ url: URL?, _ error: Error?)
   @objc optional func receivedCertificate(certificate: [Any]?, fromPeer peerID: MCPeerID) -> Bool
 }
+
+#if canImport(RealityKit)
+import RealityKit
+extension MultipeerHelperDelegate {
+  /// Checks whether the discovered session is using a compatible version of RealityKit
+  /// For collaborative sessions.
+  /// - Parameter discoveryInfo: The discoveryInfo from the advertiser
+  /// picked up by a browser.
+  /// - Returns: Boolean representing whether or not the two devices
+  /// have compatible versions of RealityKit.
+  public static func checkPeerToken(with discoveryInfo: [String: String]?) -> Bool {
+    guard let compTokenStr = discoveryInfo?["compatibility_token"]
+          else {
+      return false
+    }
+    if #available(iOS 13.4, macOS 10.15.4, *) {
+      if let tokenData = compTokenStr.data(using: .utf8),
+         let compToken = try? JSONDecoder().decode(
+          NetworkCompatibilityToken.self,
+          from: tokenData
+      ) {
+        return compToken.compatibilityWith(.local) == .compatible
+      }
+    }
+    return false
+  }
+}
+#endif