@devioarts/capacitor-mdns 0.0.3 → 0.1.0

package/ios/Sources/mDNSPlugin/mDNS.swift

@@ -10,11 +10,14 @@ import Network
 /// - Resolves each candidate with `NetService` to obtain `port`, `hosts`, and optional TXT.
 /// - Produces a normalized array of dictionaries consumable by the Capacitor bridge.
 public class MDNS: NSObject {
+    private static let publishTimeoutMs = 5000
 
     // MARK: - Advertising
 
     private var publisher: NetService?
     private var publishCompletion: ((Result<String, Error>) -> Void)?
+    private var publishTimeout: DispatchWorkItem?
+    private var publishSession: UInt64 = 0
 
     // MARK: - Discovery state
 
@@ -33,6 +36,8 @@ public class MDNS: NSObject {
 
     /// Completion invoked once with either success(array) or failure(error).
     private var discoverCompletion: ((Result<[[String: Any]], Error>) -> Void)?
+    private var discoveryError: Error?
+    private var discoverySession: UInt64 = 0
 
     /// Timers: hard timeout and short settle debounce.
     private var hardTimeout: DispatchWorkItem?
@@ -54,9 +59,20 @@ public class MDNS: NSObject {
         txt: [String: String]?,
         completion: @escaping (Result<String, Error>) -> Void
     ) {
+        guard (1...65535).contains(port) else {
+            completion(.failure(Self.error("Missing/invalid port")))
+            return
+        }
+
         runOnMain { [weak self] in
-            guard let self = self else { return }
-            self.stopPublisherIfNeeded()
+            guard let self = self else {
+                completion(.failure(Self.error("mDNS manager was released before publishing could start")))
+                return
+            }
+
+            self.publishSession &+= 1
+            let session = self.publishSession
+            self.stopPublisherIfNeeded(reason: "Replaced by a new broadcast request")
             self.publishCompletion = completion
 
             let svc = NetService(domain: "local.", type: type, name: name, port: Int32(port))
@@ -71,6 +87,7 @@ public class MDNS: NSObject {
 
             svc.delegate = self
             self.publisher = svc
+            self.schedulePublishTimeout(session: session)
             // Use default publish options; connection listening not required here.
             svc.publish()
         }
@@ -80,7 +97,7 @@ public class MDNS: NSObject {
     /// Exposed as `throws` by the bridge, but this implementation does not throw.
     public func stopBroadcast() throws {
         runOnMain { [weak self] in
-            self?.stopPublisherIfNeeded()
+            self?.stopPublisherIfNeeded(reason: "Publish stopped before completion")
         }
     }
 
@@ -99,24 +116,35 @@ public class MDNS: NSObject {
         completion: @escaping (Result<[[String: Any]], Error>) -> Void
     ) {
         runOnMain { [weak self] in
-            guard let self = self else { return }
+            guard let self = self else {
+                completion(.failure(Self.error("mDNS manager was released before discovery could start")))
+                return
+            }
+
+            if self.discoverCompletion != nil {
+                self.finishDiscovery(error: Self.error("Discovery replaced by a new request"))
+            }
+
+            self.discoverySession &+= 1
+            let session = self.discoverySession
             // Reset session state.
             self.cancelTimers()
             self.stopBrowsers()
             self.resolveMap.removeAll()
             self.discovered.removeAll()
             self.targetName = name
+            self.discoveryError = nil
             self.discoverCompletion = completion
 
             // Schedule hard timeout (always resolves/finishes).
-            let ht = DispatchWorkItem { [weak self] in self?.finishDiscovery() }
+            let ht = DispatchWorkItem { [weak self] in self?.finishDiscovery(session: session) }
             self.hardTimeout = ht
             DispatchQueue.main.asyncAfter(deadline: .now() + .milliseconds(max(0, timeoutMs)), execute: ht)
 
             // Start browsing: NWBrowser preferred when available and requested.
             #if canImport(Network)
             if useNW, #available(iOS 12.0, *) {
-                self.startNWBrowse(typeWithDot: type)
+                self.startNWBrowse(typeWithDot: type, session: session)
                 return
             }
             #endif
@@ -134,7 +162,7 @@ public class MDNS: NSObject {
 
     #if canImport(Network)
     @available(iOS 12.0, *)
-    private func startNWBrowse(typeWithDot: String) {
+    private func startNWBrowse(typeWithDot: String, session: UInt64) {
         // NWBrowser expects type without trailing dot.
         let typeNoDot = typeWithDot.hasSuffix(".") ? String(typeWithDot.dropLast()) : typeWithDot
 
@@ -145,14 +173,11 @@ public class MDNS: NSObject {
         self.nwBrowser = browser
 
         browser.stateUpdateHandler = { state in
-            // Intentionally quiet; errors are reflected via timeout or partial results.
-            // print("[mDNS][NW] state: \(state)")
             switch state {
             case .failed(let err):
-                // Do not finish immediately; let the hard timeout deliver partial results.
-                // Optionally, one could trigger a fallback here.
-                // print("[mDNS][NW] failed: \(err)")
-                _ = err // silence unused
+                DispatchQueue.main.async { [weak self] in
+                    self?.finishDiscovery(session: session, error: err)
+                }
             default:
                 break
             }
@@ -160,6 +185,7 @@ public class MDNS: NSObject {
 
         browser.browseResultsChangedHandler = { [weak self] results, _ in
             guard let self = self else { return }
+            guard session == self.discoverySession, self.discoverCompletion != nil else { return }
             for r in results {
                 guard case let NWEndpoint.service(name: n, type: t, domain: d, interface: _) = r.endpoint else { continue }
                 if !self.matchesTarget(n) { continue }
@@ -180,7 +206,7 @@ public class MDNS: NSObject {
                 resolver.resolve(withTimeout: 5.0)
 
                 // Reschedule short settle window on each new find.
-                self.scheduleSettleDebounce()
+                self.scheduleSettleDebounce(session: session)
             }
         }
 
@@ -191,7 +217,9 @@ public class MDNS: NSObject {
     // MARK: - Internal: finalize & helpers
 
     /// Build the final output and complete the discovery promise.
-    private func finishDiscovery() {
+    private func finishDiscovery(session: UInt64? = nil, error: Error? = nil) {
+        if let session = session, session != discoverySession { return }
+
         cancelTimers()
         stopBrowsers()
 
@@ -219,10 +247,16 @@ public class MDNS: NSObject {
         resolveMap.removeAll()
         discovered.removeAll()
         targetName = nil
+        let finalError = error ?? discoveryError
+        discoveryError = nil
 
         let cb = discoverCompletion
         discoverCompletion = nil
-        cb?(.success(out))
+        if let finalError = finalError {
+            cb?(.failure(finalError))
+        } else {
+            cb?(.success(out))
+        }
     }
 
     /// Cancel timers (hard timeout and settle debounce).
@@ -232,9 +266,10 @@ public class MDNS: NSObject {
     }
 
     /// Schedule a short debounce to finish discovery when the system becomes idle.
-    private func scheduleSettleDebounce(_ ms: Int = 350) {
+    private func scheduleSettleDebounce(session: UInt64? = nil, _ ms: Int = 350) {
         settleDebounce?.cancel()
-        let wi = DispatchWorkItem { [weak self] in self?.finishDiscovery() }
+        let session = session ?? discoverySession
+        let wi = DispatchWorkItem { [weak self] in self?.finishDiscovery(session: session) }
         settleDebounce = wi
         DispatchQueue.main.asyncAfter(deadline: .now() + .milliseconds(ms), execute: wi)
     }
@@ -259,14 +294,27 @@ public class MDNS: NSObject {
     }
 
     /// Stop the current publisher, if any.
-    private func stopPublisherIfNeeded() {
+    private func stopPublisherIfNeeded(reason: String) {
+        publishTimeout?.cancel()
+        publishTimeout = nil
         publisher?.stop()
         publisher?.delegate = nil
         publisher = nil
-        // Do not call `publishCompletion` here: externally, `stopBroadcast()` should be considered a neutral action.
+        publishCompletion?(.failure(Self.error(reason)))
         publishCompletion = nil
     }
 
+    /// Enforce that NetService publish cannot leave a JS promise pending forever.
+    private func schedulePublishTimeout(session: UInt64) {
+        publishTimeout?.cancel()
+        let wi = DispatchWorkItem { [weak self] in
+            guard let self = self, session == self.publishSession, self.publishCompletion != nil else { return }
+            self.stopPublisherIfNeeded(reason: "Timed out waiting for service publish after \(Self.publishTimeoutMs)ms")
+        }
+        publishTimeout = wi
+        DispatchQueue.main.asyncAfter(deadline: .now() + .milliseconds(Self.publishTimeoutMs), execute: wi)
+    }
+
     /// Normalize a service name by removing the system-appended `" (n)"` suffix.
     private func normalize(_ s: String) -> String {
         return s.replacingOccurrences(of: #" \(\d+\)$"#, with: "", options: .regularExpression)
@@ -288,6 +336,10 @@ public class MDNS: NSObject {
     private func runOnMain(_ block: @escaping () -> Void) {
         if Thread.isMainThread { block() } else { DispatchQueue.main.async(execute: block) }
     }
+
+    private static func error(_ message: String) -> NSError {
+        return NSError(domain: "mDNS", code: -1, userInfo: [NSLocalizedDescriptionKey: message])
+    }
 }
 
 // MARK: - NetServiceDelegate (publish + resolve)
@@ -296,12 +348,19 @@ extension MDNS: NetServiceDelegate {
 
     // Publish callbacks
     public func netServiceDidPublish(_ sender: NetService) {
+        guard sender === publisher else { return }
+        publishTimeout?.cancel()
+        publishTimeout = nil
         let cb = publishCompletion
         publishCompletion = nil
         cb?(.success(sender.name))
     }
 
     public func netService(_ sender: NetService, didNotPublish errorDict: [String: NSNumber]) {
+        guard sender === publisher else { return }
+        publishTimeout?.cancel()
+        publishTimeout = nil
+        publisher = nil
         let cb = publishCompletion
         publishCompletion = nil
         let code = (errorDict[NetService.errorCode] as NSNumber?)?.intValue ?? -1
@@ -318,8 +377,8 @@ extension MDNS: NetServiceDelegate {
         guard let box = resolveMap[sender] else { return }
         box.port = Int(sender.port)
         box.hosts = parseHosts(sender.addresses)
-        if let txtData = sender.txtRecordData(),
-           let dict = NetService.dictionary(fromTXTRecord: txtData) as? [String: Data] {
+        if let txtData = sender.txtRecordData() {
+            let dict = NetService.dictionary(fromTXTRecord: txtData)
             box.txt = dict.reduce(into: [:]) { acc, e in
                 acc[e.key] = String(data: e.value, encoding: .utf8) ?? ""
             }
@@ -328,17 +387,17 @@ extension MDNS: NetServiceDelegate {
 
         // Early finish if a specific target is requested and this service matches it.
         if let t = targetName, !t.isEmpty, matchesTarget(sender.name) {
-            finishDiscovery()
+            finishDiscovery(session: discoverySession)
         } else {
             // Otherwise, allow a brief settle window to collect late peers.
-            scheduleSettleDebounce()
+            scheduleSettleDebounce(session: discoverySession)
         }
     }
 
     public func netService(_ sender: NetService, didNotResolve errorDict: [String: NSNumber]) {
         // Drop the unresolved service and try to continue with others.
         resolveMap.removeValue(forKey: sender)
-        scheduleSettleDebounce()
+        scheduleSettleDebounce(session: discoverySession)
     }
 }
 
@@ -350,6 +409,9 @@ extension MDNS: NetServiceBrowserDelegate {
         // Early filter by instance name.
         guard matchesTarget(service.name) else { return }
 
+        let key = keyFor(name: service.name, type: service.type, domain: service.domain)
+        if discovered.contains(where: { $0.identityKey == key }) { return }
+
         // Create a dedicated resolver (do not reuse `service` directly).
         let resolver = NetService(domain: service.domain, type: service.type, name: service.name)
         resolver.includesPeerToPeer = true
@@ -363,7 +425,7 @@ extension MDNS: NetServiceBrowserDelegate {
         resolver.resolve(withTimeout: 5.0)
 
         // If this wave ends soon, schedule settle debounce; else wait for more.
-        if !moreComing { scheduleSettleDebounce() }
+        if !moreComing { scheduleSettleDebounce(session: discoverySession) }
     }
 
     public func netServiceBrowser(_ browser: NetServiceBrowser, didRemove service: NetService, moreComing: Bool) {
@@ -371,8 +433,13 @@ extension MDNS: NetServiceBrowserDelegate {
     }
 
     public func netServiceBrowser(_ browser: NetServiceBrowser, didNotSearch errorDict: [String: NSNumber]) {
-        // Gracefully complete with whatever we have (plugin will surface error=true).
-        finishDiscovery()
+        let code = (errorDict[NetService.errorCode] as NSNumber?)?.intValue ?? -1
+        let err = NSError(
+            domain: "mDNS.discovery",
+            code: code,
+            userInfo: [NSLocalizedDescriptionKey: "Failed to search for services", "info": errorDict]
+        )
+        finishDiscovery(session: discoverySession, error: err)
     }
 }
 

package/ios/Sources/mDNSPlugin/mDNSPlugin.swift

@@ -20,6 +20,7 @@ public class mDNSPlugin: CAPPlugin, CAPBridgedPlugin {
     public let identifier = "mDNSPlugin"
     public let jsName = "mDNS"
     public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "getPluginPlatform", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "startBroadcast", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "stopBroadcast", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "discover", returnType: CAPPluginReturnPromise)
@@ -34,13 +35,21 @@ public class mDNSPlugin: CAPPlugin, CAPBridgedPlugin {
     }
 
     private func normalizeType(_ raw: String?) -> String {
-        var t = raw ?? "_http._tcp."
+        var t = raw?.trimmingCharacters(in: .whitespacesAndNewlines) ?? ""
+        if t.isEmpty { t = "_http._tcp." }
         if t.last != "." { t += "." }
         return t
     }
 
     // MARK: - API
 
+    /// getPluginPlatform()
+    @objc public func getPluginPlatform(_ call: CAPPluginCall) {
+        call.resolve([
+            "platform": "ios"
+        ])
+    }
+
     /// startBroadcast({ type?, name?, port, txt? })
     @objc public func startBroadcast(_ call: CAPPluginCall) {
         let type = normalizeType(call.getString("type"))
@@ -48,7 +57,7 @@ public class mDNSPlugin: CAPPlugin, CAPBridgedPlugin {
         let port = call.getInt("port") ?? 0
         let txt  = call.getObject("txt") as? [String: String]
 
-        guard port > 0 else {
+        guard (1...65535).contains(port) else {
             call.resolve([
                 "publishing": false,
                 "name": "",
@@ -99,7 +108,7 @@ public class mDNSPlugin: CAPPlugin, CAPBridgedPlugin {
     /// discover({ type?, name?, timeout? })
     @objc public func discover(_ call: CAPPluginCall) {
         let type = normalizeType(call.getString("type"))
-        let targetName = call.getString("name")
+        let targetName = (call.getString("name")?.trimmingCharacters(in: .whitespacesAndNewlines)).flatMap { $0.isEmpty ? nil : $0 }
         let timeout = call.getInt("timeout") ?? 3000
         let useNW = call.getBool("useNW") ?? true
 

package/ios/Tests/mDNSPluginTests/mDNSPluginTests.swift

@@ -2,14 +2,8 @@ import XCTest
 @testable import mDNSPlugin
 
 class mDNSTests: XCTestCase {
-    func testEcho() {
-        // This is an example of a functional test case for a plugin.
-        // Use XCTAssert and related functions to verify your tests produce the correct results.
-
-        let implementation = mDNS()
-        let value = "Hello, World!"
-        let result = implementation.echo(value)
-
-        XCTAssertEqual(value, result)
+    func testManagerCanBeCreated() {
+        let implementation = MDNS()
+        XCTAssertNotNil(implementation)
     }
 }

package/package.json

@@ -1,16 +1,42 @@
 {
   "name": "@devioarts/capacitor-mdns",
-  "version": "0.0.3",
+  "version": "0.1.0",
   "description": "mDNS plugin for CapacitorJS",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",
   "unpkg": "dist/plugin.js",
+  "exports": {
+    ".": {
+      "types": "./dist/esm/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/plugin.cjs.js",
+      "default": "./dist/esm/index.js"
+    },
+    "./electron": {
+      "types": "./electron/types-public/index.d.ts",
+      "require": "./electron/dist/plugin.cjs.js",
+      "default": "./electron/dist/plugin.cjs.js"
+    },
+    "./electron/settings": {
+      "types": "./electron/types-public/index.d.ts",
+      "require": "./electron/dist/plugin-settings.js",
+      "default": "./electron/dist/plugin-settings.js"
+    },
+    "./electron/mdns": {
+      "types": "./electron/types-public/index.d.ts",
+      "require": "./electron/dist/plugin.cjs.js",
+      "default": "./electron/dist/plugin.cjs.js"
+    },
+    "./electron/mdns-bridge.cjs": "./electron/mdns-bridge.cjs",
+    "./package.json": "./package.json"
+  },
   "files": [
     "android/src/main/",
     "android/build.gradle",
     "dist/",
     "electron/",
+    "docs/",
     "ios/Sources",
     "ios/Tests",
     "Package.swift",
@@ -45,35 +71,37 @@
     "verify:web": "npm run build",
     "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
     "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format",
-    "eslint": "eslint . --ext ts",
+    "eslint": "eslint src electron --ext ts",
     "prettier": "prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java",
     "swiftlint": "node-swiftlint",
     "docgen": "docgen --api mDNSPlugin --output-readme README.md --output-json dist/docs.json",
-    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs",
-    "clean": "rimraf ./dist",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs && npm run build-electron",
+    "build-electron": "tsc --project electron/tsconfig.json && rollup -c electron/rollup.config.mjs && rimraf ./electron/build",
+    "clean": "rimraf ./dist ./electron/dist ./electron/build",
     "watch": "tsc --watch",
-    "test": "echo \"No test specified\"",
+    "test": "npm run test:e2e",
+    "test:e2e": "rimraf .tmp/e2e-build && tsc -p tsconfig.e2e.json && node --test test/e2e/*.e2e.cjs",
     "prepublishOnly": "npm run build",
     "release": "npm publish --access public"
   },
   "devDependencies": {
-    "@capacitor/android": "^8.4.0",
-    "@capacitor/core": "^8.4.0",
-    "@capacitor/docgen": "^0.3.1",
-    "@capacitor/ios": "^8.4.0",
+    "@capacitor/android": "^8.0.0",
+    "@capacitor/core": "^8.0.0",
+    "@capacitor/docgen": "^0.3.0",
+    "@capacitor/ios": "^8.0.0",
     "@ionic/prettier-config": "^4.0.0",
     "@ionic/swiftlint-config": "^2.0.0",
-    "@typescript-eslint/eslint-plugin": "^8.61.0",
-    "@typescript-eslint/parser": "^8.61.0",
+    "@typescript-eslint/eslint-plugin": "^8.63.0",
+    "@typescript-eslint/parser": "^8.63.0",
     "bonjour-service": "^1.4.0",
-    "electron": "^42.4.0",
-    "eslint": "^10.4.1",
-    "prettier": "^3.8.4",
-    "prettier-plugin-java": "^2.9.7",
-    "rimraf": "^6.1.3",
-    "rollup": "^4.61.1",
+    "electron": "^43.0.0",
+    "eslint": "^10.6.0",
+    "prettier": "^3.9.0",
+    "prettier-plugin-java": "^2.10.0",
+    "rimraf": "^6.1.0",
+    "rollup": "^4.62.0",
     "swiftlint": "^2.0.0",
-    "typescript": "^6.0.3"
+    "typescript": "^6.0.0"
   },
   "peerDependencies": {
     "@capacitor/core": ">=8.0.0"