feat: add snapshot creation to Stable API

[ianshade]

About the Contributor

This pull request is posted on behalf of TV 2 Norge

Type of Contribution

This is a:

Feature

Current Behavior

New Behavior

It is possible to take system and rundown playlist snapshots through the HTTP API.

A few extra options are available:

• withDeviceSnapshots - will include the device snapshots
• withTimeline - will include the Timeline (only for an active playlist)
• withArchivedDocuments - previously called a full snapshot, (only for a playlist)

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

This PR affects the HTTP API of Sofie Core, where the new feature is added. To achieve that, the internals of the existing Snapshot API were modified slightly.

Time Frame

Not urgent, but it would be nice to have in release 52

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 22.51462% with 265 lines in your changes missing coverage. Please review.

Project coverage is 56.37%. Comparing base (054dcb1) to head (806b0db).
Report is 33 commits behind head on release52.

Files with missing lines	Patch %	Lines
meteor/server/api/rest/v1/snapshots.ts	0.00%	81 Missing and 1 partial ⚠️
meteor/server/api/snapshot.ts	15.49%	60 Missing ⚠️
meteor/server/lib/rest/v1/snapshots.ts	0.00%	51 Missing and 1 partial ⚠️
meteor/server/api/rest/v1/middlewares.ts	0.00%	33 Missing and 1 partial ⚠️
meteor/server/api/rest/v1/typeConversion.ts	0.00%	18 Missing ⚠️
meteor/server/api/rest/v1/types.ts	0.00%	8 Missing ⚠️
meteor/server/api/userActions.ts	0.00%	4 Missing ⚠️
meteor/server/api/rest/v1/idempotencyService.ts	95.12%	1 Missing and 1 partial ⚠️
meteor/server/api/rest/v1/index.ts	0.00%	2 Missing ⚠️
meteor/server/cronjobs.ts	0.00%	1 Missing ⚠️
... and 2 more

Additional details and impacted files

@@              Coverage Diff              @@
##           release52    #1373      +/-   ##
=============================================
- Coverage      56.48%   56.37%   -0.12%     
=============================================
  Files            401      406       +5     
  Lines          72257    72576     +319     
  Branches        4170     4586     +416     
=============================================
+ Hits           40816    40913      +97     
- Misses         31204    31409     +205     
- Partials         237      254      +17     

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