fix: avoid some conversions of received variables, to minimise cpu cost #3257

Author: Julusian

companion/lib/Graphics/Controller.ts

@@ -34,7 +34,7 @@ import LogController from '../Log/Controller.js'
 import type { DataUserConfig } from '../Data/UserConfig.js'
 import type { PageController } from '../Page/Controller.js'
 import type { ControlsController } from '../Controls/Controller.js'
-import type { VariablesValues } from '../Variables/Values.js'
+import type { VariablesValues, VariableValueEntry } from '../Variables/Values.js'
 
 const CRASHED_WORKER_RETRY_COUNT = 10
 
@@ -117,7 +117,14 @@ export class GraphicsController extends EventEmitter<GraphicsControllerEvents> {
 			const values = this.#pendingVariables
 			if (values) {
 				this.#pendingVariables = null
-				this.#variableValuesController.setVariableValues('internal', values)
+
+				// This isn't ideal, but ensures we don't report duplicate changes
+				const valuesArr: VariableValueEntry[] = Object.entries(values).map(([id, value]) => ({
+					id,
+					value,
+				}))
+
+				this.#variableValuesController.setVariableValues('internal', valuesArr)
 			}
 		},
 		{

companion/lib/Instance/Wrapper.ts

@@ -35,7 +35,6 @@ import {
 	type CompanionHTTPRequest,
 	type CompanionInputFieldBase,
 	type CompanionOptionValues,
-	type CompanionVariableValue,
 	type LogLevel,
 } from '@companion-module/base'
 import type { ControlLocation } from '@companion-app/shared/Model/Common.js'
@@ -702,12 +701,7 @@ export class SocketEventsHandler {
 	async #handleSetVariableValues(msg: SetVariableValuesMessage): Promise<void> {
 		if (!this.#label) throw new Error(`Got call to handleSetVariableValues before init was called`)
 
-		const variables: Record<string, CompanionVariableValue | undefined> = {}
-		for (const variable of msg.newValues) {
-			variables[variable.id] = variable.value
-		}
-
-		this.#deps.variables.values.setVariableValues(this.#label, variables)
+		this.#deps.variables.values.setVariableValues(this.#label, msg.newValues)
 	}
 
 	/**
@@ -738,12 +732,7 @@ export class SocketEventsHandler {
 		this.#deps.variables.definitions.setVariableDefinitions(this.#label, newVariables)
 
 		if (msg.newValues) {
-			const variables: Record<string, CompanionVariableValue | undefined> = {}
-			for (const variable of msg.newValues) {
-				variables[variable.id] = variable.value
-			}
-
-			this.#deps.variables.values.setVariableValues(this.#label, variables)
+			this.#deps.variables.values.setVariableValues(this.#label, msg.newValues)
 		}
 
 		if (invalidIds.length > 0) {

companion/lib/Internal/Controller.ts

@@ -46,6 +46,7 @@ import { assertNever } from '@companion-app/shared/Util.js'
 import { ClientEntityDefinition } from '@companion-app/shared/Model/EntityDefinitionModel.js'
 import { Complete } from '@companion-module/base/dist/util.js'
 import { InternalSystem } from './System.js'
+import type { VariableValueEntry } from '../Variables/Values.js'
 
 export class InternalController {
 	readonly #logger = LogController.createLogger('Internal/Controller')
@@ -388,7 +389,13 @@ export class InternalController {
 	setVariables(variables: Record<string, CompanionVariableValue | undefined>): void {
 		if (!this.#initialized) throw new Error(`InternalController is not initialized`)
 
-		this.#variablesController.values.setVariableValues('internal', variables)
+		// This isn't ideal, but it's cheap enough and avoids updating the calling code
+		const valuesArr: VariableValueEntry[] = Object.entries(variables).map(([id, value]) => ({
+			id,
+			value,
+		}))
+
+		this.#variablesController.values.setVariableValues('internal', valuesArr)
 	}
 	/**
 	 * Recheck all feedbacks of specified types

companion/lib/Surface/Handler.ts

@@ -575,9 +575,7 @@ export class SurfaceHandler extends EventEmitter<SurfaceHandlerEvents> {
 	 * Set the value of a variable
 	 */
 	#onSetVariable(name: string, value: CompanionVariableValue): void {
-		this.#variables.values.setVariableValues('internal', {
-			[name]: value,
-		})
+		this.#variables.values.setVariableValues('internal', [{ id: name, value: value }])
 	}
 
 	/**

companion/lib/Variables/CustomVariable.ts

@@ -17,7 +17,7 @@
 
 import LogController from '../Log/Controller.js'
 import { isCustomVariableValid } from '@companion-app/shared/CustomVariable.js'
-import type { VariablesValues } from './Values.js'
+import type { VariablesValues, VariableValueEntry } from './Values.js'
 import type {
 	CustomVariablesModel,
 	CustomVariableUpdate,
@@ -174,9 +174,9 @@ export class VariablesCustomVariable {
 	init(): void {
 		// Load the startup values of custom variables
 		if (Object.keys(this.#custom_variables).length > 0) {
-			const newValues: Record<string, CompanionVariableValue> = {}
+			const newValues: VariableValueEntry[] = []
 			for (const [name, info] of Object.entries(this.#custom_variables)) {
-				newValues[name] = info.defaultValue || ''
+				newValues.push({ id: name, value: info.defaultValue || '' })
 			}
 			this.#variableValues.setVariableValues(CUSTOM_LABEL, newValues)
 		}
@@ -186,14 +186,14 @@ export class VariablesCustomVariable {
 	 * Replace all of the current custom variables with new ones
 	 */
 	replaceDefinitions(custom_variables: CustomVariablesModel): void {
-		const newValues: Record<string, CompanionVariableValue | undefined> = {}
+		const newValues: VariableValueEntry[] = []
 		// Mark the current variables as to be deleted
 		for (const name of Object.keys(this.#custom_variables || {})) {
-			newValues[name] = undefined
+			newValues.push({ id: name, value: undefined })
 		}
 		// Determine the initial values of the variables
 		for (const [name, info] of Object.entries(custom_variables || {})) {
-			newValues[name] = info.defaultValue || ''
+			newValues.push({ id: name, value: info.defaultValue || '' })
 		}
 
 		const namesBefore = Object.keys(this.#custom_variables)
@@ -358,9 +358,7 @@ export class VariablesCustomVariable {
 	 * Helper for setting the value of a custom variable
 	 */
 	#setValueInner(name: string, value: CompanionVariableValue | undefined): void {
-		this.#variableValues.setVariableValues(CUSTOM_LABEL, {
-			[name]: value,
-		})
+		this.#variableValues.setVariableValues(CUSTOM_LABEL, [{ id: name, value: value }])
 
 		this.#persistCustomVariableValue(name, value)
 	}

companion/lib/Variables/Values.ts

@@ -140,25 +140,22 @@ export class VariablesValues extends EventEmitter<VariablesValuesEvents> {
 		})
 	}
 
