react-native-zeroconf 0.15.1 → 0.16.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-zeroconf",
-  "version": "0.15.1",
+  "version": "0.16.0",
   "description": "A Zeroconf discovery utility for react-native",
   "main": "dist",
   "types": "index.d.ts",
@@ -18,6 +18,43 @@
     "dist",
     "index.d.ts",
     "android",
+    "!android/src/main/jni/mdnsresponder/mDNSWindows",
+    "!android/src/main/jni/mdnsresponder/Clients",
+    "!android/src/main/jni/mdnsresponder/android",
+    "!android/src/main/jni/mdnsresponder/Makefile",
+    "!android/src/main/jni/mdnsresponder/mDNSResponder.sln",
+    "!android/src/main/jni/mdnsresponder/mdnsd.rc",
+    "!android/src/main/jni/mdnsresponder/Android.bp",
+    "!android/src/main/jni/mdnsresponder/PrivateDNS.txt",
+    "!android/src/main/jni/mdnsresponder/mDNSCore/Implementer Notes.txt",
+    "!android/src/main/jni/mdnsresponder/mDNSPosix/Client.c",
+    "!android/src/main/jni/mdnsresponder/mDNSPosix/ExampleClientApp.c",
+    "!android/src/main/jni/mdnsresponder/mDNSPosix/ExampleClientApp.h",
+    "!android/src/main/jni/mdnsresponder/mDNSPosix/Identify.c",
+    "!android/src/main/jni/mdnsresponder/mDNSPosix/NetMonitor.c",
+    "!android/src/main/jni/mdnsresponder/mDNSPosix/ProxyResponder.c",
+    "!android/src/main/jni/mdnsresponder/mDNSPosix/Responder.c",
+    "!android/src/main/jni/mdnsresponder/mDNSPosix/nss_mdns.c",
+    "!android/src/main/jni/mdnsresponder/mDNSPosix/nss_mdns.conf",
+    "!android/src/main/jni/mdnsresponder/mDNSPosix/nss_mdns.conf.5",
+    "!android/src/main/jni/mdnsresponder/mDNSPosix/nss_ReadMe.txt",
+    "!android/src/main/jni/mdnsresponder/mDNSPosix/libnss_mdns.8",
+    "!android/src/main/jni/mdnsresponder/mDNSPosix/mdnsd.sh",
+    "!android/src/main/jni/mdnsresponder/mDNSPosix/parselog.py",
+    "!android/src/main/jni/mdnsresponder/mDNSPosix/Makefile",
+    "!android/src/main/jni/mdnsresponder/mDNSPosix/ReadMe.txt",
+    "!android/src/main/jni/mdnsresponder/mDNSPosix/Services.txt",
+    "!android/src/main/jni/mdnsresponder/mDNSShared/DebugServices.c",
+    "!android/src/main/jni/mdnsresponder/mDNSShared/dnsextd.c",
+    "!android/src/main/jni/mdnsresponder/mDNSShared/dnsextd.8",
+    "!android/src/main/jni/mdnsresponder/mDNSShared/dnsextd.conf",
+    "!android/src/main/jni/mdnsresponder/mDNSShared/dnsextd_lexer.l",
+    "!android/src/main/jni/mdnsresponder/mDNSShared/dnsextd_parser.y",
+    "!android/src/main/jni/mdnsresponder/mDNSShared/dns-sd.1",
+    "!android/src/main/jni/mdnsresponder/mDNSShared/mDNS.1",
+    "!android/src/main/jni/mdnsresponder/mDNSShared/mDNSResponder.8",
+    "!android/build",
+    "!android/.gradle",
     "ios",
     "react-native-zeroconf.podspec",
     "NOTICE"
