Initial version of status bar.

2024-08-16 20:08:21 -07:00
parent db9303c60d
commit e503f0e429
77 changed files with 3072 additions and 1061 deletions
@@ -0,0 +1,243 @@
+import { describe, expect, it, vi } from 'vitest';
+import { StatusBarItemManager } from '../../src/card-controller/status-bar-item-manager';
+import { StatusBarString } from '../../src/config/types';
+import { MediaQueriesResults } from '../../src/view/media-queries-results';
+import {
+  TestViewMedia,
+  createCameraManager,
+  createCardAPI,
+  createStore,
+  createView,
+} from '../test-utils';
+
+describe('StatusBarItemManager', () => {
+  const testItem: StatusBarString = {
+    type: 'custom:frigate-card-status-bar-string' as const,
+    string: 'test',
+  };
+
+  it('should add', () => {
+    const manager = new StatusBarItemManager(createCardAPI());
+    manager.addDynamicStatusBarItem(testItem);
+    manager.addDynamicStatusBarItem(testItem);
+
+    expect(manager.calculateItems()).toContain(testItem);
+    expect(manager.calculateItems().find((item) => item === testItem).length === 1);
+  });
+
+  it('should remove', () => {
+    const manager = new StatusBarItemManager(createCardAPI());
+    manager.addDynamicStatusBarItem(testItem);
+
+    manager.removeDynamicStatusBarItem({ ...testItem });
+    expect(manager.calculateItems()).not.toContain(testItem);
+
+    manager.removeDynamicStatusBarItem({ ...testItem, string: 'not-present' });
+    expect(manager.calculateItems()).not.toContain({
+      ...testItem,
+      string: 'not-present',
+    });
+  });
+
+  it('should remove all', () => {
+    const manager = new StatusBarItemManager(createCardAPI());
+    manager.addDynamicStatusBarItem(testItem);
+    manager.removeAllDynamicStatusBarItems();
+    expect(manager.calculateItems()).not.toContain(testItem);
+  });
+
+  describe('should have standard status bar items', () => {
+    describe('should have title', () => {
+      describe('live', () => {
+        it('with metadata', () => {
+          const manager = new StatusBarItemManager(createCardAPI());
+          const store = createStore([
+            {
+              cameraID: 'camera-1',
+            },
+          ]);
+          const cameraManager = createCameraManager(store);
+          vi.mocked(cameraManager.getCameraMetadata).mockReturnValue({
+            title: 'Camera Title',
+            icon: 'mdi:camera',
+          });
+
+          expect(
+            manager.calculateItems({
+              cameraManager: cameraManager,
+              view: createView({ view: 'live', camera: 'camera-1' }),
+            }),
+          ).toContainEqual({
+            type: 'custom:frigate-card-status-bar-string' as const,
+            string: 'Camera Title',
+            expand: true,
+            sufficient: true,
+          });
+        });
+
+        it('without metadata', () => {
+          const manager = new StatusBarItemManager(createCardAPI());
+          const cameraManager = createCameraManager();
+          expect(
+            manager.calculateItems({
+              cameraManager: cameraManager,
+              view: createView({ view: 'live', camera: 'MISSING-CAMERA' }),
+            }),
+          ).not.toContainEqual(expect.objectContaining({ sufficient: true }));
+        });
+      });
+
+      describe('media', () => {
+        it('with a title', () => {
+          const manager = new StatusBarItemManager(createCardAPI());
+          const cameraManager = createCameraManager();
+
+          const media = [new TestViewMedia({ title: 'Media Title' })];
+          const queryResults = new MediaQueriesResults({
+            results: media,
+          });
+
+          const view = createView({
+            view: 'media',
+            queryResults: queryResults,
+          });
+
+          expect(
+            manager.calculateItems({
+              cameraManager: cameraManager,
+              view: view,
+            }),
+          ).toContainEqual({
+            type: 'custom:frigate-card-status-bar-string' as const,
+            string: 'Media Title',
+            expand: true,
+            sufficient: true,
+          });
+        });
+
+        it('without a title', () => {
+          const manager = new StatusBarItemManager(createCardAPI());
+          const cameraManager = createCameraManager();
+
+          const media = [new TestViewMedia()];
+          const queryResults = new MediaQueriesResults({
+            results: media,
+          });
+
+          const view = createView({
+            view: 'media',
+            queryResults: queryResults,
+          });
+
+          expect(
+            manager.calculateItems({
+              cameraManager: cameraManager,
+              view: view,
+            }),
+          ).not.toContainEqual(expect.objectContaining({ sufficient: true }));
+        });
+      });
+    });
+
+    describe('should have resolution', () => {
+      it.each([
+        ['1080p landscape', '1080p', 1920, 1080],
+        ['1080p portrait', '1080p', 1080, 1920],
+        ['1080p approximate', '1080p', 1922, 1082],
+
+        ['720p landscape', '720p', 1280, 720],
+        ['720p portrait', '720p', 720, 1280],
+        ['720p approximate', '720p', 1282, 722],
+
+        ['VGA landscape', 'VGA', 640, 480],
+        ['VGA portrait', 'VGA', 480, 640],
+        ['VGA approximate', 'VGA', 642, 482],
+
+        ['4K landscape', '4K', 3840, 2160],
+        ['4K portrait', '4K', 2160, 3840],
+        ['4K approximate', '4K', 3842, 2162],
+
+        ['480p landscape', '480p', 720, 480],
+        ['480p portrait', '480p', 480, 720],
+        ['480p approximate', '480p', 722, 482],
+
+        ['576p landscape', '576p', 720, 576],
+        ['576p portrait', '576p', 576, 720],
+        ['576p approximate', '576p', 722, 578],
+
+        ['8K landscape', '8K', 7680, 4320],
+        ['8K portrait', '8K', 4320, 7680],
+        ['8K approximate', '8K', 7682, 4322],
+
+        ['random', '123x456', 123, 456],
+      ])(
+        '%s',
+        (_testName: string, expectedName: string, width: number, height: number) => {
+          const manager = new StatusBarItemManager(createCardAPI());
+
+          expect(
+            manager.calculateItems({
+              mediaLoadedInfo: { width, height },
+            }),
+          ).toContainEqual({
+            type: 'custom:frigate-card-status-bar-string' as const,
+            string: expectedName,
+          });
+        },
+      );
+    });
+
+    describe('should have technology', () => {
+      it('webrtc', () => {
+        const manager = new StatusBarItemManager(createCardAPI());
+
+        expect(
+          manager.calculateItems({
+            mediaLoadedInfo: { width: 640, height: 480, technology: ['webrtc'] },
+          }),
+        ).toContainEqual({
+          type: 'custom:frigate-card-status-bar-icon' as const,
+          icon: 'mdi:webrtc',
+        });
+      });
+
+      it('non-webrtc', () => {
+        const manager = new StatusBarItemManager(createCardAPI());
+
+        expect(
+          manager.calculateItems({
+            mediaLoadedInfo: { width: 640, height: 480, technology: ['hls'] },
+          }),
+        ).toContainEqual({
+          type: 'custom:frigate-card-status-bar-string' as const,
+          string: 'HLS',
+        });
+      });
+    });
+
+    it('should have engine', () => {
+      const manager = new StatusBarItemManager(createCardAPI());
+      const store = createStore([
+        {
+          cameraID: 'camera-1',
+        },
+      ]);
+      const cameraManager = createCameraManager(store);
+      vi.mocked(cameraManager.getCameraMetadata).mockReturnValue({
+        title: 'Camera Title',
+        icon: 'mdi:camera',
+        engineLogo: 'IMAGE_LOGO',
+      });
+
+      expect(
+        manager.calculateItems({
+          cameraManager: cameraManager,
+          view: createView({ view: 'live', camera: 'camera-1' }),
+        }),
+      ).toContainEqual({
+        type: 'custom:frigate-card-status-bar-image' as const,
+        image: 'IMAGE_LOGO',
+      });
+    });
+  });
+});