feat: Add support for Frigate reviews / detections [initial PR] (#2315)

- Add support for Frigate reviews / detections. - Add support for GenAI metadata. - Significant internal refactor to more flexible "UnifiedQuery" to allow mixing cameras with simple metadata and review metadata (e.g. a timeline view of a Frigate camera with reviews, and a Reolink camera with simple metadata). - Add support for folder media as camera media. There are a few more PRs to commit prior to this going live, but commiting this for now due to the scale of the change. BREAKING CHANGE: `media_type` and `events_type` are retired under `live`, `viewer` and `timeline` configuration sections, instead media type is associated (once) with the camera under `media`.
2026-01-19 13:32:50 -08:00
parent 6eb0a87ca8
commit fc32727860
215 changed files with 14491 additions and 6160 deletions
@@ -0,0 +1,236 @@
+import { describe, expect, it, vi } from 'vitest';
+import { mock } from 'vitest-mock-extended';
+import { ViewItemManager } from '../../src/card-controller/view/item-manager';
+import { RemoveContextViewModifier } from '../../src/card-controller/view/modifiers/remove-context';
+import { ViewManagerEpoch } from '../../src/card-controller/view/types';
+import { ViewManager } from '../../src/card-controller/view/view-manager';
+import {
+  downloadMedia,
+  navigateToTimeline,
+  toggleFavorite,
+  toggleReviewed,
+} from '../../src/utils/media-actions';
+import { ViewItem, ViewMediaType } from '../../src/view/item';
+import { QueryResults } from '../../src/view/query-results';
+import { View } from '../../src/view/view';
+import { TestViewMedia } from '../test-utils';
+
+describe('MediaActions', () => {
+  describe('toggleReviewed', () => {
+    it('should return false if item is not review', async () => {
+      const item = new TestViewMedia({ mediaType: ViewMediaType.Clip });
+      const options = { viewItemManager: mock<ViewItemManager>() };
+
+      expect(await toggleReviewed(item, options)).toBe(false);
+    });
+
+    it('should return false if manager is missing', async () => {
+      const item = new TestViewMedia({ mediaType: ViewMediaType.Review });
+      const options = {};
+
+      expect(await toggleReviewed(item, options)).toBe(false);
+    });
+
+    it('should toggle review status and update view', async () => {
+      const item = new TestViewMedia({
+        mediaType: ViewMediaType.Review,
+        reviewed: false,
+      });
+      const viewItemManager = mock<ViewItemManager>();
+      const viewManagerEpoch = mock<ViewManagerEpoch>();
+      const viewManager = mock<ViewManager>();
+      const view = mock<View>();
+      const queryResults = mock<QueryResults>();
+
+      viewManagerEpoch.manager = viewManager;
+      viewManager.getView.mockReturnValue(view);
+      view.queryResults = queryResults;
+      queryResults.clone.mockReturnValue(queryResults);
+      queryResults.removeItem.mockReturnValue(queryResults);
+
+      const options = { viewItemManager, viewManagerEpoch };
+
+      expect(await toggleReviewed(item, options)).toBe(true);
+      expect(viewItemManager.reviewMedia).toHaveBeenCalledWith(item, true);
+      expect(item.isReviewed()).toBe(true);
+      expect(viewManager.setViewByParameters).toHaveBeenCalled();
+    });
+
+    it('should not update view if queryResults is missing', async () => {
+      const item = new TestViewMedia({
+        mediaType: ViewMediaType.Review,
+        reviewed: false,
+      });
+      const viewItemManager = mock<ViewItemManager>();
+      const viewManagerEpoch = mock<ViewManagerEpoch>();
+      const viewManager = mock<ViewManager>();
+      const view = mock<View>();
+
+      viewManagerEpoch.manager = viewManager;
+      viewManager.getView.mockReturnValue(view);
+      view.queryResults = null;
+
+      const options = { viewItemManager, viewManagerEpoch };
+
+      expect(await toggleReviewed(item, options)).toBe(true);
+      expect(viewManager.setViewByParameters).not.toHaveBeenCalled();
+    });
+
+    it('should handle manager error', async () => {
+      const item = new TestViewMedia({
+        mediaType: ViewMediaType.Review,
+        reviewed: false,
+      });
+      const viewItemManager = mock<ViewItemManager>();
+      const error = new Error('fail');
+      viewItemManager.reviewMedia.mockRejectedValue(error);
+
+      const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
+      const options = { viewItemManager };
+
+      expect(await toggleReviewed(item, options)).toBe(false);
+      expect(consoleSpy).toHaveBeenCalledWith(error.message);
+
+      consoleSpy.mockRestore();
+    });
+  });
+
+  describe('toggleFavorite', () => {
+    it('should return false if item is not media', async () => {
+      const options = { viewItemManager: mock<ViewItemManager>() };
+
+      expect(await toggleFavorite(null as unknown as ViewItem, options)).toBe(false);
+    });
+
+    it('should return false if manager is missing', async () => {
+      const item = new TestViewMedia({ mediaType: ViewMediaType.Clip });
+      const options = {};
+
+      expect(await toggleFavorite(item, options)).toBe(false);
+    });
+
+    it('should toggle favorite status', async () => {
+      const item = new TestViewMedia({
+        mediaType: ViewMediaType.Clip,
+        favorite: false,
+      });
+      const viewItemManager = mock<ViewItemManager>();
+      const options = { viewItemManager };
+
+      expect(await toggleFavorite(item, options)).toBe(true);
+      expect(viewItemManager.favorite).toHaveBeenCalledWith(item, true);
+    });
+
+    it('should handle manager error', async () => {
+      const item = new TestViewMedia({
+        mediaType: ViewMediaType.Clip,
+        favorite: false,
+      });
+      const viewItemManager = mock<ViewItemManager>();
+      const error = new Error('fail');
+      viewItemManager.favorite.mockRejectedValue(error);
+
+      const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
+      const options = { viewItemManager };
+
+      expect(await toggleFavorite(item, options)).toBe(false);
+      expect(consoleSpy).toHaveBeenCalledWith(error.message);
+
+      consoleSpy.mockRestore();
+    });
+  });
+
+  describe('downloadMedia', () => {
+    it('should return false if manager is missing', async () => {
+      const item = new TestViewMedia({ mediaType: ViewMediaType.Clip });
+      const options = {};
+
+      expect(await downloadMedia(item, options)).toBe(false);
+    });
+
+    it('should download media', async () => {
+      const item = new TestViewMedia({ mediaType: ViewMediaType.Clip });
+      const viewItemManager = mock<ViewItemManager>();
+      const options = { viewItemManager };
+
+      expect(await downloadMedia(item, options)).toBe(true);
+      expect(viewItemManager.download).toHaveBeenCalledWith(item);
+    });
+
+    it('should handle manager error', async () => {
+      const item = new TestViewMedia({ mediaType: ViewMediaType.Clip });
+      const viewItemManager = mock<ViewItemManager>();
+      const error = new Error('fail');
+      viewItemManager.download.mockRejectedValue(error);
+
+      const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
+      const options = { viewItemManager };
+
+      expect(await downloadMedia(item, options)).toBe(false);
+      expect(consoleSpy).toHaveBeenCalledWith(error.message);
+
+      consoleSpy.mockRestore();
+    });
+  });
+
+  describe('navigateToTimeline', () => {
+    it('should return early if epoch is missing', () => {
+      const item = new TestViewMedia({ mediaType: ViewMediaType.Clip });
+      const options = {};
+
+      expect(navigateToTimeline(item, options)).toBeUndefined();
+    });
+
+    it('should navigate to timeline with correct parameters', () => {
+      const item = new TestViewMedia({ mediaType: ViewMediaType.Clip });
+      const viewManagerEpoch = mock<ViewManagerEpoch>();
+      const viewManager = mock<ViewManager>();
+      const view = mock<View>();
+      const queryResults = mock<QueryResults>();
+
+      viewManagerEpoch.manager = viewManager;
+      viewManager.getView.mockReturnValue(view);
+      view.queryResults = queryResults;
+      queryResults.clone.mockReturnValue(queryResults);
+
+      // Make selectResultIfFound call the predicate to gain coverage.
+      queryResults.selectResultIfFound.mockImplementation((predicate) => {
+        predicate(item);
+        return queryResults;
+      });
+
+      const options = { viewManagerEpoch };
+
+      navigateToTimeline(item, options);
+
+      expect(viewManager.setViewByParameters).toHaveBeenCalledWith({
+        params: {
+          view: 'timeline',
+          queryResults: queryResults,
+        },
+        modifiers: [expect.any(RemoveContextViewModifier)],
+      });
+    });
+
+    it('should handle missing view/queryResults during navigation', () => {
+      const item = new TestViewMedia({ mediaType: ViewMediaType.Clip });
+      const viewManagerEpoch = mock<ViewManagerEpoch>();
+      const viewManager = mock<ViewManager>();
+
+      viewManagerEpoch.manager = viewManager;
+      viewManager.getView.mockReturnValue(null);
+
+      const options = { viewManagerEpoch };
+
+      navigateToTimeline(item, options);
+
+      expect(viewManager.setViewByParameters).toHaveBeenCalledWith({
+        params: {
+          view: 'timeline',
+          queryResults: undefined,
+        },
+        modifiers: [new RemoveContextViewModifier(['timeline'])],
+      });
+    });
+  });
+});