feat: time of day pieces

[Julusian]

About the Contributor

This pull request is posted on behalf of the BBC

Type of Contribution

This is a: Feature

New Behavior

This builds on top of #1384

Time of day pieces are a new concept, where a rundown is able to define some pieces that should play at an absolute timestamp, no matter what part is active at the time.
This could be utilised to show some graphic about what is next, or to ensure that the outro is triggered at the correct time (doing so out of vision) to ensure it will be at the right point when the show reaches the end time.

These pieces can be returned from the getRundown blueprint method, and are very similar to pieces returned as part of a part. A few properties which are not relevant are removed, and the enable property must contain isAbsolute: true. This change allows the system to not need much special handling for them, with many of the differences based off this different start rule.

During playout, these pieces will be omitted from the timeline until ~30s before their start time. This duration is controlled by a new studio setting. Only once this point has been crossed will the pieces be considered for AB and lookahead. Sofie&playout-gateway coordinate regenerating the timeline at this 30s threshold, make sure to be running playout-gateway. (#1384 was written for this)

Other than that, these behave pretty much like normal outOnRundownChange pieces. They show in the ui in the current part, and in future parts once playback of the piece has started. They can be stopped/cleared by other pieces with the same rules as normal, and can be updated through the syncIngestChanges flow as usual.

Testing

• I have added one or more unit tests for this PR
• I have updated the relevant unit tests
• No unit test changes are needed for this PR

Affected areas

Time Frame

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.

[codecov]

Codecov Report

Attention: Patch coverage is 73.45254% with 193 lines in your changes missing coverage. Please review.

Project coverage is 56.96%. Comparing base (1cda4a8) to head (1c7a8e7).
Report is 48 commits behind head on release53.

Files with missing lines	Patch %	Lines
packages/job-worker/src/blueprints/postProcess.ts	35.00%	52 Missing ⚠️
packages/job-worker/src/playout/lookahead/index.ts	40.00%	28 Missing and 2 partials ⚠️
...ackages/job-worker/src/playout/timeline/rundown.ts	81.63%	18 Missing ⚠️
...src/ingest/model/implementation/IngestModelImpl.ts	73.21%	15 Missing ⚠️
packages/job-worker/src/blueprints/context/lib.ts	48.14%	14 Missing ⚠️
packages/job-worker/src/playout/infinites.ts	77.58%	12 Missing and 1 partial ⚠️
...s/job-worker/src/playout/timeline/multi-gateway.ts	0.00%	12 Missing ⚠️
packages/corelib/src/playout/infinites.ts	63.33%	11 Missing ⚠️
packages/job-worker/src/playout/adlibUtils.ts	10.00%	9 Missing ⚠️
packages/corelib/src/playout/processAndPrune.ts	94.59%	6 Missing ⚠️
... and 8 more

Additional details and impacted files

@@              Coverage Diff              @@
##           release53    #1406      +/-   ##
=============================================
+ Coverage      56.82%   56.96%   +0.14%     
=============================================
  Files            402      404       +2     
  Lines          72968    73678     +710     
  Branches        4463     4490      +27     
=============================================
+ Hits           41464    41974     +510     
- Misses         31363    31554     +191     
- Partials         141      150       +9     

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[codecov-commenter]

Codecov Report

❌ Patch coverage is 64.77901% with 255 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
packages/job-worker/src/blueprints/postProcess.ts	35.00%	52 Missing ⚠️
packages/job-worker/src/playout/lookahead/index.ts	20.00%	38 Missing and 2 partials ⚠️
...src/ingest/model/implementation/IngestModelImpl.ts	57.14%	24 Missing ⚠️
packages/job-worker/src/playout/infinites.ts	60.34%	22 Missing and 1 partial ⚠️
...ackages/job-worker/src/playout/timeline/rundown.ts	79.59%	20 Missing ⚠️
packages/job-worker/src/blueprints/context/lib.ts	48.14%	14 Missing ⚠️
packages/job-worker/src/ingest/expectedPackages.ts	20.00%	12 Missing ⚠️
...s/job-worker/src/playout/timeline/multi-gateway.ts	0.00%	12 Missing ⚠️
packages/corelib/src/playout/infinites.ts	63.33%	11 Missing ⚠️
...ckages/job-worker/src/playout/timeline/generate.ts	83.01%	9 Missing ⚠️
... and 14 more

📢 Thoughts on this report? Let us know!

[olzzon]

This has been tested, and documentation has been added.