cpvalente/ontime
1
0
Fork 0
mirror of https://github.com/cpvalente/ontime.git synced 2026-08-18 05:34:09 +00:00
Code Issues Packages Projects Releases 10 Wiki Activity

feat: count to end (#500)

Browse Source
This commit is contained in:
Carlos Valente
2023-08-27 19:25:40 +02:00
committed by GitHub
parent cd9dbcdc68
commit 5323e627fb
7 changed files with 259 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/server/src/services/__tests__/timerUtils.test.ts
+207 -18
View File
@@ -1,4 +1,5 @@
import { dayInMs } from 'ontime-utils';
import { TimerType } from 'ontime-types';
import { getCurrent, getExpectedFinish } from '../timerUtils.js';
@@ -9,7 +10,17 @@ describe('getExpectedFinish()', () => {
const duration = 10;
const pausedTime = 0;
const addedTime = 0;
const calculatedFinish = getExpectedFinish(startedAt, finishedAt, duration, pausedTime, addedTime);
const endTime = 10;
const timerType = TimerType.CountDown;
const calculatedFinish = getExpectedFinish(
startedAt,
finishedAt,
duration,
pausedTime,
addedTime,
endTime,
timerType,
);
expect(calculatedFinish).toBe(null);
});
it('is finishedAt if defined', () => {
@@ -18,7 +29,17 @@ describe('getExpectedFinish()', () => {
const duration = 10;
const pausedTime = 0;
const addedTime = 0;
const calculatedFinish = getExpectedFinish(startedAt, finishedAt, duration, pausedTime, addedTime);
const endTime = 20;
const timerType = TimerType.CountDown;
const calculatedFinish = getExpectedFinish(
startedAt,
finishedAt,
duration,
pausedTime,
addedTime,
endTime,
timerType,
);
expect(calculatedFinish).toBe(finishedAt);
});
it('calculates the finish time', () => {
@@ -27,7 +48,17 @@ describe('getExpectedFinish()', () => {
const duration = 10;
const pausedTime = 0;
const addedTime = 0;
const calculatedFinish = getExpectedFinish(startedAt, finishedAt, duration, pausedTime, addedTime);
const endTime = 11;
const timerType = TimerType.CountDown;
const calculatedFinish = getExpectedFinish(
startedAt,
finishedAt,
duration,
pausedTime,
addedTime,
endTime,
timerType,
);
expect(calculatedFinish).toBe(11);
});
it('adds paused and added times', () => {
@@ -36,7 +67,17 @@ describe('getExpectedFinish()', () => {
const duration = 10;
const pausedTime = 10;
const addedTime = 10;
const calculatedFinish = getExpectedFinish(startedAt, finishedAt, duration, pausedTime, addedTime);
const endTime = 11;
const timerType = TimerType.CountDown;
const calculatedFinish = getExpectedFinish(
startedAt,
finishedAt,
duration,
pausedTime,
addedTime,
endTime,
timerType,
);
expect(calculatedFinish).toBe(31);
});
it('added time could be negative', () => {
@@ -45,7 +86,17 @@ describe('getExpectedFinish()', () => {
const duration = 10;
const pausedTime = 10;
const addedTime = -10;
const calculatedFinish = getExpectedFinish(startedAt, finishedAt, duration, pausedTime, addedTime);
const endTime = 11;
const timerType = TimerType.CountDown;
const calculatedFinish = getExpectedFinish(
startedAt,
finishedAt,
duration,
pausedTime,
addedTime,
endTime,
timerType,
);
expect(calculatedFinish).toBe(11);
});
it('user could add enough time for it to be negative', () => {
@@ -54,7 +105,17 @@ describe('getExpectedFinish()', () => {
const duration = 10;
const pausedTime = 0;
const addedTime = -100;
const calculatedFinish = getExpectedFinish(startedAt, finishedAt, duration, pausedTime, addedTime);
const endTime = 11;
const timerType = TimerType.CountDown;
const calculatedFinish = getExpectedFinish(
startedAt,
finishedAt,
duration,
pausedTime,
addedTime,
endTime,
timerType,
);
expect(calculatedFinish).toBe(1);
});
it('timer can have no duration', () => {
@@ -63,7 +124,17 @@ describe('getExpectedFinish()', () => {
const duration = 0;
const pausedTime = 0;
const addedTime = 0;
const calculatedFinish = getExpectedFinish(startedAt, finishedAt, duration, pausedTime, addedTime);
const endTime = 0;
const timerType = TimerType.CountDown;
const calculatedFinish = getExpectedFinish(
startedAt,
finishedAt,
duration,
pausedTime,
addedTime,
endTime,
timerType,
);
expect(calculatedFinish).toBe(1);
});
it('finish can be the day after', () => {
@@ -72,9 +143,60 @@ describe('getExpectedFinish()', () => {
const duration = dayInMs;
const pausedTime = 0;
const addedTime = 0;
const calculatedFinish = getExpectedFinish(startedAt, finishedAt, duration, pausedTime, addedTime);
const endTime = 10;
const timerType = TimerType.CountDown;
const calculatedFinish = getExpectedFinish(
startedAt,
finishedAt,
duration,
pausedTime,
addedTime,
endTime,
timerType,
);
expect(calculatedFinish).toBe(10);
});
describe('on timers of type time-to-end', () => {
it('finish time is as schedule + added time', () => {
const startedAt = 10;
const finishedAt = null;
const duration = dayInMs;
const pausedTime = 0;
const addedTime = 10;
const endTime = 30;
const timerType = TimerType.TimeToEnd;
const calculatedFinish = getExpectedFinish(
startedAt,
finishedAt,
duration,
pausedTime,
addedTime,
endTime,
timerType,
);
expect(calculatedFinish).toBe(40);
});
it('handles events that finish the day after', () => {
const startedAt = 79200000; // 22:00:00
const finishedAt = null;
const duration = Infinity; // not relevant
const pausedTime = 0;
const addedTime = 0;
const endTime = 600000; // 00:10:00
const timerType = TimerType.TimeToEnd;
const calculatedFinish = getExpectedFinish(
startedAt,
finishedAt,
duration,
pausedTime,
addedTime,
endTime,
timerType,
);
// expected finish is not a duration but a timetag
expect(calculatedFinish).toBe(600000);
});
});
});
describe('getCurrent()', () => {
@@ -84,7 +206,9 @@ describe('getCurrent()', () => {
const pausedTime = 0;
const addedTime = 0;
const clock = 0;
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock);
const endTime = 0;
const timerType = TimerType.CountDown;
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock, endTime, timerType);
expect(current).toBe(null);
});
it('is the remaining time in clock', () => {
@@ -93,7 +217,9 @@ describe('getCurrent()', () => {
const pausedTime = 0;
const addedTime = 0;
const clock = 1;
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock);
const endTime = 10;
const timerType = TimerType.CountDown;
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock, endTime, timerType);
expect(current).toBe(9);
});
it('accounts for added times', () => {
@@ -102,7 +228,9 @@ describe('getCurrent()', () => {
const pausedTime = 5;
const addedTime = 5;
const clock = 1;
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock);
const endTime = 10;
const timerType = TimerType.CountDown;
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock, endTime, timerType);
expect(current).toBe(19);
});
it('counts over midnight', () => {
@@ -111,7 +239,9 @@ describe('getCurrent()', () => {
const pausedTime = 0;
const addedTime = 0;
const clock = 10;
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock);
const endTime = 20;
const timerType = TimerType.CountDown;
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock, endTime, timerType);
expect(current).toBe(dayInMs + 10);
});
it('rolls over midnight', () => {
@@ -120,7 +250,9 @@ describe('getCurrent()', () => {
const pausedTime = 0;
const addedTime = 0;
const clock = 5;
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock);
const endTime = 20;
const timerType = TimerType.CountDown;
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock, endTime, timerType);
expect(current).toBe(15);
});
it('midnight holds delays', () => {
@@ -129,9 +261,46 @@ describe('getCurrent()', () => {
const pausedTime = 10;
const addedTime = 10;
const clock = 5;
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock);
const endTime = 20;
const timerType = TimerType.CountDown;
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock, endTime, timerType);
expect(current).toBe(35);
});
describe('on timers of type time-to-end', () => {
it('current time is the time to end', () => {
const startedAt = 10;
const duration = 100;
const pausedTime = 0;
const addedTime = 0;
const clock = 30;
const endTime = 100;
const timerType = TimerType.TimeToEnd;
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock, endTime, timerType);
expect(current).toBe(70);
});
it('current time is the time to end + added time', () => {
const startedAt = 10;
const duration = 100;
const pausedTime = 3;
const addedTime = 4;
const clock = 30;
const endTime = 100;
const timerType = TimerType.TimeToEnd;
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock, endTime, timerType);
expect(current).toBe(77);
});
it('handles events that finish the day after', () => {
const startedAt = 79200000; // 22:00:00
const duration = Infinity; // not relevant
const pausedTime = 0;
const addedTime = 0;
const clock = 79500000; // 22:05:00
const endTime = 600000; // 00:10:00
const timerType = TimerType.TimeToEnd;
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock, endTime, timerType);
expect(current).toBe(600000 + dayInMs - clock);
});
});
});
describe('getExpectedFinish() and getCurrentTime() combined', () => {
@@ -142,8 +311,18 @@ describe('getExpectedFinish() and getCurrentTime() combined', () => {
const pausedTime = 0;
const addedTime = 0;
const clock = 0;
const expectedFinish = getExpectedFinish(startedAt, finishedAt, duration, pausedTime, addedTime);
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock);
const endTime = 10;
const timerType = TimerType.CountDown;
const expectedFinish = getExpectedFinish(
startedAt,
finishedAt,
duration,
pausedTime,
addedTime,
endTime,
timerType,
);
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock, endTime, timerType);
const elapsed = duration - current;
expect(expectedFinish).toBe(10);
expect(elapsed).toBe(0);
@@ -157,8 +336,18 @@ describe('getExpectedFinish() and getCurrentTime() combined', () => {
const pausedTime = 1;
const addedTime = 2;
const clock = 5;
const expectedFinish = getExpectedFinish(startedAt, finishedAt, duration, pausedTime, addedTime);
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock);
const endTime = 10;
const timerType = TimerType.CountDown;
const expectedFinish = getExpectedFinish(
startedAt,
finishedAt,
duration,
pausedTime,
addedTime,
endTime,
timerType,
);
const current = getCurrent(startedAt, duration, addedTime, pausedTime, clock, endTime, timerType);
const elapsed = duration - current;
expect(expectedFinish).toBe(13);
expect(elapsed).toBe(2);