Split automations into HA-style `triggers`, ongoing `conditions`, and
`actions`, with compatibility migrations for existing Advanced Camera
Card configs.
## Summary
At a glance (details below):
- **Added** `triggers:` -- a required, HA-shaped block: stock `state` /
`numeric_state` / `template` plus card-specific triggers (`camera`,
`view`, `fullscreen`, ...).
- **Added** the HA-native `if` / `then` / `else` action.
- **Removed** `actions_not` (replaced by `if` / `then` / `else`).
- **Removed** the ambient `advanced_camera_card` template namespace (use
`acc` instead).
- **Changed** the trigger template surface to a top-level `trigger.*`
variable (as in HA); the nested `acc.trigger.*` paths are removed.
- **Changed** `conditions:` to ongoing gates only -- they no longer wake
an automation, and change-only forms (`config`, valueless `camera` /
`view` / `state`) become triggers, not conditions.
- **Changed** action templates to render per step, so a later action
sees state an earlier one changed.
- **Compatibility:** HA-shaped YAML is accepted (singular keys,
single-or-list, `and` / `or` / `not` shorthand, `entity` / `entity_id`).
- **Migration:** existing configs upgrade automatically; anything that
cannot be converted faithfully is recorded under `__UPGRADE_FAILURE__`
for manual fixup.
## Breaking Changes
### 1. Automations now require triggers
Before this PR, `automations[].conditions` served two roles:
- They decided whether the automation should run.
- They also acted as the thing that woke the automation up.
After this PR:
- `triggers` wake the automation.
- `conditions` only gate it at the instant a trigger fires.
Most existing automations are migrated automatically from `conditions:`
to `triggers:`.
### 2. `actions_not` is retired
Legacy `actions_not` is replaced by an HA-style `if` action with `then`
/ `else`.
Faithful conversions are automatic. Cases that cannot be faithfully
converted are recorded under `__UPGRADE_FAILURE__.automations` and must
be migrated manually.
### 3. Template surface aligned with Home Assistant
Two related template changes, both auto-migrated:
- **Top-level `trigger.*`.** Automation actions now receive a top-level
`trigger` template variable, like Home Assistant. Legacy nested paths
such as `acc.trigger.state.to` and
`advanced_camera_card.trigger.camera.to` are migrated automatically when
they appear inside template strings.
- **The ambient `advanced_camera_card` template namespace is removed.**
The long-form ambient namespace (`advanced_camera_card.camera`,
`advanced_camera_card.view`, `advanced_camera_card.config`) is retired
in favour of its shorter `acc` alias -- supported since v7.1.0, and the
only spelling the new trigger surface uses. Existing templates are
migrated automatically by rewriting the `advanced_camera_card.` prefix
to `acc.`.
### 4. Trigger-only condition forms are no longer valid conditions
Some legacy "conditions" were really change detectors. These are now
triggers only:
- `condition: config`
- valueless `camera`
- valueless `view`
- valueless `state` / picture-elements state condition with neither
`state` nor `state_not`
These are automatically promoted in automations and stripped from
overrides/elements where they would no longer be meaningful as ongoing
conditions.
### 5. Template truthiness now follows Home Assistant behavior
Template conditions and template triggers intentionally use different
truthiness rules, matching HA:
- A template condition passes only when the rendered value is `true`
(case-insensitive), matching HA's `condition.py`.
- A template trigger uses HA's broader `result_as_boolean` coercion: a
non-zero number, or `1` / `true` / `yes` / `on` / `enable`
(case-insensitive), counts as true.
### 6. Action templates render when each action executes
Action templates are now rendered per action step, not once for the
whole sequence. This means a later action can see card-local state
changed by an earlier action in the same sequence.
The `trigger` context is fixed for the automation run. HA entity state
updates still depend on the frontend receiving updated HASS state over
the websocket.
## Automatic Migrations
### Automation `conditions:` to `triggers:`
Simple legacy automation:
```yaml
# Before
automations:
- conditions:
- condition: fullscreen
fullscreen: true
actions:
- action: custom:advanced-camera-card-action
advanced_camera_card_action: substream_on
```
```yaml
# After, automatic
automations:
- triggers:
- trigger: fullscreen
fullscreen: true
actions:
- action: custom:advanced-camera-card-action
advanced_camera_card_action: substream_on
```
State conditions become HA-style state triggers:
```yaml
# Before
automations:
- conditions:
- condition: state
entity_id: binary_sensor.front_door
state: 'on'
actions:
- action: custom:advanced-camera-card-action
advanced_camera_card_action: live
```
```yaml
# After, automatic
automations:
- triggers:
- trigger: state
entity_id: binary_sensor.front_door
to: 'on'
actions:
- action: custom:advanced-camera-card-action
advanced_camera_card_action: live
```
Multiple conditions become both triggers and ongoing conditions:
```yaml
# Before
automations:
- conditions:
- condition: camera
cameras: [front_door]
- condition: fullscreen
fullscreen: true
actions:
- action: custom:advanced-camera-card-action
advanced_camera_card_action: substream_on
```
```yaml
# After, automatic
automations:
- triggers:
- trigger: camera
cameras: [front_door]
- trigger: fullscreen
fullscreen: true
conditions:
- condition: camera
cameras: [front_door]
- condition: fullscreen
fullscreen: true
actions:
- action: custom:advanced-camera-card-action
advanced_camera_card_action: substream_on
```
The flattened trigger list is an implicit OR. The retained `conditions:`
list is an implicit AND checked when any trigger fires.
### Trigger-only legacy conditions
Legacy `config` conditions become `config` triggers:
```yaml
# Before
automations:
- conditions:
- condition: config
paths: [menu.style]
actions:
- action: custom:advanced-camera-card-action
advanced_camera_card_action: status_bar
```
```yaml
# After, automatic
automations:
- triggers:
- trigger: config
paths: [menu.style]
actions:
- action: custom:advanced-camera-card-action
advanced_camera_card_action: status_bar
```
Trigger-only leaves are removed from retained `conditions:` blocks
because they no longer describe an ongoing state.
### `actions_not` to `if` / `then` / `else`
```yaml
# Before
automations:
- conditions:
- condition: state
entity_id: input_boolean.camera_alerts
state: 'on'
actions:
- action: custom:advanced-camera-card-action
advanced_camera_card_action: live
actions_not:
- action: none
```
```yaml
# After, automatic
automations:
- triggers:
- trigger: state
entity_id: input_boolean.camera_alerts
actions:
- if:
- condition: state
entity_id: input_boolean.camera_alerts
state: 'on'
then:
- action: custom:advanced-camera-card-action
advanced_camera_card_action: live
else:
- action: none
```
If the legacy automation had no conditions, or only trigger-only
conditions, `actions_not` is dropped because the old `else` branch could
not be reproduced as an ongoing predicate.
### Trigger template paths
```yaml
# Before
message: 'Door is {{ acc.trigger.state.to }} from {{ acc.trigger.state.from }}'
```
```yaml
# After, automatic
message: 'Door is {{ trigger.to_state.state }} from {{ trigger.from_state.state }}'
```
Path rewrites performed automatically:
| Old path | New path |
| -------------------------- | -------------------------- |
| `acc.trigger.state.entity` | `trigger.entity_id` |
| `acc.trigger.state.from` | `trigger.from_state.state` |
| `acc.trigger.state.to` | `trigger.to_state.state` |
| `acc.trigger.camera.from` | `trigger.from_acc.camera` |
| `acc.trigger.camera.to` | `trigger.to_acc.camera` |
| `acc.trigger.view.from` | `trigger.from_acc.view` |
| `acc.trigger.view.to` | `trigger.to_acc.view` |
| `acc.trigger.config.from` | `trigger.from_acc.config` |
| `acc.trigger.config.to` | `trigger.to_acc.config` |
The same rewrites are applied for the older
`advanced_camera_card.trigger.*` namespace.
### Ambient template namespace
Any remaining long-form ambient `advanced_camera_card.*` references
(outside the trigger surface) are rewritten to the `acc.*` alias:
```yaml
# Before
title: 'Now viewing {{ advanced_camera_card.camera }}'
```
```yaml
# After, automatic
title: 'Now viewing {{ acc.camera }}'
```
## Manual Migration Cases
### `__UPGRADE_FAILURE__.automations`
If a legacy automation cannot be converted faithfully, the original
automation is recorded under:
```yaml
__UPGRADE_FAILURE__:
automations:
- ...
```
These entries require manual migration.
The main known case is legacy `actions_not` with a condition whose
trigger can only fire on a rising edge, such as:
- `condition: template`
- `condition: screen`
- `condition: numeric_state` without an entity-backed state to watch
Those conditions can start the `then` branch, but cannot reliably start
the `else` branch when they stop matching.
### Unsupported HA conditions and triggers
This PR aligns the card with HA where supported, but it is not a full HA
automation engine.
Unsupported HA condition families include:
- `time`
- `zone`
- `sun`
- `location`
- `device`
- `condition: trigger`
Unsupported HA trigger platforms include:
- `event`
- `time`
- `time_pattern`
- `sun`
- `zone`
- `calendar`
- `webhook`
- `tag`
- `device`
- `mqtt`
The card-specific camera `triggers:` feature (which auto-selects and
wakes the card on camera events such as motion) is a separate feature
from automation `triggers:`, despite the shared word.
### Trigger IDs and variables
HA keys such as `id`, `alias`, and `variables` are accepted so pasted HA
YAML validates, but they are ignored by the card. There is no
`trigger.id` support in this PR.
## New Compatibility Features
This PR also makes card config more forgiving for HA-style YAML:
- `trigger`, `condition`, and `action` singular keys are accepted and
normalized to `triggers`, `conditions`, and `actions`.
- Single trigger, condition, and action objects are accepted where lists
are expected.
- `if`, `then`, and `else` accept a single item or a list.
- Composite condition shorthand is accepted:
- `{ and: [...] }`
- `{ or: [...] }`
- `{ not: [...] }`
- `{ condition: [...] }` as an implicit AND
- State conditions resolve expected state values that name another
entity, matching HA/Lovelace behavior.
- Both `entity` and `entity_id` are accepted on state and numeric
conditions and triggers (a superset of HA's two dialects), so there is
no forced rename.
- `state_not` remains supported as a card/Lovelace-friendly extension.
## Trigger Payloads
Automation action templates receive a top-level `trigger` object.
For stock `state` and `numeric_state` triggers:
```yaml
trigger.platform
trigger.entity_id
trigger.entity
trigger.from_state
trigger.to_state
```
For template triggers:
```yaml
trigger.platform
```
For card-specific triggers:
```yaml
trigger.platform # "acc"
trigger.type
trigger.from_acc
trigger.to_acc
```
The card does not currently expose HA's `id`, `idx`, `for`, `attribute`,
`above`, `below`, or `alias` trigger fields.
BREAKING CHANGE: Automations now follow Home Assistant's `triggers:` /
`conditions:` / `actions:` model. Automations require a `triggers:`
block and `conditions:` no longer wake an automation; `actions_not` is
removed in favour of an `if` / `then` / `else` action; the nested
`acc.trigger.*` template paths and the ambient `advanced_camera_card`
template namespace are removed (use the top-level `trigger.*` surface
and the `acc` alias); trigger-only condition forms (`config`, valueless
`camera` / `view` / `state`) are no longer valid conditions; and
template-condition vs template-trigger truthiness now follow HA.
Existing configs are upgraded automatically where a faithful conversion
exists; anything that cannot be converted is recorded under
`__UPGRADE_FAILURE__` for manual migration.
---------
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
853 lines
28 KiB
TypeScript
853 lines
28 KiB
TypeScript
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
|
import { ZodError, z } from 'zod';
|
|
import { AutomationsManager } from '../../../src/card-controller/automations-manager';
|
|
import { ConfigManager } from '../../../src/card-controller/config/config-manager';
|
|
import { setRemoteControlEntityFromConfig } from '../../../src/card-controller/config/load-control-entities';
|
|
import { setKeyboardShortcutsFromConfig } from '../../../src/card-controller/config/load-keyboard-shortcuts';
|
|
import { InitializationAspect } from '../../../src/card-controller/initialization-manager';
|
|
import { ConditionStateManager } from '../../../src/condition-trigger/conditions/state-manager';
|
|
import { Automation } from '../../../src/config/schema/automations';
|
|
import { Trigger } from '../../../src/config/schema/condition-trigger/triggers/types';
|
|
import { advancedCameraCardConfigSchema } from '../../../src/config/schema/types';
|
|
import { createGeneralAction } from '../../../src/utils/action';
|
|
import { createCardAPI, createConfig, flushPromises } from '../../test-utils';
|
|
|
|
/**
|
|
* 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 = {
|
|
CASTING: 'casting' as const,
|
|
LOW_PERFORMANCE: 'low-performance' as const,
|
|
} as const;
|
|
|
|
describe('ConfigManager', () => {
|
|
beforeEach(() => {
|
|
vi.restoreAllMocks();
|
|
});
|
|
|
|
describe('should handle error when', () => {
|
|
it('should handle no input', () => {
|
|
const manager = new ConfigManager(createCardAPI());
|
|
expect(() => manager.setConfig()).toThrowError(/Invalid configuration/);
|
|
});
|
|
|
|
it('should handle invalid configuration', () => {
|
|
const schemaForMock: z.ZodType = advancedCameraCardConfigSchema;
|
|
const spy = vi
|
|
.spyOn(schemaForMock, 'safeParse')
|
|
.mockReturnValue({ success: false, error: new ZodError([]) });
|
|
|
|
const manager = new ConfigManager(createCardAPI());
|
|
expect(() => manager.setConfig({})).toThrowError(
|
|
'Invalid configuration: No location hint available (bad or missing type?)',
|
|
);
|
|
|
|
spy.mockRestore();
|
|
});
|
|
|
|
it('should handle invalid configuration with hint', () => {
|
|
const manager = new ConfigManager(createCardAPI());
|
|
expect(() => manager.setConfig({})).toThrowError(
|
|
'Invalid configuration: [\n "type"\n]',
|
|
);
|
|
});
|
|
|
|
it('should handle upgradeable config', () => {
|
|
const manager = new ConfigManager(createCardAPI());
|
|
expect(() =>
|
|
manager.setConfig({
|
|
// This key needs to be upgradeable in `management.ts` .
|
|
type: 'custom:frigate-card',
|
|
cameras: 'WILL_NOT_PARSE',
|
|
}),
|
|
).toThrowError(
|
|
'An automated card configuration upgrade is ' +
|
|
'available, please visit the visual card editor. ' +
|
|
'Invalid configuration: [\n "cameras"\n]',
|
|
);
|
|
});
|
|
});
|
|
|
|
it('should have initial state', () => {
|
|
const manager = new ConfigManager(createCardAPI());
|
|
|
|
expect(manager.getConfig()).toBeNull();
|
|
expect(manager.getNonOverriddenConfig()).toBeNull();
|
|
expect(manager.getRawConfig()).toBeNull();
|
|
});
|
|
|
|
it('should successfully parse basic config', () => {
|
|
const api = createCardAPI();
|
|
const manager = new ConfigManager(api);
|
|
const config = {
|
|
type: 'custom:advanced-camera-card',
|
|
cameras: [TEST_CAMERAS.OFFICE],
|
|
};
|
|
|
|
manager.setConfig(config);
|
|
|
|
expect(manager.hasConfig()).toBeTruthy();
|
|
expect(manager.getRawConfig()).toBe(config);
|
|
|
|
// Verify at least the camera is set.
|
|
expect(manager.getConfig()?.cameras?.[0].camera_entity).toBe('camera.office');
|
|
|
|
// Verify at least one default was set.
|
|
expect(manager.getConfig()?.menu.alignment).toBe('left');
|
|
|
|
// Verify appropriate API calls are made.
|
|
expect(api.getConditionStateManager().setState).toBeCalledWith({
|
|
view: undefined,
|
|
displayMode: undefined,
|
|
camera: undefined,
|
|
});
|
|
expect(api.getIssueManager().reset).toBeCalledWith('config_error');
|
|
expect(api.getMediaLoadedInfoManager().clear).toBeCalled();
|
|
expect(api.getViewManager().reset).toBeCalled();
|
|
expect(api.getAutomationsManager().addAutomations).toBeCalled();
|
|
expect(api.getStyleManager().updateFromConfig).toBeCalled();
|
|
expect(api.getCardElementManager().update).toBeCalled();
|
|
});
|
|
|
|
it('should apply profiles', () => {
|
|
const manager = new ConfigManager(createCardAPI());
|
|
const config = {
|
|
type: 'custom:advanced-camera-card',
|
|
cameras: [TEST_CAMERAS.OFFICE],
|
|
profiles: [TEST_PROFILES.LOW_PERFORMANCE],
|
|
};
|
|
|
|
manager.setConfig(config);
|
|
|
|
// Verify at least one low performance default.
|
|
expect(manager.getConfig()?.live.draggable).toBeFalsy();
|
|
});
|
|
|
|
it('should apply casting profile menu changes without affecting unrelated hidden buttons', () => {
|
|
const manager = new ConfigManager(createCardAPI());
|
|
const config = {
|
|
type: 'custom:advanced-camera-card',
|
|
cameras: [TEST_CAMERAS.OFFICE],
|
|
profiles: [TEST_PROFILES.CASTING],
|
|
};
|
|
|
|
manager.setConfig(config);
|
|
|
|
expect(manager.getConfig()?.menu.buttons.play.enabled).toBeTruthy();
|
|
expect(manager.getConfig()?.menu.buttons.mute.enabled).toBeTruthy();
|
|
expect(manager.getConfig()?.menu.buttons.fullscreen.enabled).toBeFalsy();
|
|
expect(manager.getConfig()?.menu.buttons.media_player.enabled).toBeFalsy();
|
|
expect(manager.getConfig()?.menu.buttons.clips.enabled).toBeFalsy();
|
|
});
|
|
|
|
it('should skip identical configs', () => {
|
|
const api = createCardAPI();
|
|
const manager = new ConfigManager(api);
|
|
const config = {
|
|
type: 'custom:advanced-camera-card',
|
|
cameras: [TEST_CAMERAS.OFFICE],
|
|
};
|
|
|
|
manager.setConfig(config);
|
|
expect(api.getViewManager().reset).toBeCalled();
|
|
|
|
vi.mocked(api.getViewManager().reset).mockClear();
|
|
|
|
manager.setConfig(config);
|
|
expect(api.getViewManager().reset).not.toBeCalled();
|
|
});
|
|
|
|
it('should get card wide config', () => {
|
|
const api = createCardAPI();
|
|
const manager = new ConfigManager(api);
|
|
const config = {
|
|
type: 'custom:advanced-camera-card',
|
|
cameras: [TEST_CAMERAS.OFFICE],
|
|
debug: {
|
|
logging: true,
|
|
},
|
|
performance: {
|
|
style: {
|
|
box_shadow: false,
|
|
},
|
|
},
|
|
};
|
|
|
|
manager.setConfig(config);
|
|
|
|
expect(manager.getCardWideConfig()).toEqual({
|
|
debug: {
|
|
logging: true,
|
|
},
|
|
performance: {
|
|
features: {
|
|
animated_progress_indicator: true,
|
|
card_loading_indicator: true,
|
|
card_loading_effects: true,
|
|
media_chunk_size: 50,
|
|
},
|
|
style: {
|
|
border_radius: true,
|
|
box_shadow: false,
|
|
},
|
|
},
|
|
});
|
|
});
|
|
|
|
describe('should override', () => {
|
|
it('should ignore overrides with same config', () => {
|
|
const api = createCardAPI();
|
|
const stateManager = new ConditionStateManager();
|
|
vi.mocked(api.getConditionStateManager).mockReturnValue(stateManager);
|
|
|
|
const manager = new ConfigManager(api);
|
|
const cameras = [TEST_CAMERAS.OFFICE];
|
|
const config = {
|
|
type: 'custom:advanced-camera-card',
|
|
cameras: cameras,
|
|
menu: {
|
|
style: 'hidden',
|
|
position: 'top',
|
|
},
|
|
overrides: [
|
|
{
|
|
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
|
set: {
|
|
// Override with the same.
|
|
cameras: cameras,
|
|
},
|
|
},
|
|
],
|
|
};
|
|
|
|
manager.setConfig(config);
|
|
|
|
const configBefore = manager.getConfig();
|
|
stateManager.setState({ fullscreen: true });
|
|
const configAfter = manager.getConfig();
|
|
|
|
expect(configAfter).toEqual(configBefore);
|
|
expect(api.getStyleManager().updateFromConfig).toBeCalledTimes(1);
|
|
});
|
|
|
|
it('should honor override', () => {
|
|
const api = createCardAPI();
|
|
const stateManager = new ConditionStateManager();
|
|
vi.mocked(api.getConditionStateManager).mockReturnValue(stateManager);
|
|
|
|
const manager = new ConfigManager(api);
|
|
const config = createConfig({
|
|
menu: {
|
|
style: 'hidden',
|
|
},
|
|
overrides: [
|
|
{
|
|
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
|
set: { 'menu.style': 'none' },
|
|
},
|
|
],
|
|
});
|
|
|
|
manager.setConfig(config);
|
|
expect(manager.getConfig()?.menu?.style).toBe('hidden');
|
|
|
|
stateManager.setState({ fullscreen: true });
|
|
expect(manager.getConfig()?.menu?.style).toBe('none');
|
|
expect(manager.getConfig()).not.toEqual(manager.getNonOverriddenConfig());
|
|
});
|
|
|
|
it('should set error on invalid override', () => {
|
|
const api = createCardAPI();
|
|
const stateManager = new ConditionStateManager();
|
|
vi.mocked(api.getConditionStateManager).mockReturnValue(stateManager);
|
|
|
|
const manager = new ConfigManager(api);
|
|
const config = {
|
|
type: 'custom:advanced-camera-card',
|
|
cameras: [TEST_CAMERAS.OFFICE],
|
|
overrides: [
|
|
{
|
|
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
|
delete: ['type'],
|
|
},
|
|
],
|
|
};
|
|
|
|
manager.setConfig(config);
|
|
expect(manager.getConfig()).not.toBeNull();
|
|
|
|
stateManager.setState({ fullscreen: true });
|
|
expect(manager.getConfig()).not.toBeNull();
|
|
expect(api.getIssueManager().trigger).toBeCalledWith(
|
|
'config_error',
|
|
expect.objectContaining({ error: expect.any(Error) }),
|
|
);
|
|
});
|
|
|
|
describe('should uninitialize on override', () => {
|
|
it('should uninitialize cameras', () => {
|
|
const api = createCardAPI();
|
|
const stateManager = new ConditionStateManager();
|
|
vi.mocked(api.getConditionStateManager).mockReturnValue(stateManager);
|
|
|
|
const manager = new ConfigManager(api);
|
|
const config = {
|
|
type: 'custom:advanced-camera-card',
|
|
cameras: [TEST_CAMERAS.OFFICE],
|
|
overrides: [
|
|
{
|
|
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
|
set: {
|
|
cameras: [TEST_CAMERAS.KITCHEN],
|
|
},
|
|
},
|
|
],
|
|
};
|
|
|
|
manager.setConfig(config);
|
|
|
|
expect(api.getInitializationManager().uninitialize).not.toHaveBeenCalledWith(
|
|
InitializationAspect.CAMERAS,
|
|
);
|
|
|
|
stateManager.setState({ fullscreen: true });
|
|
|
|
expect(api.getInitializationManager().uninitialize).toHaveBeenCalledWith(
|
|
InitializationAspect.CAMERAS,
|
|
);
|
|
});
|
|
|
|
it('should uninitialize cameras_global', () => {
|
|
const api = createCardAPI();
|
|
const stateManager = new ConditionStateManager();
|
|
vi.mocked(api.getConditionStateManager).mockReturnValue(stateManager);
|
|
|
|
const manager = new ConfigManager(api);
|
|
const config = {
|
|
type: 'custom:advanced-camera-card',
|
|
cameras: [TEST_CAMERAS.OFFICE],
|
|
overrides: [
|
|
{
|
|
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
|
set: {
|
|
cameras_global: { live_provider: 'jsmpeg' },
|
|
},
|
|
},
|
|
],
|
|
};
|
|
|
|
manager.setConfig(config);
|
|
|
|
expect(api.getInitializationManager().uninitialize).not.toHaveBeenCalledWith(
|
|
InitializationAspect.CAMERAS,
|
|
);
|
|
|
|
stateManager.setState({ fullscreen: true });
|
|
|
|
expect(api.getInitializationManager().uninitialize).toHaveBeenCalledWith(
|
|
InitializationAspect.CAMERAS,
|
|
);
|
|
});
|
|
|
|
it('should uninitialize live.microphone.always_connected', () => {
|
|
const api = createCardAPI();
|
|
const stateManager = new ConditionStateManager();
|
|
vi.mocked(api.getConditionStateManager).mockReturnValue(stateManager);
|
|
|
|
const manager = new ConfigManager(api);
|
|
const config = {
|
|
type: 'custom:advanced-camera-card',
|
|
cameras: [TEST_CAMERAS.OFFICE],
|
|
overrides: [
|
|
{
|
|
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
|
set: {
|
|
'live.microphone.always_connected': true,
|
|
},
|
|
},
|
|
],
|
|
};
|
|
|
|
manager.setConfig(config);
|
|
|
|
expect(api.getInitializationManager().uninitialize).not.toHaveBeenCalledWith(
|
|
InitializationAspect.MICROPHONE_CONNECT,
|
|
);
|
|
|
|
stateManager.setState({ fullscreen: true });
|
|
|
|
expect(api.getInitializationManager().uninitialize).toHaveBeenCalledWith(
|
|
InitializationAspect.MICROPHONE_CONNECT,
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('should initialize on override', () => {
|
|
it('should initialize background items', async () => {
|
|
const api = createCardAPI();
|
|
const stateManager = new ConditionStateManager();
|
|
const listener = vi.fn();
|
|
stateManager.addListener(listener);
|
|
vi.mocked(api.getConditionStateManager).mockReturnValue(stateManager);
|
|
|
|
const manager = new ConfigManager(api);
|
|
const config = {
|
|
type: 'custom:advanced-camera-card',
|
|
cameras: [TEST_CAMERAS.OFFICE],
|
|
overrides: [
|
|
{
|
|
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
|
set: {
|
|
cameras: [TEST_CAMERAS.KITCHEN],
|
|
},
|
|
},
|
|
],
|
|
};
|
|
|
|
manager.setConfig(config);
|
|
|
|
await flushPromises();
|
|
|
|
expect(api.getDefaultManager().initializeIfNecessary).toBeCalledTimes(1);
|
|
expect(api.getMediaPlayerManager().initializeIfNecessary).toBeCalledTimes(1);
|
|
expect(listener).not.toBeCalledWith(
|
|
expect.objectContaining({ change: { config: expect.anything() } }),
|
|
);
|
|
|
|
vi.mocked(api.getInitializationManager().isInitializedMandatory).mockReturnValue(
|
|
true,
|
|
);
|
|
stateManager.setState({ fullscreen: true });
|
|
|
|
await flushPromises();
|
|
|
|
expect(api.getDefaultManager().initializeIfNecessary).toBeCalledTimes(2);
|
|
expect(api.getMediaPlayerManager().initializeIfNecessary).toBeCalledTimes(2);
|
|
|
|
// Should set the config condition state.
|
|
expect(listener).toBeCalledWith(
|
|
expect.objectContaining({ change: { config: expect.anything() } }),
|
|
);
|
|
});
|
|
});
|
|
|
|
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);
|
|
await flushPromises();
|
|
|
|
// Verify keyboard shortcuts automations were added initially with ptz_home
|
|
expect(addAutomationsSpy).toHaveBeenCalledWith(
|
|
expect.arrayContaining([
|
|
expect.objectContaining({
|
|
triggers: expect.arrayContaining([
|
|
expect.objectContaining({ trigger: '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: Automation) =>
|
|
automation.triggers.some(
|
|
(trig: Trigger) => trig.trigger === 'key' && trig.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);
|
|
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 = {
|
|
triggers: [{ trigger: 'fullscreen' as const, fullscreen: false }],
|
|
actions: [createGeneralAction('screenshot')],
|
|
};
|
|
const config = createConfig({
|
|
automations: [automation],
|
|
overrides: [
|
|
{
|
|
delete: ['automations'],
|
|
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
|
},
|
|
],
|
|
});
|
|
|
|
manager.setConfig(config);
|
|
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();
|
|
});
|
|
|
|
it('should not reload user automations for unrelated override changes', async () => {
|
|
const { manager, stateManager, api, addAutomationsSpy, deleteAutomationsSpy } =
|
|
createConfigManagerTestSetup();
|
|
|
|
const executeActionsMock = vi.fn();
|
|
vi.mocked(api.getActionsManager().executeActions).mockImplementation(
|
|
executeActionsMock,
|
|
);
|
|
|
|
const automation = {
|
|
triggers: [{ trigger: 'fullscreen' as const, fullscreen: true }],
|
|
actions: [createGeneralAction('screenshot')],
|
|
};
|
|
const config = createConfig({
|
|
automations: [automation],
|
|
overrides: [
|
|
{
|
|
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
|
set: {
|
|
'menu.buttons.microphone.enabled': false,
|
|
},
|
|
},
|
|
],
|
|
});
|
|
|
|
manager.setConfig(config);
|
|
await flushPromises();
|
|
|
|
addAutomationsSpy.mockClear();
|
|
deleteAutomationsSpy.mockClear();
|
|
executeActionsMock.mockClear();
|
|
|
|
stateManager.setState({ fullscreen: true });
|
|
await flushPromises();
|
|
|
|
expect(deleteAutomationsSpy).not.toHaveBeenCalled();
|
|
expect(addAutomationsSpy).not.toHaveBeenCalled();
|
|
expect(executeActionsMock).toHaveBeenCalledTimes(1);
|
|
});
|
|
});
|
|
|
|
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);
|
|
await flushPromises();
|
|
|
|
// Verify remote-control automations were added initially with config condition
|
|
expect(addAutomationsSpy).toHaveBeenCalledWith(
|
|
expect.arrayContaining([
|
|
expect.objectContaining({
|
|
triggers: expect.arrayContaining([
|
|
expect.objectContaining({
|
|
trigger: '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: Automation) =>
|
|
automation.triggers.some(
|
|
(trig: Trigger) =>
|
|
trig.trigger === 'config' &&
|
|
trig.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({
|
|
triggers: expect.arrayContaining([
|
|
expect.objectContaining({
|
|
trigger: 'config',
|
|
paths: expect.arrayContaining(['remote_control.entities.camera']),
|
|
}),
|
|
]),
|
|
}),
|
|
]),
|
|
);
|
|
});
|
|
|
|
it('should not reload remote-control automations for unrelated override changes', async () => {
|
|
const { manager, stateManager, deleteAutomationsSpy } =
|
|
createConfigManagerTestSetup();
|
|
|
|
const config = createConfig({
|
|
remote_control: {
|
|
entities: { camera: 'input_select.camera' },
|
|
},
|
|
overrides: [
|
|
{
|
|
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
|
set: {
|
|
'menu.buttons.microphone.enabled': false,
|
|
},
|
|
},
|
|
],
|
|
});
|
|
|
|
manager.setConfig(config);
|
|
await flushPromises();
|
|
|
|
deleteAutomationsSpy.mockClear();
|
|
|
|
stateManager.setState({ fullscreen: true });
|
|
await flushPromises();
|
|
|
|
expect(deleteAutomationsSpy).not.toHaveBeenCalledWith(
|
|
setRemoteControlEntityFromConfig,
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('keyboard-shortcuts loader with overrides', () => {
|
|
it('should not reload keyboard-shortcut automations for unrelated override changes', async () => {
|
|
const { manager, stateManager, deleteAutomationsSpy } =
|
|
createConfigManagerTestSetup();
|
|
|
|
const config = createConfig({
|
|
view: {
|
|
keyboard_shortcuts: {
|
|
enabled: true,
|
|
ptz_left: { key: 'ArrowLeft' },
|
|
},
|
|
},
|
|
overrides: [
|
|
{
|
|
conditions: [TEST_CONDITIONS.FULLSCREEN_ON],
|
|
set: {
|
|
'menu.buttons.microphone.enabled': false,
|
|
},
|
|
},
|
|
],
|
|
});
|
|
|
|
manager.setConfig(config);
|
|
await flushPromises();
|
|
|
|
deleteAutomationsSpy.mockClear();
|
|
|
|
stateManager.setState({ fullscreen: true });
|
|
await flushPromises();
|
|
|
|
expect(deleteAutomationsSpy).not.toHaveBeenCalledWith(
|
|
setKeyboardShortcutsFromConfig,
|
|
);
|
|
});
|
|
});
|
|
});
|
|
});
|