From cf14b0b42777aebc1b45b7b59e084454827c02cf Mon Sep 17 00:00:00 2001 From: Carlos Valente <34649812+cpvalente@users.noreply.github.com> Date: Wed, 17 Apr 2024 21:31:10 +0200 Subject: [PATCH] refactor: consolidate language of AuxTimer (#896) --- apps/client/src/common/hooks/useSocket.ts | 6 +++--- .../control/playback/PlaybackControl.tsx | 4 ++-- .../AuxTimer.module.scss} | 0 .../ExtraTimer.tsx => aux-timer/AuxTimer.tsx} | 18 +++++++++--------- .../api-integration/integration.controller.ts | 12 ++++++------ .../AuxTimerService.ts} | 4 ++-- .../{ExtraTimer.type.ts => AuxTimer.type.ts} | 0 .../definitions/runtime/RuntimeStore.type.ts | 2 +- packages/types/src/index.ts | 2 +- 9 files changed, 24 insertions(+), 24 deletions(-) rename apps/client/src/features/control/playback/{extra-timer/ExtraTimer.module.scss => aux-timer/AuxTimer.module.scss} (100%) rename apps/client/src/features/control/playback/{extra-timer/ExtraTimer.tsx => aux-timer/AuxTimer.tsx} (83%) rename apps/server/src/services/{extra-timer-service/ExtraTimerService.ts => aux-timer-service/AuxTimerService.ts} (94%) rename packages/types/src/definitions/runtime/{ExtraTimer.type.ts => AuxTimer.type.ts} (100%) diff --git a/apps/client/src/common/hooks/useSocket.ts b/apps/client/src/common/hooks/useSocket.ts index b98d8c36d..2f41b3804 100644 --- a/apps/client/src/common/hooks/useSocket.ts +++ b/apps/client/src/common/hooks/useSocket.ts @@ -86,13 +86,13 @@ export const useInfoPanel = () => { return useRuntimeStore(featureSelector); }; -export const useExtraTimerTime = () => { +export const useAuxTimerTime = () => { const featureSelector = (state: RuntimeStore) => state.auxtimer1.current; return useRuntimeStore(featureSelector); }; -export const useExtraTimerControl = () => { +export const useAuxTimerControl = () => { const featureSelector = (state: RuntimeStore) => ({ playback: state.auxtimer1.playback, direction: state.auxtimer1.direction, @@ -101,7 +101,7 @@ export const useExtraTimerControl = () => { return useRuntimeStore(featureSelector); }; -export const setExtraTimer = { +export const setAuxTimer = { start: () => socketSendJson('auxtimer', { '1': SimplePlayback.Start }), pause: () => socketSendJson('auxtimer', { '1': SimplePlayback.Pause }), stop: () => socketSendJson('auxtimer', { '1': SimplePlayback.Stop }), diff --git a/apps/client/src/features/control/playback/PlaybackControl.tsx b/apps/client/src/features/control/playback/PlaybackControl.tsx index b45fa1e7b..c55acf922 100644 --- a/apps/client/src/features/control/playback/PlaybackControl.tsx +++ b/apps/client/src/features/control/playback/PlaybackControl.tsx @@ -3,7 +3,7 @@ import { Playback } from 'ontime-types'; import { usePlaybackControl } from '../../../common/hooks/useSocket'; import AddTime from './add-time/AddTime'; -import { ExtraTimer } from './extra-timer/ExtraTimer'; +import { AuxTimer } from './aux-timer/AuxTimer'; import PlaybackButtons from './playback-buttons/PlaybackButtons'; import PlaybackTimer from './playback-timer/PlaybackTimer'; @@ -22,7 +22,7 @@ export default function PlaybackControl() { numEvents={data.numEvents} selectedEventIndex={data.selectedEventIndex} /> - + ); } diff --git a/apps/client/src/features/control/playback/extra-timer/ExtraTimer.module.scss b/apps/client/src/features/control/playback/aux-timer/AuxTimer.module.scss similarity index 100% rename from apps/client/src/features/control/playback/extra-timer/ExtraTimer.module.scss rename to apps/client/src/features/control/playback/aux-timer/AuxTimer.module.scss diff --git a/apps/client/src/features/control/playback/extra-timer/ExtraTimer.tsx b/apps/client/src/features/control/playback/aux-timer/AuxTimer.tsx similarity index 83% rename from apps/client/src/features/control/playback/extra-timer/ExtraTimer.tsx rename to apps/client/src/features/control/playback/aux-timer/AuxTimer.tsx index c791a2b3c..9e5573d85 100644 --- a/apps/client/src/features/control/playback/extra-timer/ExtraTimer.tsx +++ b/apps/client/src/features/control/playback/aux-timer/AuxTimer.tsx @@ -6,16 +6,16 @@ import { IoStop } from '@react-icons/all-files/io5/IoStop'; import { Playback, SimpleDirection, SimplePlayback } from 'ontime-types'; import TimeInput from '../../../../common/components/input/time-input/TimeInput'; -import { setExtraTimer, useExtraTimerControl, useExtraTimerTime } from '../../../../common/hooks/useSocket'; +import { setAuxTimer, useAuxTimerControl, useAuxTimerTime } from '../../../../common/hooks/useSocket'; import { forgivingStringToMillis } from '../../../../common/utils/dateConfig'; import TapButton from '../tap-button/TapButton'; -import style from './ExtraTimer.module.scss'; +import style from './AuxTimer.module.scss'; -export function ExtraTimer() { - const { playback, direction } = useExtraTimerControl(); +export function AuxTimer() { + const { playback, direction } = useAuxTimerControl(); - const { start, pause, stop, setDirection } = setExtraTimer; + const { start, pause, stop, setDirection } = setAuxTimer; const toggleDirection = () => { const newDirection = direction === SimpleDirection.CountDown ? SimpleDirection.CountUp : SimpleDirection.CountDown; @@ -30,7 +30,7 @@ export function ExtraTimer() { return (
- + {direction === SimpleDirection.CountDown && } {direction === SimpleDirection.CountUp && } @@ -59,9 +59,9 @@ export function ExtraTimer() { ); } -function ExtraTimeInput() { - const time = useExtraTimerTime(); - const { setDuration } = setExtraTimer; +function AuxTimerInput() { + const time = useAuxTimerTime(); + const { setDuration } = setAuxTimer; const handleTimeUpdate = (_field: string, value: string) => { const newTime = forgivingStringToMillis(value); diff --git a/apps/server/src/api-integration/integration.controller.ts b/apps/server/src/api-integration/integration.controller.ts index b8cba7b3a..2ec06f05c 100644 --- a/apps/server/src/api-integration/integration.controller.ts +++ b/apps/server/src/api-integration/integration.controller.ts @@ -1,7 +1,7 @@ import { DeepPartial, MessageState, OntimeEvent, SimpleDirection, SimplePlayback } from 'ontime-types'; import { ONTIME_VERSION } from '../ONTIME_VERSION.js'; -import { extraTimerService } from '../services/extra-timer-service/ExtraTimerService.js'; +import { auxTimerService } from '../services/aux-timer-service/AuxTimerService.js'; import { messageService } from '../services/message-service/MessageService.js'; import { validateMessage, validateTimerMessage } from '../services/message-service/messageUtils.js'; import { runtimeService } from '../services/runtime-service/RuntimeService.js'; @@ -190,26 +190,26 @@ const actionHandlers: Record = { const command = payload['1']; if (typeof command === 'string') { if (command === SimplePlayback.Start) { - const reply = extraTimerService.start(); + const reply = auxTimerService.start(); return { payload: reply }; } if (command === SimplePlayback.Pause) { - const reply = extraTimerService.pause(); + const reply = auxTimerService.pause(); return { payload: reply }; } if (command === SimplePlayback.Stop) { - const reply = extraTimerService.stop(); + const reply = auxTimerService.stop(); return { payload: reply }; } } else if (command && typeof command === 'object') { const reply = { payload: {} }; if ('duration' in command) { const time = numberOrError(command.duration); - reply.payload = extraTimerService.setTime(time * 1000); //frontend is seconds based + reply.payload = auxTimerService.setTime(time * 1000); //frontend is seconds based } if ('direction' in command) { if (command.direction === SimpleDirection.CountUp || command.direction === SimpleDirection.CountDown) { - reply.payload = extraTimerService.setDirection(command.direction); + reply.payload = auxTimerService.setDirection(command.direction); } else { throw new Error('Invalid direction payload'); } diff --git a/apps/server/src/services/extra-timer-service/ExtraTimerService.ts b/apps/server/src/services/aux-timer-service/AuxTimerService.ts similarity index 94% rename from apps/server/src/services/extra-timer-service/ExtraTimerService.ts rename to apps/server/src/services/aux-timer-service/AuxTimerService.ts index 81e883509..e348d583b 100644 --- a/apps/server/src/services/extra-timer-service/ExtraTimerService.ts +++ b/apps/server/src/services/aux-timer-service/AuxTimerService.ts @@ -6,7 +6,7 @@ import { eventStore } from '../../stores/EventStore.js'; export type EmitFn = (state: SimpleTimerState) => void; export type GetTimeFn = () => number; -export class ExtraTimerService { +export class AuxTimerService { private timer: SimpleTimer; private interval: NodeJS.Timer | null = null; private emit: EmitFn; @@ -76,4 +76,4 @@ function broadcastReturn(_target: any, _propertyKey: string, descriptor: Propert const emit = (state: SimpleTimerState) => eventStore.set('auxtimer1', state); const timeNow = () => Date.now(); -export const extraTimerService = new ExtraTimerService(emit, timeNow); +export const auxTimerService = new AuxTimerService(emit, timeNow); diff --git a/packages/types/src/definitions/runtime/ExtraTimer.type.ts b/packages/types/src/definitions/runtime/AuxTimer.type.ts similarity index 100% rename from packages/types/src/definitions/runtime/ExtraTimer.type.ts rename to packages/types/src/definitions/runtime/AuxTimer.type.ts diff --git a/packages/types/src/definitions/runtime/RuntimeStore.type.ts b/packages/types/src/definitions/runtime/RuntimeStore.type.ts index 78bbc1b6b..0829dbf38 100644 --- a/packages/types/src/definitions/runtime/RuntimeStore.type.ts +++ b/packages/types/src/definitions/runtime/RuntimeStore.type.ts @@ -1,5 +1,5 @@ import type { OntimeEvent } from '../core/OntimeEvent.type.js'; -import type { SimpleTimerState } from './ExtraTimer.type.js'; +import type { SimpleTimerState } from './AuxTimer.type.js'; import type { MessageState } from './MessageControl.type.js'; import type { Runtime } from './Runtime.type.js'; import type { TimerState } from './TimerState.type.js'; diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts index 51431ee2d..8267a27c7 100644 --- a/packages/types/src/index.ts +++ b/packages/types/src/index.ts @@ -63,7 +63,7 @@ export type { RuntimeStore } from './definitions/runtime/RuntimeStore.type.js'; export type { TimerState } from './definitions/runtime/TimerState.type.js'; // ---> Extra Timer -export { type SimpleTimerState, SimplePlayback, SimpleDirection } from './definitions/runtime/ExtraTimer.type.js'; +export { type SimpleTimerState, SimplePlayback, SimpleDirection } from './definitions/runtime/AuxTimer.type.js'; // CLIENT