Feat/openmedia hotstandby heartbeat logic

[olzzon]

About the Contributor

This is a PR made on behalf of BBC

Type of Contribution

This is a Feature

Current Behavior

Currently MOS-connection checks for heartbeat on all devices.

New Behavior

There has been added an option openMediaHotStandby?: boolean in the API
When set to true, the heartbeat will be enabled/disabled depending on what OpenMedia server is being used.

Testing Instructions

For test a dual OpenMedia server setup is needed, and openMediaHotStandby must be set on the secondary connection in deviceOptions.

deviceOptions.secondary.openMediaHotStandby = true
const mosDevice: MosDevice = await this.mos.connect(deviceOptions)

Other Information

Status

• PR is ready to be reviewed.
• The functionality has been tested by the author.
• Relevant unit tests has been added / updated.
• Relevant documentation (code comments, system documentation) has been added / updated.

[olzzon]

Converted the PR to upstream from Draft to Ready be reviewed/merged

[nytamin]

I'm missing a few things in this one to be able to merge it.

Mainly I'm missing unit tests covering this situation, and the mosDevice.getConnectionStatus() is not updated/defined how it should work.

I've added a (failing) unit test in the branch chore/pr-105 to highlight some of the issues, please have a look at it and feel free merge it into your branch.

Also I have a question regarding the OpenMedia server: When the secondary server is standing by, does it accept any Socket connections still, or is it completely offline? (This is relevant to designing the unit test properly).

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.87%. Comparing base (a348b97) to head (562d74b).
Report is 4 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #105      +/-   ##
==========================================
+ Coverage   75.28%   75.87%   +0.59%     
==========================================
  Files          67       67              
  Lines        3985     4009      +24     
  Branches      949      948       -1     
==========================================
+ Hits         3000     3042      +42     
- Misses        906      943      +37     
+ Partials       79       24      -55     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests
• JS Bundle Analysis - Avoid shipping oversized bundles

[mint-dewit]

I've added some commits to this PR to better reflect what this feature entails. Specifically clarifying that the connection status report for the individual connections should still reflect the actual status of the system.

I am open to adding a method that exposes a single status for both primary and secondary connection but if we are reporting the individual connections we should not add a "fake" connected status. That smells of bad magic. The user of the lib is already aware of the system being a "hot standby" and should interpret the status of the secondary accordingly.