feat: warn about usage of removed properties

Author: Julusian

packages/companion-module-host/src/internal/actions.ts

@@ -9,6 +9,7 @@ import {
 } from '@companion-module/base'
 import type { ActionInstance, HostActionDefinition } from '../context.js'
 import { ExecuteActionResult } from '../instance.js'
+import { hasAnyOldIsVisibleFunctions } from './util.js'
 
 function convertActionInstanceToEvent(action: ActionInstance): CompanionActionInfo {
 	return {
@@ -169,25 +170,58 @@ export class ActionManager {
 
 		this.#actionDefinitions.clear()
 
-		for (const [actionId, action] of Object.entries(actions)) {
-			if (action) {
-				hostActions.push({
-					id: actionId,
-					name: action.name,
-					description: action.description,
-					options: action.options,
-					optionsToMonitorForSubscribe: action.optionsToMonitorForSubscribe,
-					hasLearn: !!action.learn,
-					learnTimeout: action.learnTimeout,
-					hasLifecycleFunctions: !!action.subscribe || !!action.unsubscribe,
-				})
+		const definitionsWantingOptionsToMonitor: string[] = []
+		const definitionsWithOptionsToIgnore: string[] = []
+		const definitionsWithOldIsVisible: string[] = []
 
-				// Remember the definition locally
-				this.#actionDefinitions.set(actionId, action)
-			}
+		for (const [actionId, action] of Object.entries(actions)) {
+			if (!action) continue
+
+			const hasSubscriptionMethods = !!action.subscribe || !!action.unsubscribe
+
+			hostActions.push({
+				id: actionId,
+				name: action.name,
+				description: action.description,
+				options: action.options,
+				optionsToMonitorForSubscribe: action.optionsToMonitorForSubscribe,
+				hasLearn: !!action.learn,
+				learnTimeout: action.learnTimeout,
+				hasLifecycleFunctions: hasSubscriptionMethods,
+			})
+
+			// Remember the definition locally
+			this.#actionDefinitions.set(actionId, action)
+
+			// Check for old removed properties
+			if (hasSubscriptionMethods && !action.optionsToMonitorForSubscribe) definitionsWithOptionsToIgnore.push(actionId)
+			if ('optionsToIgnoreForSubscribe' in action) definitionsWithOptionsToIgnore.push(actionId)
+			if (hasAnyOldIsVisibleFunctions(action.options)) definitionsWithOldIsVisible.push(actionId)
 		}
 
 		this.#setActionDefinitions(hostActions)
+
+		if (definitionsWantingOptionsToMonitor.length > 0) {
+			this.#logger.warn(
+				`Some actions definitions have a subscribe or unsubscribe method without a optionsToMonitorForSubscribe property. This is not recommended and will cause more calls of those methods than is necessary.\nThe affected actions are: ${definitionsWantingOptionsToMonitor
+					.sort()
+					.join(', ')}`,
+			)
+		}
+		if (definitionsWantingOptionsToMonitor.length > 0) {
+			this.#logger.warn(
+				`The following action definitions have a removed optionsToIgnoreForSubscribe property. Please use optionsToMonitorForSubscribe instead: ${definitionsWithOptionsToIgnore
+					.sort()
+					.join(', ')}`,
+			)
+		}
+		if (definitionsWithOldIsVisible.length > 0) {
+			this.#logger.warn(
+				`The following action definitions have options with the old isVisible functions. These should be replaced with isVisibleExpression to continue to operate. The definitions: ${definitionsWithOldIsVisible
+					.sort()
+					.join(', ')}`,
+			)
+		}
 	}
 
 	subscribeActions(actionIds: string[]): void {

packages/companion-module-host/src/internal/feedback.ts

@@ -11,6 +11,7 @@ import {
 } from '@companion-module/base'
 import debounceFn from 'debounce-fn'
 import type { FeedbackInstance, HostFeedbackDefinition, HostFeedbackValue } from '../context.js'
+import { hasAnyOldIsVisibleFunctions } from './util.js'
 
 function convertFeedbackInstanceToEvent(
 	type: 'boolean' | 'value' | 'advanced',
@@ -257,26 +258,49 @@ export class FeedbackManager {
 
 		this.#feedbackDefinitions.clear()
 
+		const definitionsWithSubscribeMethod: string[] = []
+		const definitionsWithOldIsVisible: string[] = []
+
 		for (const [feedbackId, feedback] of Object.entries(feedbacks)) {
-			if (feedback) {
-				hostFeedbacks.push({
-					id: feedbackId,
-					name: feedback.name,
-					description: feedback.description,
-					options: feedback.options,
-					type: feedback.type,
-					defaultStyle: feedback.type === 'boolean' ? feedback.defaultStyle : undefined,
-					hasLearn: !!feedback.learn,
-					learnTimeout: feedback.learnTimeout,
-					showInvert: feedback.type === 'boolean' ? feedback.showInvert : false,
-				})
+			if (!feedback) continue
+
+			hostFeedbacks.push({
+				id: feedbackId,
+				name: feedback.name,
+				description: feedback.description,
+				options: feedback.options,
+				type: feedback.type,
+				defaultStyle: feedback.type === 'boolean' ? feedback.defaultStyle : undefined,
+				hasLearn: !!feedback.learn,
+				learnTimeout: feedback.learnTimeout,
+				showInvert: feedback.type === 'boolean' ? feedback.showInvert : false,
+			})
 
-				// Remember the definition locally
-				this.#feedbackDefinitions.set(feedbackId, feedback)
-			}
+			// Remember the definition locally
+			this.#feedbackDefinitions.set(feedbackId, feedback)
+
+			// Check for old subscribe method
+			if ('subscribe' in feedback && typeof feedback.subscribe === 'function')
+				definitionsWithSubscribeMethod.push(feedbackId)
+			if (hasAnyOldIsVisibleFunctions(feedback.options)) definitionsWithOldIsVisible.push(feedbackId)
 		}
 
 		this.#setFeedbackDefinitions(hostFeedbacks)
+
+		if (definitionsWithSubscribeMethod.length > 0) {
+			this.#logger.warn(
+				`The following feedback definitions have a subscribe method, which is no longer supported: ${definitionsWithSubscribeMethod
+					.sort()
+					.join(', ')}`,
+			)
+		}
+		if (definitionsWithOldIsVisible.length > 0) {
+			this.#logger.warn(
+				`The following feedback definitions have options with the old isVisible functions. These should be replaced with isVisibleExpression to continue to operate. The definitions: ${definitionsWithOldIsVisible
+					.sort()
+					.join(', ')}`,
+			)
+		}
 	}
 
 	checkFeedbacks(feedbackTypes: string[]): void {

packages/companion-module-host/src/internal/util.ts

@@ -0,0 +1,13 @@
+import { SomeCompanionActionInputField, SomeCompanionFeedbackInputField } from '../main.js'
+
+export function hasAnyOldIsVisibleFunctions(
+	options: (SomeCompanionActionInputField | SomeCompanionFeedbackInputField)[] | undefined,
+): boolean {
+	if (!options) return false
+
+	for (const option of options) {
+		if ('isVisible' in option && !!option.isVisible) return true
+	}
+
+	return false
+}