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

feat: Make cameras optional (#2343)

Browse Source
This commit is contained in:
Dermot Duffy
2026-02-13 20:21:05 -08:00
committed by GitHub
parent 21f9469784
commit 93f1f08e51
61 changed files with 1312 additions and 557 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/components-lib/effects/effects-controller.test.ts
-254
View File
@@ -1,254 +0,0 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { EffectsController } from '../../../src/components-lib/effects/effects-controller';
import { EffectComponent } from '../../../src/components-lib/effects/types';
import { EffectName } from '../../../src/types';
import { flushPromises } from '../../test-utils';
vi.mock('../../../src/components/effects/fireworks', () => ({
AdvancedCameraCardEffectFireworks: vi.fn(() => createMockEffectComponent()),
}));
vi.mock('../../../src/components/effects/check', () => ({
AdvancedCameraCardEffectCheck: vi.fn(() => createMockEffectComponent()),
}));
vi.mock('../../../src/components/effects/ghost', () => ({
AdvancedCameraCardEffectGhost: vi.fn(() => createMockEffectComponent()),
}));
vi.mock('../../../src/components/effects/hearts', () => ({
AdvancedCameraCardEffectHearts: vi.fn(() => createMockEffectComponent()),
}));
vi.mock('../../../src/components/effects/shamrocks', () => ({
AdvancedCameraCardEffectShamrocks: vi.fn(() => createMockEffectComponent()),
}));
vi.mock('../../../src/components/effects/snow', () => ({
AdvancedCameraCardEffectSnow: vi.fn(() => createMockEffectComponent()),
}));
const createMockEffectComponent = (): EffectComponent => {
const element = document.createElement('div') as unknown as EffectComponent;
element.fadeIn = true;
element.startFadeOut = vi.fn().mockResolvedValue(undefined);
return element;
};
// @vitest-environment jsdom
describe('EffectsController', () => {
let container: HTMLElement;
let controller: EffectsController;
beforeEach(() => {
container = document.createElement('div');
controller = new EffectsController();
controller.setContainer(container);
vi.useFakeTimers();
});
afterEach(() => {
vi.clearAllMocks();
vi.useRealTimers();
});
describe('startEffect', () => {
it('should load and start snow effect', async () => {
expect(container.children.length).toBe(0);
await controller.startEffect('snow');
expect(container.children.length).toBe(1);
});
it('should load and start hearts effect', async () => {
expect(container.children.length).toBe(0);
await controller.startEffect('hearts');
expect(container.children.length).toBe(1);
});
it('should load and start shamrocks effect', async () => {
expect(container.children.length).toBe(0);
await controller.startEffect('shamrocks');
expect(container.children.length).toBe(1);
});
it('should load and start fireworks effect', async () => {
expect(container.children.length).toBe(0);
await controller.startEffect('fireworks');
expect(container.children.length).toBe(1);
});
it('should load and start ghost effect', async () => {
expect(container.children.length).toBe(0);
await controller.startEffect('ghost');
expect(container.children.length).toBe(1);
});
it('should load and start check effect', async () => {
expect(container.children.length).toBe(0);
await controller.startEffect('check');
expect(container.children.length).toBe(1);
});
it('should stop effect automatically after duration', async () => {
const effectPromise = controller.startEffect('snow', { duration: 1 });
// Wait for the effect to be added to the DOM.
await flushPromises();
expect(container.children.length).toBe(1);
vi.advanceTimersByTime(1000);
await effectPromise;
expect(container.children.length).toBe(0);
});
it('should clean up timer when stopped manually', async () => {
// Don't await startEffect as it waits for the duration
controller.startEffect('snow', { duration: 10 });
// Wait for the effect to be added to the DOM.
await flushPromises();
await controller.stopEffect('snow');
expect(container.children.length).toBe(0);
});
it('should set fadeIn to true by default', async () => {
await controller.startEffect('snow');
const effectElement = container.children[0] as EffectComponent;
expect(effectElement.fadeIn).toBe(true);
});
it('should set fadeIn from options', async () => {
await controller.startEffect('snow', { fadeIn: false });
const effectElement = container.children[0] as EffectComponent;
expect(effectElement.fadeIn).toBe(false);
});
it('should not start effect if container is null', async () => {
controller.setContainer(null);
await controller.startEffect('snow');
expect(container.children.length).toBe(0);
});
it('should not start effect if already active', async () => {
await controller.startEffect('snow');
await controller.startEffect('snow');
// Should only have one child since the second call is ignored.
expect(container.children.length).toBe(1);
});
it('should allow starting different effects simultaneously', async () => {
await controller.startEffect('snow');
await controller.startEffect('hearts');
expect(container.children.length).toBe(2);
});
it('should return early if effect module cannot be loaded', async () => {
// Use an effect name that doesn't exist in the registry
await controller.startEffect('unknown' as EffectName);
expect(container.children.length).toBe(0);
});
});
describe('stopEffect', () => {
it('should stop an active effect', async () => {
await controller.startEffect('snow');
const effectElement = container.children[0] as EffectComponent;
await controller.stopEffect('snow');
expect(effectElement.startFadeOut).toHaveBeenCalled();
expect(container.children.length).toBe(0);
});
it('should do nothing if effect is not active', async () => {
expect(container.children.length).toBe(0);
await controller.stopEffect('snow');
expect(container.children.length).toBe(0);
});
it('should allow starting effect again after stopping', async () => {
await controller.startEffect('snow');
await controller.stopEffect('snow');
await controller.startEffect('snow');
expect(container.children.length).toBe(1);
});
it('should cancel effect when stopped during loading', async () => {
// Start the effect but don't await it - simulates the loading phase.
const startPromise = controller.startEffect('snow');
// Stop the effect immediately while it's still loading.
await controller.stopEffect('snow');
// Wait for start to complete.
await startPromise;
// The effect should not appear since it was stopped during loading.
expect(container.children.length).toBe(0);
});
});
describe('toggleEffect', () => {
it('should start effect when not active', async () => {
await controller.toggleEffect('snow');
expect(container.children.length).toBe(1);
});
it('should stop effect when active', async () => {
await controller.startEffect('snow');
const effectElement = container.children[0] as EffectComponent;
await controller.toggleEffect('snow');
expect(effectElement.startFadeOut).toHaveBeenCalled();
});
it('should pass options when starting effect', async () => {
await controller.toggleEffect('snow', { fadeIn: false });
const effectElement = container.children[0] as EffectComponent;
expect(effectElement.fadeIn).toBe(false);
});
it('should cancel effect when toggled during loading', async () => {
// Start the effect but don't await it - simulates the loading phase.
const startPromise = controller.startEffect('snow');
// Toggle the effect immediately while it's still loading.
await controller.toggleEffect('snow');
// Wait for start to complete.
await startPromise;
// The effect should not appear since it was toggled (stopped) during loading.
expect(container.children.length).toBe(0);
});
});
});
tests/components-lib/menu-button-controller.test.ts
+43 -30
View File
@@ -26,8 +26,8 @@ import { ViewMedia, ViewMediaType } from '../../src/view/item.js';
import { QueryResults } from '../../src/view/query-results.js';
import { UnifiedQuery } from '../../src/view/unified-query.js';
import {
getCameraIDsForViewName,
isViewSupportedByCamera,
getCameraIDsWithCapabilityForView,
isViewSupported,
} from '../../src/view/view-support.js';
import { View } from '../../src/view/view.js';
import {
@@ -89,6 +89,7 @@ describe('MenuButtonController', () => {
beforeEach(() => {
vi.resetAllMocks();
vi.mocked(isViewSupported).mockReturnValue(true);
controller = new MenuButtonController();
});
@@ -507,7 +508,7 @@ describe('MenuButtonController', () => {
describe('should have live menu button', () => {
it('when in live view', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(true);
vi.mocked(isViewSupported).mockReturnValue(true);
const buttons = calculateButtons(controller, {
view: createView({ view: 'live' }),
viewManager: viewManager,
@@ -526,7 +527,7 @@ describe('MenuButtonController', () => {
it('when not in live view', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(true);
vi.mocked(isViewSupported).mockReturnValue(true);
const buttons = calculateButtons(controller, {
view: createView({ view: 'clips' }),
viewManager: viewManager,
@@ -545,7 +546,7 @@ describe('MenuButtonController', () => {
it('when not supported', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(false);
vi.mocked(isViewSupported).mockReturnValue(false);
const buttons = calculateButtons(controller, {
viewManager: viewManager,
});
@@ -561,7 +562,7 @@ describe('MenuButtonController', () => {
describe('should have clips menu button', () => {
it('when in clips view', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(true);
vi.mocked(isViewSupported).mockReturnValue(true);
const buttons = calculateButtons(controller, {
view: createView({ view: 'clips' }),
viewManager: viewManager,
@@ -581,7 +582,7 @@ describe('MenuButtonController', () => {
it('when not in clips view', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(true);
vi.mocked(isViewSupported).mockReturnValue(true);
const buttons = calculateButtons(controller, {
viewManager: viewManager,
});
@@ -600,7 +601,7 @@ describe('MenuButtonController', () => {
it('when not supported', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(false);
vi.mocked(isViewSupported).mockReturnValue(false);
const buttons = calculateButtons(controller, {
viewManager: viewManager,
});
@@ -614,9 +615,7 @@ describe('MenuButtonController', () => {
describe('should have snapshots menu button', () => {
it('when in snapshots view', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockImplementation(
(view) => view !== 'reviews',
);
vi.mocked(isViewSupported).mockImplementation((view) => view !== 'reviews');
const buttons = calculateButtons(controller, {
view: createView({ view: 'snapshots' }),
viewManager: viewManager,
@@ -642,7 +641,7 @@ describe('MenuButtonController', () => {
it('when not in snapshots view', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(true);
vi.mocked(isViewSupported).mockReturnValue(true);
const buttons = calculateButtons(controller, {
viewManager: viewManager,
});
@@ -667,7 +666,7 @@ describe('MenuButtonController', () => {
it('when not supported', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(false);
vi.mocked(isViewSupported).mockReturnValue(false);
const buttons = calculateButtons(controller, {
viewManager: viewManager,
});
@@ -683,7 +682,7 @@ describe('MenuButtonController', () => {
describe('should have reviews menu button', () => {
it('when in reviews view', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(true);
vi.mocked(isViewSupported).mockReturnValue(true);
const buttons = calculateButtons(controller, {
view: createView({ view: 'reviews' }),
viewManager: viewManager,
@@ -709,7 +708,7 @@ describe('MenuButtonController', () => {
it('when not in reviews view', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(true);
vi.mocked(isViewSupported).mockReturnValue(true);
const buttons = calculateButtons(controller, {
viewManager: viewManager,
});
@@ -734,7 +733,7 @@ describe('MenuButtonController', () => {
it('when not supported', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(false);
vi.mocked(isViewSupported).mockReturnValue(false);
const buttons = calculateButtons(controller, {
viewManager: viewManager,
});
@@ -748,7 +747,7 @@ describe('MenuButtonController', () => {
describe('should have gallery menu button', () => {
it('when in gallery view', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(true);
vi.mocked(isViewSupported).mockReturnValue(true);
const buttons = calculateButtons(controller, {
view: createView({ view: 'gallery' }),
viewManager: viewManager,
@@ -774,7 +773,7 @@ describe('MenuButtonController', () => {
it('when not in gallery view', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(true);
vi.mocked(isViewSupported).mockReturnValue(true);
const buttons = calculateButtons(controller, {
viewManager: viewManager,
});
@@ -799,7 +798,7 @@ describe('MenuButtonController', () => {
it('when not supported', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(false);
vi.mocked(isViewSupported).mockReturnValue(false);
const buttons = calculateButtons(controller, {
viewManager: viewManager,
});
@@ -813,7 +812,7 @@ describe('MenuButtonController', () => {
describe('should have recordings menu button', () => {
it('when in recordings view', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(true);
vi.mocked(isViewSupported).mockReturnValue(true);
const buttons = calculateButtons(controller, {
view: createView({ view: 'recordings' }),
viewManager: viewManager,
@@ -839,7 +838,7 @@ describe('MenuButtonController', () => {
it('when not in recordings view', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(true);
vi.mocked(isViewSupported).mockReturnValue(true);
const buttons = calculateButtons(controller, {
viewManager: viewManager,
});
@@ -864,7 +863,7 @@ describe('MenuButtonController', () => {
it('when not supported', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(false);
vi.mocked(isViewSupported).mockReturnValue(false);
const buttons = calculateButtons(controller, {
viewManager: viewManager,
});
@@ -880,7 +879,7 @@ describe('MenuButtonController', () => {
describe('should have image menu button', () => {
it('when in image view', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(true);
vi.mocked(isViewSupported).mockReturnValue(true);
const buttons = calculateButtons(controller, {
view: createView({ view: 'image' }),
@@ -900,7 +899,7 @@ describe('MenuButtonController', () => {
it('when not in image view', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(true);
vi.mocked(isViewSupported).mockReturnValue(true);
const buttons = calculateButtons(controller, {
view: createView({ view: 'live' }),
@@ -920,7 +919,7 @@ describe('MenuButtonController', () => {
it('when not supported', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(false);
vi.mocked(isViewSupported).mockReturnValue(false);
const buttons = calculateButtons(controller, {
viewManager: viewManager,
});
@@ -936,7 +935,7 @@ describe('MenuButtonController', () => {
describe('should have timeline button', () => {
it('when in timeline view', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(true);
vi.mocked(isViewSupported).mockReturnValue(true);
const buttons = calculateButtons(controller, {
view: createView({ view: 'timeline' }),
viewManager: viewManager,
@@ -958,7 +957,7 @@ describe('MenuButtonController', () => {
it('when not in timeline view', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(true);
vi.mocked(isViewSupported).mockReturnValue(true);
const buttons = calculateButtons(controller, {
view: createView({ view: 'live' }),
viewManager: viewManager,
@@ -980,7 +979,7 @@ describe('MenuButtonController', () => {
it('when not supported', () => {
const viewManager = mock<ViewManager>();
vi.mocked(isViewSupportedByCamera).mockReturnValue(false);
vi.mocked(isViewSupported).mockReturnValue(false);
const buttons = calculateButtons(controller, {
view: createView({ view: 'live' }),
viewManager: viewManager,
@@ -1640,7 +1639,7 @@ describe('MenuButtonController', () => {
]),
);
vi.mocked(getCameraIDsForViewName).mockReturnValue(
vi.mocked(getCameraIDsWithCapabilityForView).mockReturnValue(
new Set(['camera-1', 'camera-2']),
);
@@ -1928,6 +1927,7 @@ describe('MenuButtonController', () => {
describe('should have folders button', () => {
it('should have no folders button without folders', () => {
const foldersManager = mock<FoldersManager>();
foldersManager.hasFolders.mockReturnValue(true);
foldersManager.getFolders.mockReturnValue(new Map().entries());
const buttons = calculateButtons(controller, {
@@ -1945,6 +1945,7 @@ describe('MenuButtonController', () => {
it('should have a folders button for a single folder outside the folder view', () => {
const foldersManager = mock<FoldersManager>();
foldersManager.hasFolders.mockReturnValue(true);
foldersManager.getFolders.mockReturnValue(
new Map([['folder-0', createFolder({ id: 'folder-0' })]]).entries(),
);
@@ -1968,6 +1969,7 @@ describe('MenuButtonController', () => {
it('should have a folders button for a single folder inside the folder view', () => {
const folder = createFolder({ id: 'folder-0' });
const foldersManager = mock<FoldersManager>();
foldersManager.hasFolders.mockReturnValue(true);
foldersManager.getFolders.mockReturnValue(
new Map([['folder-0', folder]]).entries(),
);
@@ -2006,6 +2008,7 @@ describe('MenuButtonController', () => {
['folder-0', createFolder({ id: 'folder-0' })],
['folder-selected', selectedFolder],
]);
foldersManager.hasFolders.mockReturnValue(true);
foldersManager.getFolders.mockReturnValue(folders.entries());
const selectedFolderNode: FolderQuery = {
@@ -2079,6 +2082,7 @@ describe('MenuButtonController', () => {
['folder-0', createFolder({ id: 'folder-0' })],
['folder-1', createFolder({ id: 'folder-1' })],
]);
foldersManager.hasFolders.mockReturnValue(true);
foldersManager.getFolders.mockReturnValue(folders.entries());
const buttons = calculateButtons(controller, {
@@ -2202,9 +2206,10 @@ describe('MenuButtonController', () => {
...dynamicButton,
tap_action: { action: 'fire-dom-event', advanced_camera_card_action: 'default' },
};
const cameraManager = createCameraManager(createStore([{ cameraID: 'camera-1' }]));
controller.addDynamicMenuButton(button);
expect(calculateButtons(controller)).toContainEqual({
expect(calculateButtons(controller, { cameraManager })).toContainEqual({
...button,
style: { color: 'var(--advanced-camera-card-menu-button-active-color)' },
});
@@ -2346,4 +2351,12 @@ describe('MenuButtonController', () => {
);
});
});
it('should handle view without camera', () => {
const buttons = calculateButtons(controller, {
view: createView({ camera: null }),
});
expect(buttons).toBeDefined();
});
});