@@ -42,6 +79,7 @@
     "events": "^3.0.0"
   },
   "peerDependencies": {
+    "react": "*",
     "react-native": ">=0.60"
   },
   "devDependencies": {

package/react-native-zeroconf.podspec

@@ -10,12 +10,18 @@ Pod::Spec.new do |s|
 
   s.authors      = package['author']
   s.homepage     = package['homepage']
-  s.ios.deployment_target = '9.0'
-  s.macos.deployment_target = '10.13'
-  s.tvos.deployment_target = '9.0'
-  
-  s.source       = { :git => "https://github.com/balthazar/react-native-zeroconf.git", :tag => "v#{s.version}" }
+  # React Native's own minimum when available (RN 0.71+)
+  s.ios.deployment_target = respond_to?(:min_ios_version_supported, true) ? min_ios_version_supported : '13.4'
+  s.macos.deployment_target = '10.15'
+  s.tvos.deployment_target = '13.4'
+
+  s.source       = { :git => "https://github.com/balthazar/react-native-zeroconf.git", :tag => "#{s.version}" }
   s.source_files  = "ios/**/*.{h,m}"
+  s.frameworks = 'Network'
 
-  s.dependency 'React-Core'
+  if respond_to?(:install_modules_dependencies, true)
+    install_modules_dependencies(s)
+  else
+    s.dependency 'React-Core'
+  end
 end

package/src/index.js

@@ -1,3 +1,4 @@
+import { useCallback, useEffect, useRef, useState } from 'react'
 import { Platform, NativeModules, DeviceEventEmitter } from 'react-native'
 import { EventEmitter } from 'events'
 
@@ -8,6 +9,72 @@ export const ImplType = {
   DNSSD: 'DNSSD',
 }
 
+const SCAN_DEFAULTS = {
+  type: 'http',
+  protocol: 'tcp',
+  domain: 'local.',
+  implType: ImplType.NSD,
+  resolveTimeout: 5,
+}
+
+const PUBLISH_DEFAULTS = {
+  domain: 'local.',
+  txt: {},
+  implType: ImplType.NSD,
+}
+
+/**
+ * Merge options over defaults, ignoring undefined values
+ */
+const withDefaults = (defaults, options) => {
+  const merged = { ...defaults }
+  Object.entries(options).forEach(([key, value]) => {
+    if (value !== undefined) {
+      merged[key] = value
+    }
+  })
+  return merged
+}
+
+const isOptionsObject = value => value !== null && typeof value === 'object'
+
+// Each instance runs its own scan, identified by this id in native events
+let instanceCount = 0
+
+/**
+ * Error from a native { message, code, domain, serviceName } payload
+ */
+const toError = payload => {
+  if (!payload || typeof payload !== 'object') {
+    return new Error(payload)
+  }
+  const error = new Error(payload.message)
+  error.code = payload.code
+  error.domain = payload.domain
+  if (payload.serviceName) {
+    error.serviceName = payload.serviceName
+  }
+  return error
+}
+
+/**
+ * Promise rejections carry the same payload as error events in userInfo
+ */
+const toRejection = error =>
+  error && error.userInfo && error.userInfo.domain ? toError(error.userInfo) : error
+
+/**
+ * Normalizes rejections, and marks the promise handled so callers that don't await it
+ * don't get unhandled rejection warnings (errors are also emitted as error events)
+ */
+const asPromise = nativePromise => {
+  const promise = Promise.resolve(nativePromise).catch(error => {
+    throw toRejection(error)
+  })
+  promise.catch(() => {})
+  return promise
+}
+
 const isIPv6 = address => address.includes(':')
 
 /**
@@ -42,6 +109,8 @@ export default class Zeroconf extends EventEmitter {
     this._publishedServices = {}
     this._publishedImplTypes = {}
     this._scanImplType = null
+    this._scanId = `zeroconf-${++instanceCount}`
+    this._hasScanned = false
     this._dListeners = {}
 
     this.addDeviceListeners()
@@ -55,33 +124,37 @@ export default class Zeroconf extends EventEmitter {
       return this.emit('error', new Error('RNZeroconf listeners already in place.'))
     }
 
-    this._dListeners.start = DeviceEventEmitter.addListener('RNZeroconfStart', () =>
-      this.emit('start'),
-    )
+    this._dListeners.start = DeviceEventEmitter.addListener('RNZeroconfStart', payload => {
+      if (this._isOwnEvent(payload)) {
+        this.emit('start')
+      }
+    })
 
-    this._dListeners.stop = DeviceEventEmitter.addListener('RNZeroconfStop', () =>
-      this.emit('stop'),
-    )
+    this._dListeners.stop = DeviceEventEmitter.addListener('RNZeroconfStop', payload => {
+      if (this._isOwnEvent(payload)) {
+        this.emit('stop')
+      }
+    })
 
     this._dListeners.error = DeviceEventEmitter.addListener('RNZeroconfError', err => {
-      if (this.listenerCount('error') > 0) {
-        this.emit('error', new Error(err))
+      if (this._isOwnEvent(err) && this.listenerCount('error') > 0) {
+        this.emit('error', toError(err))
       }
     })
 
     this._dListeners.found = DeviceEventEmitter.addListener('RNZeroconfFound', service => {
-      if (!service || !service.name) {
+      if (!service || !service.name || !this._isOwnEvent(service)) {
         return
       }
       const { name } = service
 
-      this._services[name] = service
+      this._services[name] = { name }
       this.emit('found', name)
       this.emit('update')
     })
 
     this._dListeners.remove = DeviceEventEmitter.addListener('RNZeroconfRemove', service => {
-      if (!service || !service.name) {
+      if (!service || !service.name || !this._isOwnEvent(service)) {
         return
       }
       const { name } = service
@@ -93,11 +166,13 @@ export default class Zeroconf extends EventEmitter {
     })
 
     this._dListeners.resolved = DeviceEventEmitter.addListener('RNZeroconfResolved', data => {
-      if (!data || !data.name) {
+      if (!data || !data.name || !this._isOwnEvent(data)) {
         return
       }
 
-      const service = withAddressFamilies(data)
+      const resolved = { ...data }
+      delete resolved.scanId
+      const service = withAddressFamilies(resolved)
       this._services[service.name] = service
       this.emit('resolved', service)
       this.emit('update')
@@ -128,6 +203,25 @@ export default class Zeroconf extends EventEmitter {
     )
   }
 
+  /**
+   * Add a listener and get a function that removes it, handy in useEffect cleanups
+   */
+  subscribe(event, listener) {
+    this.on(event, listener)
+    return () => this.removeListener(event, listener)
+  }
+
+  /**
+   * Scan events belong to the instance that started the scan. Instances that never scanned still receive
+   * every scan's events, as before multiple scans, and events without a scan id (publishing) go to everyone.
+   */
+  _isOwnEvent(payload) {
+    if (!payload || typeof payload !== 'object' || payload.scanId == null || !this._hasScanned) {
+      return true
+    }
+    return payload.scanId === this._scanId
+  }
+
   /**
    * Remove all event listeners and clean map
    */
@@ -144,21 +238,31 @@ export default class Zeroconf extends EventEmitter {
   }
 
   /**
-   * Scan for Zeroconf services,
-   * Defaults to _http._tcp. on local domain
+   * Scan for Zeroconf services, defaults to _http._tcp. on the local. domain
+   *
+   * scan({ type, protocol, domain, implType, resolveTimeout })
+   * scan(type, protocol, domain, implType) is deprecated
    */
-  scan(type = 'http', protocol = 'tcp', domain = 'local.', implType = ImplType.NSD) {
+  scan(options, protocolArg, domainArg, implTypeArg) {
+    const { type, protocol, domain, implType, resolveTimeout } = withDefaults(
+      SCAN_DEFAULTS,
+      isOptionsObject(options)
+        ? options
+        : { type: options, protocol: protocolArg, domain: domainArg, implType: implTypeArg },
+    )
+
     this._services = {}
+    this._hasScanned = true
     this.emit('update')
     if (Platform.OS === 'android') {
       if (this._scanImplType && implType !== this._scanImplType) {
-        // Only one scan runs at a time, stop the one running on the other implementation
-        RNZeroconf.stop(this._scanImplType)
+        // This instance's scan moves to the other implementation
+        RNZeroconf.stop(this._scanId, this._scanImplType)
       }
       this._scanImplType = implType
-      RNZeroconf.scan(type, protocol, domain, implType)
+      RNZeroconf.scan(this._scanId, type, protocol, domain, implType)
     } else {
-      RNZeroconf.scan(type, protocol, domain)
+      RNZeroconf.scan(this._scanId, type, protocol, domain, resolveTimeout)
     }
   }
 
@@ -168,35 +272,122 @@ export default class Zeroconf extends EventEmitter {
    */
   stop(implType = this._scanImplType || ImplType.NSD) {
     if (Platform.OS === 'android') {
-      RNZeroconf.stop(implType)
+      RNZeroconf.stop(this._scanId, implType)
     } else {
-      RNZeroconf.stop()
+      RNZeroconf.stop(this._scanId)
+    }
+  }
+
+  /**
+   * Checks the iOS Local Network permission, resolves 'granted', 'denied' or 'unknown'.
+   * Uses a service type from NSBonjourServices (the first one by default) and can show the permission prompt.
+   * Android has no equivalent permission to check and resolves 'unknown'.
+   */
+  checkLocalNetworkAccess({ type, protocol = 'tcp', timeout = 5 } = {}) {
+    if (Platform.OS === 'android') {
+      return Promise.resolve('unknown')
     }
+    const serviceType = type ? `_${type}._${protocol}` : null
+    return asPromise(RNZeroconf.checkLocalNetworkAccess(serviceType, timeout))
   }
 
   /**
-   * Publish a service
+   * Publish a service, resolves with the published service once it is advertised.
+   * Its name can differ from the requested one when that name is already taken.
+   *
+   * publishService({ type, protocol, domain, name, port, txt, implType })
+   * publishService(type, protocol, domain, name, port, txt, implType) is deprecated
    */
-  publishService(type, protocol, domain = 'local.', name, port, txt = {}, implType = ImplType.NSD) {
+  publishService(options, protocolArg, domainArg, nameArg, portArg, txtArg, implTypeArg) {
+    const { type, protocol, domain, name, port, txt, implType } = withDefaults(
+      PUBLISH_DEFAULTS,
+      isOptionsObject(options)
+        ? options
+        : {
+            type: options,
+            protocol: protocolArg,
+            domain: domainArg,
+            name: nameArg,
+            port: portArg,
+            txt: txtArg,
+            implType: implTypeArg,
+          },
+    )
     const txtRecord = toTxtPairs(txt)
     if (Platform.OS === 'android') {
       this._publishedImplTypes[name] = implType
-      RNZeroconf.registerService(type, protocol, domain, name, port, txtRecord, implType)
-    } else {
-      RNZeroconf.registerService(type, protocol, domain, name, port, txtRecord)
+      return asPromise(
+        RNZeroconf.registerService(type, protocol, domain, name, port, txtRecord, implType),
+      )
     }
+    return asPromise(RNZeroconf.registerService(type, protocol, domain, name, port, txtRecord))
   }
 
   /**
-   * Unpublish a service,
+   * Unpublish a service, resolves once it is no longer advertised.
    * Defaults to the implementation the service was published with
    */
   unpublishService(name, implType = this._publishedImplTypes[name] || ImplType.NSD) {
     if (Platform.OS === 'android') {
       delete this._publishedImplTypes[name]
-      RNZeroconf.unregisterService(name, implType)
-    } else {
-      RNZeroconf.unregisterService(name)
+      return asPromise(RNZeroconf.unregisterService(name, implType))
     }
+    return asPromise(RNZeroconf.unregisterService(name))
   }
 }
+
+/**
+ * Scans while mounted and returns the resolved services.
+ * Scans again when the options change, stops and cleans up on unmount.
+ * Each hook runs its own scan, several can run at once.
+ *
+ * const { services, isScanning, error, stop, restart } = useZeroconf({ type: 'http' })
+ */
+export function useZeroconf(options = {}) {
+  const { type, protocol, domain, implType, resolveTimeout, enabled = true } = options
+  const zeroconfRef = useRef(null)
+  const [services, setServices] = useState([])
+  const [isScanning, setIsScanning] = useState(false)
+  const [error, setError] = useState(null)
+  const [scanCount, setScanCount] = useState(0)
+
+  useEffect(() => {
+    const zeroconf = new Zeroconf()
+    zeroconfRef.current = zeroconf
+    // Found services only have a name until they are resolved
+    const updateServices = () =>
+      setServices(Object.values(zeroconf.getServices()).filter(service => service.addresses))
+    const unsubscribes = [
+      zeroconf.subscribe('start', () => setIsScanning(true)),
+      zeroconf.subscribe('stop', () => setIsScanning(false)),
+      zeroconf.subscribe('update', updateServices),
+      zeroconf.subscribe('error', setError),
+    ]
+    return () => {
+      unsubscribes.forEach(unsubscribe => unsubscribe())
+      zeroconf.stop()
+      zeroconf.removeDeviceListeners()
+      zeroconfRef.current = null
+    }
+  }, [])
+
+  useEffect(() => {
+    const zeroconf = zeroconfRef.current
+    if (!zeroconf || !enabled) {
+      return undefined
+    }
+    setServices([])
+    setError(null)
+    zeroconf.scan({ type, protocol, domain, implType, resolveTimeout })
+    return () => zeroconf.stop()
+  }, [enabled, type, protocol, domain, implType, resolveTimeout, scanCount])
+
+  const stop = useCallback(() => {
+    if (zeroconfRef.current) {
+      zeroconfRef.current.stop()
+    }
+  }, [])
+  const restart = useCallback(() => setScanCount(count => count + 1), [])
+
+  return { services, isScanning, error, stop, restart }
+}

package/android/src/main/java/com/github/druk/dnssd/DNSSDBindable.java

@@ -1,67 +0,0 @@
-/*
- * Copyright (C) 2016 Andriy Druk
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.github.druk.dnssd;
-
-import android.annotation.TargetApi;
-import android.content.Context;
-import android.os.Build;
-import android.util.Log;
-
-/**
- * RxDnssdBindable is implementation of RxDnssd with system's daemon {@link InternalDNSSD}
- */
-@TargetApi(Build.VERSION_CODES.JELLY_BEAN)
-public final class DNSSDBindable extends DNSSD {
-
-    private static final String TAG = "DNSSDBindable";
-    private final Context context;
-
-    public DNSSDBindable(Context context) {
-        super(context, "jdns_sd");
-        this.context = context.getApplicationContext();
-    }
-
-    @Override
-    public void onServiceStarting() {
-        super.onServiceStarting();
-        try {
-            context.getSystemService(Context.NSD_SERVICE);
-        }
-        catch (Exception e) {
-            Log.e(TAG, "Can't start NSD_SERVICE: ", e);
-        }
-    }
-
-    @Override
-    public void onServiceStopped() {
-        super.onServiceStopped();
-        // Not used in bindable version
-    }
-
-    /** Return the canonical name of a particular interface index.<P>
-     @param	ifIndex
-     A valid interface index. Must not be ALL_INTERFACES.
-     <P>
-     @return		The name of the interface, which should match java.net.NetworkInterface.getName().
-
-     @throws SecurityException If a security manager is present and denies <tt>RuntimePermission("getDNSSDInstance")</tt>.
-     @see    RuntimePermission
-     */
-    public String getNameForIfIndex(int ifIndex) {
-        return InternalDNSSD.getNameForIfIndex(ifIndex);
-    }
-}

package/android/src/main/java/com/github/druk/rx2dnssd/Rx2DnssdBindable.java

@@ -1,35 +0,0 @@
-/*
- * Copyright (C) 2016 Andriy Druk
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package com.github.druk.rx2dnssd;
-
-import android.annotation.TargetApi;
-import android.content.Context;
-import android.os.Build;
-
-import com.github.druk.dnssd.DNSSD;
-import com.github.druk.dnssd.DNSSDBindable;
-
-/**
- * RxDnssdBindable is implementation of RxDnssd with system's daemon {@link DNSSD}
- */
-@TargetApi(Build.VERSION_CODES.JELLY_BEAN)
-public class Rx2DnssdBindable extends Rx2DnssdCommon {
-
-    public Rx2DnssdBindable(Context context) {
-        super(new DNSSDBindable(context));
-    }
-
-}