refactor: fixes to custom field

apps/server/src/api-data/rundown/__mocks__/rundown.mocks.ts

@@ -49,7 +49,7 @@ export function makeRundown(patch: Partial<Rundown>): Rundown {
 
 export function makeCustomField(patch: Partial<CustomField>): CustomField {
   return {
-    type: 'string',
+    type: 'text',
     colour: '#000000',
     label: 'Custom Field',
     ...patch,

apps/server/src/api-data/rundown/__tests__/rundown.dao.test.ts

@@ -62,7 +62,7 @@ describe('createTransaction', () => {
     rundown.title = 'Another Title';
     customFields['newField'] = {
       label: 'New Field',
-      type: 'string',
+      type: 'text',
       colour: 'blue',
     };
 
@@ -524,12 +524,12 @@ describe('processRundown()', () => {
       const customProperties: CustomFields = {
         lighting: {
           label: 'lighting',
-          type: 'string',
+          type: 'text',
           colour: 'red',
         },
         sound: {
           label: 'sound',
-          type: 'string',
+          type: 'text',
           colour: 'red',
         },
       };

apps/server/src/api-data/rundown/__tests__/rundown.parser.test.ts

@@ -197,12 +197,12 @@ describe('parseRundown()', () => {
 
     const customFields: CustomFields = {
       lighting: {
-        type: 'string',
+        type: 'text',
         colour: 'red',
         label: 'lighting',
       },
       sound: {
-        type: 'string',
+        type: 'text',
         colour: 'red',
         label: 'sound',
       },
@@ -229,7 +229,7 @@ describe('parseRundown()', () => {
 
     const customFields: CustomFields = {
       lighting: {
-        type: 'string',
+        type: 'text',
         colour: 'red',
         label: 'lighting',
       },
@@ -308,12 +308,12 @@ describe('handleCustomField()', () => {
   it('creates a map of where custom fields are used', () => {
     const customFields = {
       lighting: {
-        type: 'string',
+        type: 'text',
         colour: 'red',
         label: 'lighting',
       },
       sound: {
-        type: 'string',
+        type: 'text',
         colour: 'red',
         label: 'sound',
       },

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

@@ -121,38 +121,28 @@ export function createTransaction(options: TransactionOptions): Transaction {
         await getDataProvider().setRundown(cachedRundown.id, cachedRundown);
       });
 
-      // increment the revision number
+      // update fields which are agnostic of whether the rundown is processed
       cachedRundown.revision = cachedRundown.revision + 1;
+      cachedRundown.title = rundown.title;
 
-      /**
-       * Some mutations do not require processing the rundown
-       * We simply increment the revision and return the rundown
-       */
       if (!shouldProcess) {
-        cachedRundown.title = rundown.title;
+        // if we dont need to process, we just reassign the commit data to the cache
         cachedRundown.entries = rundown.entries;
         cachedRundown.order = rundown.order;
         cachedRundown.flatOrder = rundown.flatOrder;
-        return {
-          rundown: cachedRundown,
-          rundownMetadata, // metadata doesnt change as long as we dont process the rundown
-          customFields: projectCustomFields,
-          revision: cachedRundown.revision,
-        };
+      } else {
+        const processedData = processRundown(rundown, projectCustomFields);
+        // update the cache values
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars -- we are not interested in the iteration data
+        const { previousEvent, latestEvent, previousEntry, entries, order, assignedCustomFields, ...metadata } =
+          processedData;
+
+        cachedRundown.entries = entries;
+        cachedRundown.order = order;
+        cachedRundown.flatOrder = metadata.flatEntryOrder;
+        customFieldsMetadata.assigned = assignedCustomFields;
+        rundownMetadata = metadata;
       }
-
-      const processedData = processRundown(rundown, projectCustomFields);
-      // update the cache values
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars -- we are not interested in the iteration data
-      const { previousEvent, latestEvent, previousEntry, entries, order, assignedCustomFields, ...metadata } =
-        processedData;
-
-      cachedRundown.title = rundown.title;
-      cachedRundown.entries = entries;
-      cachedRundown.order = order;
-      cachedRundown.flatOrder = metadata.flatEntryOrder;
-      customFieldsMetadata.assigned = assignedCustomFields;
-      rundownMetadata = metadata;
     }
 
     // if the customFields are mutable we persist the changes

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

@@ -464,9 +464,14 @@ export async function editCustomField(key: CustomFieldKey, newField: Partial<Cus
 
   const { oldKey, newKey } = customFieldMutation.edit(customFields, key, existingField, newField);
 
-  // if key has changed we remove the old reference
-  if (oldKey !== newKey && oldKey in customFieldsMetadata.assigned) {
-    customFieldMutation.renameUsages(rundown, customFieldsMetadata.assigned, oldKey, newKey);
+  // if key has changed
+  if (oldKey !== newKey) {
+    // 1. delete the old key
+    customFieldMutation.remove(customFields, oldKey);
+    if (oldKey in customFieldsMetadata.assigned) {
+      // 2. reassign references
+      customFieldMutation.renameUsages(rundown, customFieldsMetadata.assigned, oldKey, newKey);
+    }
   }
 
   // the custom fields have been removed and there is no processing to be done