feat: add 'Surface: When connected' feedback #4124

Author: Julusian

companion/lib/Internal/Surface.ts

@@ -135,10 +135,12 @@ export class InternalSurface extends EventEmitter<InternalModuleFragmentEvents>
 		this.#surfaceController.on('surface-add', () => {
 			debounceUpdateVariableDefinitions()
 			debounceUpdateVariables()
+			this.emit('checkFeedbacks', 'surface_connected')
 		})
 		this.#surfaceController.on('surface-delete', () => {
 			debounceUpdateVariableDefinitions()
 			debounceUpdateVariables()
+			this.emit('checkFeedbacks', 'surface_connected')
 		})
 		this.#surfaceController.on('surface-in-group', () => debounceUpdateVariables())
 		this.#surfaceController.on('surface_name', () => debounceUpdateVariables())
@@ -727,6 +729,28 @@ export class InternalSurface extends EventEmitter<InternalModuleFragmentEvents>
 				optionsSupportExpressions: true,
 			},
 
+			surface_connected: {
+				feedbackType: FeedbackEntitySubType.Boolean,
+				label: 'Surface: When connected',
+				description: 'Change style when a surface is connected',
+				feedbackStyle: {
+					color: 0xffffff,
+					bgcolor: 0x00aa00,
+				},
+				showInvert: true,
+				options: [
+					{
+						type: 'internal:surface_serial',
+						label: 'Surface',
+						id: 'surfaceId',
+						includeSelf: false,
+						default: '',
+						listMode: 'surfaces',
+					},
+				],
+				optionsSupportExpressions: true,
+			},
+
 			outbound_surface_enabled: {
 				feedbackType: FeedbackEntitySubType.Boolean,
 				label: 'Remote surface: When enabled',
@@ -753,6 +777,12 @@ export class InternalSurface extends EventEmitter<InternalModuleFragmentEvents>
 
 			return currentPage == thePage
 		}
+		if (feedback.definitionId == 'surface_connected') {
+			const surfaceId = stringifyVariableValue(feedback.options.surfaceId)?.trim()
+			if (!surfaceId) return false
+
+			return this.#surfaceController.isSurfaceConnected(surfaceId, true)
+		}
 		if (feedback.definitionId == 'outbound_surface_enabled') {
 			const surfaceId = stringifyVariableValue(feedback.options.surfaceId)?.trim()
 			if (!surfaceId) return false

companion/lib/Surface/Controller.ts

@@ -1905,6 +1905,10 @@ export class SurfaceController extends EventEmitter<SurfaceControllerEvents> {
 	/**
 	 * Get the page id of a surface
 	 */
+	isSurfaceConnected(surfaceId: string, looseIdMatching: boolean): boolean {
+		return !!this.#getSurfaceHandlerForId(surfaceId, looseIdMatching)
+	}
+
 	devicePageGet(surfaceOrGroupId: string, looseIdMatching = false): string | undefined {
 		const surfaceGroup = this.#getGroupForId(surfaceOrGroupId, looseIdMatching)
 		if (surfaceGroup) {

companion/test/Internal/Surface.test.ts

@@ -483,6 +483,41 @@ describe('InternalSurface', () => {
 			expect(surface.executeFeedback(makeFeedback('surface_on_page', { surfaceId: '', page: 2 }))).toBe(false)
 		})
 
+		test('surface_connected reflects the surface connection state', () => {
+			const { surface, surfaceController } = createSurface()
+			surfaceController.isSurfaceConnected.mockReturnValue(true)
+
+			expect(surface.executeFeedback(makeFeedback('surface_connected', { surfaceId: 'surface0' }))).toBe(true)
+			expect(surfaceController.isSurfaceConnected).toHaveBeenCalledWith('surface0', true)
+		})
+
+		test('surface_connected is false when the surface is not connected', () => {
+			const { surface, surfaceController } = createSurface()
+			surfaceController.isSurfaceConnected.mockReturnValue(false)
+
+			expect(surface.executeFeedback(makeFeedback('surface_connected', { surfaceId: 'surface0' }))).toBe(false)
+		})
+
+		test('surface_connected is false when no surface is selected', () => {
+			const { surface, surfaceController } = createSurface()
+			surfaceController.isSurfaceConnected.mockReturnValue(true)
+
+			expect(surface.executeFeedback(makeFeedback('surface_connected', { surfaceId: '' }))).toBe(false)
+		})
+
+		test('surface_connected is rechecked when a surface connects or disconnects', () => {
+			const { surface, surfaceController } = createSurface()
+			const checkFeedbacks = vi.fn()
+			surface.on('checkFeedbacks', checkFeedbacks)
+
+			const handlers = new Map(surfaceController.on.mock.calls.map(([event, fn]) => [event, fn as () => void]))
+			handlers.get('surface-add')!()
+			handlers.get('surface-delete')!()
+
+			expect(checkFeedbacks).toHaveBeenCalledTimes(2)
+			expect(checkFeedbacks).toHaveBeenCalledWith('surface_connected')
+		})
+
 		test('outbound_surface_enabled reflects the surface enabled state', () => {
 			const { surface, surfaceController } = createSurface()
 			surfaceController.outbound.getById.mockReturnValue({ enabled: true } as any)
@@ -607,7 +642,7 @@ describe('InternalSurface', () => {
 			const { surface } = createSurface()
 
 			expect(Object.keys(surface.getFeedbackDefinitions()).sort()).toEqual(
-				['surface_on_page', 'outbound_surface_enabled'].sort()
+				['surface_on_page', 'surface_connected', 'outbound_surface_enabled'].sort()
 			)
 		})
 	})