feat: http url interpolation SOFIE-3310

[Julusian]

About the Contributor

This pull request is posted on behalf of the NRK.

Type of Contribution

This is a Feature

New Behavior

This allows for defining the urls for the httpsend device, as well as urls passed to the renderers in sofieChef and casparcg, in a format that allows for taking fragments from the datastore.

For example an object could look something like:

{
  deviceType: 'httpSend',
  type: 'post',
  url: {
    key: `http://example.com/{{subPath}?apiKey={{apiKey}}`,
    args: {
      subPath: 'my-default', // Overriden by the datastore
      apiKey: '', // Taken from datastore
    }
  },
  $references: {
    'url.args.subPath': {
      datastoreKey: 'httpSubpath',
      overwrite: true,
    },
    'url.args.apiKey': {
      datastoreKey: 'httpApiKey',
      overwrite: false,
    }
  }
}

In this example, the 'apiKey' will be taken from the datastore, avoiding being baked into the rundown.
And the 'subPath' being taken from the datastore, means it can be changed while playing the rundown more easily.

The syntax of the interpolation matches the translations format we use elsewhere in Sofie.

This has been added to the httpSend and sofieChef devices, and to casparcg for the html content type

Testing Instructions

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-commenter]

Codecov Report

Attention: Patch coverage is 95.23810% with 1 line in your changes missing coverage. Please review.

Project coverage is 55.76%. Comparing base (7acebc8) to head (eb3c376).
Report is 4 commits behind head on release51.

Files	Patch %	Lines
packages/timeline-state-resolver/src/lib.ts	90.90%	1 Missing ⚠️

Additional details and impacted files

@@              Coverage Diff              @@
##           release51     #342      +/-   ##
=============================================
+ Coverage      55.71%   55.76%   +0.04%     
=============================================
  Files            129      129              
  Lines          10117    10130      +13     
  Branches        2446     2515      +69     
=============================================
+ Hits            5637     5649      +12     
- Misses          4103     4104       +1     
  Partials         377      377              

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