Merge pull request #15 from phillipivan/main

v1.1.4

Author: phillipivan

Diff for: .gitignore

@@ -8,4 +8,5 @@ package-lock.json
 *.log
 *.npa
 *.bak
-DEBUG-*
+DEBUG-*
+peavy-ratc-*.tgz

Diff for: companion/HELP.md

@@ -49,7 +49,11 @@ The Action Recorder will translate any recieved numeric valueIs messages into Co
 
 ## Version History
 
-### Version 1.1.2
+### Version 1.1.4
+
+- Better sanitising of variable Ids
+
+### Version 1.1.3
 
 - Parse local variables
 

Diff for: package.json

@@ -1,6 +1,6 @@
 {
 	"name": "peavy-ratc",
-	"version": "1.1.3",
+	"version": "1.1.4",
 	"main": "src/main.js",
 	"type": "module",
 	"scripts": {
@@ -19,13 +19,13 @@
 		"@companion-module/base": "~1.11.3"
 	},
 	"devDependencies": {
-		"@companion-module/tools": "^2.1.1",
-		"eslint": "^9.21.0",
+		"@companion-module/tools": "^2.2.3",
+		"eslint": "^9.24.0",
 		"prettier": "^3.5.3"
 	},
 	"engines": {
 		"node": "^22.13"
 	},
 	"prettier": "@companion-module/tools/.prettierrc.json",
-	"packageManager": "yarn@4.7.0"
+	"packageManager": "yarn@4.8.1"
 }

Diff for: src/processcmd.js

@@ -1,6 +1,15 @@
 import { resp, cmd, alert, aliasSep, paramSep, rawAliasIdent } from './consts.js'
 import { InstanceStatus } from '@companion-module/base'
 
+/**
+ * Remove illegal characters from variable Ids
+ * @param {string} id variable id to sanitize
+ * @param {'' | '.' | '-' | '_'} substitute Char to replace illegal characters
+ * @since 1.1.4
+ */
+
+const sanitiseVariableId = (id, substitute = '_') => id.replaceAll(/[^a-zA-Z0-9-_.]/gm, substitute)
+
 export function actionUpdate() {
 	if (this.actionTimer) {
 		clearTimeout(this.actionTimer)
@@ -45,7 +54,7 @@ export async function processCmd(chunk) {
 				return true
 			}
 		}
-		let newAlias = alias[1].replaceAll(/\/| /g, '_')
+		let newAlias = sanitiseVariableId(alias[1])
 		this.controlAliases.push({ id: alias[1], label: alias[1] })
 		this.varList.push(
 			{ variableId: `controlAliasName_${newAlias}`, name: `Control Alias Name ${newAlias}` },
@@ -80,14 +89,14 @@ export async function processCmd(chunk) {
 	}
 	switch (params[0]) {
 		case resp.ratcV1.username:
-			//this.sendCommand(this.config.username) - doing this will get stuck in a loop if user/pass is incorrect.
+			//await this.sendCommand(this.config.username) - doing this will get stuck in a loop if user/pass is incorrect.
 			if (this.config.v2) {
 				this.updateStatus(InstanceStatus.BadConfig, 'Device in RATCv1 mode')
 				this.log('error', `Device in RATCv1 mode`)
 			}
 			break
 		case resp.ratcV1.password:
-			//this.sendCommand(this.config.password)
+			//await this.sendCommand(this.config.password)
 			break
 		case resp.ratcV1.ratcVersion:
 			this.log('info', `${reply}`)
@@ -134,7 +143,7 @@ export async function processCmd(chunk) {
 						)
 				}
 			}
-			aliases[1] = aliases[1].replaceAll(/\/| /g, '_')
+			aliases[1] = sanitiseVariableId(aliases[1])
 			this.log('debug', `control data for alias: ${aliases[1]} value: ${valPos[0]} position: ${valPos[1]}`)
 			aliasValues[`controlAliasValue_${aliases[1]}`] = valPos[0]
 			if (this.config.v2) {
@@ -181,7 +190,7 @@ export async function processCmd(chunk) {
 			this.log('debug', `${reply}`)
 			this.log('debug', `params: ${params.toString()}`)
 			if (params[1] == resp.ratcV1.aliasControlGroupList) {
-				alias[0] = alias[1].replaceAll(/\/| /g, '_')
+				alias[0] = sanitiseVariableId(alias[1])
 				this.controlAliases.push({ id: alias[1], label: alias[1] })
 				this.varList.push(
 					{ variableId: `controlAliasName_${alias[0]}`, name: `Control Alias Name ${alias[0]}` },
@@ -291,7 +300,7 @@ export async function processCmd(chunk) {
 		case resp.ratcV2.notLoggedIn:
 			this.log('error', `${reply}`)
 			this.updateStatus(InstanceStatus.BadConfig, `${reply}`)
-			this.sendCommand(cmd.ratcV2.logIn + paramSep + this.config.username + paramSep + this.config.password)
+			await this.sendCommand(cmd.ratcV2.logIn + paramSep + this.config.username + paramSep + this.config.password)
 			break
 		case resp.ratcV2.loginFailed:
 			this.log('error', 'Username / Password is incorrect')

Diff for: src/tcp.js

@@ -48,12 +48,11 @@ export function stopCmdQueue() {
 	}
 }
 
-export function sendCommand(msg) {
+export async function sendCommand(msg) {
 	if (msg !== undefined) {
 		if (this.socket !== undefined && this.socket.isConnected) {
 			//this.log('debug', `Sending Command: ${msg}`)
-			this.socket.send(msg + EOM)
-			return true
+			return await this.socket.send(msg + EOM)
 		} else {
 			this.log('warn', `Socket not connected, tried to send: ${msg}`)
 		}
@@ -64,23 +63,23 @@ export function sendCommand(msg) {
 }
 
 //queries made on initial connection.
-export function queryOnConnect() {
+export async function queryOnConnect() {
 	if (this.config.v2) {
 		let msg =
 			this.config.username === ''
 				? ''
 				: this.config.password === ''
 					? paramSep + this.config.username
 					: paramSep + this.config.username + paramSep + this.config.password
-		this.sendCommand(cmd.ratcV2.logIn + msg)
+		await this.sendCommand(cmd.ratcV2.logIn + msg)
 		this.addCmdtoQueue(cmd.ratcV2.statusGet)
 		this.addCmdtoQueue(cmd.ratcV2.keepAlive + paramSep + keepAliveValue)
 		this.addCmdtoQueue(cmd.ratcV2.quietModeDisable)
 		this.addCmdtoQueue(cmd.ratcV2.controlList)
 		this.addCmdtoQueue(cmd.ratcV2.changeGroupSchedule + paramSep + groupSubscribeInterval)
 	} else {
-		this.sendCommand(this.config.username)
-		this.sendCommand(this.config.password)
+		await this.sendCommand(this.config.username)
+		await this.sendCommand(this.config.password)
 	}
 }
 
@@ -174,11 +173,11 @@ export function initTCP() {
 			this.startTimeOut()
 			this.stopActionUpdateTimer()
 		})
-		this.socket.on('connect', () => {
+		this.socket.on('connect', async () => {
 			this.log('info', `Connected to ${this.config.host}:${this.config.port}`)
 			this.updateStatus(InstanceStatus.Connecting, `Logging In`)
 			this.receiveBuffer = ''
-			this.queryOnConnect()
+			await this.queryOnConnect()
 		})
 		this.socket.on('data', (chunk) => {
 			let i = 0,