refactor: WS (#1622)

* refactor: WS

* refactor refetch

extract refetch keys to package/types

auto invalidata all keys

use refetch keys for project data

no need for constant update of info, just fetch when looking at it

split refetch and query keys

rename types

* refactor viewSettings

* fixup! refactor: WS

* rearange files and make types for api calls

* cleanup viewsettings

* switch exhaustiveCheck

* combine send socket function

* exhaustive check

* rename type to tag

* fixup! fixup! refactor: WS

* remove custom etag solution

* get errors from socket

* lint

* small change

---------

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

apps/server/src/api-data/automation/automation.service.ts

@@ -115,8 +115,10 @@ export function testConditions(
         return typeof fieldValue === 'string' && fieldValue.includes(value);
       case 'not_contains':
         return typeof fieldValue === 'string' && !fieldValue.includes(value);
-      default:
+      default: {
+        operator satisfies never;
         return false;
+      }
     }
   }
 }

apps/server/src/api-data/automation/clients/ontime.client.ts

@@ -5,7 +5,8 @@ import { auxTimerService } from '../../../services/aux-timer-service/AuxTimerSer
 import * as messageService from '../../../services/message-service/MessageService.js';
 
 export function toOntimeAction(action: OntimeAction) {
-  switch (action.action) {
+  const actionType = action.action;
+  switch (actionType) {
     // Aux timer actions
     case 'aux-start':
       auxTimerService.start();
@@ -40,9 +41,10 @@ export function toOntimeAction(action: OntimeAction) {
       break;
     }
 
-    default:
-      // @ts-expect-error -- this guard checks that we handled all the cases, but we still want to log just in case
-      logger.warning(LogOrigin.Tx, `Unknown action type: ${action.type}`);
+    default: {
+      actionType satisfies never;
+      logger.warning(LogOrigin.Tx, `Unknown action type: ${actionType}`);
       break;
+    }
   }
 }

apps/server/src/api-data/report/report.service.ts

@@ -1,7 +1,7 @@
-import { OntimeReport, OntimeEventReport, TimerLifeCycle } from 'ontime-types';
+import { OntimeReport, OntimeEventReport, TimerLifeCycle, RefetchKey } from 'ontime-types';
 import { RuntimeState } from '../../stores/runtimeState.js';
-import { RefetchTargets, sendRefetch } from '../../adapters/websocketAux.js';
 import { DeepReadonly } from 'ts-essentials';
+import { sendRefetch } from '../../adapters/WebsocketAdapter.js';
 
 const report = new Map<string, OntimeEventReport>();
 
@@ -57,8 +57,6 @@ export function triggerReportEntry(
     const startedAt = report.get(eventId)?.startedAt ?? null;
     report.set(eventId, { startedAt, endedAt: state.clock });
     formattedReport = null;
-    sendRefetch({
-      target: RefetchTargets.Report,
-    });
+    sendRefetch(RefetchKey.Report);
   }
 }

apps/server/src/api-data/rundown/rundown.service.ts

@@ -10,17 +10,18 @@ import {
   OntimeEntry,
   OntimeEvent,
   PatchWithId,
+  RefetchKey,
   Rundown,
 } from 'ontime-types';
 import { customFieldLabelToKey } from 'ontime-utils';
 
 import { updateRundownData } from '../../stores/runtimeState.js';
-import { sendRefetch } from '../../adapters/websocketAux.js';
 import { runtimeService } from '../../services/runtime-service/RuntimeService.js';
 
 import { createTransaction, customFieldMutation, rundownCache, rundownMutation } from './rundown.dao.js';
 import type { RundownMetadata } from './rundown.types.js';
 import { generateEvent, getInsertAfterId, hasChanges } from './rundown.utils.js';
+import { sendRefetch } from '../../adapters/WebsocketAdapter.js';
 
 /**
  * creates a new entry with given data
@@ -553,13 +554,10 @@ export function notifyChanges(rundownMetadata: RundownMetadata, revision: number
   }
 
   // notify external services of changes
-  if (options.external) {
-    const payload = {
-      target: 'RUNDOWN',
-      reload: options.reload,
-      revision,
-    };
-    sendRefetch(payload);
+  if (options.reload) {
+    sendRefetch(RefetchKey.All);
+  } else if (options.external) {
+    sendRefetch(RefetchKey.Rundown, revision);
   }
 }
 

apps/server/src/api-data/view-settings/viewSettings.controller.ts

@@ -1,29 +0,0 @@
-import type { ErrorResponse, ViewSettings } from 'ontime-types';
-import { getErrorMessage } from 'ontime-utils';
-
-import type { Request, Response } from 'express';
-
-import { getDataProvider } from '../../classes/data-provider/DataProvider.js';
-
-export async function getViewSettings(_req: Request, res: Response<ViewSettings>) {
-  const views = getDataProvider().getViewSettings();
-  res.status(200).send(views);
-}
-
-export async function postViewSettings(req: Request, res: Response<ViewSettings | ErrorResponse>) {
-  try {
-    const newData = {
-      dangerColor: req.body.dangerColor,
-      endMessage: req.body.endMessage,
-      freezeEnd: req.body.freezeEnd,
-      normalColor: req.body.normalColor,
-      overrideStyles: req.body.overrideStyles,
-      warningColor: req.body.warningColor,
-    } as ViewSettings;
-    await getDataProvider().setViewSettings(newData);
-    res.status(200).send(newData);
-  } catch (error) {
-    const message = getErrorMessage(error);
-    res.status(400).send({ message });
-  }
-}

apps/server/src/api-data/view-settings/viewSettings.router.ts

@@ -1,9 +1,36 @@
 import express from 'express';
+import type { Request, Response } from 'express';
+import { RefetchKey, type ErrorResponse, type ViewSettings } from 'ontime-types';
+import { getErrorMessage } from 'ontime-utils';
 
 import { validateViewSettings } from './viewSettings.validation.js';
-import { getViewSettings, postViewSettings } from './viewSettings.controller.js';
+import { getDataProvider } from '../../classes/data-provider/DataProvider.js';
+import { sendRefetch } from '../../adapters/WebsocketAdapter.js';
 
 export const router = express.Router();
 
-router.get('/', getViewSettings);
-router.post('/', validateViewSettings, postViewSettings);
+router.get('/', (_req: Request, res: Response<ViewSettings>) => {
+  const views = getDataProvider().getViewSettings();
+  res.status(200).send(views);
+});
+
+router.post('/', validateViewSettings, async (req: Request, res: Response<ViewSettings | ErrorResponse>) => {
+  try {
+    const newData = {
+      dangerColor: req.body.dangerColor,
+      endMessage: req.body.endMessage,
+      freezeEnd: req.body.freezeEnd,
+      normalColor: req.body.normalColor,
+      overrideStyles: req.body.overrideStyles,
+      warningColor: req.body.warningColor,
+    } as ViewSettings;
+    await getDataProvider().setViewSettings(newData);
+    res.status(200).send(newData);
+    setImmediate(() => {
+      sendRefetch(RefetchKey.ViewSettings);
+    });
+  } catch (error) {
+    const message = getErrorMessage(error);
+    res.status(400).send({ message });
+  }
+});