refactor: migrate custom fields to transactions

refactor: extract functions to api domain

refactor: strict custom field parsing

refactor: remove rundown cache utilities

refactor: directory restructure

apps/server/src/api-data/custom-fields/__tests__/customFields.parser.test.ts

@@ -0,0 +1,128 @@
+import { CustomFields } from 'ontime-types';
+
+import { parseCustomFields, sanitiseCustomFields } from '../customFields.parser.js';
+
+describe('parseCustomFields()', () => {
+  it('returns an a base model if nothing is given', () => {
+    const errorEmitter = vi.fn();
+    const result = parseCustomFields({}, errorEmitter);
+    expect(result).toBeTypeOf('object');
+    expect(errorEmitter).toHaveBeenCalledOnce();
+  });
+
+  it('parses data, skipping invalid results', () => {
+    const errorEmitter = vi.fn();
+    // @ts-expect-error -- data is external, we check bad types
+    const customFields = {
+      1: { label: 'test', type: 'string', colour: 'red' }, // ok
+      2: { label: 'test', type: 'string' }, // duplicate label
+      3: { label: '', type: 'string' }, // missing colour
+      4: { type: 'string', colour: '' }, // missing label
+    } as CustomFields;
+
+    const result = parseCustomFields({ customFields }, errorEmitter);
+    expect(result).toMatchObject({
+      test: {
+        label: 'test',
+        type: 'string',
+        colour: 'red',
+      },
+    });
+    expect(errorEmitter).toHaveBeenCalled();
+  });
+});
+
+describe('sanitiseCustomFields()', () => {
+  it('returns an empty object the type is incorrect', () => {
+    expect(sanitiseCustomFields({})).toEqual({});
+  });
+
+  it('returns an object of valid entries', () => {
+    const customFields: CustomFields = {
+      test: { label: 'test', type: 'string', colour: 'red' },
+      test2: { label: 'test2', type: 'string', colour: 'green' },
+      Test3: { label: 'Test3', type: 'string', colour: '' },
+    };
+    const sanitationResult = sanitiseCustomFields(customFields);
+    expect(sanitationResult).toStrictEqual(customFields);
+  });
+
+  it('type should be one of (image | string)', () => {
+    const testTypes = sanitiseCustomFields({
+      test1: { label: 'test1', type: 'another', colour: 'red' },
+      test2: { label: 'test2', type: 'image', colour: 'red' },
+      test3: { label: 'test3', type: 'string', colour: 'red' },
+    });
+    expect(testTypes).toMatchObject({
+      test2: { label: 'test2', type: 'image', colour: 'red' },
+      test3: { label: 'test3', type: 'string', colour: 'red' },
+    });
+  });
+
+  it('colour must be a string', () => {
+    const customFields: CustomFields = {
+      // @ts-expect-error intentional bad data
+      test: { label: 'test', type: 'string', colour: 5 },
+    };
+    const sanitationResult = sanitiseCustomFields(customFields);
+    expect(sanitationResult).toStrictEqual({});
+  });
+
+  it('label can not be empty', () => {
+    const customFields: CustomFields = {
+      '': { label: '', type: 'string', colour: 'red' },
+    };
+    const sanitationResult = sanitiseCustomFields(customFields);
+    expect(sanitationResult).toStrictEqual({});
+  });
+
+  it('remove extra stuff', () => {
+    const customFields: CustomFields = {
+      // @ts-expect-error intentional bad data
+      test: { label: 'test', type: 'string', colour: 'red', extra: 'should be removed' },
+    };
+    const expectedCustomFields: CustomFields = {
+      test: { label: 'test', type: 'string', colour: 'red' },
+    };
+    const sanitationResult = sanitiseCustomFields(customFields);
+    expect(sanitationResult).toStrictEqual(expectedCustomFields);
+  });
+
+  it('enforce name cohesion', () => {
+    const customFields: CustomFields = {
+      test: { label: 'NewName', type: 'string', colour: 'red' },
+    };
+    const expectedCustomFields: CustomFields = {
+      NewName: { label: 'NewName', type: 'string', colour: 'red' },
+    };
+    const sanitationResult = sanitiseCustomFields(customFields);
+    expect(sanitationResult).toStrictEqual(expectedCustomFields);
+  });
+
+  it('labels with space', () => {
+    const customFields: CustomFields = {
+      Test_with_Space: { label: 'Test with Space', type: 'string', colour: 'red' },
+    };
+    const expectedCustomFields: CustomFields = {
+      Test_with_Space: { label: 'Test with Space', type: 'string', colour: 'red' },
+    };
+    const sanitationResult = sanitiseCustomFields(customFields);
+    expect(sanitationResult).toStrictEqual(expectedCustomFields);
+  });
+
+  it('filters invalid entries', () => {
+    const customFields: CustomFields = {
+      test: { label: 'test', type: 'string', colour: 'red' },
+      test2: { label: 'test2', type: 'string', colour: 'green' },
+      bad: { label: '', type: 'string', colour: '' },
+      Test3: { label: 'Test3', type: 'string', colour: '' },
+    };
+    const expectedCustomFields: CustomFields = {
+      test: { label: 'test', type: 'string', colour: 'red' },
+      test2: { label: 'test2', type: 'string', colour: 'green' },
+      Test3: { label: 'Test3', type: 'string', colour: '' },
+    };
+    const sanitationResult = sanitiseCustomFields(customFields);
+    expect(sanitationResult).toStrictEqual(expectedCustomFields);
+  });
+});

