The `initialized` state (used in conditions/triggers) was written once and never cleared, so it meant "has this card ever been initialized" while everything reading it took it as "is this card usable now". Home Assistant takes a card off the page and puts it back whenever its dashboard tab is left and returned to, so the card initialized again while the state claimed it was initialized throughout: `trigger: initialized` fired once per card rather than once per startup, and automations were dropped in between. The card lifecycle is now an explicit state machine (`SessionManager`), the only writer of `initialized`, which separates a card that is starting up from one initializing part of itself again while it runs. A new `ever` parameter (conditions/triggers) selects the old latched behaviour. `remote_control` uses that parameter to keep its two camera priorities correct under repeated starts. With `camera_priority: entity` the card now re-reads the entity every time it starts, so a camera selected while the card was away is picked up on return. With `camera_priority: card` the card writes the entity on its first start only, unchanged, since repeating that write would overwrite a camera the user had selected. Closes: #2642 BREAKING CHANGE: `condition: initialized` is now `false` whenever the card is not usable, and `trigger: initialized` fires each time the card starts up rather than only the first time. Set `ever: true` on either to keep the previous behaviour.
328 lines
11 KiB
TypeScript
328 lines
11 KiB
TypeScript
import { STATE_RUNNING, STATE_STARTING } from 'home-assistant-js-websocket';
|
|
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
|
|
|
import { EventWatcher } from '../../../src/card-controller/hass/event-watcher';
|
|
import { HASSManager } from '../../../src/card-controller/hass/hass-manager';
|
|
import { StateWatcher } from '../../../src/card-controller/hass/state-watcher';
|
|
import { InitializationAspect } from '../../../src/card-controller/initialization/initialization-manager';
|
|
import { createCameraManager, createStore } from '../../camera-manager/test-utils';
|
|
import { createCameraConfig, createConfig } from '../../config/test-utils';
|
|
import { createCardAPI, createHASS, createStateEntity } from '../../test-utils';
|
|
import { createView } from '../../view/test-utils';
|
|
|
|
describe('HASSManager', () => {
|
|
beforeEach(() => {
|
|
vi.resetAllMocks();
|
|
});
|
|
|
|
it('should have null hass on construction', () => {
|
|
const manager = new HASSManager(createCardAPI());
|
|
expect(manager.getHASS()).toBeNull();
|
|
expect(manager.hasHASS()).toBeFalsy();
|
|
});
|
|
|
|
it('should get state watcher', () => {
|
|
const manager = new HASSManager(createCardAPI());
|
|
expect(manager.getStateWatcher()).toEqual(expect.any(StateWatcher));
|
|
});
|
|
|
|
it('should get event watcher', () => {
|
|
const manager = new HASSManager(createCardAPI());
|
|
expect(manager.getEventWatcher()).toEqual(expect.any(EventWatcher));
|
|
});
|
|
|
|
it('should get hass after set', () => {
|
|
const manager = new HASSManager(createCardAPI());
|
|
const hass = createHASS();
|
|
manager.setHASS(hass);
|
|
|
|
expect(manager.getHASS()).toBe(hass);
|
|
expect(manager.hasHASS()).toBeTruthy();
|
|
});
|
|
|
|
describe('as a HASS source', () => {
|
|
it('should fan out to registered listeners with (hass, oldHass)', () => {
|
|
const manager = new HASSManager(createCardAPI());
|
|
const listener = vi.fn();
|
|
manager.addListener(listener);
|
|
|
|
const hass1 = createHASS();
|
|
manager.setHASS(hass1);
|
|
expect(listener).toHaveBeenCalledWith(hass1, null);
|
|
|
|
const hass2 = createHASS();
|
|
manager.setHASS(hass2);
|
|
expect(listener).toHaveBeenCalledWith(hass2, hass1);
|
|
});
|
|
|
|
it('should call listeners in insertion order on every fan-out', () => {
|
|
const manager = new HASSManager(createCardAPI());
|
|
const order: string[] = [];
|
|
manager.addListener(() => order.push('first'));
|
|
manager.addListener(() => order.push('second'));
|
|
|
|
manager.setHASS(createHASS());
|
|
|
|
expect(order).toEqual(['first', 'second']);
|
|
});
|
|
|
|
it('should detach a listener via the returned unlisten callback', () => {
|
|
const manager = new HASSManager(createCardAPI());
|
|
const listener = vi.fn();
|
|
const unlisten = manager.addListener(listener);
|
|
|
|
unlisten();
|
|
manager.setHASS(createHASS());
|
|
|
|
expect(listener).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should not fan out on null/undefined hass', () => {
|
|
const manager = new HASSManager(createCardAPI());
|
|
const listener = vi.fn();
|
|
manager.addListener(listener);
|
|
|
|
manager.setHASS(null);
|
|
manager.setHASS();
|
|
|
|
expect(listener).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should expose current hass via getHASS for source consumers', () => {
|
|
const manager = new HASSManager(createCardAPI());
|
|
expect(manager.getHASS()).toBeNull();
|
|
|
|
const hass = createHASS();
|
|
manager.setHASS(hass);
|
|
expect(manager.getHASS()).toBe(hass);
|
|
});
|
|
});
|
|
|
|
describe('should handle connection state change when', () => {
|
|
it('should end the session on ready → lost transition', () => {
|
|
const api = createCardAPI();
|
|
const manager = new HASSManager(api);
|
|
|
|
const readyHASS = createHASS();
|
|
readyHASS.connected = true;
|
|
readyHASS.config.state = STATE_RUNNING;
|
|
manager.setHASS(readyHASS);
|
|
|
|
expect(
|
|
api.getInitializationManager().getSessionManager().end,
|
|
).not.toHaveBeenCalled();
|
|
|
|
const disconnectedHASS = createHASS();
|
|
disconnectedHASS.connected = false;
|
|
manager.setHASS(disconnectedHASS);
|
|
|
|
// A card cannot be started without Home Assistant, so the session ends
|
|
// when it goes away rather than when it returns. The aspects built during
|
|
// the session are untouched until then.
|
|
expect(api.getInitializationManager().getSessionManager().end).toHaveBeenCalled();
|
|
expect(api.getInitializationManager().invalidateAspect).not.toHaveBeenCalled();
|
|
});
|
|
|
|
// Ending it would be unrecoverable: a call with no hass leaves `_hass`
|
|
// untouched, so the next ready hass does not look like a transition and
|
|
// nothing would restart the session.
|
|
it('should not end the session when given no hass at all', () => {
|
|
const api = createCardAPI();
|
|
const manager = new HASSManager(api);
|
|
|
|
const readyHASS = createHASS();
|
|
readyHASS.connected = true;
|
|
readyHASS.config.state = STATE_RUNNING;
|
|
manager.setHASS(readyHASS);
|
|
|
|
manager.setHASS(null);
|
|
manager.setHASS();
|
|
|
|
expect(
|
|
api.getInitializationManager().getSessionManager().end,
|
|
).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should reinitialize cameras and view on lost → ready transition', () => {
|
|
const api = createCardAPI();
|
|
const manager = new HASSManager(api);
|
|
|
|
// First establish a fully-ready state.
|
|
const readyHASS = createHASS();
|
|
readyHASS.connected = true;
|
|
readyHASS.config.state = STATE_RUNNING;
|
|
manager.setHASS(readyHASS);
|
|
|
|
// Simulate disconnection.
|
|
const disconnectedHASS = createHASS();
|
|
disconnectedHASS.connected = false;
|
|
manager.setHASS(disconnectedHASS);
|
|
|
|
// Simulate full recovery (connected AND running).
|
|
const recoveredHASS = createHASS();
|
|
recoveredHASS.connected = true;
|
|
recoveredHASS.config.state = STATE_RUNNING;
|
|
manager.setHASS(recoveredHASS);
|
|
|
|
// Cameras and view should be uninitialized so they get re-subscribed
|
|
// to event sources (e.g. Frigate WebSocket events) on the next
|
|
// render cycle.
|
|
expect(api.getInitializationManager().invalidateAspect).toHaveBeenCalledWith(
|
|
InitializationAspect.CAMERAS,
|
|
);
|
|
expect(api.getInitializationManager().invalidateAspect).toHaveBeenCalledWith(
|
|
InitializationAspect.VIEW,
|
|
);
|
|
expect(api.getCameraManager().destroy).toHaveBeenCalled();
|
|
});
|
|
|
|
it('should reinitialize on starting → ready transition (integrations finished loading)', () => {
|
|
const api = createCardAPI();
|
|
const manager = new HASSManager(api);
|
|
|
|
// WebSocket reconnected but HA still booting.
|
|
const startingHASS = createHASS();
|
|
startingHASS.connected = true;
|
|
startingHASS.config.state = STATE_STARTING;
|
|
manager.setHASS(startingHASS);
|
|
|
|
// No reinit yet -- HA isn't fully ready.
|
|
expect(api.getInitializationManager().invalidateAspect).not.toHaveBeenCalled();
|
|
expect(api.getCameraManager().destroy).not.toHaveBeenCalled();
|
|
|
|
// HA finishes booting.
|
|
const readyHASS = createHASS();
|
|
readyHASS.connected = true;
|
|
readyHASS.config.state = STATE_RUNNING;
|
|
manager.setHASS(readyHASS);
|
|
|
|
expect(api.getInitializationManager().invalidateAspect).toHaveBeenCalledWith(
|
|
InitializationAspect.CAMERAS,
|
|
);
|
|
expect(api.getInitializationManager().invalidateAspect).toHaveBeenCalledWith(
|
|
InitializationAspect.VIEW,
|
|
);
|
|
expect(api.getCameraManager().destroy).toHaveBeenCalled();
|
|
});
|
|
|
|
it('should not reinitialize on lost → starting transition', () => {
|
|
const api = createCardAPI();
|
|
const manager = new HASSManager(api);
|
|
|
|
const disconnectedHASS = createHASS();
|
|
disconnectedHASS.connected = false;
|
|
manager.setHASS(disconnectedHASS);
|
|
|
|
const startingHASS = createHASS();
|
|
startingHASS.connected = true;
|
|
startingHASS.config.state = STATE_STARTING;
|
|
manager.setHASS(startingHASS);
|
|
|
|
// WS came back but integrations still loading -- wait for RUNNING.
|
|
expect(api.getInitializationManager().invalidateAspect).not.toHaveBeenCalled();
|
|
expect(api.getCameraManager().destroy).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should not reinitialize on first hass set (no previous hass)', () => {
|
|
const api = createCardAPI();
|
|
const manager = new HASSManager(api);
|
|
|
|
const readyHASS = createHASS();
|
|
readyHASS.connected = true;
|
|
readyHASS.config.state = STATE_RUNNING;
|
|
manager.setHASS(readyHASS);
|
|
|
|
// First-ever hass set -- there's no "previous not-ready state" to
|
|
// transition from, so the normal first-load init flow applies and we must
|
|
// not blow away cameras.
|
|
expect(api.getInitializationManager().invalidateAspect).not.toHaveBeenCalled();
|
|
expect(api.getCameraManager().destroy).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should not reinitialize on ready → ready (no transition)', () => {
|
|
const api = createCardAPI();
|
|
const manager = new HASSManager(api);
|
|
|
|
const readyHASS = createHASS();
|
|
readyHASS.connected = true;
|
|
readyHASS.config.state = STATE_RUNNING;
|
|
manager.setHASS(readyHASS);
|
|
|
|
const anotherReadyHASS = createHASS();
|
|
anotherReadyHASS.connected = true;
|
|
anotherReadyHASS.config.state = STATE_RUNNING;
|
|
manager.setHASS(anotherReadyHASS);
|
|
|
|
expect(api.getInitializationManager().invalidateAspect).not.toHaveBeenCalled();
|
|
expect(api.getCameraManager().destroy).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should not crash when hass is null', () => {
|
|
const api = createCardAPI();
|
|
const manager = new HASSManager(api);
|
|
const connectedHASS = createHASS();
|
|
connectedHASS.connected = true;
|
|
|
|
manager.setHASS(connectedHASS);
|
|
manager.setHASS(null);
|
|
manager.setHASS(connectedHASS);
|
|
});
|
|
});
|
|
|
|
describe('should not set default view when', () => {
|
|
it('should not set default view when selected camera is unknown', () => {
|
|
const api = createCardAPI();
|
|
vi.mocked(api.getCameraManager).mockReturnValue(createCameraManager());
|
|
vi.mocked(api.getCameraManager().getStore).mockReturnValue(
|
|
createStore([
|
|
{
|
|
cameraID: 'camera.foo',
|
|
config: createCameraConfig({
|
|
triggers: {
|
|
entities: ['binary_sensor.motion'],
|
|
},
|
|
}),
|
|
},
|
|
]),
|
|
);
|
|
vi.mocked(api.getViewManager().getView).mockReturnValue(
|
|
createView({
|
|
camera: 'camera.UNKNOWN',
|
|
}),
|
|
);
|
|
|
|
const manager = new HASSManager(api);
|
|
const hass = createHASS({
|
|
'binary_sensor.motion': createStateEntity(),
|
|
});
|
|
|
|
manager.setHASS(hass);
|
|
|
|
expect(api.getViewManager().setViewDefault).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should not set default view when there is card interaction', () => {
|
|
const api = createCardAPI();
|
|
vi.mocked(api.getConfigManager().getConfig).mockReturnValue(
|
|
createConfig({
|
|
view: {
|
|
default_reset: {
|
|
entities: ['sensor.force_default_view'],
|
|
},
|
|
},
|
|
}),
|
|
);
|
|
vi.mocked(api.getInteractionManager().hasInteraction).mockReturnValue(true);
|
|
|
|
const manager = new HASSManager(api);
|
|
const hass = createHASS({
|
|
'sensor.force_default_view': createStateEntity(),
|
|
});
|
|
|
|
manager.setHASS(hass);
|
|
|
|
expect(api.getViewManager().setViewDefault).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
});
|