refactor: A series of refactorings and fixes in vMix integration

[ianshade]

About the Contributor

This PR is being opened on behalf of TV 2 Norge.

Type of Contribution

This is a:

Code improvement that also tackles some issues that can be considered as bugs

Current Behavior

• Total control of the features available in this integration is assumed, causing TSR to reset properties that may be intended to be controlled manually or left at the defaults stored in the Preset. This causes several conflicts:
  • audio properties of inputs are reset even when not intended to be controlled by the TSR, but for example with other tools like Sisyfos (even though separate mappings for audio already exist, the state is combined together with other input properties)
  • layer (overlay / multi view) properties of inputs are incorrectly parsed from vMix and reset at unexpected times
  • output assignments are reset
  • streaming, recording, ..., are turned off
• Because of the retry functionality, commands resetting the Alpha value are sent to all inputs every time the real state is polled (the value is not available in the XML returned by vMix)
• Inputs previously added by TSR are incorrectly treated as fixed inputs when TSR is restarted
• Usage of deepMerge causes duplication in some arrays
• Some debug events are emitted without respecting the debugLogging flag

New Behavior

• The code is split into multiple classes
• Similarly to the TriCaster integration, a resource is controlled (and may receive TSR-default state) on an opt-in basis, only when a layer mapping associated with it exists. This includes:
  • inputs (each one individually)
  • audio channels (each one individually)
  • outputs (each one individually)
  • overlays (each one individually)
  • recording
  • streaming
  • external
  • mixes (each one individually)
• Readme file describing implementation details and limitations is added
• The retry functionality is refactored. Only relevant properties of inputs are synced, not deeply merging the whole state anymore. An edge case potentially causing duplicate commands to be sent due to a response to polling arriving after commands from a new resolving are sent is (hopefully) solved.
• Commands setting Alpha are not re-sent repeatedly as a result of polling
• Input layers (overlay / multi view) parsing is fixed
• Inputs added by TSR are handled separately from the pre-existing inputs for an improved recovery when restarting the TSR. Note: this might need further improvements that are out of the scope for this PR and partially depend on features already existing in release51.
• Debug logging is done through emitDebug. Note: this needs further improvements to separate commands from other logs

Testing Instructions

Other Information

Many of the changes are based on #235.
Some TODOs and one uncommented test case are left for when this will be merged with release51.

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.

[codecov-commenter]

Codecov Report

Attention: 264 lines in your changes are missing coverage. Please review.

Comparison is base (7a40f53) 35.80% compared to head (226d20e) 37.23%.

Files	Patch %	Lines
...rc/integrations/vmix/VMixTimelineStateConverter.ts	31.72%	83 Missing and 16 partials ⚠️
...-resolver/src/integrations/vmix/VMixStateDiffer.ts	64.87%	81 Missing and 4 partials ⚠️
...line-state-resolver/src/integrations/vmix/index.ts	0.00%	71 Missing and 5 partials ⚠️
...solver/src/integrations/vmix/VMixXmlStateParser.ts	94.00%	3 Missing ⚠️
...ver/src/integrations/vmix/VMixStateSynchronizer.ts	92.85%	1 Missing ⚠️

Additional details and impacted files

@@              Coverage Diff              @@
##           release50     #315      +/-   ##
=============================================
+ Coverage      35.80%   37.23%   +1.42%     
=============================================
  Files             99      105       +6     
  Lines          10062    10204     +142     
  Branches        2467     2484      +17     
=============================================
+ Hits            3603     3799     +196     
+ Misses          5891     5856      -35     
+ Partials         568      549      -19     

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

[mint-dewit]

I'm happy to accept this into R50 since they are constrained to just the VMix integration which is not in use by NRK right now.

Before merging I just want to see the naming of the files be camelCase for consistency.