apps/server/src/api-data/custom-fields/customFields.controller.ts

@@ -1,49 +0,0 @@
-import { CustomField, CustomFields, ErrorResponse } from 'ontime-types';
-
-import type { Request, Response } from 'express';
-
-import { getErrorMessage } from 'ontime-utils';
-
-import { createCustomField, editCustomField, removeCustomField } from '../../services/rundown-service/rundownCache.js';
-
-import { getProjectCustomFields } from '../rundown/rundown.dao.js';
-
-export async function getCustomFields(_req: Request, res: Response<CustomFields>) {
-  const customFields = getProjectCustomFields();
-  res.json(customFields);
-}
-
-export async function postCustomField(req: Request, res: Response<CustomFields | ErrorResponse>) {
-  try {
-    const newField = req.body as CustomField;
-    const allFields = await createCustomField(newField);
-    res.status(201).send(allFields);
-  } catch (error) {
-    const message = getErrorMessage(error);
-    res.status(400).send({ message });
-  }
-}
-
-export async function putCustomField(req: Request, res: Response<CustomFields | ErrorResponse>) {
-  try {
-    const oldLabel = req.params.label;
-    const { colour, type, label } = req.body;
-    const newFields = await editCustomField(oldLabel, { label, colour, type });
-    res.status(200).send(newFields);
-  } catch (error) {
-    const message = getErrorMessage(error);
-    res.status(400).send({ message });
-  }
-}
-
-// Expects { label: <label> }
-export async function deleteCustomField(req: Request, res: Response<CustomFields | ErrorResponse>) {
-  try {
-    const fieldToDelete = req.params.label;
-    await removeCustomField(fieldToDelete);
-    res.sendStatus(204);
-  } catch (error) {
-    const message = getErrorMessage(error);
-    res.status(400).send({ message });
-  }
-}

apps/server/src/api-data/custom-fields/customFields.parser.ts

@@ -0,0 +1,64 @@
+import { DatabaseModel, CustomFields, CustomField } from 'ontime-types';
+import { isAlphanumericWithSpace, customFieldLabelToKey } from 'ontime-utils';
+
+import type { ErrorEmitter } from '../../utils/parserUtils.js';
+
+/**
+ * Parse customFields entry
+ */
+export function parseCustomFields(data: Partial<DatabaseModel>, emitError?: ErrorEmitter): CustomFields {
+  if (typeof data.customFields !== 'object') {
+    emitError?.('No data found to import');
+    return {};
+  }
+  console.log('Found Custom Fields, importing...');
+
+  const customFields = sanitiseCustomFields(data.customFields);
+
+  if (Object.keys(customFields).length !== Object.keys(data.customFields).length) {
+    emitError?.('Skipped invalid custom fields');
+  }
+  return customFields;
+}
+
+export function sanitiseCustomFields(data: object): CustomFields {
+  const newCustomFields: CustomFields = {};
+
+  for (const [_originalKey, field] of Object.entries(data)) {
+    if (!isValidField(field)) {
+      continue;
+    }
+
+    if (!isAlphanumericWithSpace(field.label)) {
+      continue;
+    }
+
+    // the key is always made from the label
+    const key = customFieldLabelToKey(field.label);
+
+    if (key in newCustomFields) {
+      continue;
+    }
+
+    newCustomFields[key] = {
+      type: field.type,
+      colour: field.colour,
+      label: field.label,
+    };
+  }
+
+  function isValidField(data: unknown): data is CustomField {
+    return (
+      typeof data === 'object' &&
+      data !== null &&
+      'label' in data &&
+      data.label !== '' &&
+      'colour' in data &&
+      typeof data.colour === 'string' &&
+      'type' in data &&
+      (data.type === 'string' || data.type === 'image')
+    );
+  }
+
+  return newCustomFields;
+}

