fix: remote_control cannot be overridden (#2297)
### Problem
When configuration overrides are removed or changed for
`remote_control`, the automations previously registered by the card were
not updated, causing stale automations to remain active.
### Fix
Re-run the remote-control and automations loaders when the effective
configuration changes due to overrides so that automation
additions/removals reflect the current config.
#### What changed
- Modified: config-manager.ts
- Call `setKeyboardShortcutsFromConfig(this._api)`,
`setRemoteControlEntityFromConfig(this._api)` and
`setAutomationsFromConfig(this._api)` inside `_processOverrideConfig()`.
- Modified: `config-manager.test.ts`
- Added ConfigManager for test setup with real AutomationsManager and
ConditionStateManager
- Added test constants to centralize test data
- Expanded test coverage for override conditions:
- loaders should re-run when overrides change
- remote-control loader with overrides
#### Testing
- Full test suite run locally: 229 files, 2852 tests — all passing (with
TZ forced to 'UTC') ✅
This commit is contained in:
phill
@@ -108,10 +108,6 @@ export class ConfigManager {
|
||||
this._api.getMessageManager().reset();
|
||||
this._api.getStatusBarItemManager().removeAllDynamicStatusBarItems();
|
||||
|
||||
setKeyboardShortcutsFromConfig(this._api);
|
||||
setRemoteControlEntityFromConfig(this._api);
|
||||
setAutomationsFromConfig(this._api);
|
||||
|
||||
this._processOverrideConfig();
|
||||
|
||||
this._api.getCardElementManager().update();
|
||||
@@ -132,6 +128,14 @@ export class ConfigManager {
|
||||
setFoldersFromConfig(this._api);
|
||||
this._api.getStyleManager().updateFromConfig();
|
||||
|
||||
// Ensure features that register automations or other side-effects from
|
||||
// configuration are updated when overrides change (e.g. remote_control).
|
||||
// Re-run loaders that may add/remove automations based on the current
|
||||
// effective configuration.
|
||||
setKeyboardShortcutsFromConfig(this._api);
|
||||
setRemoteControlEntityFromConfig(this._api);
|
||||
setAutomationsFromConfig(this._api);
|
||||
|
||||
if (
|
||||
previousConfig &&
|
||||
(!isEqual(previousConfig?.cameras, this._overriddenConfig?.cameras) ||
|
||||
|
||||
@@ -3,8 +3,66 @@ import { ZodError } from 'zod';
|
||||
import { ConfigManager } from '../../../src/card-controller/config/config-manager';
|
||||
import { InitializationAspect } from '../../../src/card-controller/initialization-manager';
|
||||
import { ConditionStateManager } from '../../../src/conditions/state-manager';
|
||||
import { AutomationsManager } from '../../../src/card-controller/automations-manager';
|
||||
import { advancedCameraCardConfigSchema } from '../../../src/config/schema/types';
|
||||
import { createCardAPI, createConfig, flushPromises } from '../../test-utils';
|
||||
import { createGeneralAction } from '../../../src/utils/action';
|
||||
|
||||
/**
|
||||
* Create a ConfigManager test setup with real AutomationsManager and ConditionStateManager.
|
||||
* Includes spies for automation manager methods to track calls in tests.
|
||||
*/
|
||||
function createConfigManagerTestSetup(options?: {
|
||||
hasHASS?: boolean;
|
||||
isInitializedMandatory?: boolean;
|
||||
}) {
|
||||
const api = createCardAPI();
|
||||
const stateManager = new ConditionStateManager();
|
||||
vi.mocked(api.getConditionStateManager).mockReturnValue(stateManager);
|
||||
|
||||
const automationsManager = new AutomationsManager(api);
|
||||
vi.mocked(api.getAutomationsManager).mockReturnValue(automationsManager);
|
||||
vi.mocked(api.getHASSManager().hasHASS).mockReturnValue(options?.hasHASS ?? true);
|
||||
vi.mocked(api.getInitializationManager().isInitializedMandatory).mockReturnValue(
|
||||
options?.isInitializedMandatory ?? true,
|
||||
);
|
||||
|
||||
const manager = new ConfigManager(api);
|
||||
vi.mocked(api.getConfigManager).mockReturnValue(manager);
|
||||
|
||||
const addAutomationsSpy = vi.spyOn(automationsManager, 'addAutomations');
|
||||
const deleteAutomationsSpy = vi.spyOn(automationsManager, 'deleteAutomations');
|
||||
|
||||
return {
|
||||
api,
|
||||
manager,
|
||||
stateManager,
|
||||
automationsManager,
|
||||
addAutomationsSpy,
|
||||
deleteAutomationsSpy,
|
||||
};
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Test Constants - Centralized test data to avoid magic numbers/strings
|
||||
// ============================================================================
|
||||
|
||||
/** Test camera entities - Primary is used for standard tests */
|
||||
const TEST_CAMERAS = {
|
||||
OFFICE: { camera_entity: 'camera.office' },
|
||||
KITCHEN: { camera_entity: 'camera.kitchen' },
|
||||
} as const;
|
||||
|
||||
/** Override conditions commonly used in tests */
|
||||
const TEST_CONDITIONS = {
|
||||
FULLSCREEN_ON: { condition: 'fullscreen' as const, fullscreen: true },
|
||||
FULLSCREEN_OFF: { condition: 'fullscreen' as const, fullscreen: false },
|
||||
} as const;
|
||||
|
||||
/** Profile settings for testing */
|
||||
const TEST_PROFILES = {
|
||||
LOW_PERFORMANCE: 'low-performance' as const,
|
||||
} as const;
|
||||
|
||||
describe('ConfigManager', () => {
|
||||
beforeEach(() => {
|
||||
@@ -67,7 +125,7 @@ describe('ConfigManager', () => {
|
||||
const manager = new ConfigManager(api);
|
||||
const config = {
|
||||
type: 'custom:advanced-camera-card',
|
||||
cameras: [{ camera_entity: 'camera.office' }],
|
||||
cameras: [TEST_CAMERAS.OFFICE],
|
||||
};
|
||||
|
||||
manager.setConfig(config);
|
||||
@@ -99,8 +157,8 @@ describe('ConfigManager', () => {
|
||||
const manager = new ConfigManager(createCardAPI());
|
||||
const config = {
|
||||
type: 'custom:advanced-camera-card',
|
||||
cameras: [{ camera_entity: 'camera.office' }],
|
||||
profiles: ['low-performance'],
|
||||
cameras: [TEST_CAMERAS.OFFICE],
|
||||
profiles: [TEST_PROFILES.LOW_PERFORMANCE],
|
||||
};
|
||||
|
||||
manager.setConfig(config);
|
||||
@@ -114,7 +172,7 @@ describe('ConfigManager', () => {
|
||||
const manager = new ConfigManager(api);
|
||||
const config = {
|
||||
type: 'custom:advanced-camera-card',
|
||||
cameras: [{ camera_entity: 'camera.office' }],
|
||||
cameras: [TEST_CAMERAS.OFFICE],
|
||||
};
|
||||
|
||||
manager.setConfig(config);
|
||||
@@ -131,7 +189,7 @@ describe('ConfigManager', () => {
|
||||
const manager = new ConfigManager(api);
|
||||
const config = {
|
||||
type: 'custom:advanced-camera-card',
|
||||
cameras: [{ camera_entity: 'camera.office' }],
|
||||
cameras: [TEST_CAMERAS.OFFICE],
|
||||
debug: {
|
||||
logging: true,
|
||||
},
|
||||
@@ -170,13 +228,13 @@ describe('ConfigManager', () => {
|
||||
vi.mocked(api.getConditionStateManager).mockReturnValue(stateManager);
|
||||
|
||||
const manager = new ConfigManager(api);
|
||||
const cameras = [{ camera_entity: 'camera.office' }];
|
||||
const cameras = [TEST_CAMERAS.OFFICE];
|
||||
const config = {
|
||||
type: 'custom:advanced-camera-card',
|
||||
cameras: cameras,
|
||||
overrides: [
|
||||
{
|
||||
conditions: [{ condition: 'fullscreen', fullscreen: true }],
|
||||
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
||||
set: {
|
||||
// Override with the same.
|
||||
cameras: cameras,
|
||||
@@ -206,7 +264,7 @@ describe('ConfigManager', () => {
|
||||
},
|
||||
overrides: [
|
||||
{
|
||||
conditions: [{ condition: 'fullscreen', fullscreen: true }],
|
||||
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
||||
set: { 'menu.style': 'none' },
|
||||
},
|
||||
],
|
||||
@@ -228,10 +286,10 @@ describe('ConfigManager', () => {
|
||||
const manager = new ConfigManager(api);
|
||||
const config = {
|
||||
type: 'custom:advanced-camera-card',
|
||||
cameras: [{ camera_entity: 'camera.office' }],
|
||||
cameras: [TEST_CAMERAS.OFFICE],
|
||||
overrides: [
|
||||
{
|
||||
conditions: [{ condition: 'fullscreen', fullscreen: true }],
|
||||
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
||||
delete: ['cameras'],
|
||||
},
|
||||
],
|
||||
@@ -256,12 +314,12 @@ describe('ConfigManager', () => {
|
||||
const manager = new ConfigManager(api);
|
||||
const config = {
|
||||
type: 'custom:advanced-camera-card',
|
||||
cameras: [{ camera_entity: 'camera.office' }],
|
||||
cameras: [TEST_CAMERAS.OFFICE],
|
||||
overrides: [
|
||||
{
|
||||
conditions: [{ condition: 'fullscreen', fullscreen: true }],
|
||||
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
||||
set: {
|
||||
cameras: [{ camera_entity: 'camera.kitchen' }],
|
||||
cameras: [TEST_CAMERAS.KITCHEN],
|
||||
},
|
||||
},
|
||||
],
|
||||
@@ -288,10 +346,10 @@ describe('ConfigManager', () => {
|
||||
const manager = new ConfigManager(api);
|
||||
const config = {
|
||||
type: 'custom:advanced-camera-card',
|
||||
cameras: [{ camera_entity: 'camera.office' }],
|
||||
cameras: [TEST_CAMERAS.OFFICE],
|
||||
overrides: [
|
||||
{
|
||||
conditions: [{ condition: 'fullscreen', fullscreen: true }],
|
||||
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
||||
set: {
|
||||
cameras_global: { live_provider: 'jsmpeg' },
|
||||
},
|
||||
@@ -320,10 +378,10 @@ describe('ConfigManager', () => {
|
||||
const manager = new ConfigManager(api);
|
||||
const config = {
|
||||
type: 'custom:advanced-camera-card',
|
||||
cameras: [{ camera_entity: 'camera.office' }],
|
||||
cameras: [TEST_CAMERAS.OFFICE],
|
||||
overrides: [
|
||||
{
|
||||
conditions: [{ condition: 'fullscreen', fullscreen: true }],
|
||||
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
||||
set: {
|
||||
'live.microphone.always_connected': true,
|
||||
},
|
||||
@@ -356,12 +414,12 @@ describe('ConfigManager', () => {
|
||||
const manager = new ConfigManager(api);
|
||||
const config = {
|
||||
type: 'custom:advanced-camera-card',
|
||||
cameras: [{ camera_entity: 'camera.office' }],
|
||||
cameras: [TEST_CAMERAS.OFFICE],
|
||||
overrides: [
|
||||
{
|
||||
conditions: [{ condition: 'fullscreen', fullscreen: true }],
|
||||
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
||||
set: {
|
||||
cameras: [{ camera_entity: 'camera.kitchen' }],
|
||||
cameras: [TEST_CAMERAS.KITCHEN],
|
||||
},
|
||||
},
|
||||
],
|
||||
@@ -393,5 +451,267 @@ describe('ConfigManager', () => {
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('loaders should re-run when overrides change', () => {
|
||||
it('should re-run keyboard-shortcuts loader when overrides change', async () => {
|
||||
const { manager, stateManager, addAutomationsSpy } =
|
||||
createConfigManagerTestSetup();
|
||||
|
||||
const config = createConfig({
|
||||
view: {
|
||||
keyboard_shortcuts: {
|
||||
enabled: true,
|
||||
ptz_home: { key: 'h' },
|
||||
},
|
||||
},
|
||||
overrides: [
|
||||
{
|
||||
delete: ['view.keyboard_shortcuts'],
|
||||
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
||||
},
|
||||
],
|
||||
});
|
||||
|
||||
manager.setConfig(config as any);
|
||||
await flushPromises();
|
||||
|
||||
// Verify keyboard shortcuts automations were added initially with ptz_home
|
||||
expect(addAutomationsSpy).toHaveBeenCalledWith(
|
||||
expect.arrayContaining([
|
||||
expect.objectContaining({
|
||||
conditions: expect.arrayContaining([
|
||||
expect.objectContaining({ condition: 'key', key: 'h' }),
|
||||
]),
|
||||
actions: expect.arrayContaining([
|
||||
expect.objectContaining({
|
||||
advanced_camera_card_action: 'ptz_multi',
|
||||
}),
|
||||
]),
|
||||
}),
|
||||
]),
|
||||
);
|
||||
|
||||
addAutomationsSpy.mockClear();
|
||||
|
||||
// Trigger the override - keyboard_shortcuts should be deleted
|
||||
stateManager.setState({ fullscreen: true });
|
||||
await flushPromises();
|
||||
|
||||
// Verify newly added automations don't contain keyboard shortcuts (key: 'h')
|
||||
// This confirms the override removed them (directly verified through add calls)
|
||||
const addCalls = addAutomationsSpy.mock.calls;
|
||||
const hasKeyboardShortcut = addCalls.some((call) =>
|
||||
call[0].some((automation: any) =>
|
||||
automation.conditions?.some(
|
||||
(cond: any) => cond.condition === 'key' && cond.key === 'h',
|
||||
),
|
||||
),
|
||||
);
|
||||
expect(hasKeyboardShortcut).toBe(false);
|
||||
});
|
||||
|
||||
it('should re-run folders loader when overrides change', async () => {
|
||||
const { manager, stateManager, api } = createConfigManagerTestSetup();
|
||||
|
||||
const folders = [{ id: 'f' }];
|
||||
const config = createConfig({
|
||||
folders,
|
||||
overrides: [
|
||||
{
|
||||
delete: ['folders'],
|
||||
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
||||
},
|
||||
],
|
||||
});
|
||||
|
||||
manager.setConfig(config as any);
|
||||
await flushPromises();
|
||||
|
||||
// Verify initial payload (folders may be populated with defaults, so
|
||||
// assert the passed folders contain our folder id).
|
||||
expect(api.getFoldersManager().addFolders).toHaveBeenCalled();
|
||||
expect(api.getFoldersManager().addFolders).toHaveBeenCalledWith(
|
||||
expect.arrayContaining([expect.objectContaining({ id: 'f' })]),
|
||||
);
|
||||
|
||||
// Reset calls so we only see calls resulting from the override
|
||||
vi.mocked(api.getFoldersManager().deleteFolders).mockClear();
|
||||
vi.mocked(api.getFoldersManager().addFolders).mockClear();
|
||||
|
||||
// Trigger override which deletes folders
|
||||
stateManager.setState({ fullscreen: true });
|
||||
await flushPromises();
|
||||
|
||||
// Verify delete was called when override triggered
|
||||
expect(api.getFoldersManager().deleteFolders).toBeCalled();
|
||||
|
||||
// Verify folder 'f' is no longer present after override
|
||||
// Since the override removes folders, the folders passed should no
|
||||
// longer include our folder `f`.
|
||||
const calls = vi.mocked(api.getFoldersManager().addFolders).mock.calls;
|
||||
expect(calls.length).toBeGreaterThanOrEqual(1);
|
||||
const lastArg = calls[calls.length - 1][0] as unknown[];
|
||||
expect(lastArg).not.toEqual(
|
||||
expect.arrayContaining([expect.objectContaining({ id: 'f' })]),
|
||||
);
|
||||
|
||||
// Verify folder is restored when override exits
|
||||
vi.mocked(api.getFoldersManager().addFolders).mockClear();
|
||||
|
||||
stateManager.setState({ fullscreen: false });
|
||||
await flushPromises();
|
||||
|
||||
// Verify the folder 'f' is restored
|
||||
const restoreCalls = vi.mocked(api.getFoldersManager().addFolders).mock.calls;
|
||||
expect(restoreCalls.length).toBeGreaterThanOrEqual(1);
|
||||
const restoredArg = restoreCalls[restoreCalls.length - 1][0] as unknown[];
|
||||
expect(restoredArg).toEqual(
|
||||
expect.arrayContaining([expect.objectContaining({ id: 'f' })]),
|
||||
);
|
||||
});
|
||||
|
||||
it('should re-run automations loader when overrides change and properly manage automations', async () => {
|
||||
const { manager, stateManager, api, addAutomationsSpy, deleteAutomationsSpy } =
|
||||
createConfigManagerTestSetup();
|
||||
|
||||
// Mock executeActions to track automation execution
|
||||
const executeActionsMock = vi.fn();
|
||||
vi.mocked(api.getActionsManager().executeActions).mockImplementation(
|
||||
executeActionsMock,
|
||||
);
|
||||
|
||||
const automation = {
|
||||
conditions: [TEST_CONDITIONS.FULLSCREEN_OFF],
|
||||
actions: [createGeneralAction('screenshot')],
|
||||
};
|
||||
const config = createConfig({
|
||||
automations: [automation],
|
||||
overrides: [
|
||||
{
|
||||
delete: ['automations'],
|
||||
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
||||
},
|
||||
],
|
||||
});
|
||||
|
||||
manager.setConfig(config as any);
|
||||
await flushPromises();
|
||||
|
||||
// Verify automations were added initially
|
||||
expect(addAutomationsSpy).toHaveBeenCalled();
|
||||
|
||||
// Trigger a state change to evaluate conditions (fullscreen: false matches our condition)
|
||||
stateManager.setState({ fullscreen: false });
|
||||
await flushPromises();
|
||||
|
||||
// The automation should execute since the condition matches and override is not active
|
||||
expect(executeActionsMock).toHaveBeenCalled();
|
||||
|
||||
// Clear to observe only calls caused by the override
|
||||
executeActionsMock.mockClear();
|
||||
deleteAutomationsSpy.mockClear();
|
||||
addAutomationsSpy.mockClear();
|
||||
|
||||
// Trigger the override which deletes automations
|
||||
stateManager.setState({ fullscreen: true });
|
||||
await flushPromises();
|
||||
|
||||
// Verify delete was called when override triggered
|
||||
expect(deleteAutomationsSpy).toHaveBeenCalled();
|
||||
|
||||
// After override, the automation should have been deleted from the manager,
|
||||
// so no further executions should occur
|
||||
expect(executeActionsMock).not.toHaveBeenCalled();
|
||||
|
||||
// Clear and verify that exiting fullscreen doesn't restore the automation
|
||||
executeActionsMock.mockClear();
|
||||
|
||||
stateManager.setState({ fullscreen: false });
|
||||
await flushPromises();
|
||||
|
||||
// The automation should still not execute because it was deleted by the override
|
||||
expect(executeActionsMock).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe('remote-control loader with overrides', () => {
|
||||
it('should re-run remote-control loader when overrides change', async () => {
|
||||
const { manager, stateManager, addAutomationsSpy, deleteAutomationsSpy } =
|
||||
createConfigManagerTestSetup();
|
||||
|
||||
const config = createConfig({
|
||||
remote_control: {
|
||||
entities: { camera: 'input_select.camera' },
|
||||
},
|
||||
overrides: [
|
||||
{
|
||||
delete: ['remote_control'],
|
||||
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
||||
},
|
||||
],
|
||||
});
|
||||
|
||||
// Initial set should register remote control automations
|
||||
manager.setConfig(config as any);
|
||||
await flushPromises();
|
||||
|
||||
// Verify remote-control automations were added initially with config condition
|
||||
expect(addAutomationsSpy).toHaveBeenCalledWith(
|
||||
expect.arrayContaining([
|
||||
expect.objectContaining({
|
||||
conditions: expect.arrayContaining([
|
||||
expect.objectContaining({
|
||||
condition: 'config',
|
||||
paths: expect.arrayContaining(['remote_control.entities.camera']),
|
||||
}),
|
||||
]),
|
||||
}),
|
||||
]),
|
||||
);
|
||||
|
||||
addAutomationsSpy.mockClear();
|
||||
deleteAutomationsSpy.mockClear();
|
||||
|
||||
// Trigger the override condition - remote_control should be deleted
|
||||
stateManager.setState({ fullscreen: true });
|
||||
await flushPromises();
|
||||
|
||||
// Verify delete was called
|
||||
expect(deleteAutomationsSpy).toHaveBeenCalled();
|
||||
|
||||
// Verify new automations don't contain remote-control config conditions
|
||||
const addCalls = addAutomationsSpy.mock.calls;
|
||||
const hasRemoteControl = addCalls.some((call) =>
|
||||
call[0].some((automation: any) =>
|
||||
automation.conditions?.some(
|
||||
(cond: any) =>
|
||||
cond.condition === 'config' &&
|
||||
cond.paths?.includes('remote_control.entities.camera'),
|
||||
),
|
||||
),
|
||||
);
|
||||
expect(hasRemoteControl).toBe(false);
|
||||
|
||||
addAutomationsSpy.mockClear();
|
||||
|
||||
// Exit override - remote-control automations should be restored
|
||||
stateManager.setState({ fullscreen: false });
|
||||
await flushPromises();
|
||||
|
||||
// Verify remote-control automations were restored
|
||||
expect(addAutomationsSpy).toHaveBeenCalledWith(
|
||||
expect.arrayContaining([
|
||||
expect.objectContaining({
|
||||
conditions: expect.arrayContaining([
|
||||
expect.objectContaining({
|
||||
condition: 'config',
|
||||
paths: expect.arrayContaining(['remote_control.entities.camera']),
|
||||
}),
|
||||
]),
|
||||
}),
|
||||
]),
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user