mirror of
https://github.com/cpvalente/ontime.git
synced 2026-08-15 20:33:47 +00:00
feat: event cue (#473)
* feat: parse cue * refactor: get delay from backend * feat: add cue to UI * refactor: remove deprecated delay logic * refactor: extract studio clock specific logic * refactor: extract utilities * refactor: fix issue with missing key * style: prevent cue overflow * style: prevent whitespace wrap * feat: add support for cues in integrations
This commit is contained in:
Carlos Valente
GitHub
@@ -0,0 +1,160 @@
|
||||
import { OntimeRundown, SupportedEvent } from 'ontime-types';
|
||||
|
||||
import { getCueCandidate, getIncrement, sanitiseCue } from './cueUtils.js';
|
||||
|
||||
describe('getIncrement()', () => {
|
||||
it('increments number', () => {
|
||||
expect(getIncrement('1')).toBe('2');
|
||||
expect(getIncrement('10')).toBe('11');
|
||||
expect(getIncrement('99')).toBe('100');
|
||||
expect(getIncrement('101')).toBe('102');
|
||||
});
|
||||
it('increments decimal number', () => {
|
||||
expect(getIncrement('1.1')).toBe('1.2');
|
||||
expect(getIncrement('10.10')).toBe('10.11');
|
||||
expect(getIncrement('99.99')).toBe('99.100');
|
||||
expect(getIncrement('101.101')).toBe('101.102');
|
||||
// NOTE: we know the below would fail, handling this amount of decimals is outside of scope
|
||||
// expect(getIncrement('101.999')).toBe('101.1000');
|
||||
});
|
||||
// NOTE: we also know the following fails since we only handle one decimal
|
||||
//it('handles multiple decimals', () => {
|
||||
// expect(getIncrement('2.1.1')).toBe('2.1.2');
|
||||
//});
|
||||
it('finds last digit in string', () => {
|
||||
expect(getIncrement('Presenter1')).toBe('Presenter2');
|
||||
expect(getIncrement('Presenter10')).toBe('Presenter11');
|
||||
expect(getIncrement('Presenter99')).toBe('Presenter100');
|
||||
expect(getIncrement('Presenter101')).toBe('Presenter102');
|
||||
});
|
||||
it('adds a 2 if none is found', () => {
|
||||
expect(getIncrement('Presenter')).toBe('Presenter2');
|
||||
});
|
||||
});
|
||||
|
||||
describe('findCueName()', () => {
|
||||
describe('in the beginning of the rundown', () => {
|
||||
it('names cue as 1 if next event does not collide', () => {
|
||||
const testRundown = [
|
||||
{ id: '1', cue: '10', type: SupportedEvent.Event },
|
||||
{ id: '2', cue: '11', type: SupportedEvent.Event },
|
||||
] as OntimeRundown;
|
||||
const cue = getCueCandidate(testRundown);
|
||||
expect(cue).toBe('1');
|
||||
});
|
||||
it('creates decimal stem if next cue is 1', () => {
|
||||
const testRundown = [
|
||||
{ id: '1', cue: '1', type: SupportedEvent.Event },
|
||||
{ id: '2', cue: '10', type: SupportedEvent.Event },
|
||||
] as OntimeRundown;
|
||||
const cue = getCueCandidate(testRundown);
|
||||
expect(cue).toBe('0.1');
|
||||
});
|
||||
});
|
||||
describe('in the middle of the rundown', () => {
|
||||
it('names cue as an increment if next event has different stem (case of numbers)', () => {
|
||||
const testRundown = [
|
||||
{ id: '1', cue: '1', type: SupportedEvent.Event },
|
||||
{ id: '2', cue: '10', type: SupportedEvent.Event },
|
||||
] as OntimeRundown;
|
||||
const cue = getCueCandidate(testRundown, '1');
|
||||
expect(cue).toBe('2');
|
||||
});
|
||||
it('names cue as an increment if next event has different stem (case of letters)', () => {
|
||||
const testRundown = [
|
||||
{ id: '1', cue: 'Presenter', type: SupportedEvent.Event },
|
||||
{
|
||||
id: '2',
|
||||
cue: 'Interval',
|
||||
type: SupportedEvent.Event,
|
||||
},
|
||||
] as OntimeRundown;
|
||||
const cue = getCueCandidate(testRundown, '1');
|
||||
expect(cue).toBe('Presenter2');
|
||||
});
|
||||
it('creates decimal stem if next cue has same stem (case of numbers)', () => {
|
||||
const testRundown = [
|
||||
{ id: '1', cue: '1', type: SupportedEvent.Event },
|
||||
{ id: '2', cue: '2', type: SupportedEvent.Event },
|
||||
] as OntimeRundown;
|
||||
const cue = getCueCandidate(testRundown, '1');
|
||||
expect(cue).toBe('1.1');
|
||||
});
|
||||
it('creates decimal stem if next cue has same stem (case of letters)', () => {
|
||||
const testRundown = [
|
||||
{ id: '1', cue: 'Presenter1', type: SupportedEvent.Event },
|
||||
{ id: '2', cue: 'Presenter2', type: SupportedEvent.Event },
|
||||
] as OntimeRundown;
|
||||
const cue = getCueCandidate(testRundown, '1');
|
||||
expect(cue).toBe('Presenter1.1');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('findCueName() with mixed events', () => {
|
||||
describe('in the beginning of the rundown', () => {
|
||||
it('names cue as 1 if next event does not collide', () => {
|
||||
const testRundown = [
|
||||
{ id: '1', cue: '10', type: SupportedEvent.Event },
|
||||
{ id: '2', cue: '11', type: SupportedEvent.Event },
|
||||
] as OntimeRundown;
|
||||
const cue = getCueCandidate(testRundown);
|
||||
expect(cue).toBe('1');
|
||||
});
|
||||
it('creates decimal stem if next cue is 1', () => {
|
||||
const testRundown = [
|
||||
{ id: '1', cue: '1', type: SupportedEvent.Event },
|
||||
{ id: '2', cue: '10', type: SupportedEvent.Event },
|
||||
] as OntimeRundown;
|
||||
const cue = getCueCandidate(testRundown);
|
||||
expect(cue).toBe('0.1');
|
||||
});
|
||||
});
|
||||
describe('in the middle of the rundown', () => {
|
||||
it('names cue as an increment if next event has different stem (case of numbers)', () => {
|
||||
const testRundown = [
|
||||
{ id: '1', cue: '1', type: SupportedEvent.Event },
|
||||
{ id: '2', cue: '10', type: SupportedEvent.Event },
|
||||
] as OntimeRundown;
|
||||
const cue = getCueCandidate(testRundown, '1');
|
||||
expect(cue).toBe('2');
|
||||
});
|
||||
it('names cue as an increment if next event has different stem (case of letters)', () => {
|
||||
const testRundown = [
|
||||
{ id: '1', cue: 'Presenter', type: SupportedEvent.Event },
|
||||
{ id: '2', cue: 'Interval', type: SupportedEvent.Event },
|
||||
] as OntimeRundown;
|
||||
const cue = getCueCandidate(testRundown, '1');
|
||||
expect(cue).toBe('Presenter2');
|
||||
});
|
||||
it('creates decimal stem if next cue has same stem (case of numbers)', () => {
|
||||
const testRundown = [
|
||||
{ id: '1', cue: '1', type: SupportedEvent.Event },
|
||||
{ id: '2', cue: '2', type: SupportedEvent.Event },
|
||||
] as OntimeRundown;
|
||||
const cue = getCueCandidate(testRundown, '1');
|
||||
expect(cue).toBe('1.1');
|
||||
});
|
||||
it('creates decimal stem if next cue has same stem (case of letters)', () => {
|
||||
const testRundown = [
|
||||
{ id: '1', cue: 'Presenter1', type: SupportedEvent.Event },
|
||||
{ id: '2', cue: 'Presenter2', type: SupportedEvent.Event },
|
||||
] as OntimeRundown;
|
||||
const cue = getCueCandidate(testRundown, '1');
|
||||
expect(cue).toBe('Presenter1.1');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('sanitiseCue()', () => {
|
||||
it('removes spaces', () => {
|
||||
expect(sanitiseCue(' test')).toBe('test');
|
||||
expect(sanitiseCue(' test ')).toBe('test');
|
||||
expect(sanitiseCue('test')).toBe('test');
|
||||
expect(sanitiseCue('t e s t ')).toBe('test');
|
||||
});
|
||||
it('enforces . as decimals', () => {
|
||||
expect(sanitiseCue('1,2')).toBe('1.2');
|
||||
expect(sanitiseCue('1,2,3')).toBe('1.2.3');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,80 @@
|
||||
import { OntimeEvent, OntimeRundown } from 'ontime-types';
|
||||
|
||||
import { getFirstEvent, getNextEvent } from '../rundown-utils/rundownUtils.js';
|
||||
import { isNumeric } from '../types/types.js';
|
||||
|
||||
/**
|
||||
* Finds if last characters in input are a number and increments
|
||||
* @param input {string}
|
||||
*/
|
||||
export function getIncrement(input: string): string {
|
||||
// Check if the input string contains a number at the end
|
||||
const match = input.match(/^(\D*)(\d+)(\.\d+)?$/);
|
||||
|
||||
if (match) {
|
||||
// If a number is found, extract the non-numeric prefix, integer part, and decimal part
|
||||
let [, prefix, integerPart, decimalPart] = match;
|
||||
|
||||
if (decimalPart) {
|
||||
if (decimalPart === '.99') {
|
||||
decimalPart = '.100';
|
||||
} else {
|
||||
const addDecimal = '0'.repeat(decimalPart.length - 2) + '1';
|
||||
const incrementedDecimal = (Number(decimalPart) + Number('0.' + addDecimal)).toFixed(decimalPart.length - 1);
|
||||
decimalPart = incrementedDecimal.toString().replace('0.', '.');
|
||||
}
|
||||
return `${prefix}${integerPart}${decimalPart}`;
|
||||
}
|
||||
const incrementedInteger = Number(integerPart) + 1;
|
||||
integerPart = incrementedInteger.toString();
|
||||
return `${prefix}${integerPart}`;
|
||||
}
|
||||
// If no number is found, append "2" to the string and return the updated string
|
||||
return input + '2';
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets suitable name for a new event cue
|
||||
* @param rundown {OntimeRundown}
|
||||
* @param insertAfterId {string}
|
||||
*/
|
||||
export function getCueCandidate(rundown: OntimeRundown, insertAfterId?: string): string {
|
||||
function addAtTop() {
|
||||
const firstEventCue = getFirstEvent(rundown)?.cue;
|
||||
|
||||
if (isNumeric(firstEventCue)) {
|
||||
return (Number(firstEventCue) / 10).toString();
|
||||
}
|
||||
return '1';
|
||||
}
|
||||
|
||||
// we did not provide a element to go after, we attempt to go first so only need to check for a cue with value 1
|
||||
if (typeof insertAfterId === 'undefined' || rundown.length === 0) {
|
||||
return addAtTop();
|
||||
}
|
||||
|
||||
const afterIndex = rundown.findIndex((event) => event.id === insertAfterId);
|
||||
|
||||
// we did not find the previous element, insert at top
|
||||
if (afterIndex === -1) {
|
||||
return addAtTop();
|
||||
}
|
||||
|
||||
// get elements around
|
||||
const previousEvent = rundown.at(afterIndex);
|
||||
const nextEvent = getNextEvent(rundown, insertAfterId);
|
||||
|
||||
// try and increment the cue
|
||||
let cue = getIncrement((previousEvent as OntimeEvent).cue);
|
||||
|
||||
// if increment is clashing with next, we add a decimal instead
|
||||
if (cue === nextEvent?.cue) {
|
||||
cue = (previousEvent as OntimeEvent).cue + '.1';
|
||||
}
|
||||
|
||||
return cue;
|
||||
}
|
||||
|
||||
export function sanitiseCue(cue: string) {
|
||||
return cue.replaceAll(' ', '').replaceAll(',', '.');
|
||||
}
|
||||
Reference in New Issue
Block a user