apps/server/src/api-data/custom-fields/customFields.router.ts

@@ -1,14 +1,49 @@
-import express from 'express';
+import { CustomField, CustomFields, ErrorResponse } from 'ontime-types';
+import { getErrorMessage } from 'ontime-utils';
+
+import express from 'express';
+import type { Request, Response } from 'express';
+
+import { getProjectCustomFields } from '../rundown/rundown.dao.js';
+import { createCustomField, editCustomField, deleteCustomField } from '../rundown/rundown.service.js';
 
-import { deleteCustomField, getCustomFields, postCustomField, putCustomField } from './customFields.controller.js';
 import { validateCustomField, validateDeleteCustomField, validateEditCustomField } from './customFields.validation.js';
 
 export const router = express.Router();
 
-router.get('/', getCustomFields);
+router.get('/', async (_req: Request, res: Response<CustomFields>) => {
+  const customFields = getProjectCustomFields();
+  res.json(customFields);
+});
 
-router.post('/', validateCustomField, postCustomField);
+router.post('/', validateCustomField, async (req: Request, res: Response<CustomFields | ErrorResponse>) => {
+  try {
+    const newFields = await createCustomField(req.body as CustomField);
+    res.status(201).send(newFields);
+  } catch (error) {
+    const message = getErrorMessage(error);
+    res.status(400).send({ message });
+  }
+});
 
-router.put('/:label', validateEditCustomField, putCustomField);
+router.put('/:key', validateEditCustomField, async (req: Request, res: Response<CustomFields | ErrorResponse>) => {
+  try {
+    const currentKey = req.params.key;
+    const { colour, type, label } = req.body;
+    const newFields = await editCustomField(currentKey, { label, colour, type });
+    res.status(200).send(newFields);
+  } catch (error) {
+    const message = getErrorMessage(error);
+    res.status(400).send({ message });
+  }
+});
 
-router.delete('/:label', validateDeleteCustomField, deleteCustomField);
+router.delete('/:key', validateDeleteCustomField, async (req: Request, res: Response<CustomFields | ErrorResponse>) => {
+  try {
+    const customFields = await deleteCustomField(req.params.key);
+    res.status(200).send(customFields);
+  } catch (error) {
+    const message = getErrorMessage(error);
+    res.status(400).send({ message });
+  }
+});

apps/server/src/api-data/custom-fields/customFields.validation.ts

@@ -5,14 +5,14 @@ import { body, param, validationResult } from 'express-validator';
 
 export const validateCustomField = [
   body('label')
-    .exists()
     .isString()
     .trim()
+    .notEmpty()
     .custom((value) => {
       return isAlphanumericWithSpace(value);
     }),
-  body('type').exists().isIn(['string', 'image']),
-  body('colour').exists().isString().trim(),
+  body('type').isIn(['string', 'image']),
+  body('colour').isString().trim(),
 
   (req: Request, res: Response, next: NextFunction) => {
     const errors = validationResult(req);
@@ -22,16 +22,16 @@ export const validateCustomField = [
 ];
 
 export const validateEditCustomField = [
-  param('label').exists().isString().trim(),
+  param('key').isString().trim().notEmpty(),
   body('label')
-    .exists()
     .isString()
     .trim()
+    .notEmpty()
     .custom((value) => {
       return isAlphanumericWithSpace(value);
     }),
-  body('type').exists().isIn(['string', 'image']),
-  body('colour').exists().isString().trim(),
+  body('type').isIn(['string', 'image']),
+  body('colour').isString().trim(),
 
   (req: Request, res: Response, next: NextFunction) => {
     const errors = validationResult(req);
@@ -41,7 +41,7 @@ export const validateEditCustomField = [
 ];
 
 export const validateDeleteCustomField = [
-  param('label').exists().isString(),
+  param('key').isString().notEmpty(),
 
   (req: Request, res: Response, next: NextFunction) => {
     const errors = validationResult(req);