-
-
Notifications
You must be signed in to change notification settings - Fork 486
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Loading branch information
Showing
10 changed files
with
397 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,184 @@ | ||
| import { isEqual } from 'lodash-es' | ||
| import ServiceBase from './Base.js' | ||
| import { Bonjour, Browser } from 'bonjour-service' | ||
| import { nanoid } from 'nanoid' | ||
|
|
||
| function BonjourRoom(id) { | ||
| return `bonjour:${id}` | ||
| } | ||
|
|
||
| /** | ||
| * Class providing Bonjour discovery for modules. | ||
| * | ||
| * @extends ServiceBonjour | ||
| * @author Håkon Nessjøen <haakon@bitfocus.io> | ||
| * @author Keith Rocheck <keith.rocheck@gmail.com> | ||
| * @author William Viker <william@bitfocus.io> | ||
| * @author Julian Waller <me@julusian.co.uk> | ||
| * @since 1.2.0 | ||
| * @copyright 2022 Bitfocus AS | ||
| * @license | ||
| * This program is free software. | ||
| * You should have received a copy of the MIT licence as well as the Bitfocus | ||
| * Individual Contributor License Agreement for Companion along with | ||
| * this program. | ||
| * | ||
| * You can be released from the requirements of the license by purchasing | ||
| * a commercial license. Buying such a license is mandatory as soon as you | ||
| * develop commercial activities involving the Companion software without | ||
| * disclosing the source code of your own applications. | ||
| */ | ||
| class ServiceBonjourDiscovery extends ServiceBase { | ||
| /** | ||
| * Active browsers running | ||
| */ | ||
| #browsers = new Map() | ||
|
|
||
| /** | ||
| * @param {Registry} registry - the application core | ||
| */ | ||
| constructor(registry) { | ||
| super(registry, 'bonjour-discovery', 'Service/BonjourDiscovery', undefined, undefined) | ||
|
|
||
| this.init() | ||
| } | ||
|
|
||
| /** | ||
| * Start the service if it is not already running | ||
| * @access protected | ||
| */ | ||
| listen() { | ||
| if (this.server === undefined) { | ||
| try { | ||
| this.server = new Bonjour() | ||
|
|
||
| this.logger.info('Listening for Bonjour messages') | ||
| } catch (e) { | ||
| this.logger.error(`Could not launch: ${e.message}`) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Close the socket before deleting it | ||
| * @access protected | ||
| */ | ||
| close() { | ||
| this.server.destroy() | ||
| } | ||
|
|
||
| /** | ||
| * Setup a new socket client's events | ||
| * @param {SocketIO} client - the client socket | ||
| * @access public | ||
| */ | ||
| clientConnect(client) { | ||
| client.on('disconnect', () => { | ||
| // Ensure any sessions the client was part of are cleaned up | ||
| for (const subId of this.#browsers.keys()) { | ||
| this.#removeClientFromSession(client.id, subId) | ||
| } | ||
| }) | ||
|
|
||
| client.onPromise('bonjour:subscribe', (connectionId, queryId) => | ||
| this.#joinOrCreateSession(client, connectionId, queryId) | ||
| ) | ||
| client.on('bonjour:unsubscribe', (subId) => this.#leaveSession(client, subId)) | ||
| } | ||
|
|
||
| #convertService(id, svc) { | ||
| return { | ||
| subId: id, | ||
| fqdn: svc.fqdn, | ||
| name: svc.name, | ||
| port: svc.port, | ||
| // type: svc.type, | ||
| // protocol: svc.protocol, | ||
| // txt: svc.txt, | ||
| // host: svc.host, | ||
| addresses: svc.addresses, | ||
| } | ||
| } | ||
|
|
||
| #joinOrCreateSession(client, connectionId, queryId) { | ||
| const manifest = this.instance.getManifestForInstance(connectionId) | ||
| const bonjourQuery = manifest?.bonjourQueries?.[queryId] | ||
| if (!bonjourQuery) throw new Error('Missing bonjour query') | ||
|
|
||
| const filter = { | ||
| type: bonjourQuery.type, | ||
| protocol: bonjourQuery.protocol, | ||
| txt: bonjourQuery.txt, | ||
| } | ||
| if (typeof filter.type !== 'string' || !filter.type) throw new Error('Invalid type for bonjour query') | ||
| if (typeof filter.protocol !== 'string' || !filter.protocol) throw new Error('Invalid protocol for bonjour query') | ||
|
|
||
| // Find existing browser | ||
| for (const [id, session] of this.#browsers.entries()) { | ||
| if (isEqual(session.filter, filter)) { | ||
| session.clientIds.add(client.id) | ||
|
|
||
| client.join(BonjourRoom(id)) | ||
| this.logger.info(`Client ${client.id} joined ${id}`) | ||
|
|
||
| // After this message, send already known services to the client | ||
| setImmediate(() => { | ||
| for (const svc of session.browser.services) { | ||
| client.emit(`bonjour:service:up`, this.#convertService(id, svc)) | ||
| } | ||
| }) | ||
|
|
||
| return id | ||
| } | ||
| } | ||
|
|
||
| // Create new browser | ||
| this.logger.info(`Starting discovery of: ${JSON.stringify(filter)}`) | ||
| const browser = this.server.find(filter) | ||
| const id = nanoid() | ||
| const room = BonjourRoom(id) | ||
| this.#browsers.set(id, { | ||
| browser, | ||
| filter, | ||
| clientIds: new Set([client.id]), | ||
| }) | ||
|
|
||
| // Setup event handlers | ||
| browser.on('up', (svc) => { | ||
| this.io.emitToRoom(room, `bonjour:service:up`, this.#convertService(id, svc)) | ||
| }) | ||
| browser.on('down', (svc) => { | ||
| this.io.emitToRoom(room, `bonjour:service:down`, this.#convertService(id, svc)) | ||
| }) | ||
|
|
||
| // Report to client | ||
| client.join(room) | ||
| this.logger.info(`Client ${client.id} joined ${id}`) | ||
| return id | ||
| } | ||
|
|
||
| #leaveSession(client, subId) { | ||
| this.logger.info(`Client ${client.id} left ${subId}`) | ||
| client.leave(BonjourRoom(subId)) | ||
|
|
||
| this.#removeClientFromSession(client.id, subId) | ||
| } | ||
|
|
||
| #removeClientFromSession(clientId, subId) { | ||
| const session = this.#browsers.get(subId) | ||
| if (!session || !session.clientIds.delete(clientId)) return | ||
|
|
||
| // Cleanup after a timeout, as restarting the same query immediately causes it to fail | ||
| setTimeout(() => { | ||
| if (this.#browsers.has(subId) && session.clientIds.size === 0) { | ||
| this.logger.info(`Stopping discovery of: ${JSON.stringify(session.filter)}`) | ||
|
|
||
| this.#browsers.delete(subId) | ||
|
|
||
| session.browser.stop() | ||
| } | ||
| }, 500) | ||
| } | ||
| } | ||
|
|
||
| export default ServiceBonjourDiscovery |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.