feat: http integration (#575)

* addtime endpoint

* create universal Subscription

* add http integration

* catch error from HTTP integration emit

* unify osc and http validateSubscriptionEntry

* add necessary endpoint for http subscription

* make subscription part of modal generic

* add http subscription to integration modal

* remove log

* Revert "addtime endpoint"

This reverts commit 4c039220dc.

* reuse agent and test url compatibility

* simplify retun path

* add todo in UI

* test for http protocol

* import not needed yet

* lint

* fix merge

* lint

* fix httpPlaceholder

* wip: prepare endpoints

* wip: temporary fix to get form to work

* disable HTTP integration if enabledOut==false

* register/unregister http

* refactor: subscription types and form register

* refactor: validation

* cleanup

* cleanup

* try GOT

* allow https

* split url and searchParams allow for post option

* add options to post

* add retry count

* fix test

* Revert "fix test"

This reverts commit 927e88370f.

* Revert "add options to post"

This reverts commit 0523a68ef4.

* Revert "split url and searchParams allow for post option"

This reverts commit 54ab8d4ffe.

* missing retryCount in httpPlaceholder

* remove global this

* remove retry count

* remove https

---------

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

apps/server/src/app.ts

@@ -1,4 +1,4 @@
-import { LogOrigin, OSCSettings } from 'ontime-types';
+import { HttpSettings, LogOrigin, OSCSettings } from 'ontime-types';
 
 import 'dotenv/config';
 import express from 'express';
@@ -29,6 +29,7 @@ import { eventLoader } from './classes/event-loader/EventLoader.js';
 import { integrationService } from './services/integration-service/IntegrationService.js';
 import { logger } from './classes/Logger.js';
 import { oscIntegration } from './services/integration-service/OscIntegration.js';
+import { httpIntegration } from './services/integration-service/HttpIntegration.js';
 import { populateStyles } from './modules/loadStyles.js';
 import { eventStore, getInitialPayload } from './stores/EventStore.js';
 import { PlaybackService } from './services/PlaybackService.js';
@@ -165,7 +166,6 @@ export const startServer = async () => {
 };
 
 /**
- * @description starts OSC server
  * @description starts OSC server
  * @param overrideConfig
  * @return {Promise<void>}
@@ -194,20 +194,30 @@ export const startOSCServer = async (overrideConfig = null) => {
 /**
  * starts integrations
  */
-export const startIntegrations = async (config?: { osc: OSCSettings }) => {
+export const startIntegrations = async (config?: { osc: OSCSettings; http: HttpSettings }) => {
   checkStart(OntimeStartOrder.InitIO);
 
-  const { osc } = config ?? DataProvider.getData();
+  const { osc, http } = config ?? DataProvider.getData();
 
   if (!osc) {
     return 'OSC Invalid configuration';
+  } else {
+    const { success, message } = oscIntegration.init(osc);
+    logger.info(LogOrigin.Tx, message);
+
+    if (success) {
+      integrationService.register(oscIntegration);
+    }
   }
+  if (!http) {
+    return 'HTTP Invalid configuration';
+  } else {
+    const { success, message } = httpIntegration.init(http);
+    logger.info(LogOrigin.Tx, message);
 
-  const { success, message } = oscIntegration.init(osc);
-  logger.info(LogOrigin.Tx, message);
-
-  if (success) {
-    integrationService.register(oscIntegration);
+    if (success) {
+      integrationService.register(httpIntegration);
+    }
   }
 };
 

apps/server/src/classes/data-provider/DataProvider.ts

@@ -62,6 +62,10 @@ export class DataProvider {
     return data.osc;
   }
 
+  static getHttp() {
+    return data.http;
+  }
+
   static getAliases() {
     return data.aliases;
   }
@@ -94,6 +98,11 @@ export class DataProvider {
     await this.persist();
   }
 
+  static async setHttp(newData) {
+    data.http = { ...newData };
+    await this.persist();
+  }
+
   static getRundown() {
     return [...data.rundown];
   }

apps/server/src/controllers/ontimeController.ts

@@ -1,4 +1,5 @@
-import { Alias, DatabaseModel, GetInfo, LogOrigin, ProjectData } from 'ontime-types';
+import { LogOrigin } from 'ontime-types';
+import type { Alias, DatabaseModel, GetInfo, HttpSettings, ProjectData } from 'ontime-types';
 
 import { RequestHandler, Request, Response } from 'express';
 import fs from 'fs';
@@ -11,6 +12,7 @@ import { PlaybackService } from '../services/PlaybackService.js';
 import { eventStore } from '../stores/EventStore.js';
 import { isDocker, pathToStartStyles, resolveDbPath } from '../setup.js';
 import { oscIntegration } from '../services/integration-service/OscIntegration.js';
+import { httpIntegration } from '../services/integration-service/HttpIntegration.js';
 import { logger } from '../classes/Logger.js';
 import { deleteAllEvents, notifyChanges } from '../services/rundown-service/RundownService.js';
 import { deepmerge } from 'ontime-utils';
@@ -284,27 +286,6 @@ export const getOSC = async (req, res) => {
   res.status(200).send(osc);
 };
 
-export const postOscSubscriptions = async (req, res) => {
-  if (failEmptyObjects(req.body, res)) {
-    return;
-  }
-
-  try {
-    const oscSubscriptions = req.body;
-    const oscSettings = DataProvider.getOsc();
-    oscSettings.subscriptions = oscSubscriptions;
-    await DataProvider.setOsc(oscSettings);
-
-    // TODO: this update could be more granular, checking that relevant data was changed
-    const { message } = oscIntegration.init(oscSettings);
-    logger.info(LogOrigin.Tx, message);
-
-    res.send(oscSettings).status(200);
-  } catch (error) {
-    res.status(400).send({ message: error.toString() });
-  }
-};
-
 // Create controller for POST request to '/ontime/osc'
 // Returns ACK message
 export const postOSC = async (req, res) => {
@@ -332,6 +313,59 @@ export const postOSC = async (req, res) => {
   }
 };
 
+export const postOscSubscriptions = async (req, res) => {
+  if (failEmptyObjects(req.body, res)) {
+    return;
+  }
+
+  try {
+    const subscriptions = req.body;
+    const oscSettings = DataProvider.getOsc();
+    oscSettings.subscriptions = subscriptions;
+    await DataProvider.setOsc(oscSettings);
+
+    // TODO: this update could be more granular, checking that relevant data was changed
+    const { message } = oscIntegration.init(oscSettings);
+    logger.info(LogOrigin.Tx, message);
+
+    res.send(oscSettings).status(200);
+  } catch (error) {
+    res.status(400).send({ message: error.toString() });
+  }
+};
+
+// Create controller for GET request to '/ontime/http'
+export const getHTTP = async (_req, res: Response<HttpSettings>) => {
+  const http = DataProvider.getHttp();
+  res.status(200).send(http);
+};
+
+// Create controller for POST request to '/ontime/http'
+export const postHTTP = async (req, res) => {
+  if (failEmptyObjects(req.body, res)) {
+    return;
+  }
+
+  try {
+    const httpSettings = req.body;
+    await DataProvider.setHttp(httpSettings);
+
+    integrationService.unregister(httpIntegration);
+
+    // TODO: this update could be more granular, checking that relevant data was changed
+    const { success, message } = httpIntegration.init(httpSettings);
+    logger.info(LogOrigin.Tx, message);
+
+    if (success) {
+      integrationService.register(httpIntegration);
+    }
+
+    res.send(httpSettings).status(200);
+  } catch (error) {
+    res.status(400).send({ message: error.toString() });
+  }
+};
+
 export async function patchPartialProjectFile(req, res) {
   if (failEmptyObjects(req.body, res)) {
     return;

apps/server/src/controllers/ontimeController.validate.ts

@@ -1,5 +1,9 @@
 import { body, check, validationResult } from 'express-validator';
-import { validateOscObject, validateOscSubscriptionEntry } from '../utils/parserFunctions.js';
+import {
+  validateHttpSubscriptionObject,
+  validateOscSubscriptionObject,
+  validateOscSubscriptionCycle,
+} from '../utils/parserFunctions.js';
 
 /**
  * @description Validates object for POST /ontime/views
@@ -82,7 +86,22 @@ export const validateOSC = [
   body('enabledOut').exists().isBoolean(),
   body('subscriptions')
     .isObject()
-    .custom((value) => validateOscObject(value)),
+    .custom((value) => validateOscSubscriptionObject(value)),
+  (req, res, next) => {
+    const errors = validationResult(req);
+    if (!errors.isEmpty()) return res.status(422).json({ errors: errors.array() });
+    next();
+  },
+];
+
+/**
+ * @description Validates object for POST /ontime/http
+ */
+export const validateHTTP = [
+  body('enabledOut').exists().isBoolean(),
+  body('subscriptions')
+    .isObject()
+    .custom((value) => validateHttpSubscriptionObject(value)),
   (req, res, next) => {
     const errors = validationResult(req);
     if (!errors.isEmpty()) return res.status(422).json({ errors: errors.array() });
@@ -96,22 +115,22 @@ export const validateOSC = [
 export const validateOscSubscription = [
   body('onLoad')
     .isArray()
-    .custom((value) => validateOscSubscriptionEntry(value)),
+    .custom((value) => validateOscSubscriptionCycle(value)),
   body('onStart')
     .isArray()
-    .custom((value) => validateOscSubscriptionEntry(value)),
+    .custom((value) => validateOscSubscriptionCycle(value)),
   body('onPause')
     .isArray()
-    .custom((value) => validateOscSubscriptionEntry(value)),
+    .custom((value) => validateOscSubscriptionCycle(value)),
   body('onStop')
     .isArray()
-    .custom((value) => validateOscSubscriptionEntry(value)),
+    .custom((value) => validateOscSubscriptionCycle(value)),
   body('onUpdate')
     .isArray()
-    .custom((value) => validateOscSubscriptionEntry(value)),
+    .custom((value) => validateOscSubscriptionCycle(value)),
   body('onFinish')
     .isArray()
-    .custom((value) => validateOscSubscriptionEntry(value)),
+    .custom((value) => validateOscSubscriptionCycle(value)),
   (req, res, next) => {
     const errors = validationResult(req);
     if (!errors.isEmpty()) return res.status(422).json({ errors: errors.array() });

apps/server/src/models/dataModel.ts

@@ -57,4 +57,15 @@ export const dbModel: DatabaseModel = {
       onFinish: [],
     },
   },
+  http: {
+    enabledOut: false,
+    subscriptions: {
+      onLoad: [],
+      onStart: [],
+      onPause: [],
+      onStop: [],
+      onUpdate: [],
+      onFinish: [],
+    },
+  },
 };

apps/server/src/routes/ontimeRouter.ts

@@ -6,6 +6,7 @@ import {
   getAliases,
   getInfo,
   getOSC,
+  getHTTP,
   getSettings,
   getUserFields,
   getViewSettings,
@@ -19,16 +20,18 @@ import {
   postUserFields,
   postViewSettings,
   previewExcel,
+  postHTTP,
 } from '../controllers/ontimeController.js';
 
 import {
   validateAliases,
   validateOSC,
-  validateOscSubscription,
   validatePatchProjectFile,
   validateSettings,
   validateUserFields,
   viewValidator,
+  validateHTTP,
+  validateOscSubscription,
 } from '../controllers/ontimeController.validate.js';
 import { projectSanitiser } from '../controllers/projectController.validate.js';
 
@@ -85,5 +88,11 @@ router.post('/osc', validateOSC, postOSC);
 // create route between controller and '/ontime/osc-subscriptions' endpoint
 router.post('/osc-subscriptions', validateOscSubscription, postOscSubscriptions);
 
+// create route between controller and '/ontime/http' endpoint
+router.get('/http', getHTTP);
+
+// create route between controller and '/ontime/http' endpoint
+router.post('/http', validateHTTP, postHTTP);
+
 // create route between controller and '/ontime/new' endpoint
 router.post('/new', projectSanitiser, postNew);

apps/server/src/services/integration-service/HttpIntegration.ts

@@ -0,0 +1,99 @@
+import got from 'got';
+
+import { HttpSettings, HttpSubscription, HttpSubscriptionOptions, LogOrigin } from 'ontime-types';
+
+import IIntegration, { TimerLifeCycleKey } from './IIntegration.js';
+import { parseTemplateNested } from './integrationUtils.js';
+import { dbModel } from '../../models/dataModel.js';
+import { logger } from '../../classes/Logger.js';
+import { validateHttpSubscriptionObject } from '../../utils/parserFunctions.js';
+
+type Action = TimerLifeCycleKey | string;
+
+/**
+ * @description Class contains logic towards outgoing HTTP communications
+ * @class
+ */
+export class HttpIntegration implements IIntegration<HttpSubscriptionOptions> {
+  subscriptions: HttpSubscription;
+  constructor() {
+    this.subscriptions = dbModel.http.subscriptions;
+  }
+
+  /**
+   * Initializes httpClient
+   */
+  init(config: HttpSettings) {
+    const { subscriptions, enabledOut } = config;
+
+    if (!enabledOut) {
+      return {
+        success: false,
+        message: 'HTTP output disabled',
+      };
+    }
+
+    this.initSubscriptions(subscriptions);
+
+    try {
+      return {
+        success: true,
+        message: `HTTP integration client ready`,
+      };
+    } catch (error) {
+      return {
+        success: false,
+        message: `Failed initialising HTTP integration: ${error}`,
+      };
+    }
+  }
+
+  initSubscriptions(subscriptionOptions: HttpSubscription) {
+    if (validateHttpSubscriptionObject(subscriptionOptions)) {
+      this.subscriptions = { ...subscriptionOptions };
+    }
+  }
+
+  dispatch(action: Action, state?: object) {
+    if (!action) {
+      return {
+        success: false,
+        message: 'HTTP called with no action',
+      };
+    }
+
+    // check subscriptions for action
+    const eventSubscriptions = this.subscriptions?.[action] || [];
+
+    eventSubscriptions.forEach((sub) => {
+      const { enabled, message } = sub;
+      if (enabled && message) {
+        const parsedMessage = parseTemplateNested(message, state || {});
+        try {
+          const parsedUrl = new URL(parsedMessage);
+          this.emit(parsedUrl);
+        } catch (err) {
+          logger.error(LogOrigin.Tx, `HTTP Integration: ${err}`);
+          return {
+            success: false,
+            message: `${err}`,
+          };
+        }
+      }
+    });
+  }
+
+  async emit(path: URL) {
+    try {
+      await got.get(path, {
+        retry: { limit: 0 },
+      });
+    } catch (err) {
+      logger.error(LogOrigin.Tx, `HTTP integration: ${err}`);
+    }
+  }
+
+  shutdown() {}
+}
+
+export const httpIntegration = new HttpIntegration();

apps/server/src/services/integration-service/IIntegration.ts

@@ -1,9 +1,9 @@
-import { TimerLifeCycle, OscSubscription } from 'ontime-types';
+import { TimerLifeCycle, Subscription } from 'ontime-types';
 
 export type TimerLifeCycleKey = keyof typeof TimerLifeCycle;
 
-export default interface IIntegration {
-  subscriptions: OscSubscription;
+export default interface IIntegration<T> {
+  subscriptions: Subscription<T>;
   init: (config: unknown) => OperationReturn;
   dispatch: (action: TimerLifeCycleKey, state?: object) => OperationReturn;
   emit: (...args: unknown[]) => unknown;

apps/server/src/services/integration-service/IntegrationService.ts

@@ -2,17 +2,17 @@ import IIntegration, { TimerLifeCycleKey } from './IIntegration.js';
 import { eventStore } from '../../stores/EventStore.js';
 
 class IntegrationService {
-  private integrations: IIntegration[];
+  private integrations: IIntegration<unknown>[];
 
   constructor() {
     this.integrations = [];
   }
 
-  register(integrationService: IIntegration) {
+  register(integrationService: IIntegration<unknown>) {
     this.integrations.push(integrationService);
   }
 
-  unregister(integrationService: IIntegration) {
+  unregister(integrationService: IIntegration<unknown>) {
     this.integrations = this.integrations.filter((int) => int !== integrationService);
   }
 

apps/server/src/services/integration-service/OscIntegration.ts

@@ -1,11 +1,11 @@
 import { ArgumentType, Client, Message } from 'node-osc';
-import { OSCSettings, OscSubscription } from 'ontime-types';
+import { OSCSettings, OscSubscription, OscSubscriptionOptions } from 'ontime-types';
 
 import IIntegration, { TimerLifeCycleKey } from './IIntegration.js';
 import { parseTemplateNested } from './integrationUtils.js';
 import { isObject } from '../../utils/varUtils.js';
 import { dbModel } from '../../models/dataModel.js';
-import { validateOscObject } from '../../utils/parserFunctions.js';
+import { validateOscSubscriptionObject } from '../../utils/parserFunctions.js';
 
 type Action = TimerLifeCycleKey | string;
 
@@ -13,7 +13,7 @@ type Action = TimerLifeCycleKey | string;
  * @description Class contains logic towards outgoing OSC communications
  * @class
  */
-export class OscIntegration implements IIntegration {
+export class OscIntegration implements IIntegration<OscSubscriptionOptions> {
   protected oscClient: null | Client;
   subscriptions: OscSubscription;
 
@@ -66,7 +66,7 @@ export class OscIntegration implements IIntegration {
   }
 
   initSubscriptions(subscriptionOptions: OscSubscription) {
-    if (validateOscObject(subscriptionOptions)) {
+    if (validateOscSubscriptionObject(subscriptionOptions)) {
       this.subscriptions = { ...subscriptionOptions };
     }
   }

apps/server/src/utils/__tests__/parserFunctions.test.js

@@ -1,91 +0,0 @@
-import { validateOscObject } from '../parserFunctions.ts';
-
-test('validateOscSubscription()', () => {
-  it('should return true when given a valid OscSubscription', () => {
-    const validSubscription = {
-      onLoad: [{ id: '1', message: 'test', enabled: true }],
-      onStart: [{ id: '2', message: 'test', enabled: false }],
-      onPause: [{ id: '3', message: 'test', enabled: true }],
-      onStop: [{ id: '4', message: 'test', enabled: false }],
-      onUpdate: [{ id: '5', message: 'test', enabled: true }],
-      onFinish: [{ id: '6', message: 'test', enabled: false }],
-    };
-
-    const result = validateOscObject(validSubscription);
-
-    expect(result).toBe(true);
-  });
-
-  it('should return false when given undefined', () => {
-    const result = validateOscObject(undefined);
-    expect(result).toBe(false);
-  });
-
-  it('should return false when given null', () => {
-    const result = validateOscObject(null);
-    expect(result).toBe(false);
-  });
-
-  it('should return false when given an empty object', () => {
-    const result = validateOscObject({});
-    expect(result).toBe(false);
-  });
-
-  it('should return false when given an empty array', () => {
-    const result = validateOscObject([]);
-    expect(result).toBe(false);
-  });
-
-  it('should return false when given an object that is not an OscSubscription', () => {
-    const invalidObject = { foo: 'bar' };
-
-    const result = validateOscObject(invalidObject);
-
-    expect(result).toBe(false);
-  });
-
-  it('should return false when given an OscSubscription with a missing property', () => {
-    const invalidSubscription = {
-      onLoad: [{ id: '1', message: 'test', enabled: true }],
-      onStart: [{ id: '2', message: 'test', enabled: false }],
-      onPause: [{ id: '3', message: 'test', enabled: true }],
-      // Missing onStop
-      onUpdate: [{ id: '5', message: 'test', enabled: true }],
-      onFinish: [{ id: '6', message: 'test', enabled: false }],
-    };
-
-    const result = validateOscObject(invalidSubscription);
-
-    expect(result).toBe(false);
-  });
-
-  it('should return false when given an OscSubscription with an invalid property value', () => {
-    const invalidSubscription = {
-      onLoad: [{ id: '1', message: 'test', enabled: true }],
-      onStart: [{ id: '2', message: 'test', enabled: false }],
-      onPause: [{ id: '3', message: 'test', enabled: true }],
-      onStop: [{ id: '4', message: 'test', enabled: false }],
-      onUpdate: [{ id: '5', message: 'test', enabled: true }],
-      onFinish: [{ id: '6', message: 'test', enabled: 'not a boolean' }],
-    };
-
-    const result = validateOscObject(invalidSubscription);
-
-    expect(result).toBe(false);
-  });
-
-  it('should return true if the message field is empty', () => {
-    const invalidSubscription = {
-      onLoad: [{ id: '1', message: 'test', enabled: true }],
-      onStart: [{ id: '2', message: '', enabled: false }],
-      onPause: [{ id: '3', message: '', enabled: true }],
-      onStop: [{ id: '4', message: 'test', enabled: false }],
-      onUpdate: [{ id: '5', message: 'test', enabled: true }],
-      onFinish: [{ id: '6', message: 'test', enabled: 'not a boolean' }],
-    };
-
-    const result = validateOscObject(invalidSubscription);
-
-    expect(result).toBe(true);
-  });
-});

apps/server/src/utils/__tests__/parserFunctions.test.ts

@@ -0,0 +1,162 @@
+import { HttpSubscription, OscSubscription } from 'ontime-types';
+import {
+  validateOscSubscriptionObject,
+  validateOscSubscriptionCycle,
+  validateHttpSubscriptionCycle,
+  validateHttpSubscriptionObject,
+} from '../parserFunctions.js';
+
+describe('validateOscSubscriptionCycle()', () => {
+  it('should return false when given an OscSubscription with an invalid property value', () => {
+    const invalidEntry = [{ message: 'test', enabled: 'not a boolean' }];
+
+    // @ts-expect-error -- since this comes from the client, we check things that typescript would have caught
+    const result = validateOscSubscriptionCycle(invalidEntry);
+    expect(result).toBe(false);
+  });
+});
+
+describe('validateOscSubscriptionObject()', () => {
+  it('should return true when given a valid OscSubscription', () => {
+    const validSubscription: OscSubscription = {
+      onLoad: [{ message: 'test', enabled: true }],
+      onStart: [{ message: 'test', enabled: false }],
+      onPause: [{ message: 'test', enabled: true }],
+      onStop: [{ message: 'test', enabled: false }],
+      onUpdate: [{ message: 'test', enabled: true }],
+      onFinish: [{ message: 'test', enabled: false }],
+    };
+
+    const result = validateOscSubscriptionObject(validSubscription);
+    expect(result).toBe(true);
+  });
+
+  it('should return false when given undefined', () => {
+    const result = validateOscSubscriptionObject(undefined);
+    expect(result).toBe(false);
+  });
+
+  it('should return false when given null', () => {
+    const result = validateOscSubscriptionObject(null);
+    expect(result).toBe(false);
+  });
+
+  it('should return false when given an empty object', () => {
+    // @ts-expect-error -- since this comes from the client, we check things that typescript would have caught
+    const result = validateOscSubscriptionObject({});
+    expect(result).toBe(false);
+  });
+
+  it('should return false when given an empty array', () => {
+    // @ts-expect-error -- since this comes from the client, we check things that typescript would have caught
+    const result = validateOscSubscriptionObject([]);
+    expect(result).toBe(false);
+  });
+
+  it('should return false when given an object that is not an OscSubscription', () => {
+    const invalidObject = { foo: 'bar' };
+
+    // @ts-expect-error -- since this comes from the client, we check things that typescript would have caught
+    const result = validateOscSubscriptionObject(invalidObject);
+    expect(result).toBe(false);
+  });
+
+  it('should return false when given an OscSubscription with a missing property', () => {
+    const invalidSubscription = {
+      onLoad: [{ message: 'test', enabled: true }],
+      onStart: [{ message: 'test', enabled: false }],
+      onPause: [{ message: 'test', enabled: true }],
+      // Missing onStop
+      onUpdate: [{ message: 'test', enabled: true }],
+      onFinish: [{ message: 'test', enabled: false }],
+    };
+
+    // @ts-expect-error -- since this comes from the client, we check things that typescript would have caught
+    const result = validateOscSubscriptionObject(invalidSubscription);
+    expect(result).toBe(false);
+  });
+});
+
+describe('validateHttpSubscriptionCycle()', () => {
+  it('should return false when given an HttpSubscription with an invalid property value', () => {
+    const invalidBoolean = [{ message: 'http://', enabled: 'not a boolean' }];
+    const invalidHttp = [{ message: 'test', enabled: true }];
+    const noFtp = [{ message: 'ftp://test', enabled: true }];
+    const noEmpty = [{ message: '', enabled: true }];
+
+    // @ts-expect-error -- since this comes from the client, we check things that typescript would have caught
+    expect(validateHttpSubscriptionCycle(invalidBoolean)).toBe(false);
+
+    expect(validateHttpSubscriptionCycle(invalidHttp)).toBe(false);
+    expect(validateHttpSubscriptionCycle(noFtp)).toBe(false);
+    expect(validateHttpSubscriptionCycle(noEmpty)).toBe(false);
+  });
+  it('should return true when given an HttpSubscription matches definition', () => {
+    const validHttp = [{ message: 'http://', enabled: true }];
+    const invalidHttps = [{ message: 'https://', enabled: true }];
+
+    expect(validateHttpSubscriptionCycle(validHttp)).toBe(true);
+    expect(validateHttpSubscriptionCycle(invalidHttps)).toBe(false);
+  });
+});
+
+describe('validateHttpSubscriptionObject()', () => {
+  it('should return true when given a valid HttpSubscription', () => {
+    const validSubscription: HttpSubscription = {
+      onLoad: [{ message: 'http://', enabled: true }],
+      onStart: [{ message: 'http://', enabled: false }],
+      onPause: [{ message: 'http://', enabled: true }],
+      onStop: [{ message: 'http://', enabled: false }],
+      onUpdate: [{ message: 'http://', enabled: true }],
+      onFinish: [{ message: 'http://', enabled: false }],
+    };
+
+    const result = validateHttpSubscriptionObject(validSubscription);
+    expect(result).toBe(true);
+  });
+
+  it('should return false when given undefined', () => {
+    const result = validateHttpSubscriptionObject(undefined);
+    expect(result).toBe(false);
+  });
+
+  it('should return false when given null', () => {
+    const result = validateHttpSubscriptionObject(null);
+    expect(result).toBe(false);
+  });
+
+  it('should return false when given an empty object', () => {
+    // @ts-expect-error -- since this comes from the client, we check things that typescript would have caught
+    const result = validateOscSubscriptionObject({});
+    expect(result).toBe(false);
+  });
+
+  it('should return false when given an empty array', () => {
+    // @ts-expect-error -- since this comes from the client, we check things that typescript would have caught
+    const result = validateHttpSubscriptionObject([]);
+    expect(result).toBe(false);
+  });
+
+  it('should return false when given an object that is not an HttpSubscription', () => {
+    const invalidObject = { foo: 'bar' };
+
+    // @ts-expect-error -- since this comes from the client, we check things that typescript would have caught
+    const result = validateHttpSubscriptionObject(invalidObject);
+    expect(result).toBe(false);
+  });
+
+  it('should return false when given an HttpSubscription with a missing property', () => {
+    const invalidSubscription = {
+      onLoad: [{ message: 'http://', enabled: true }],
+      onStart: [{ message: 'http://', enabled: false }],
+      onPause: [{ message: 'http://', enabled: true }],
+      // Missing onStop
+      onUpdate: [{ message: 'http://', enabled: true }],
+      onFinish: [{ message: 'http://', enabled: false }],
+    };
+
+    // @ts-expect-error -- since this comes from the client, we check things that typescript would have caught
+    const result = validateHttpSubscriptionObject(invalidSubscription);
+    expect(result).toBe(false);
+  });
+});

apps/server/src/utils/parser.ts

@@ -29,6 +29,7 @@ import {
   parseAliases,
   parseProject,
   parseOsc,
+  parseHttp,
   parseRundown,
   parseSettings,
   parseUserFields,
@@ -275,7 +276,7 @@ export const parseJson = async (jsonData): Promise<DatabaseModel | null> => {
   // Import OSC settings if any
   returnData.osc = parseOsc(jsonData) ?? dbModel.osc;
   // Import HTTP settings if any
-  // returnData.http = parseHttp(jsonData, enforce);
+  returnData.http = parseHttp(jsonData) ?? dbModel.http;
 
   return returnData as DatabaseModel;
 };

apps/server/src/utils/parserFunctions.ts

@@ -2,14 +2,17 @@ import { generateId } from 'ontime-utils';
 import {
   Alias,
   OntimeRundown,
+  HttpSettings,
   OSCSettings,
-  OscSubscription,
-  OscSubscriptionOptions,
   ProjectData,
   Settings,
   TimerLifeCycle,
   UserFields,
   ViewSettings,
+  OscSubscription,
+  HttpSubscription,
+  OscSubscriptionOptions,
+  HttpSubscriptionOptions,
 } from 'ontime-types';
 
 import { block as blockDef, delay as delayDef } from '../models/eventsDefinition.js';
@@ -159,12 +162,12 @@ export const parseViewSettings = (data): ViewSettings => {
 };
 
 /**
- * Parses and validates subscription entry
+ * Parses and validates OSC subscription cycle options
  * @param data
  */
-export const validateOscSubscriptionEntry = (data: OscSubscriptionOptions): boolean => {
-  for (const subscription in data) {
-    if (typeof data[subscription].message !== 'string' || typeof data[subscription].enabled !== 'boolean') {
+export const validateOscSubscriptionCycle = (data: OscSubscriptionOptions[]): boolean => {
+  for (const subscriptionOption of data) {
+    if (typeof subscriptionOption.message !== 'string' || typeof subscriptionOption.enabled !== 'boolean') {
       return false;
     }
   }
@@ -172,22 +175,23 @@ export const validateOscSubscriptionEntry = (data: OscSubscriptionOptions): bool
 };
 
 /**
- * Parses and validates subscription object
+ * Parses and validates OSC subscription object
  * @param data
  */
-export const validateOscObject = (data: OscSubscription): boolean => {
+export const validateOscSubscriptionObject = (data: OscSubscription): boolean => {
   if (!data) {
     return false;
   }
+
   const timerKeys = Object.keys(TimerLifeCycle);
   for (const key of timerKeys) {
+    // must contains all keys and be an array
     if (!(key in data) || !Array.isArray(data[key])) {
       return false;
     }
-    for (const subscription of data[key]) {
-      if (typeof subscription.message !== 'string' || typeof subscription.enabled !== 'boolean') {
-        return false;
-      }
+    const isValid = validateOscSubscriptionCycle(data[key]);
+    if (!isValid) {
+      return false;
     }
   }
   return true;
@@ -200,8 +204,9 @@ export const parseOsc = (data: { osc?: Partial<OSCSettings> }): OSCSettings => {
   if ('osc' in data) {
     console.log('Found OSC definition, importing...');
 
+    // TODO: this can be improved by only merging known keys
     const loadedConfig = data.osc || {};
-    const validatedSubscriptions = validateOscObject(loadedConfig.subscriptions)
+    const validatedSubscriptions = validateOscSubscriptionObject(loadedConfig.subscriptions)
       ? loadedConfig.subscriptions
       : dbModel.osc.subscriptions;
 
@@ -216,20 +221,63 @@ export const parseOsc = (data: { osc?: Partial<OSCSettings> }): OSCSettings => {
   }
 };
 
+/**
+ * Parses and validates HTTP subscription cycle options
+ * @param data
+ */
+export const validateHttpSubscriptionCycle = (data: HttpSubscriptionOptions[]): boolean => {
+  for (const subscriptionOption of data) {
+    const isHttp = subscriptionOption.message?.startsWith('http://');
+    if (typeof subscriptionOption.message !== 'string' || !isHttp || typeof subscriptionOption.enabled !== 'boolean') {
+      return false;
+    }
+  }
+  return true;
+};
+
+/**
+ * Parses and validates HTTP subscription object
+ * @param data
+ */
+export const validateHttpSubscriptionObject = (data: HttpSubscription): boolean => {
+  if (!data) {
+    return false;
+  }
+  const timerKeys = Object.keys(TimerLifeCycle);
+  // must contains all keys and be an array
+  for (const key of timerKeys) {
+    if (!(key in data) || !Array.isArray(data[key])) {
+      return false;
+    }
+    const isValid = validateHttpSubscriptionCycle(data[key]);
+    if (!isValid) {
+      return false;
+    }
+  }
+  return true;
+};
+
 /**
  * Parse Http portion of an entry
  * @param {object} data - data object
  * @param {boolean} enforce - whether to create a definition if one is missing
  * @returns {object} - event object data
  */
-export const parseHttp = (data, enforce) => {
-  const newHttp = {};
+export const parseHttp = (data: { http?: Partial<HttpSettings> }): HttpSettings => {
   if ('http' in data) {
     console.log('Found HTTP definition, importing...');
-  } else if (enforce) {
-    /* Not yet */
+
+    // TODO: this can be improved by only merging known keys
+    const loadedConfig = data?.http || {};
+    const validatedSubscriptions = validateHttpSubscriptionObject(loadedConfig.subscriptions)
+      ? loadedConfig.subscriptions
+      : dbModel.http.subscriptions;
+
+    return {
+      enabledOut: loadedConfig.enabledOut ?? dbModel.http.enabledOut,
+      subscriptions: validatedSubscriptions,
+    };
   }
-  return newHttp;
 };
 
 /**