V3 (#657)

* refactor: cleanup routes

* style: smaller base font

* chore: upgrade dependencies

* chore: lock node version to electron

* refactor: pass HTTP to integration controller (#652)

* refactor: deprecate onair control

* refactor: remove playback router

* Several project files user folder (#617)

* chore: automated screenshots (#667)

* feat: app settings (#658)

* refactor: remove deprecated event data (#674)

* Studio clock (#663)

---------

Co-authored-by: Carlos Valente <carlosvalente@pm.me>

* Feat: reorder events with alt+ctrl + arrow up/down (#645)

* Warning and danger per event (#677)

---------

Co-authored-by: Fabian Posenau <fabian@fphome.de>

* refactor: stabilise actionHandler (#683)

Co-authored-by: Fabian Posenau <fabian@fphome.de>

* improvement: hide seconds (#675)

* wip: overview (#688)

* fix: focus cursor (#695)

* refactor: update lower third (#665)

* Refactor/time formatting (#696)

---------

Co-authored-by: Carlos Valente <34649812+cpvalente@users.noreply.github.com>
Co-authored-by: Carlos Valente <carlosvalente@pm.me>

* feat: multiple selection (#703)

---------

Co-authored-by: asharonbaltazar <asharonbaltazar@outlook.com>
Co-authored-by: Alex <ac@omnivox.dk>

* fix: test - go to `Edit mode` befor tying to click `Event options` button (#708)

* refactor: runtime service (#715)

* fix: issue with loosing cursor position on message (#719)

* remove info panel (#721)

* Event editor continue (#722)

* update API - part  (#709)

---------

Co-authored-by: Carlos Valente <34649812+cpvalente@users.noreply.github.com>
Co-authored-by: Carlos Valente <carlosvalente@pm.me>

* refactor: update timers (#729)

* feat: many timers (#706)

---------

Co-authored-by: arc-alex <ac@omnivox.dk>

* refactor: excel cleanup (#734)

* refactor: allow import of blocks and skip import (#735)

* Project manager (#697)

* refactor: UI for linking events (#763)

* upgraded pipeline actions (#777)

* Over under (#771)

* custom fields (#744)


---------

Co-authored-by: Carlos Valente <carlosvalente@pm.me>

* Sheets settings (#774)

---------

Co-authored-by: arc-alex <ac@omnivox.dk>

* style: tweaks to lower thirds (#785)

* refactor: delays account for gaps (#784)

* refactor: partial state updates (#780)

* feat: generate crash report (#787)

* Sheet use limited input device auth flow (#782)

---------

Co-authored-by: cv <34649812+cpvalente@users.noreply.github.com>
Co-authored-by: Carlos Valente <carlosvalente@pm.me>

* Custom fields views (#789)

* refactor: deprecate presenter and subtitle (#795)

* refactor: organise API around resources (#798)

---------

Co-authored-by: Bianca Procopio <biancahprocopio@gmail.com>

* Time to end (#804)

* Skip fixes (#805)

* fix: onair derives from playback

* Param nav (#822)

---------

Co-authored-by: Alex Christoffer Rasmussen <ac@omnivox.dk>

* refactor: download files from interface (#831)

* Quick options (#814)

* End pause (#832)

* chore: bump node version in docker (#834)

* refactor: follow in run mode (#840)

* fix: uncaught error in http integration (#837)

* Apply project (#843)

Co-authored-by: Matteo Gheza <matteo.gheza07@gmail.com>
Co-authored-by: Ary <arylmoraesn@gmail.com>
Co-authored-by: Alex Christoffer Rasmussen <ac@omnivox.dk>
Co-authored-by: Fabian Posenau <19673098+kellhogs@users.noreply.github.com>
Co-authored-by: Fabian Posenau <fabian@fphome.de>
Co-authored-by: Alex Rohleder <alexrohleder96@gmail.com>
Co-authored-by: asharonbaltazar <asharonbaltazar@outlook.com>
Co-authored-by: Bianca Procopio <biancahprocopio@gmail.com>
Co-authored-by: Fabian Posenau <fabianpos99+github@gmail.com>

packages/utils/src/validate-times/validateTimes.test.ts

@@ -0,0 +1,191 @@
+import type { OntimeEvent } from 'ontime-types';
+import { TimeStrategy } from 'ontime-types';
+
+import { dayInMs } from '../timeConstants';
+import { calculateDuration, getLinkedTimes, validateTimes } from './validateTimes';
+
+describe('validateTimes()', () => {
+  describe('when time strategy is inferred', () => {
+    it('passes through a well defined time list', () => {
+      const { timeStart, timeEnd, duration, timeStrategy } = validateTimes(5, 10, 5);
+      expect(timeStart).toBe(5);
+      expect(timeEnd).toBe(10);
+      expect(duration).toBe(5);
+      expect(timeStrategy).toBe(TimeStrategy.LockDuration);
+    });
+
+    it('handles cases when no times are given', () => {
+      const { timeStart, timeEnd, duration, timeStrategy } = validateTimes(null, undefined, null);
+      expect(timeStart).toBe(0);
+      expect(timeEnd).toBe(0);
+      expect(duration).toBe(0);
+      expect(timeStrategy).toBe(TimeStrategy.LockDuration);
+    });
+
+    it('calculates duration', () => {
+      const { timeStart, timeEnd, duration, timeStrategy } = validateTimes(5, 10, undefined);
+      expect(timeStart).toBe(5);
+      expect(timeEnd).toBe(10);
+      expect(duration).toBe(5);
+      expect(timeStrategy).toBe(TimeStrategy.LockEnd);
+    });
+
+    it('calculates end time', () => {
+      const { timeStart, timeEnd, duration, timeStrategy } = validateTimes(5, undefined, 10);
+      expect(timeStart).toBe(5);
+      expect(timeEnd).toBe(15);
+      expect(duration).toBe(10);
+      expect(timeStrategy).toBe(TimeStrategy.LockDuration);
+    });
+
+    it('handles events that finish the day after', () => {
+      const { timeStart, timeEnd, duration, timeStrategy } = validateTimes(100, 10, undefined);
+      expect(timeStart).toBe(100);
+      expect(timeEnd).toBe(10);
+      expect(duration).toBe(dayInMs - 90);
+      expect(timeStrategy).toBe(TimeStrategy.LockEnd);
+    });
+
+    it('corrects time in case of conflicts', () => {
+      const { timeStart, timeEnd, duration, timeStrategy } = validateTimes(5, 15, 15);
+      expect(timeStart).toBe(5);
+      expect(timeEnd).toBe(15);
+      expect(duration).toBe(10);
+      expect(timeStrategy).toBe(TimeStrategy.LockDuration);
+    });
+
+    it('calculates start time', () => {
+      const { timeStart, timeEnd, duration, timeStrategy } = validateTimes(undefined, 15, 10);
+      expect(timeStart).toBe(5);
+      expect(timeEnd).toBe(15);
+      expect(duration).toBe(10);
+      expect(timeStrategy).toBe(TimeStrategy.LockDuration);
+    });
+
+    it('calculates start and end time', () => {
+      const { timeStart, timeEnd, duration, timeStrategy } = validateTimes(undefined, undefined, 10);
+      expect(timeStart).toBe(0);
+      expect(timeEnd).toBe(10);
+      expect(duration).toBe(10);
+      expect(timeStrategy).toBe(TimeStrategy.LockDuration);
+    });
+
+    it('ensures values are integers', () => {
+      const { timeStart, timeEnd, duration, timeStrategy } = validateTimes(0.000001, 10.312335342, 10);
+      expect(timeStart).toBe(0);
+      expect(timeEnd).toBe(10);
+      expect(duration).toBe(10);
+      expect(timeStrategy).toBe(TimeStrategy.LockDuration);
+    });
+    it('prevents values from overflowing', () => {
+      const { timeStart, timeEnd, duration, timeStrategy } = validateTimes(dayInMs - 5, undefined, 10);
+      expect(timeStart).toBe(dayInMs - 5);
+      expect(timeEnd).toBe(5);
+      expect(duration).toBe(10);
+      expect(timeStrategy).toBe(TimeStrategy.LockDuration);
+    });
+  });
+  describe('when time strategy is given', () => {
+    it('calculates end', () => {
+      const { timeStart, timeEnd, duration, timeStrategy } = validateTimes(5, 20, 20, TimeStrategy.LockDuration);
+      expect(timeStart).toBe(5);
+      expect(timeEnd).toBe(25);
+      expect(duration).toBe(20);
+      expect(timeStrategy).toBe(TimeStrategy.LockDuration);
+    });
+    it('calculates duration', () => {
+      const { timeStart, timeEnd, duration, timeStrategy } = validateTimes(5, 20, 20, TimeStrategy.LockEnd);
+      expect(timeStart).toBe(5);
+      expect(timeEnd).toBe(20);
+      expect(duration).toBe(15);
+      expect(timeStrategy).toBe(TimeStrategy.LockEnd);
+    });
+  });
+});
+
+describe('calculateDuration()', () => {
+  describe('Given start and end values', () => {
+    it('is the difference between end and start', () => {
+      const duration = calculateDuration(10, 20);
+      expect(duration).toBe(10);
+    });
+  });
+
+  describe('Handles edge cases', () => {
+    it('handles events that go over midnight', () => {
+      const duration = calculateDuration(51, 50);
+      expect(duration).toBe(dayInMs - 1);
+    });
+    it('handles no difference', () => {
+      const duration1 = calculateDuration(0, 0);
+      const duration2 = calculateDuration(dayInMs, dayInMs);
+      expect(duration1).toBe(0);
+      expect(duration2).toBe(0);
+    });
+  });
+});
+
+describe('getLinkedTimes()', () => {
+  it('returns times with lock end', () => {
+    const source = {
+      timeStart: 5,
+      timeEnd: 15,
+      duration: 10,
+    } as OntimeEvent;
+    const target = {
+      timeStart: 10,
+      timeEnd: 20,
+      duration: 10,
+      timeStrategy: TimeStrategy.LockEnd,
+    } as OntimeEvent;
+
+    const timePatch = getLinkedTimes(target, source);
+    expect(timePatch).toStrictEqual({
+      timeStart: 15,
+      timeEnd: 20,
+      duration: 5,
+    });
+  });
+
+  it('returns times with lock duration', () => {
+    const source = {
+      timeStart: 5,
+      timeEnd: 15,
+      duration: 10,
+    } as OntimeEvent;
+    const target = {
+      timeStart: 10,
+      timeEnd: 20,
+      duration: 10,
+      timeStrategy: TimeStrategy.LockDuration,
+    } as OntimeEvent;
+
+    const timePatch = getLinkedTimes(target, source);
+    expect(timePatch).toStrictEqual({
+      timeStart: 15,
+      timeEnd: 25,
+      duration: 10,
+    });
+  });
+
+  it('prevents overflow', () => {
+    const source = {
+      timeStart: 5,
+      timeEnd: dayInMs - 5,
+      duration: 10,
+    } as OntimeEvent;
+    const target = {
+      timeStart: 0,
+      timeEnd: 20,
+      duration: 10,
+      timeStrategy: TimeStrategy.LockDuration,
+    } as OntimeEvent;
+
+    const timePatch = getLinkedTimes(target, source);
+    expect(timePatch).toStrictEqual({
+      timeStart: dayInMs - 5,
+      timeEnd: 5,
+      duration: 10,
+    });
+  });
+});

packages/utils/src/validate-times/validateTimes.ts

@@ -0,0 +1,130 @@
+import type { OntimeEvent } from 'ontime-types';
+import { TimeStrategy } from 'ontime-types';
+
+import { dayInMs } from '../timeConstants.js';
+import { validateTimeStrategy } from '../validate-events/validateEvent.js';
+
+export function getLinkedTimes(
+  target: OntimeEvent,
+  source: OntimeEvent,
+): { timeStart: number; duration: number; timeEnd: number } {
+  const lockEnd = target.timeStrategy === TimeStrategy.LockEnd;
+  const lockDuration = target.timeStrategy === TimeStrategy.LockDuration;
+  const newStart = source.timeEnd;
+
+  const timePatch = {
+    timeStart: newStart,
+    timeEnd: lockEnd ? target.timeEnd : calculateEnd(newStart, target.duration),
+    duration: lockDuration ? target.duration : calculateDuration(newStart, target.timeEnd),
+  };
+
+  return timePatch;
+}
+
+function inferTimes(
+  _start?: unknown,
+  _end?: unknown,
+  _duration?: unknown,
+): { timeStart: number; duration: number; timeEnd: number; timeStrategy: TimeStrategy } {
+  const timeStart = convertToInteger(_start);
+  const timeEnd = convertToInteger(_end);
+  const duration = convertToInteger(_duration);
+
+  // TODO: prevent overflow
+
+  if (_start != null && _end != null) {
+    // Case 1. if we have start and end, duration must be derived
+    return {
+      timeStart,
+      duration: calculateDuration(timeStart, timeEnd),
+      timeEnd,
+      timeStrategy: _duration != null ? TimeStrategy.LockDuration : TimeStrategy.LockEnd,
+    };
+  }
+
+  if (_start == null && _end == null) {
+    if (_duration == null) {
+      // Case 2. no valid times were given
+      return { timeStart: 0, duration: 0, timeEnd: 0, timeStrategy: TimeStrategy.LockDuration };
+    }
+    // Case 3. we have a duration and infer the rest
+    return { timeStart, duration, timeEnd: duration, timeStrategy: TimeStrategy.LockDuration };
+  }
+
+  if (_start != null) {
+    // Case 5. with only start, we can calculate the rest
+    return { timeStart, duration, timeEnd: (timeStart + duration) % dayInMs, timeStrategy: TimeStrategy.LockDuration };
+  }
+
+  if (_end != null) {
+    // Case 6. with only end, we can calculate the rest
+    return {
+      timeStart: timeEnd - duration,
+      duration,
+      timeEnd,
+      timeStrategy: _duration != null ? TimeStrategy.LockDuration : TimeStrategy.LockEnd,
+    };
+  }
+
+  // we should have covered all cases
+  return { timeStart, duration, timeEnd, timeStrategy: TimeStrategy.LockDuration };
+}
+
+/**
+ * Ensures the time input variables are valid in relationship to each other
+ * Infers values if necessary
+ * @param _start
+ * @param _end
+ * @param _duration
+ */
+export function validateTimes(
+  _start?: unknown,
+  _end?: unknown,
+  _duration?: unknown,
+  _strategy?: TimeStrategy,
+): { timeStart: number; duration: number; timeEnd: number; timeStrategy: TimeStrategy } {
+  if (_strategy == null) {
+    // if no strategy is given we infer it from given parameters
+    return inferTimes(_start, _end, _duration);
+  }
+
+  const timeStrategy = validateTimeStrategy(_strategy);
+  const timeStart = convertToInteger(_start);
+  let timeEnd = convertToInteger(_end);
+  let duration = convertToInteger(_duration);
+
+  if (timeStrategy === TimeStrategy.LockEnd) {
+    duration = calculateDuration(timeStart, timeEnd);
+  } else {
+    timeEnd = calculateEnd(timeStart, duration);
+  }
+  return { timeStart, duration, timeEnd, timeStrategy };
+}
+
+/**
+ * @description calculates event duration considering midnight
+ * @param {number} timeStart
+ * @param {number} timeEnd
+ * @returns {number}
+ */
+export function calculateDuration(timeStart: number, timeEnd: number): number {
+  // Durations must be positive
+  if (timeEnd < timeStart) {
+    return timeEnd + dayInMs - timeStart;
+  }
+  return timeEnd - timeStart;
+}
+
+export function calculateEnd(timeStart: number, duration: number): number {
+  return (timeStart + duration) % dayInMs;
+}
+
+/**
+ * Converts a given value to an int, returns 0 otherwise
+ * @param value
+ * number
+ */
+function convertToInteger(value: unknown): number {
+  const result = Number(value);
+  return isNaN(result) ? 0 : Math.floor(result);
+}