-	setVariableValues(label: string, variables: Record<string, CompanionVariableValue | undefined>): void {
+	setVariableValues(label: string, variables: VariableValueEntry[]): void {
 		const moduleValues = this.#variableValues[label] ?? {}
 		this.#variableValues[label] = moduleValues
 
 		const all_changed_variables_set = new Set<string>()
-		for (const variable in variables) {
-			// Note: explicitly using for-in here, as Object.entries is slow
-			const value = variables[variable]
+		for (const variable of variables) {
+			if (moduleValues[variable.id] !== variable.value) {
+				moduleValues[variable.id] = variable.value
 
-			if (moduleValues[variable] !== value) {
-				moduleValues[variable] = value
-
-				all_changed_variables_set.add(`${label}:${variable}`)
+				all_changed_variables_set.add(`${label}:${variable.id}`)
 				// Also report the old custom variable names as having changed
-				if (label === 'custom') all_changed_variables_set.add(`internal:custom_${variable}`)
+				if (label === 'custom') all_changed_variables_set.add(`internal:custom_${variable.id}`)
 
 				// Skip debug if it's just internal:time_* spamming.
-				if (this.#logger.isSillyEnabled() && !(label === 'internal' && variable.startsWith('time_'))) {
-					this.#logger.silly('Variable $(' + label + ':' + variable + ') is "' + value + '"')
+				if (this.#logger.isSillyEnabled() && !(label === 'internal' && variable.id.startsWith('time_'))) {
+					this.#logger.silly('Variable $(' + label + ':' + variable.id + ') is "' + variable.value + '"')
 				}
 			}
 		}
@@ -192,3 +189,8 @@ export class VariablesValues extends EventEmitter<VariablesValuesEvents> {
 		}
 	}
 }
+
+export interface VariableValueEntry {
+	id: string
+	value: CompanionVariableValue | undefined
+}