Feat resumability (#547)

* add resumability functionality --------- Co-authored-by: arc-alex <ac@omnivox.dk> Co-authored-by: Carlos Valente <34649812+cpvalente@users.noreply.github.com>
2026-08-18 05:34:09 +00:00 · 2023-10-24 08:33:17 +02:00
parent b34fe71995
commit a84c0654e2
12 changed files with 453 additions and 33 deletions
@@ -0,0 +1,128 @@
+import { describe, expect, it, vi } from 'vitest';
+
+import { Playback } from 'ontime-types';
+
+import { isRestorePoint, RestorePoint, RestoreService } from '../RestoreService.js';
+
+describe('isRestorePoint()', () => {
+  it('validates a well defined object', () => {
+    let restorePoint = {
+      playback: 'play',
+      selectedEventId: '123',
+      startedAt: 1,
+      addedTime: 2,
+      pausedAt: 3,
+    };
+    expect(isRestorePoint(restorePoint)).toBe(true);
+
+    restorePoint = {
+      playback: 'roll',
+      selectedEventId: '123',
+      startedAt: null,
+      addedTime: null,
+      pausedAt: null,
+    };
+    expect(isRestorePoint(restorePoint)).toBe(true);
+  });
+
+  describe('rejects a badly formatted file', () => {
+    it('with invalid playback value', () => {
+      const restorePoint = {
+        playback: 'unknown',
+        selectedEventId: '123',
+        startedAt: null,
+        addedTime: null,
+        pausedAt: null,
+      };
+      expect(isRestorePoint(restorePoint)).toBe(false);
+    });
+    it('with missing playback value', () => {
+      const restorePoint = {
+        selectedEventId: '123',
+        startedAt: null,
+        addedTime: null,
+        pausedAt: null,
+      };
+      expect(isRestorePoint(restorePoint)).toBe(false);
+    });
+    it('with incorrect value', () => {
+      const restorePoint = {
+        playback: 'roll',
+        selectedEventId: '123',
+        startedAt: 'testing',
+        addedTime: null,
+        pausedAt: null,
+      };
+      expect(isRestorePoint(restorePoint)).toBe(false);
+    });
+  });
+});
+
+describe('RestoreService()', () => {
+  describe('load()', () => {
+    it('loads working file with times', () => {
+      const expected = {
+        playback: Playback.Play,
+        selectedEventId: 'da5b4',
+        startedAt: 1234,
+        addedTime: 5678,
+        pausedAt: 9087,
+      };
+
+      const restoreService = new RestoreService('/path/to/restore/file');
+      vi.spyOn<any, any>(restoreService, 'read').mockImplementation(() => JSON.stringify(expected));
+
+      const testLoad = restoreService.load();
+      expect(testLoad).toStrictEqual(expected);
+    });
+
+    it('loads working file without times', () => {
+      const expected = {
+        playback: Playback.Stop,
+        selectedEventId: null,
+        startedAt: null,
+        addedTime: null,
+        pausedAt: null,
+      };
+
+      const restoreService = new RestoreService('/path/to/restore/file');
+      vi.spyOn<any, any>(restoreService, 'read').mockImplementation(() => JSON.stringify(expected));
+
+      const testLoad = restoreService.load();
+      expect(testLoad).toStrictEqual(expected);
+    });
+
+    it('does not load wrong play state', () => {
+      const expected = {
+        playback: 'does-not-exist',
+        selectedEventId: 'da5b4',
+        startedAt: 1234,
+        addedTime: 1234,
+        pausedAt: 1234,
+      };
+
+      const restoreService = new RestoreService('/path/to/restore/file');
+      vi.spyOn<any, any>(restoreService, 'read').mockImplementation(() => JSON.stringify(expected));
+
+      const testLoad = restoreService.load();
+      expect(testLoad).toBe(null);
+    });
+  });
+
+  describe('save()', () => {
+    it('saves data to file', async () => {
+      const testData: RestorePoint = {
+        playback: Playback.Play,
+        selectedEventId: '1234',
+        startedAt: 1234,
+        addedTime: 1234,
+        pausedAt: 1234,
+      };
+
+      const restoreService = new RestoreService('/path/to/restore/file');
+      const writeSpy = vi.spyOn<any, any>(restoreService, 'write').mockImplementation(() => undefined);
+      await restoreService.save(testData);
+      expect(writeSpy).toHaveBeenCalledWith(JSON.stringify(testData));
+    });
+  });
+});