Feat: custom ws server (#18)

* feat: custom ws server

* chore: update deps

* chore: version up

Author: bryce-seifert

actions.js

@@ -171,7 +171,7 @@ export function getActions() {
 
 		panning: {
 			name: 'Local: Set Audio Pan',
-			description: 'Sets the stereo pannning of all incoming audio streams',
+			description: 'Sets the stereo panning of all incoming audio streams',
 			options: [
 				{
 					type: 'number',

companion/manifest.json

@@ -3,7 +3,7 @@
 	"name": "vdo-ninja",
 	"shortname": "VDO.Ninja",
 	"description": "vdo-ninja",
-	"version": "2.1.0",
+	"version": "2.2.0",
 	"license": "MIT",
 	"repository": "git+https://github.com/bitfocus/companion-module-vdo-ninja.git",
 	"bugs": "https://github.com/bitfocus/companion-module-vdo-ninja/issues",

index.js

@@ -3,6 +3,7 @@ import { getActions } from './actions.js'
 import { getPresets } from './presets.js'
 import { getVariables, updateVariables } from './variables.js'
 import { getFeedbacks } from './feedbacks.js'
+import { upgradeScripts } from './upgrades.js'
 
 import WebSocket from 'ws'
 
@@ -47,11 +48,31 @@ class VDONinjaInstance extends InstanceBase {
 				label: 'API ID',
 				width: 6,
 			},
+			{
+				type: 'checkbox',
+				id: 'wsCustom',
+				label: 'Custom Websockets Server (Advanced)',
+				default: false,
+				width: 6,
+			},
+			{
+				type: 'textinput',
+				id: 'wsServer',
+				label: 'Custom Websockets Server Domain',
+				default: 'api.vdo.ninja',
+				tooltip:
+					'Only use this if you are self-hosting your own websockets server. Only include the domain, not "wss://" or port',
+				width: 6,
+				isVisible: (options) => options.wsCustom,
+			},
 		]
 	}
 
 	async configUpdated(config) {
 		this.config = config
+		if (this.reconnect) {
+			clearInterval(this.reconnect)
+		}
 		this.initWebSocket()
 	}
 
@@ -85,7 +106,12 @@ class VDONinjaInstance extends InstanceBase {
 				delete this.ws
 			}
 
-			this.ws = new WebSocket(`wss://api.vdo.ninja:443`)
+			let serverUrl = 'api.vdo.ninja'
+			if (this.config.wsCustom && this.config.wsServer) {
+				serverUrl = this.config.wsServer
+			}
+
+			this.ws = new WebSocket(`wss://${serverUrl}:443`)
 
 			this.ws.on('open', () => {
 				if (!this.connected) {
@@ -115,7 +141,7 @@ class VDONinjaInstance extends InstanceBase {
 					this.connected = false
 					this.updateStatus('connection_failure')
 					if (data?.code == 'ENOTFOUND') {
-						this.log('error', `Unable to reach api.vdo.ninja`)
+						this.log('error', `Unable to reach ${serverUrl}`)
 					} else {
 						this.log('error', `WebSocket ${data}`)
 					}
@@ -251,4 +277,4 @@ class VDONinjaInstance extends InstanceBase {
 	}
 }
 
-runEntrypoint(VDONinjaInstance, [])
+runEntrypoint(VDONinjaInstance, upgradeScripts)

package.json

@@ -1,15 +1,15 @@
 {
 	"name": "vdo-ninja",
-	"version": "2.1.0",
+	"version": "2.2.0",
 	"main": "index.js",
 	"type": "module",
 	"scripts": {
 		"format": "prettier -w ."
 	},
 	"license": "MIT",
 	"dependencies": {
-		"@companion-module/base": "~1.5.1",
-		"ws": "^8.14.2"
+		"@companion-module/base": "~1.6.0",
+		"ws": "^8.15.1"
 	},
 	"repository": {
 		"type": "git",

upgrades.js

@@ -0,0 +1,19 @@
+export const upgradeScripts = [
+	function (context, props) {
+		//customWebsocketsConfig
+		let changed = {
+			updatedConfig: null,
+			updatedActions: [],
+			updatedFeedbacks: [],
+		}
+		if (props.config !== null) {
+			let config = props.config
+			if (config.wsCustom == undefined || config.wsCustom == null) {
+				config.wsCustom = false
+				config.wsServer = 'api.vdo.ninja'
+				changed.updatedConfig = config
+			}
+		}
+		return changed
+	},
+]

yarn.lock

@@ -7,14 +7,15 @@
   resolved "https://registry.yarnpkg.com/@aashutoshrathi/word-wrap/-/word-wrap-1.2.6.tgz#bd9154aec9983f77b3a034ecaa015c2e4201f6cf"
   integrity sha512-1Yjs2SvM8TflER/OD3cOjhWWOZb58A2t7wpE2S9XfBYTiIl+XFhQG2bjy4Pu1I+EAlCNUzRDYDdFwFYUKvXcIA==
 
-"@companion-module/base@~1.5.1":
-  version "1.5.1"
-  resolved "https://registry.yarnpkg.com/@companion-module/base/-/base-1.5.1.tgz#20612ba8adbe04ed2220ded9acb99c4cd877c304"
-  integrity sha512-gpUtE7121CuPJkZMEoqh1GU6QwDoqmj4WvjI/fqyeTrqejKcKz/oSgMxSMeh7T1Gf02a5OOTpJ+aYWBlNB0BKw==
+"@companion-module/base@~1.6.0":
+  version "1.6.0"
+  resolved "https://registry.yarnpkg.com/@companion-module/base/-/base-1.6.0.tgz#1caa1b310855a757a0a55eb4b1f1b301f37615e3"
+  integrity sha512-KnsgHtgmB36t2wlBSYyRgw4eSrm6rJXoBWClBURfssk9OgochaJtWwPLuA/SgjLAxPOnTTNt4PvHgzcVv6MjYg==
   dependencies:
     "@sentry/node" "^7.63.0"
     "@sentry/tracing" "^7.63.0"
     ajv "^8.12.0"
+    colord "^2.9.3"
     ejson "^2.2.3"
     eventemitter3 "^4.0.7"
     mimic-fn "^3.0.0"
@@ -711,6 +712,11 @@ color-name@~1.1.4:
   resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2"
   integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==
 
+colord@^2.9.3:
+  version "2.9.3"
+  resolved "https://registry.yarnpkg.com/colord/-/colord-2.9.3.tgz#4f8ce919de456f1d5c1c368c307fe20f3e59fb43"
+  integrity sha512-jeC1axXpnb0/2nn/Y1LPuLdgXBLH7aDcHu4KEKfqw3CUhX7ZpfBSlPKyqXE6btIgEzfWtrX3/tyBCaCvXvMkOw==
+
 colorette@^2.0.14:
   version "2.0.19"
   resolved "https://registry.yarnpkg.com/colorette/-/colorette-2.0.19.tgz#cdf044f47ad41a0f4b56b3a0d5b4e6e1a2d5a798"
@@ -2178,10 +2184,10 @@ wrappy@1:
   resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f"
   integrity sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==
 
-ws@^8.14.2:
-  version "8.14.2"
-  resolved "https://registry.yarnpkg.com/ws/-/ws-8.14.2.tgz#6c249a806eb2db7a20d26d51e7709eab7b2e6c7f"
-  integrity sha512-wEBG1ftX4jcglPxgFCMJmZ2PLtSbJ2Peg6TmpJFTbe9GZYOQCDPdMYu/Tm0/bGZkw8paZnJY45J4K2PZrLYq8g==
+ws@^8.15.1:
+  version "8.15.1"
+  resolved "https://registry.yarnpkg.com/ws/-/ws-8.15.1.tgz#271ba33a45ca0cc477940f7f200cd7fba7ee1997"
+  integrity sha512-W5OZiCjXEmk0yZ66ZN82beM5Sz7l7coYxpRkzS+p9PP+ToQry8szKh+61eNktr7EA9DOwvFGhfC605jDHbP6QQ==
 
 yallist@^4.0.0:
   version "4.0.0"