mdns vs bonjour hopefully last iteration

.github/workflows/test.yml

@@ -14,9 +14,5 @@ jobs:
           node-version: 20
       - name: Install Dependencies
         run: make install
-      - name: Run Hub tests
-        run: make testhub
-      - name: Run Service tests
-        run: make testservice
-      - name: Run Client tests
-        run: make testclient
+      - name: Run tests
+        run: make test

client/src/index.ts

@@ -79,7 +79,13 @@ export class NestorClient {
   }
 
   start(): void {
-
+
+    // we use bonjour-service and not mdns
+    // as mdns has platform dependencies
+    // which makes it painful to embed in electron
+    // and it seems to be fine enough for a client
+    // despite seeming to be not as good as mdns
+
     // now start the browser
     const bonjour = new Bonjour()
     this.browser = bonjour.find({ type: 'nestor' })

hub/package.json

@@ -22,7 +22,6 @@
   "dependencies": {
     "@sindresorhus/slugify": "^2.2.1",
     "body-parser": "^1.20.3",
-    "bonjour-service": "^1.2.1",
     "commander": "^12.1.0",
     "config": "^3.3.12",
     "cors": "^2.8.5",

hub/src/server.ts

@@ -1,8 +1,7 @@
 
 import express, { Express } from 'express'
-import { Service } from 'bonjour-service'
 import bodyParser from 'body-parser'
-import * as mdns from 'mdns'
+import mdns from 'mdns'
 import helmet from 'helmet'
 import morgan from 'morgan'
 import cors from 'cors'
@@ -20,11 +19,11 @@ import DiscoveryService from './services/discovery'
 // start discovery immediately
 const serviceDirectory = new ServiceDirectory()
 const discoveryService = new DiscoveryService()
-discoveryService.start((service: Service) => {
-  if (service.name && (service.subtypes?.includes('service') || service.txt.type === 'service')) {
-    serviceDirectory.add(service.name, service.host, service.port, service.txt.path)
+discoveryService.start((service: mdns.Service) => {
+  if (service.name && (/*service.subtypes?.includes('service') || */service.txtRecord.type === 'service')) {
+    serviceDirectory.add(service.name, service.host, service.port, service.txtRecord.path)
   }
-}, (service: Service) => {
+}, (service: mdns.Service) => {
   if (service.name) {
     serviceDirectory.remove(service.name)
   }
@@ -94,9 +93,6 @@ process.on('SIGINT', async () => {
 // publish
 const publish = (name: string, port: number) => {
 
-  // we use mdns instead of bonjour-service here 
-  // https://github.com/onlxltd/bonjour-service/issues/46
-
   // subtype is not consistently supported so using txtRecord too
   ad = mdns.createAdvertisement(mdns.tcp('nestor', 'hub'), port, {
     name: name,

hub/src/services/discovery.ts

@@ -1,21 +1,25 @@
 
-import { Bonjour, Browser, Service } from 'bonjour-service'
+import mdns from 'mdns'
 
 export default class DiscoveryService {
 
-  bonjour!: Bonjour
-  browser?: Browser
+  browser!: mdns.Browser
 
   start(onUp: CallableFunction, onDown: CallableFunction) {
-    this.bonjour = new Bonjour()
-    this.browser = this.bonjour.find({ type: 'nestor' })
-    this.browser.on('up', (service: Service) => {
+
+    // getaddr fails: https://stackoverflow.com/questions/29589543/raspberry-pi-mdns-getaddrinfo-3008-error
+    this.browser = mdns.createBrowser(mdns.tcp('nestor'), { resolverSequence: [
+      mdns.rst.DNSServiceResolve(),
+      'DNSServiceGetAddrInfo' in mdns.dns_sd ? mdns.rst.DNSServiceGetAddrInfo() : mdns.rst.getaddrinfo({families:[4]}),
+      mdns.rst.makeAddressesUnique()
+    ]})
+    this.browser.on('serviceUp', (service: mdns.Service) => {
       onUp(service)
     })
-    this.browser.on('down', (service: Service) => {
+    this.browser.on('serviceDown', (service: mdns.Service) => {
       onDown(service)
-    })
-    this.browser.start()
+    });
+    this.browser.start();
 
   }
 

hub/tests/unit/discovery.test.ts

@@ -1,22 +1,18 @@
 
 import { vi, test, expect } from 'vitest'
 import ServiceDiscovery from '../../src/services/discovery'
-import { Bonjour } from 'bonjour-service'
+import mdns from 'mdns'
 
-//const spyCreateBrowser = vi.spyOn(Bonjour(), 'find')
+const spyCreateBrowser = vi.spyOn(mdns, 'createBrowser')
 
 class ServiceMock {
   ad: any
 
   // subtype is not consistently supported so using txt.type too
   start(port: number) {
-    const bonjour = new Bonjour()
-    this.ad = bonjour.publish({
+    this.ad = mdns.createAdvertisement(mdns.tcp('nestor', 'service'), port, {
       name: 'service-test-1',
-      type: 'nestor',
-      subtypes: [ 'service' ],
-      port: port,
-      txt: {
+      txtRecord: {
         type: 'service',
       }
     })
@@ -30,7 +26,7 @@ class ServiceMock {
 test('creates browser', async () => {
   const discovery = new ServiceDiscovery()
   discovery.start(() => {}, () => {})
-  //expect(spyCreateBrowser).toHaveBeenCalled()
+  expect(spyCreateBrowser).toHaveBeenCalled()
 })
 
 test('calls callbacks', async () => {

service/src/index.ts

@@ -1,5 +1,5 @@
 
-import * as mdns from 'mdns'
+import mdns from 'mdns'
 
 export interface NestorServiceOptions {
   autostart?: boolean
@@ -43,9 +43,6 @@ export class NestorService {
 
   start(): void {
 
-    // we use mdns instead of bonjour-service here 
-    // https://github.com/onlxltd/bonjour-service/issues/46
-
     // subtype is not consistently supported so using txtRecord too
     this.advertise = mdns.createAdvertisement(mdns.tcp('nestor', 'service'), this.port, {
       name: this.name,

service/tests/service.test.ts

@@ -1,7 +1,7 @@
 
 import { vi, test, expect } from 'vitest'
 import { NestorService } from '../src/index'
-import * as mdns from 'mdns'
+import mdns from 'mdns'
 
 global.fetch = vi.fn((req) => {
   if (req.includes('3000'))  return { ok: true }