flan/advanced-camera-card
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

perf(bundle): lazy-load the nunjucks template engine (#2535)

Browse Source 
Closes #2531.

## Summary

The full `nunjucks` templating engine (~226KB) plus `ha-nunjucks`
(~46KB) — roughly **272KB, ~13% of the eager entry chunk** — was
statically imported and downloaded by every card on initial load, even
though templates only apply when a config value contains a `{{ … }}` /
`{% … %}` delimiter. Most cards use no templates and never need the
engine.

This defers the engine behind a dynamic `import('ha-nunjucks/dist')` so
it ships in a separate, on-demand chunk instead of the eager
`card-*.js`.

## Approach

The render path (`TemplateRenderer.renderRecursively`) is **kept
synchronous** — it is called from many synchronous hot paths
(condition/trigger evaluators, picture-elements rendering, actions,
folder matchers), and making it async would be a large, high-risk
refactor of the evaluation core.

Instead:

- **New `src/card-controller/templates/engine.ts`** — a module-level
singleton lazy loader (`loadTemplateEngine()` / `getTemplateEngine()`)
shared across all `TemplateRenderer` instances, plus a
`containsTemplate()` delimiter helper.
- **Delimiter gating** — strings without a delimiter never touch the
engine (the overwhelming majority of renders).
- **Pre-warm at config time** — because every template string originates
in the config, a new mandatory `TEMPLATE_ENGINE` initialization aspect
loads the engine before first render whenever the config contains a
delimiter. This **guarantees no raw `{{ … }}` flash**: content/condition
rendering is blocked until the engine is present for template-using
cards. Cards without templates never load it.

## Result

- nunjucks + ha-nunjucks move out of the eager chunk into a separate
chunk fetched only when a card actually uses templates.
- No change to the synchronous public render API; condition/trigger
evaluation core untouched.

## Tests

- New `engine.ts` loader coverage (concurrent load, cached reuse,
not-loaded fallback).
- The 11 existing test files that render real (delimiter-bearing)
templates declare their dependency explicitly via
`beforeAll(loadTemplateEngine)` — no global/implicit setup hook.
- Full suite green (4764 tests), lint and ts-prune clean, per-file 100%
coverage maintained for the affected directories.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

https://claude.ai/code/session_016ykWemdkZrgywvC71pHc6c

---
_Generated by [Claude
Code](https://claude.ai/code/session_016ykWemdkZrgywvC71pHc6c)_
This commit is contained in:
Dermot Duffy
2026-06-30 17:45:13 -07:00
committed by dermotduffy
parent b33c034810
commit ea251ca988
59 changed files with 1420 additions and 541 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/card-controller/actions/actions-manager.test.ts
+58 -37
View File
@@ -8,7 +8,6 @@ import {
it,
vi,
} from 'vitest';
import { mock } from 'vitest-mock-extended';
import {
ActionsManager,
@@ -16,14 +15,20 @@ import {
type InteractionName,
} from '../../../src/card-controller/actions/actions-manager';
import type { CardController } from '../../../src/card-controller/controller';
import { TemplateRenderer } from '../../../src/card-controller/templates';
import { TemplateManager } from '../../../src/card-controller/templates';
import type { AdvancedCameraCardView } from '../../../src/config/schema/common/const';
import {
createInternalCallbackAction,
createLogAction,
} from '../../../src/utils/action';
import { arrayify } from '../../../src/utils/basic';
import { createCardAPI, createConfig, createHASS, createView } from '../../test-utils';
import {
createCardAPI,
createConfig,
createHASS,
createMockTemplateRenderer,
createView,
} from '../../test-utils';
const createAPI = (): CardController => {
const api = createCardAPI();
@@ -337,10 +342,9 @@ describe('ActionsManager', () => {
it('should render templates', async () => {
const action = createLogAction('{{ acc.camera }}');
const templateRenderer = mock<TemplateRenderer>();
templateRenderer.renderRecursivelyAsType.mockReturnValue(action);
const api = createAPI();
vi.mocked(api.getTemplateManager).mockReturnValue(createMockTemplateRenderer());
const hass = createHASS();
vi.mocked(api.getHASSManager().getHASS).mockReturnValue(hass);
@@ -349,7 +353,7 @@ describe('ActionsManager', () => {
};
vi.mocked(api.getConditionStateManager().getState).mockReturnValue(conditionState);
const manager = new ActionsManager(api, templateRenderer);
const manager = new ActionsManager(api);
const config = { entity: 'light.office' };
const triggerData = {
platform: 'acc',
@@ -361,10 +365,14 @@ describe('ActionsManager', () => {
await manager.executeActions({ actions: action, config, triggerData });
expect(templateRenderer.renderRecursivelyAsType).toBeCalledWith(hass, action, {
conditionState,
triggerData,
});
expect(vi.mocked(api.getTemplateManager().renderRecursivelyAsType)).toBeCalledWith(
hass,
action,
{
conditionState,
triggerData,
},
);
});
it('should filter actions through the lock manager before rendering them', async () => {
@@ -377,20 +385,18 @@ describe('ActionsManager', () => {
allowedRan();
});
const templateRenderer = mock<TemplateRenderer>();
templateRenderer.renderRecursivelyAsType.mockReturnValue(allowedAction);
const api = createAPI();
vi.mocked(api.getTemplateManager).mockReturnValue(createMockTemplateRenderer());
vi.mocked(api.getHASSManager().getHASS).mockReturnValue(createHASS());
vi.mocked(api.getLockManager().getAllowedActions).mockReturnValue([allowedAction]);
const manager = new ActionsManager(api, templateRenderer);
const manager = new ActionsManager(api);
await manager.executeActions({ actions: rawAction });
// The lock manager sees the raw (unrendered) action; only the action it
// returns is rendered and run.
expect(api.getLockManager().getAllowedActions).toBeCalledWith(rawAction);
expect(api.getLockManager().getAllowedActions).toBeCalledWith([rawAction]);
expect(allowedRan).toBeCalled();
expect(rawRan).not.toBeCalled();
});
@@ -398,17 +404,16 @@ describe('ActionsManager', () => {
it('should render each action against the state at its turn', async () => {
let camera = 'first';
const templateRenderer = mock<TemplateRenderer>();
// Identity render -- assert on the render *inputs*, not a swapped output.
templateRenderer.renderRecursivelyAsType.mockImplementation((_hass, data) => data);
const api = createAPI();
// The mock renderer passes values through, so assert on the render
// *inputs*, not a swapped output.
vi.mocked(api.getTemplateManager).mockReturnValue(createMockTemplateRenderer());
vi.mocked(api.getHASSManager().getHASS).mockReturnValue(createHASS());
vi.mocked(api.getConditionStateManager().getState).mockImplementation(() => ({
camera,
}));
const manager = new ActionsManager(api, templateRenderer);
const manager = new ActionsManager(api);
await manager.executeActions({
actions: [
@@ -423,13 +428,17 @@ describe('ActionsManager', () => {
// Each action renders with the state as it is at its turn: the second
// sees the camera the first action set.
expect(templateRenderer.renderRecursivelyAsType).toHaveBeenNthCalledWith(
expect(
vi.mocked(api.getTemplateManager().renderRecursivelyAsType),
).toHaveBeenNthCalledWith(
1,
expect.anything(),
expect.anything(),
expect.objectContaining({ conditionState: { camera: 'first' } }),
);
expect(templateRenderer.renderRecursivelyAsType).toHaveBeenNthCalledWith(
expect(
vi.mocked(api.getTemplateManager().renderRecursivelyAsType),
).toHaveBeenNthCalledWith(
2,
expect.anything(),
expect.anything(),
@@ -440,16 +449,14 @@ describe('ActionsManager', () => {
it('should render against the hass available at each step', async () => {
const ran: string[] = [];
const templateRenderer = mock<TemplateRenderer>();
templateRenderer.renderRecursivelyAsType.mockImplementation((_hass, data) => data);
const api = createAPI();
vi.mocked(api.getTemplateManager).mockReturnValue(createMockTemplateRenderer());
// No HASS for the first action's render; HASS thereafter.
vi.mocked(api.getHASSManager().getHASS)
.mockReturnValueOnce(null)
.mockReturnValue(createHASS());
const manager = new ActionsManager(api, templateRenderer);
const manager = new ActionsManager(api);
await manager.executeActions({
actions: [
@@ -465,23 +472,27 @@ describe('ActionsManager', () => {
// Both actions ran; only the second was rendered -- the first saw no
// HASS, so HASS is read per action rather than captured once.
expect(ran).toEqual(['one', 'two']);
expect(templateRenderer.renderRecursivelyAsType).toBeCalledTimes(1);
expect(
vi.mocked(api.getTemplateManager().renderRecursivelyAsType),
).toBeCalledTimes(1);
});
it('should abort the remaining actions when one fails to render', async () => {
const ran: string[] = [];
const templateRenderer = mock<TemplateRenderer>();
templateRenderer.renderRecursivelyAsType
const api = createAPI();
const renderer = createMockTemplateRenderer();
vi.mocked(api.getTemplateManager).mockReturnValue(renderer);
// The second action's render throws, to exercise a mid-sequence failure.
vi.mocked(renderer.renderRecursivelyAsType)
.mockImplementationOnce((_hass, data) => data)
.mockImplementationOnce(() => {
throw new Error('bad template');
});
const api = createAPI();
vi.mocked(api.getHASSManager().getHASS).mockReturnValue(createHASS());
const manager = new ActionsManager(api, templateRenderer);
const manager = new ActionsManager(api);
const warnSpy = vi.spyOn(global.console, 'warn').mockReturnValue(undefined);
await manager.executeActions({
@@ -511,7 +522,11 @@ describe('ActionsManager', () => {
fullscreen: true,
});
const manager = new ActionsManager(api, new TemplateRenderer());
// The if-action renders its own (non-branch) fields, so give it an
// identity renderer that passes the config through unchanged.
vi.mocked(api.getTemplateManager).mockReturnValue(createMockTemplateRenderer());
const manager = new ActionsManager(api);
const consoleSpy = vi.spyOn(global.console, 'info').mockReturnValue(undefined);
const thenAction = createLogAction('{{ trigger.entity_id }}');
@@ -527,7 +542,7 @@ describe('ActionsManager', () => {
// The branch is left raw (template intact) and forwarded with the trigger
// data, so the nested executor renders it per-step when it runs -- not
// frozen against the state at the `if` step.
expect(api.getActionsManager().executeActions).toBeCalledWith({
expect(api.getActionsManager().executeNestedActions).toBeCalledWith({
actions: [thenAction],
config: undefined,
triggerData: { platform: 'state', entity_id: 'binary_sensor.door' },
@@ -541,14 +556,20 @@ describe('ActionsManager', () => {
it('should render if-action branch actions per-step', async () => {
let camera = 'before';
// This case renders a real branch template, so load the lazily-imported
// engine for the synchronous renderer.
const templateManager = new TemplateManager();
await templateManager.loadRenderer();
const api = createAPI();
vi.mocked(api.getHASSManager().getHASS).mockReturnValue(createHASS());
vi.mocked(api.getConditionStateManager().getState).mockImplementation(() => ({
camera,
fullscreen: true,
}));
vi.mocked(api.getTemplateManager).mockReturnValue(templateManager);
const manager = new ActionsManager(api, new TemplateRenderer());
const manager = new ActionsManager(api);
// The if-action's nested executor is the same (real) manager.
vi.mocked(api.getActionsManager).mockReturnValue(manager);
@@ -578,7 +599,7 @@ describe('ActionsManager', () => {
const api = createAPI();
vi.mocked(api.getHASSManager().getHASS).mockReturnValue(createHASS());
const manager = new ActionsManager(api, new TemplateRenderer());
const manager = new ActionsManager(api);
const warnSpy = vi.spyOn(global.console, 'warn').mockReturnValue(undefined);
await manager.executeActions({
tests/card-controller/actions/actions/generated-action.test.ts
+77
View File
@@ -0,0 +1,77 @@
import { describe, expect, it, vi } from 'vitest';
import { GeneratedAction } from '../../../../src/card-controller/actions/actions/generated-action';
import type { TriggerData } from '../../../../src/condition-trigger/triggers/types';
import type { ActionGenerator } from '../../../../src/config/schema/actions/custom/generated-action';
import { createCameraAction, createGeneratedAction } from '../../../../src/utils/action';
import { createCardAPI } from '../../../test-utils';
describe('GeneratedAction', () => {
it('should run the generated action as a nested action set', async () => {
const api = createCardAPI();
const generated = createCameraAction('camera.office');
const action = new GeneratedAction(
{},
createGeneratedAction(() => generated),
);
await action.execute(api);
expect(api.getActionsManager().executeNestedActions).toBeCalledWith({
actions: generated,
config: undefined,
triggerData: undefined,
});
});
it('should run multiple generated actions when the generator returns several', async () => {
const api = createCardAPI();
const generated = [
createCameraAction('camera.one'),
createCameraAction('camera.two'),
];
const action = new GeneratedAction(
{},
createGeneratedAction(() => generated),
);
await action.execute(api);
expect(api.getActionsManager().executeNestedActions).toBeCalledWith({
actions: generated,
config: undefined,
triggerData: undefined,
});
});
it('should do nothing when the generator produces nothing', async () => {
const api = createCardAPI();
const action = new GeneratedAction(
{},
createGeneratedAction(() => null),
);
await action.execute(api);
expect(api.getActionsManager().executeNestedActions).not.toBeCalled();
});
it('should pass the api and trigger data to the generator', async () => {
const api = createCardAPI();
const triggerData: TriggerData = {
platform: 'state',
entity_id: 'input_select.camera',
};
const generator: ActionGenerator = vi.fn(() => null);
const action = new GeneratedAction(
{},
createGeneratedAction(generator),
undefined,
triggerData,
);
await action.execute(api);
expect(generator).toBeCalledWith({ api, triggerData });
});
});
tests/card-controller/actions/actions/if.test.ts
+3 -3
View File
@@ -35,7 +35,7 @@ describe('IfAction', () => {
await action.execute(api);
expect(api.getActionsManager().executeActions).toBeCalledWith({
expect(api.getActionsManager().executeNestedActions).toBeCalledWith({
actions: thenActions,
config: undefined,
triggerData: undefined,
@@ -59,7 +59,7 @@ describe('IfAction', () => {
await action.execute(api);
expect(api.getActionsManager().executeActions).toBeCalledWith({
expect(api.getActionsManager().executeNestedActions).toBeCalledWith({
actions: elseActions,
config: undefined,
triggerData: undefined,
@@ -82,6 +82,6 @@ describe('IfAction', () => {
await action.execute(api);
expect(api.getActionsManager().executeActions).not.toBeCalled();
expect(api.getActionsManager().executeNestedActions).not.toBeCalled();
});
});
tests/card-controller/actions/actions/set.test.ts
+12 -3
View File
@@ -2,11 +2,20 @@ import { describe, expect, it, vi } from 'vitest';
import { ActionSet } from '../../../../src/card-controller/actions/actions/set';
import { createLogAction } from '../../../../src/utils/action';
import { arrayify } from '../../../../src/utils/basic';
import { createCardAPI } from '../../../test-utils';
describe('ActionSet', () => {
it('should execute single action', async () => {
const createAPI = () => {
const api = createCardAPI();
vi.mocked(api.getLockManager().getAllowedActions).mockImplementation((actions) =>
arrayify(actions),
);
return api;
};
it('should execute single action', async () => {
const api = createAPI();
const set = new ActionSet({}, createLogAction('Hello, world!'));
@@ -16,7 +25,7 @@ describe('ActionSet', () => {
});
it('should not execute invalid action', async () => {
const api = createCardAPI();
const api = createAPI();
const set = new ActionSet(
{},
createLogAction('Hello, world!', {
@@ -30,7 +39,7 @@ describe('ActionSet', () => {
});
it('should stop execution', async () => {
const api = createCardAPI();
const api = createAPI();
const set = new ActionSet({}, createLogAction('Hello, world!'));
tests/card-controller/actions/factory.test.ts
+9
View File
@@ -13,6 +13,7 @@ import { DownloadAction } from '../../../src/card-controller/actions/actions/dow
import { EffectAction } from '../../../src/card-controller/actions/actions/effect';
import { ExpandAction } from '../../../src/card-controller/actions/actions/expand';
import { FullscreenAction } from '../../../src/card-controller/actions/actions/fullscreen';
import { GeneratedAction } from '../../../src/card-controller/actions/actions/generated-action';
import { IfAction } from '../../../src/card-controller/actions/actions/if';
import { InfoAction } from '../../../src/card-controller/actions/actions/info';
import { InternalCallbackAction } from '../../../src/card-controller/actions/actions/internal-callback';
@@ -48,6 +49,7 @@ import { UnmuteAction } from '../../../src/card-controller/actions/actions/unmut
import { URLAction } from '../../../src/card-controller/actions/actions/url';
import { ViewAction } from '../../../src/card-controller/actions/actions/view';
import { ActionFactory } from '../../../src/card-controller/actions/factory';
import { GENERATED_ACTION } from '../../../src/config/schema/actions/custom/generated-action';
import { INTERNAL_CALLBACK_ACTION } from '../../../src/config/schema/actions/custom/internal';
import type { ActionConfig } from '../../../src/config/schema/actions/types';
@@ -203,6 +205,13 @@ describe('ActionFactory', () => {
},
InternalCallbackAction,
],
[
{
advanced_camera_card_action: GENERATED_ACTION,
generator: vi.fn(),
},
GeneratedAction,
],
[{ advanced_camera_card_action: 'reload' as const }, ReloadAction],
[{ advanced_camera_card_action: 'set_review' as const }, SetReviewAction],
[{ advanced_camera_card_action: 'effect' as const }, EffectAction],
tests/card-controller/automations-manager.test.ts
+27
View File
@@ -109,6 +109,33 @@ describe('AutomationsManager', () => {
expect(api.getActionsManager().executeActions).toBeCalledTimes(2);
});
it('should subscribe automations registered before initialization', () => {
const api = createCardAPI();
vi.mocked(api.getHASSManager().hasHASS).mockReturnValue(true);
const isInitialized = vi.mocked(
api.getInitializationManager().isInitializedMandatory,
);
isInitialized.mockReturnValue(false);
const stateManager = new ConditionStateManager();
vi.mocked(api.getConditionStateManager).mockReturnValue(stateManager);
const automationsManager = new AutomationsManager(api);
automationsManager.addAutomations([automation]);
// Registered before initialization: the triggers are not yet subscribed, so
// a matching change does nothing.
stateManager.setState({ fullscreen: true });
expect(api.getActionsManager().executeActions).not.toBeCalled();
// Initialization completes and subscribes the dormant automations.
isInitialized.mockReturnValue(true);
automationsManager.subscribe();
stateManager.setState({ fullscreen: false });
stateManager.setState({ fullscreen: true });
expect(api.getActionsManager().executeActions).toBeCalledTimes(1);
});
it('should run actions when the ongoing conditions hold', () => {
const api = createCardAPI();
vi.mocked(api.getHASSManager().hasHASS).mockReturnValue(true);
tests/card-controller/config/config-manager.test.ts
+29
View File
@@ -894,4 +894,33 @@ describe('ConfigManager', () => {
});
});
});
describe('hasTemplate', () => {
it('should report true when the config contains a template', () => {
const { manager } = createConfigManagerTestSetup();
manager.setConfig({
type: 'custom:advanced-camera-card',
cameras: [TEST_CAMERAS.OFFICE],
view: {
actions: {
tap_action: { action: 'navigate', navigation_path: '{{ acc.camera }}' },
},
},
});
expect(manager.hasTemplate()).toBe(true);
});
it('should report false when the config contains no template', () => {
const { manager } = createConfigManagerTestSetup();
manager.setConfig({
type: 'custom:advanced-camera-card',
cameras: [TEST_CAMERAS.OFFICE],
});
expect(manager.hasTemplate()).toBe(false);
});
});
});
tests/card-controller/config/load-control-entities.test.ts
+112 -20
View File
@@ -2,13 +2,23 @@ import { assert, describe, expect, it, vi } from 'vitest';
import { AutomationsManager } from '../../../src/card-controller/automations-manager';
import { setRemoteControlEntityFromConfig } from '../../../src/card-controller/config/load-control-entities';
import { TemplateRenderer } from '../../../src/card-controller/templates/index';
import type { CardController } from '../../../src/card-controller/controller';
import { ConditionStateManager } from '../../../src/condition-trigger/conditions/state-manager';
import {
GENERATED_ACTION,
type ActionGenerator,
type GeneratedActionConfig,
} from '../../../src/config/schema/actions/custom/generated-action';
import {
INTERNAL_CALLBACK_ACTION,
type InternalCallbackActionConfig,
} from '../../../src/config/schema/actions/custom/internal';
import { isAdvancedCameraCardCustomAction } from '../../../src/utils/action';
import type { ActionConfig } from '../../../src/config/schema/actions/types';
import {
createCameraAction,
isAdvancedCameraCardCustomAction,
} from '../../../src/utils/action';
import { arrayify } from '../../../src/utils/basic';
import {
createCardAPI,
createConfig,
@@ -18,6 +28,10 @@ import {
createView,
} from '../../test-utils';
const isGeneratedAction = (action: ActionConfig): action is GeneratedActionConfig =>
'advanced_camera_card_action' in action &&
action.advanced_camera_card_action === GENERATED_ACTION;
describe('setRemoteControlEntityFromConfig', () => {
it('without control entity', () => {
const api = createCardAPI();
@@ -94,8 +108,8 @@ describe('setRemoteControlEntityFromConfig', () => {
actions: [
{
action: 'fire-dom-event',
advanced_camera_card_action: 'camera_select',
camera: '{{ trigger.to_state.state }}',
advanced_camera_card_action: '__GENERATED_ACTION__',
generator: expect.any(Function),
},
],
triggers: [
@@ -161,8 +175,8 @@ describe('setRemoteControlEntityFromConfig', () => {
actions: [
{
action: 'fire-dom-event',
advanced_camera_card_action: 'camera_select',
camera: '{{ hass.states["input_select.camera"].state }}',
advanced_camera_card_action: '__GENERATED_ACTION__',
generator: expect.any(Function),
},
],
triggers: [
@@ -176,8 +190,8 @@ describe('setRemoteControlEntityFromConfig', () => {
actions: [
{
action: 'fire-dom-event',
advanced_camera_card_action: 'camera_select',
camera: '{{ trigger.to_state.state }}',
advanced_camera_card_action: '__GENERATED_ACTION__',
generator: expect.any(Function),
},
],
triggers: [
@@ -623,8 +637,8 @@ describe('setRemoteControlEntityFromConfig', () => {
});
});
describe('should render the firing trigger into the camera action', () => {
it('should resolve the new entity state through the trigger template', () => {
describe('should wire the firing trigger into the camera action', () => {
it('should carry the new entity state to the camera-select action', () => {
const api = createCardAPI();
vi.mocked(api.getConfigManager().getConfig).mockReturnValue(
createConfig({
@@ -638,10 +652,12 @@ describe('setRemoteControlEntityFromConfig', () => {
);
// Capture the automations the loader registers, then drive them through a
// real AutomationsManager so the state trigger actually fires and its
// `{{ trigger.to_state.state }}` template is rendered end to end (the
// other tests only string-match the literal, so a context mis-wire would
// silently break remote control).
// real AutomationsManager so the state trigger actually fires. The
// registered action is a generated action whose generator reads the
// firing trigger's `to_state` to pick the camera, so this verifies that
// the generator and the exact triggering value are wired through together
// (the other tests only string-match the registered action shape, so a
// context mis-wire would silently break remote control).
setRemoteControlEntityFromConfig(api);
const automations = vi.mocked(api.getAutomationsManager().addAutomations).mock
.calls[0][0];
@@ -670,16 +686,92 @@ describe('setRemoteControlEntityFromConfig', () => {
.mock.calls.at(-1)?.[0];
assert(captured);
const rendered = new TemplateRenderer().renderRecursively(hass, captured.actions, {
triggerData: captured.triggerData,
});
expect(rendered).toEqual([
expect(captured.actions).toEqual([
{
action: 'fire-dom-event',
advanced_camera_card_action: 'camera_select',
camera: 'camera.two',
advanced_camera_card_action: '__GENERATED_ACTION__',
generator: expect.any(Function),
},
]);
expect(captured.triggerData?.platform).toBe('state');
expect(captured.triggerData?.entity_id).toBe('input_select.camera');
expect(captured.triggerData?.to_state?.state).toBe('camera.two');
// Running the generated action's generator with the firing trigger
// selects the camera named by the new state.
const generated = arrayify(captured.actions)[0];
assert(isGeneratedAction(generated));
expect(generated.generator({ api, triggerData: captured.triggerData })).toEqual({
action: 'fire-dom-event',
advanced_camera_card_action: 'camera_select',
camera: 'camera.two',
});
});
});
describe('should generate a camera-select action only when a camera is named', () => {
// Register the automations for a given camera priority, then pull the
// generator off the generated action on the named trigger's automation.
const getGenerator = (
api: CardController,
cameraPriority: 'card' | 'entity',
triggerName: string,
): ActionGenerator => {
vi.mocked(api.getConfigManager().getConfig).mockReturnValue(
createConfig({
remote_control: {
entities: {
camera: 'input_select.camera',
camera_priority: cameraPriority,
},
},
}),
);
setRemoteControlEntityFromConfig(api);
const automations = vi.mocked(api.getAutomationsManager().addAutomations).mock
.calls[0][0];
const automation = automations.find((candidate) =>
candidate.triggers.some((trigger) => trigger.trigger === triggerName),
);
assert(automation);
const action = arrayify(automation.actions)[0];
assert(isGeneratedAction(action));
return action.generator;
};
it('should select the camera named by the entity state on initialize', () => {
const api = createCardAPI();
vi.mocked(api.getHASSManager().getHASS).mockReturnValue(
createHASS({
'input_select.camera': createStateEntity({ state: 'camera.kitchen' }),
}),
);
expect(getGenerator(api, 'entity', 'initialized')({ api })).toEqual(
createCameraAction('camera.kitchen'),
);
});
it('should generate nothing on initialize when the entity has no state', () => {
const api = createCardAPI();
vi.mocked(api.getHASSManager().getHASS).mockReturnValue(createHASS({}));
expect(getGenerator(api, 'entity', 'initialized')({ api })).toBeNull();
});
it('should generate nothing for a state trigger that carries no to_state', () => {
const api = createCardAPI();
expect(
getGenerator(
api,
'card',
'state',
)({
api,
triggerData: { platform: 'state', entity_id: 'input_select.camera' },
}),
).toBeNull();
});
});
});
tests/card-controller/config/overrides-manager.test.ts
+16 -14
View File
@@ -4,9 +4,11 @@ import { OverridesManager } from '../../../src/card-controller/config/overrides-
import { ConditionStateManager } from '../../../src/condition-trigger/conditions/state-manager';
import type { AdvancedCameraCardConfig } from '../../../src/config/schema/types';
import { AdvancedCameraCardError } from '../../../src/types';
import { createConfig } from '../../test-utils';
import { createConfig, createMockTemplateRenderer } from '../../test-utils';
describe('OverridesManager', () => {
const templateManager = createMockTemplateRenderer();
it('should add overrides', () => {
const config = createConfig({
overrides: [
@@ -25,7 +27,7 @@ describe('OverridesManager', () => {
});
const manager = new OverridesManager(vi.fn());
manager.set(new ConditionStateManager(), config.overrides);
manager.set(new ConditionStateManager(), templateManager, config.overrides);
expect(manager.hasOverrides()).toBe(true);
});
@@ -49,11 +51,11 @@ describe('OverridesManager', () => {
const stateManager = new ConditionStateManager();
const manager = new OverridesManager(vi.fn());
manager.set(stateManager, config.overrides);
manager.set(stateManager, templateManager, config.overrides);
expect(manager.getConfig(config).menu?.style).toBe('hidden');
manager.set(stateManager, []);
manager.set(stateManager, templateManager, []);
stateManager.setState({ fullscreen: true });
expect(manager.getConfig(config).menu?.style).toBe('hidden');
@@ -79,7 +81,7 @@ describe('OverridesManager', () => {
});
const manager = new OverridesManager(vi.fn());
manager.set(new ConditionStateManager(), config.overrides);
manager.set(new ConditionStateManager(), templateManager, config.overrides);
expect(manager.getConfig(config)).toBe(config);
});
@@ -104,7 +106,7 @@ describe('OverridesManager', () => {
const callback = vi.fn();
const stateManager = new ConditionStateManager();
const manager = new OverridesManager(callback);
manager.set(stateManager, config.overrides);
manager.set(stateManager, templateManager, config.overrides);
expect(manager.getConfig(config).menu?.style).toBe('hidden');
@@ -139,7 +141,7 @@ describe('OverridesManager', () => {
stateManager.setState({ fullscreen: true });
const manager = new OverridesManager(vi.fn());
manager.set(stateManager, config.overrides);
manager.set(stateManager, templateManager, config.overrides);
const overriddenConfig = manager.getConfig(config);
@@ -174,7 +176,7 @@ describe('OverridesManager', () => {
stateManager.setState({ fullscreen: true });
const manager = new OverridesManager(vi.fn());
manager.set(stateManager, config.overrides);
manager.set(stateManager, templateManager, config.overrides);
const overriddenConfig = manager.getConfig(config);
@@ -205,7 +207,7 @@ describe('OverridesManager', () => {
stateManager.setState({ fullscreen: true });
const manager = new OverridesManager(vi.fn());
manager.set(stateManager, config.overrides);
manager.set(stateManager, templateManager, config.overrides);
const overriddenConfig = manager.getConfig(config);
@@ -240,7 +242,7 @@ describe('OverridesManager', () => {
stateManager.setState({ fullscreen: true });
const manager = new OverridesManager(vi.fn());
manager.set(stateManager, config.overrides);
manager.set(stateManager, templateManager, config.overrides);
const overriddenConfig = manager.getConfig(config);
@@ -276,7 +278,7 @@ describe('OverridesManager', () => {
stateManager.setState({ fullscreen: true });
const manager = new OverridesManager(vi.fn());
manager.set(stateManager, config.overrides);
manager.set(stateManager, templateManager, config.overrides);
const overriddenConfig = manager.getConfig(config);
@@ -310,7 +312,7 @@ describe('OverridesManager', () => {
stateManager.setState({ fullscreen: true });
const manager = new OverridesManager(vi.fn());
manager.set(stateManager, config.overrides);
manager.set(stateManager, templateManager, config.overrides);
const overriddenConfig = manager.getConfig(config);
@@ -341,7 +343,7 @@ describe('OverridesManager', () => {
stateManager.setState({ fullscreen: true });
const manager = new OverridesManager(vi.fn());
manager.set(stateManager, config.overrides);
manager.set(stateManager, templateManager, config.overrides);
let thrown: unknown = null;
try {
@@ -442,7 +444,7 @@ describe('OverridesManager', () => {
const stateManager = new ConditionStateManager();
const manager = new OverridesManager(vi.fn());
manager.set(stateManager, config.overrides);
manager.set(stateManager, templateManager, config.overrides);
expect(manager.getConfig(config).live.controls.thumbnails.mode).toBe('right');
tests/card-controller/controller.test.ts
+8
View File
@@ -32,6 +32,7 @@ import { PIPManager } from '../../src/card-controller/pip-manager';
import { QueryStringManager } from '../../src/card-controller/query-string-manager';
import { StatusBarItemManager } from '../../src/card-controller/status-bar-item-manager';
import { StyleManager } from '../../src/card-controller/style-manager';
import { TemplateManager } from '../../src/card-controller/templates';
import { ViewItemManager } from '../../src/card-controller/view/item-manager';
import { ViewManager } from '../../src/card-controller/view/view-manager';
import { ConditionStateManager } from '../../src/condition-trigger/conditions/state-manager';
@@ -67,6 +68,7 @@ vi.mock('../../src/card-controller/issues/issue-manager');
vi.mock('../../src/card-controller/query-string-manager');
vi.mock('../../src/card-controller/status-bar-item-manager');
vi.mock('../../src/card-controller/style-manager');
vi.mock('../../src/card-controller/templates');
vi.mock('../../src/card-controller/camera-triggers-manager');
vi.mock('../../src/card-controller/view/item-manager');
vi.mock('../../src/card-controller/view/view-manager');
@@ -320,6 +322,12 @@ describe('CardController', () => {
);
});
it('should return getTemplateManager', () => {
expect(createController().getTemplateManager()).toBe(
vi.mocked(TemplateManager).mock.instances[0],
);
});
it('should return getCameraTriggersManager', () => {
expect(createController().getCameraTriggersManager()).toBe(
vi.mocked(CameraTriggersManager).mock.instances[0],
tests/card-controller/folders/executor.test.ts
+18 -15
View File
@@ -4,6 +4,7 @@ import { mock } from 'vitest-mock-extended';
import { FoldersExecutor } from '../../../src/card-controller/folders/executor';
import type { HAFoldersEngine } from '../../../src/card-controller/folders/ha/engine';
import type { FolderQuery } from '../../../src/card-controller/folders/types';
import { TemplateManager } from '../../../src/card-controller/templates';
import type { FolderConfig } from '../../../src/config/schema/folders';
import { QuerySource } from '../../../src/query-source';
import type { Endpoint } from '../../../src/types';
@@ -14,6 +15,8 @@ vi.mock('../../../src/card-controller/folders/ha/engine');
vi.mock('../../../../src/utils/ha/download');
describe('FoldersExecutor', () => {
const templateManager = new TemplateManager();
afterEach(() => {
vi.clearAllMocks();
});
@@ -21,7 +24,7 @@ describe('FoldersExecutor', () => {
describe('getItemCapabilities', () => {
it('should not get capabilities for non-folder media', () => {
const item = new TestViewMedia({ folder: null });
const executor = new FoldersExecutor();
const executor = new FoldersExecutor(templateManager);
expect(executor.getItemCapabilities(item)).toBeNull();
});
@@ -31,7 +34,7 @@ describe('FoldersExecutor', () => {
type: 'UNKNOWN',
} as unknown as FolderConfig;
const item = new TestViewMedia({ folder });
const executor = new FoldersExecutor();
const executor = new FoldersExecutor(templateManager);
expect(executor.getItemCapabilities(item)).toBeNull();
});
@@ -47,7 +50,7 @@ describe('FoldersExecutor', () => {
const haFolderEngine = mock<HAFoldersEngine>();
haFolderEngine.getItemCapabilities.mockReturnValue(capabilities);
const executor = new FoldersExecutor({
const executor = new FoldersExecutor(templateManager, {
ha: haFolderEngine,
});
@@ -60,7 +63,7 @@ describe('FoldersExecutor', () => {
const folder: FolderConfig = {
type: 'UNKNOWN',
} as unknown as FolderConfig;
const executor = new FoldersExecutor();
const executor = new FoldersExecutor(templateManager);
expect(executor.getDefaultQueryParameters(folder)).toBeNull();
});
@@ -75,7 +78,7 @@ describe('FoldersExecutor', () => {
};
haFolderEngine.getDefaultQueryParameters.mockReturnValue(expectedQuery);
const executor = new FoldersExecutor({
const executor = new FoldersExecutor(templateManager, {
ha: haFolderEngine,
});
@@ -89,7 +92,7 @@ describe('FoldersExecutor', () => {
type: 'UNKNOWN',
} as unknown as FolderConfig;
const item = new TestViewMedia({ folder });
const executor = new FoldersExecutor();
const executor = new FoldersExecutor(templateManager);
expect(await executor.getDownloadPath(createHASS(), item)).toBeNull();
});
@@ -99,7 +102,7 @@ describe('FoldersExecutor', () => {
const haFolderEngine = mock<HAFoldersEngine>();
haFolderEngine.getDownloadPath.mockResolvedValue(endpoint);
const executor = new FoldersExecutor({
const executor = new FoldersExecutor(templateManager, {
ha: haFolderEngine,
});
const item = new TestViewMedia({ folder: createFolder() });
@@ -113,7 +116,7 @@ describe('FoldersExecutor', () => {
type: 'UNKNOWN',
} as unknown as FolderConfig;
const item = new TestViewMedia({ folder });
const executor = new FoldersExecutor();
const executor = new FoldersExecutor(templateManager);
await executor.favorite(createHASS(), item, true);
@@ -122,7 +125,7 @@ describe('FoldersExecutor', () => {
it('should favorite', async () => {
const haFolderEngine = mock<HAFoldersEngine>();
const executor = new FoldersExecutor({
const executor = new FoldersExecutor(templateManager, {
ha: haFolderEngine,
});
@@ -147,7 +150,7 @@ describe('FoldersExecutor', () => {
const haFolderEngine = mock<HAFoldersEngine>();
haFolderEngine.generateChildFolderQuery.mockReturnValue(query);
const executor = new FoldersExecutor({ ha: haFolderEngine });
const executor = new FoldersExecutor(templateManager, { ha: haFolderEngine });
expect(executor.generateChildFolderQuery(query, viewFolder)).toEqual(query);
expect(haFolderEngine.generateChildFolderQuery).toBeCalledWith(query, viewFolder);
@@ -163,7 +166,7 @@ describe('FoldersExecutor', () => {
path: [{ ha: { id: 'media-source://' } }],
};
const viewFolder = new ViewFolder(folder, []);
const executor = new FoldersExecutor();
const executor = new FoldersExecutor(templateManager);
expect(executor.generateChildFolderQuery(query, viewFolder)).toBeNull();
});
@@ -175,7 +178,7 @@ describe('FoldersExecutor', () => {
folder: { type: 'UNKNOWN' },
} as unknown as FolderQuery;
const executor = new FoldersExecutor();
const executor = new FoldersExecutor(templateManager);
expect(await executor.expandFolder(createHASS(), query)).toBeNull();
});
@@ -197,7 +200,7 @@ describe('FoldersExecutor', () => {
const haFolderEngine = mock<HAFoldersEngine>();
haFolderEngine.expandFolder.mockResolvedValue([folderItem, mediaItem, folderItem]);
const executor = new FoldersExecutor({
const executor = new FoldersExecutor(templateManager, {
ha: haFolderEngine,
});
const hass = createHASS();
@@ -216,7 +219,7 @@ describe('FoldersExecutor', () => {
type: 'UNKNOWN',
} as unknown as FolderConfig;
const query: FolderQuery = { source: QuerySource.Folder, folder, path: [{}] };
const executor = new FoldersExecutor();
const executor = new FoldersExecutor(templateManager);
expect(executor.areResultsFresh(new Date(), query)).toBe(true);
});
@@ -227,7 +230,7 @@ describe('FoldersExecutor', () => {
const haFolderEngine = mock<HAFoldersEngine>();
haFolderEngine.areResultsFresh.mockReturnValue(false);
const executor = new FoldersExecutor({
const executor = new FoldersExecutor(templateManager, {
ha: haFolderEngine,
});
tests/card-controller/folders/ha/engine.test.ts
+23 -20
View File
@@ -2,6 +2,7 @@ import { afterAll, afterEach, beforeAll, describe, expect, it, vi } from 'vitest
import { HAFoldersEngine } from '../../../../src/card-controller/folders/ha/engine';
import type { FolderQuery } from '../../../../src/card-controller/folders/types';
import { TemplateManager } from '../../../../src/card-controller/templates';
import type { FolderConfig, Matcher } from '../../../../src/config/schema/folders';
import { BrowseMediaViewFolder } from '../../../../src/ha/browse-media/item';
import { browseMediaSchema } from '../../../../src/ha/browse-media/types';
@@ -21,6 +22,8 @@ vi.mock('../../../../src/ha/download');
vi.mock('../../../../src/ha/ws-request');
describe('HAFoldersEngine', () => {
const templateManager = new TemplateManager();
afterEach(() => {
vi.clearAllMocks();
});
@@ -28,7 +31,7 @@ describe('HAFoldersEngine', () => {
describe('getItemCapabilities', () => {
it('should not be able to download a folder', () => {
const item = new ViewFolder(createFolder(), []);
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
expect(engine.getItemCapabilities(item)).toEqual({
canFavorite: false,
@@ -38,7 +41,7 @@ describe('HAFoldersEngine', () => {
it('should be able to download a media item', () => {
const item = new TestViewMedia({ folder: createFolder() });
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
expect(engine.getItemCapabilities(item)).toEqual({
canFavorite: false,
@@ -50,13 +53,13 @@ describe('HAFoldersEngine', () => {
describe('getDownloadPath', () => {
it('should return null if item is not a media item', async () => {
const item = new ViewFolder(createFolder(), []);
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
expect(await engine.getDownloadPath(createHASS(), item)).toBeNull();
});
it('should return a download path for a media item', async () => {
const item = new TestViewMedia({ folder: createFolder() });
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
const endpoint: Endpoint = { endpoint: '/media', sign: false };
vi.mocked(getMediaDownloadPath).mockResolvedValue(endpoint);
@@ -67,7 +70,7 @@ describe('HAFoldersEngine', () => {
describe('favorite', () => {
it('should favorite', async () => {
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
const item = new TestViewMedia({ folder: createFolder() });
await engine.favorite(createHASS(), item, true);
@@ -81,14 +84,14 @@ describe('HAFoldersEngine', () => {
const folder: FolderConfig = {
type: 'UNKNOWN',
} as unknown as FolderConfig;
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
expect(engine.getDefaultQueryParameters(folder)).toBeNull();
});
it('should return default query parameters for ha folder config', () => {
const folder = createFolder();
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
expect(engine.getDefaultQueryParameters(folder)).toEqual({
source: QuerySource.Folder,
@@ -104,7 +107,7 @@ describe('HAFoldersEngine', () => {
source: QuerySource.Folder,
folder: { type: 'UNKNOWN' },
} as unknown as FolderQuery;
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
expect(await engine.expandFolder(createHASS(), query)).toBeNull();
});
@@ -134,7 +137,7 @@ describe('HAFoldersEngine', () => {
}),
);
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
const results = await engine.expandFolder(createHASS(), query);
expect(results?.length).toBe(2);
expect(results?.[0]).toBeInstanceOf(ViewMedia);
@@ -174,7 +177,7 @@ describe('HAFoldersEngine', () => {
)
.mockResolvedValueOnce([]);
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
const results = await engine.expandFolder(
createHASS(),
query,
@@ -219,7 +222,7 @@ describe('HAFoldersEngine', () => {
);
const hass = createHASS();
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
await engine.expandFolder(hass, query);
expect(homeAssistantWSRequest).toBeCalledWith(hass, browseMediaSchema, {
@@ -235,7 +238,7 @@ describe('HAFoldersEngine', () => {
// There's no component in the query with an id to start from.
path: [{ ha: {} }],
};
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
expect(await engine.expandFolder(createHASS(), query)).toBeNull();
});
@@ -264,7 +267,7 @@ describe('HAFoldersEngine', () => {
}),
);
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
const results = await engine.expandFolder(createHASS(), query);
// Even though there are 2 children, the limit of 1 should trigger earlyExit.
@@ -329,7 +332,7 @@ describe('HAFoldersEngine', () => {
}),
);
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
const results = await engine.expandFolder(createHASS(), query);
expect(results?.length).toBe(expectedMatches);
});
@@ -338,7 +341,7 @@ describe('HAFoldersEngine', () => {
describe('generateChildFolderQuery', () => {
it('should return null if folder type is not ha', () => {
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
const query: FolderQuery = {
source: QuerySource.Folder,
folder: { type: 'other' } as unknown as FolderConfig,
@@ -350,7 +353,7 @@ describe('HAFoldersEngine', () => {
});
it('should return null if folder has no id', () => {
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
const query: FolderQuery = {
source: QuerySource.Folder,
folder: { type: 'ha', id: 'test' },
@@ -362,7 +365,7 @@ describe('HAFoldersEngine', () => {
});
it('should extend query with configured component', () => {
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
const folderConfig: FolderConfig = {
type: 'ha',
id: 'test',
@@ -393,7 +396,7 @@ describe('HAFoldersEngine', () => {
});
it('should extend query with default component when no configuration exists', () => {
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
const folderConfig: FolderConfig = { type: 'ha', id: 'test' };
const query: FolderQuery = {
source: QuerySource.Folder,
@@ -431,7 +434,7 @@ describe('HAFoldersEngine', () => {
const now = new Date('2026-01-02T07:54:32Z');
vi.setSystemTime(now);
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
const query = { folder: { type: 'ha' } } as FolderQuery;
const resultsTimestamp = new Date('2026-01-02T07:54:30Z');
@@ -442,7 +445,7 @@ describe('HAFoldersEngine', () => {
const now = new Date('2026-01-02T07:54:32Z');
vi.setSystemTime(now);
const engine = new HAFoldersEngine();
const engine = new HAFoldersEngine(templateManager);
const query = { folder: { type: 'ha' } } as FolderQuery;
const resultsTimestamp = new Date('2026-01-02T07:53:30Z');
tests/card-controller/folders/ha/media-matcher.test.ts
+59 -71
View File
@@ -1,18 +1,20 @@
import { sub } from 'date-fns';
import { renderTemplate } from 'ha-nunjucks';
import { describe, expect, it, vi } from 'vitest';
import { beforeAll, describe, expect, it } from 'vitest';
import { MediaMatcher } from '../../../../src/card-controller/folders/ha/media-matcher';
import { TemplateManager } from '../../../../src/card-controller/templates';
import type { Matcher } from '../../../../src/config/schema/folders';
import type {
BrowseMediaMetadata,
RichBrowseMedia,
} from '../../../../src/ha/browse-media/types';
import { createHASS } from '../../../test-utils';
vi.mock('ha-nunjucks');
import { createHASS, createMockTemplateRenderer } from '../../../test-utils';
describe('MediaMatcher', () => {
// A mock renderer for the matcher plumbing, which never renders templates.
// The `value_template` suite below uses its own real, loaded engine.
const templateManager = createMockTemplateRenderer();
describe('match', () => {
const createMediaItem = (
title: string,
@@ -29,7 +31,7 @@ describe('MediaMatcher', () => {
});
it('should return false if foldersOnly is true and media.can_expand is false', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Test File');
expect(
mediaMatcher.match(createHASS(), media, { matchers: [], foldersOnly: true }),
@@ -37,7 +39,7 @@ describe('MediaMatcher', () => {
});
it('should return true if foldersOnly is true and media.can_expand is true', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Test Folder', true, 'directory');
expect(
mediaMatcher.match(createHASS(), media, { matchers: [], foldersOnly: true }),
@@ -45,13 +47,13 @@ describe('MediaMatcher', () => {
});
it('should return true if matchers array is empty', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Test Media');
expect(mediaMatcher.match(createHASS(), media, { matchers: [] })).toBe(true);
});
it('should return true if matchers array is undefined', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Test Media');
expect(mediaMatcher.match(createHASS(), media, { matchers: undefined })).toBe(
true,
@@ -60,21 +62,21 @@ describe('MediaMatcher', () => {
describe('with title matcher', () => {
it('should return true when title matches exactly', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Exact Title');
const matchers: Matcher[] = [{ type: 'title', title: 'Exact Title' }];
expect(mediaMatcher.match(createHASS(), media, { matchers })).toBe(true);
});
it('should return false when title does not match exactly', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('DOES NOT MATCH');
const matchers: Matcher[] = [{ type: 'title', title: 'Exact Title' }];
expect(mediaMatcher.match(createHASS(), media, { matchers })).toBe(false);
});
it('should return true when title matches regexp and extracted value matches matcher.title', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Prefix-ImportantPart-Suffix');
const matchers: Matcher[] = [
{
@@ -87,7 +89,7 @@ describe('MediaMatcher', () => {
});
it('should return false when title matches regexp but extracted value does not match matcher.title', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Prefix-ImportantPart-Suffix');
const matchers: Matcher[] = [
{
@@ -100,7 +102,7 @@ describe('MediaMatcher', () => {
});
it('should return true when title matches regexp with an explicit title value', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Prefix-ImportantPart-Suffix');
const matchers: Matcher[] = [
{
@@ -113,7 +115,7 @@ describe('MediaMatcher', () => {
});
it('should return false when title does not match regexp', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Unrelated Title');
const matchers: Matcher[] = [
{
@@ -126,7 +128,7 @@ describe('MediaMatcher', () => {
});
it('should return false when regexp is provided but does not extract the required group', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Prefix-ImportantPart-Suffix');
const matchers: Matcher[] = [
{
@@ -139,7 +141,7 @@ describe('MediaMatcher', () => {
});
it('should return true when no regexp and no matcher.title (matches any title)', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Any Title Will Do');
const matchers: Matcher[] = [{ type: 'title' }];
expect(mediaMatcher.match(createHASS(), media, { matchers })).toBe(true);
@@ -147,42 +149,16 @@ describe('MediaMatcher', () => {
});
describe('with template matcher', () => {
it('should return true when template value matches', () => {
const mediaMatcher = new MediaMatcher();
const title = 'Any Title Will Do';
const media = createMediaItem(title);
vi.mocked(renderTemplate).mockReturnValue(true);
const matchers: Matcher[] = [
{
type: 'template',
value_template: '{{ acc.media.title == "Any Title Will Do" }}',
},
];
const hass = createHASS();
expect(mediaMatcher.match(hass, media, { matchers })).toBe(true);
expect(renderTemplate).toHaveBeenCalledWith(
hass,
'{{ acc.media.title == "Any Title Will Do" }}',
{
acc: {
media: {
title,
is_folder: false,
},
},
},
);
// These matchers render, so use a real engine loaded for the synchronous
// renderer (rather than the shared mock).
const templateManager = new TemplateManager();
beforeAll(async () => {
await templateManager.loadRenderer();
});
it('should return false when template value does not match', () => {
const mediaMatcher = new MediaMatcher();
const title = 'Any Title Will Do';
const media = createMediaItem(title);
vi.mocked(renderTemplate).mockReturnValue(false);
it('should return true when template value renders to true', () => {
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Any Title Will Do');
const matchers: Matcher[] = [
{
@@ -190,27 +166,39 @@ describe('MediaMatcher', () => {
value_template: '{{ acc.media.title == "Any Title Will Do" }}',
},
];
const hass = createHASS();
expect(mediaMatcher.match(hass, media, { matchers })).toBe(false);
expect(mediaMatcher.match(createHASS(), media, { matchers })).toBe(true);
});
expect(renderTemplate).toHaveBeenCalledWith(
hass,
'{{ acc.media.title == "Any Title Will Do" }}',
it('should return true when template reads the is_folder media value', () => {
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Test Folder', true, 'directory');
const matchers: Matcher[] = [
{
acc: {
media: {
title,
is_folder: false,
},
},
type: 'template',
value_template: '{{ acc.media.is_folder }}',
},
);
];
expect(mediaMatcher.match(createHASS(), media, { matchers })).toBe(true);
});
it('should return false when template value renders to false', () => {
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Any Title Will Do');
const matchers: Matcher[] = [
{
type: 'template',
value_template: '{{ acc.media.title == "Some Other Title" }}',
},
];
expect(mediaMatcher.match(createHASS(), media, { matchers })).toBe(false);
});
});
describe('with or matcher', () => {
it('should return true if at least one sub-matcher matches', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Test Media');
const matcher: Matcher = {
type: 'or',
@@ -225,7 +213,7 @@ describe('MediaMatcher', () => {
});
it('should return false if no sub-matcher matches', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Test Media');
const matcher: Matcher = {
type: 'or',
@@ -242,7 +230,7 @@ describe('MediaMatcher', () => {
describe('with date matcher', () => {
it('should not match without metadata', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Test Media');
const matcher: Matcher = {
type: 'date',
@@ -279,7 +267,7 @@ describe('MediaMatcher', () => {
},
],
])('should match with date more recent than matcher %s', (matcher: Matcher) => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Test Media');
media._metadata = {
startDate: sub(new Date(), { days: 1 }),
@@ -290,7 +278,7 @@ describe('MediaMatcher', () => {
});
it('should not match with date less recent than matcher', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Test Media');
media._metadata = {
startDate: sub(new Date(), { days: 2 }),
@@ -306,7 +294,7 @@ describe('MediaMatcher', () => {
});
it('should return false if one of multiple matchers fails', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Test Media One');
const matchers: Matcher[] = [
{ type: 'title', title: 'Test Media One' }, // Pass
@@ -316,7 +304,7 @@ describe('MediaMatcher', () => {
});
it('should return true if all multiple matchers pass', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Test Media One');
const matchers: Matcher[] = [
{ type: 'title', title: 'Test Media One' },
@@ -330,7 +318,7 @@ describe('MediaMatcher', () => {
});
it('should ignore matchers of unknown types', () => {
const mediaMatcher = new MediaMatcher();
const mediaMatcher = new MediaMatcher(templateManager);
const media = createMediaItem('Test Media');
const matchers: Matcher[] = [{ type: 'unknownMatcherType' as 'title' }];
tests/card-controller/initialization-manager.test.ts
+37
View File
@@ -139,6 +139,40 @@ describe('InitializationManager', () => {
expect(manager.isInitialized(InitializationAspect.INITIAL_TRIGGER)).toBeTruthy();
});
it('should load the template renderer for a templated config', async () => {
const api = createCardAPI();
vi.mocked(api.getHASSManager().getHASS).mockReturnValue(createHASS());
vi.mocked(api.getConfigManager().getConfig).mockReturnValue(createConfig());
vi.mocked(api.getConfigManager().hasTemplate).mockReturnValue(true);
const loadRenderer = vi.mocked(api.getTemplateManager().loadRenderer);
const manager = new InitializationManager(api);
expect(manager.isInitialized(InitializationAspect.TEMPLATE_RENDERER)).toBeFalsy();
await manager.initializeMandatory();
expect(loadRenderer).toBeCalled();
expect(manager.isInitialized(InitializationAspect.TEMPLATE_RENDERER)).toBeTruthy();
expect(manager.isInitializedMandatory()).toBeTruthy();
});
it('should not load the template renderer for a config without templates', async () => {
const api = createCardAPI();
vi.mocked(api.getHASSManager().getHASS).mockReturnValue(createHASS());
vi.mocked(api.getConfigManager().getConfig).mockReturnValue(createConfig());
vi.mocked(api.getConfigManager().hasTemplate).mockReturnValue(false);
const loadRenderer = vi.mocked(api.getTemplateManager().loadRenderer);
const manager = new InitializationManager(api);
await manager.initializeMandatory();
expect(loadRenderer).not.toBeCalled();
expect(manager.isInitialized(InitializationAspect.TEMPLATE_RENDERER)).toBeFalsy();
expect(manager.isInitializedMandatory()).toBeTruthy();
});
it('should succeed with microphone if configured', async () => {
const api = createCardAPI();
vi.mocked(api.getHASSManager().getHASS).mockReturnValue(createHASS());
@@ -280,6 +314,9 @@ describe('InitializationManager', () => {
expect(initializer.uninitialize).toBeCalledWith(
InitializationAspect.MICROPHONE_CONNECT,
);
expect(initializer.uninitialize).toBeCalledWith(
InitializationAspect.TEMPLATE_RENDERER,
);
expect(initializer.uninitialize).toBeCalledWith(InitializationAspect.VIEW);
expect(initializer.uninitialize).toBeCalledWith(
InitializationAspect.INITIAL_TRIGGER,
tests/card-controller/templates/index.test.ts
+148 -53
View File
@@ -1,35 +1,117 @@
import { describe, expect, it } from 'vitest';
import { describe, expect, it, vi } from 'vitest';
import { TemplateRenderer } from '../../../src/card-controller/templates/index';
import { TemplateManager } from '../../../src/card-controller/templates/index';
import { createConfig, createHASS, createStateEntity } from '../../test-utils';
describe('TemplateRenderer', () => {
describe('TemplateManager', () => {
describe('loadRenderer', () => {
it('should render a template raw before the engine is loaded', () => {
const manager = new TemplateManager();
const result = manager.renderRecursively(createHASS(), '{{ acc.camera }}', {
conditionState: { camera: 'camera.office' },
});
expect(result).toBe('{{ acc.camera }}');
});
it('should render a template after the engine is loaded', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
const result = manager.renderRecursively(createHASS(), '{{ acc.camera }}', {
conditionState: { camera: 'camera.office' },
});
expect(result).toBe('camera.office');
});
it('should be idempotent across repeat loads', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
await manager.loadRenderer();
const result = manager.renderRecursively(createHASS(), '{{ acc.camera }}', {
conditionState: { camera: 'camera.office' },
});
expect(result).toBe('camera.office');
});
it('should pass a non-template string through unchanged before loading', () => {
const manager = new TemplateManager();
expect(manager.renderRecursively(createHASS(), 'hello world')).toBe('hello world');
});
it('should prime the renderer on demand when a template is rendered unloaded', () => {
const manager = new TemplateManager();
const loadRenderer = vi.spyOn(manager, 'loadRenderer').mockResolvedValue();
manager.renderRecursively(createHASS(), '{{ acc.camera }}');
expect(loadRenderer).toBeCalled();
});
it('should swallow a load failure when priming on an unloaded render', () => {
const manager = new TemplateManager();
vi.spyOn(manager, 'loadRenderer').mockRejectedValue(new Error('load failed'));
expect(() =>
manager.renderRecursively(createHASS(), '{{ acc.camera }}'),
).not.toThrow();
});
});
describe('isLoaded', () => {
it('should report false before loading and true after', async () => {
const manager = new TemplateManager();
expect(manager.isLoaded()).toBe(false);
await manager.loadRenderer();
expect(manager.isLoaded()).toBe(true);
});
});
describe('dataContainsTemplate', () => {
it.each([
['an expression marker', 'before {{ acc.camera }} after', true],
['a statement marker', '{% if acc.camera %}x{% endif %}', true],
['a template nested in an object', { a: { b: '{{ acc.view }}' } }, true],
['a template nested in an array', ['plain', '{{ acc.view }}'], true],
['a plain string', 'no templates here', false],
['an unmatched marker', 'an isolated {{ with no close', false],
['a non-string value', { count: 42, on: true }, false],
['an undefined value', undefined, false],
])('should detect %s', (_name, data, expected) => {
expect(TemplateManager.dataContainsTemplate(data)).toBe(expected);
});
});
describe('renderRecursively', () => {
it('should render string templates with camera context', () => {
const renderer = new TemplateRenderer();
it('should render string templates with camera context', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
const hass = createHASS();
const result = renderer.renderRecursively(hass, 'Camera: {{ acc.camera }}', {
const result = manager.renderRecursively(hass, 'Camera: {{ acc.camera }}', {
conditionState: { camera: 'camera.office' },
});
expect(result).toBe('Camera: camera.office');
});
it('should render string templates with view context', () => {
const renderer = new TemplateRenderer();
it('should render string templates with view context', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
const hass = createHASS();
const result = renderer.renderRecursively(hass, 'View: {{ acc.view }}', {
const result = manager.renderRecursively(hass, 'View: {{ acc.view }}', {
conditionState: { view: 'live' },
});
expect(result).toBe('View: live');
});
it('should render string templates with the acc context', () => {
const renderer = new TemplateRenderer();
it('should render string templates with the acc context', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
const hass = createHASS();
const result = renderer.renderRecursively(
const result = manager.renderRecursively(
hass,
'{{ acc.camera }} - {{ acc.view }}',
{
@@ -39,11 +121,12 @@ describe('TemplateRenderer', () => {
expect(result).toBe('camera.front - clips');
});
it('should render templates in arrays', () => {
const renderer = new TemplateRenderer();
it('should render templates in arrays', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
const hass = createHASS();
const result = renderer.renderRecursively(
const result = manager.renderRecursively(
hass,
['{{ acc.camera }}', 'static', '{{ acc.view }}'],
{ conditionState: { camera: 'camera.office', view: 'live' } },
@@ -51,11 +134,12 @@ describe('TemplateRenderer', () => {
expect(result).toEqual(['camera.office', 'static', 'live']);
});
it('should render templates in object values', () => {
const renderer = new TemplateRenderer();
it('should render templates in object values', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
const hass = createHASS();
const result = renderer.renderRecursively(
const result = manager.renderRecursively(
hass,
{ camera: '{{ acc.camera }}', view: '{{ acc.view }}', static: 'value' },
{ conditionState: { camera: 'camera.office', view: 'live' } },
@@ -63,11 +147,12 @@ describe('TemplateRenderer', () => {
expect(result).toEqual({ camera: 'camera.office', view: 'live', static: 'value' });
});
it('should render templates in nested objects', () => {
const renderer = new TemplateRenderer();
it('should render templates in nested objects', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
const hass = createHASS();
const result = renderer.renderRecursively(
const result = manager.renderRecursively(
hass,
{ outer: { inner: '{{ acc.camera }}' } },
{ conditionState: { camera: 'camera.office' } },
@@ -75,27 +160,30 @@ describe('TemplateRenderer', () => {
expect(result).toEqual({ outer: { inner: 'camera.office' } });
});
it('should return non-string/array/object values unchanged', () => {
const renderer = new TemplateRenderer();
it('should return non-string/array/object values unchanged', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
const hass = createHASS();
expect(renderer.renderRecursively(hass, 42)).toBe(42);
expect(renderer.renderRecursively(hass, true)).toBe(true);
expect(renderer.renderRecursively(hass, null)).toBe(null);
expect(manager.renderRecursively(hass, 42)).toBe(42);
expect(manager.renderRecursively(hass, true)).toBe(true);
expect(manager.renderRecursively(hass, null)).toBe(null);
});
it('should render strings without templates unchanged', () => {
const renderer = new TemplateRenderer();
it('should render strings without templates unchanged', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
const hass = createHASS();
expect(renderer.renderRecursively(hass, 'hello world')).toBe('hello world');
expect(manager.renderRecursively(hass, 'hello world')).toBe('hello world');
});
it('should render with a top-level stock trigger context', () => {
const renderer = new TemplateRenderer();
it('should render with a top-level stock trigger context', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
const hass = createHASS();
const result = renderer.renderRecursively(hass, '{{ trigger.to_state.state }}', {
const result = manager.renderRecursively(hass, '{{ trigger.to_state.state }}', {
triggerData: {
platform: 'state',
entity_id: 'binary_sensor.door',
@@ -105,11 +193,12 @@ describe('TemplateRenderer', () => {
expect(result).toBe('on');
});
it('should render with a top-level card trigger context', () => {
const renderer = new TemplateRenderer();
it('should render with a top-level card trigger context', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
const hass = createHASS();
const result = renderer.renderRecursively(hass, '{{ trigger.to_acc.camera }}', {
const result = manager.renderRecursively(hass, '{{ trigger.to_acc.camera }}', {
triggerData: {
platform: 'acc',
type: 'camera',
@@ -120,21 +209,23 @@ describe('TemplateRenderer', () => {
expect(result).toBe('camera.backyard');
});
it('should render with config context', () => {
const renderer = new TemplateRenderer();
it('should render with config context', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
const hass = createHASS();
const result = renderer.renderRecursively(hass, '{{ acc.config.view.default }}', {
const result = manager.renderRecursively(hass, '{{ acc.config.view.default }}', {
conditionState: { config: createConfig({ view: { default: 'clips' } }) },
});
expect(result).toBe('clips');
});
it('should render with mediaData context', () => {
const renderer = new TemplateRenderer();
it('should render with mediaData context', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
const hass = createHASS();
const result = renderer.renderRecursively(
const result = manager.renderRecursively(
hass,
'Title: {{ acc.media.title }}, Folder: {{ acc.media.is_folder }}',
{
@@ -144,11 +235,12 @@ describe('TemplateRenderer', () => {
expect(result).toBe('Title: Test Media, Folder: false');
});
it('should render with combined context options', () => {
const renderer = new TemplateRenderer();
it('should render with combined context options', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
const hass = createHASS();
const result = renderer.renderRecursively(
const result = manager.renderRecursively(
hass,
'{{ acc.camera }} - {{ acc.media.title }}',
{
@@ -159,21 +251,23 @@ describe('TemplateRenderer', () => {
expect(result).toBe('camera.office - My Video');
});
it('should return undefined context when no options provided', () => {
const renderer = new TemplateRenderer();
it('should return undefined context when no options provided', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
const hass = createHASS();
// Without options, templates referencing acc should render empty.
const result = renderer.renderRecursively(hass, 'Value: {{ acc.camera }}');
const result = manager.renderRecursively(hass, 'Value: {{ acc.camera }}');
expect(result).toBe('Value:');
});
it('should return undefined context when options have no relevant data', () => {
const renderer = new TemplateRenderer();
it('should return undefined context when options have no relevant data', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
const hass = createHASS();
// Empty conditionState without camera or view should not create context.
const result = renderer.renderRecursively(hass, 'Value: {{ acc.camera }}', {
const result = manager.renderRecursively(hass, 'Value: {{ acc.camera }}', {
conditionState: {},
});
expect(result).toBe('Value:');
@@ -181,11 +275,12 @@ describe('TemplateRenderer', () => {
});
describe('renderRecursivelyAsType', () => {
it('should render in place while preserving the input structure', () => {
const renderer = new TemplateRenderer();
it('should render in place while preserving the input structure', async () => {
const manager = new TemplateManager();
await manager.loadRenderer();
const hass = createHASS();
const result = renderer.renderRecursivelyAsType(
const result = manager.renderRecursivelyAsType(
hass,
{ camera: '{{ acc.camera }}', static: 'value' },
{ conditionState: { camera: 'camera.office' } },
tests/card-controller/templates/renderer-via-event.test.ts
+32
View File
@@ -0,0 +1,32 @@
import { describe, expect, it, vi } from 'vitest';
import { mock } from 'vitest-mock-extended';
import type { TemplateRenderer } from '../../../src/card-controller/templates/index';
import {
getTemplateRendererViaEvent,
type TemplateRendererGetEvent,
} from '../../../src/card-controller/templates/renderer-via-event';
// @vitest-environment jsdom
describe('getTemplateRendererViaEvent', () => {
it('should dispatch event and retrieve template renderer', () => {
const element = document.createElement('div');
const templateRenderer = mock<TemplateRenderer>();
const handler = vi.fn().mockImplementation((ev: TemplateRendererGetEvent) => {
ev.templateRenderer = templateRenderer;
});
element.addEventListener('advanced-camera-card:template-renderer:get', handler);
expect(getTemplateRendererViaEvent(element)).toBe(templateRenderer);
});
it('should return null when no template renderer is provided', () => {
const element = document.createElement('div');
const handler = vi.fn();
element.addEventListener('advanced-camera-card:template-renderer:get', handler);
expect(getTemplateRendererViaEvent(element)).toBeNull();
});
});