Add metadata to data being sent to API endpoint in json dump registration backend

[viktorvanwijk]

Closes #5012

Changes

Add metadata to data being sent to API endpoint in JSON dump registration backend

Checklist

Check off the items that are completed or not relevant.

• Impact on features

  • Checked copying a form
  • Checked import/export of a form
  • Config checks in the configuration overview admin page
  • Problem detection in the admin email digest is handled

• Release management

  • I have labelled the PR as "needs-backport" accordingly

• I have updated the translations assets (you do NOT need to provide translations)

  • Ran ./bin/makemessages_js.sh
  • Ran ./bin/compilemessages_js.sh

• Dockerfile/scripts

  • Updated the Dockerfile with the necessary scripts from the ./bin folder

• Commit hygiene

  • Commit messages refer to the relevant Github issue
  • Commit messages explain the "why" of change, not the how

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.73%. Comparing base (53752fa) to head (58b6492).
Report is 9 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #5053   +/-   ##
=======================================
  Coverage   96.72%   96.73%           
=======================================
  Files         770      771    +1     
  Lines       26534    26588   +54     
  Branches     3452     3458    +6     
=======================================
+ Hits        25666    25720   +54     
  Misses        606      606           
  Partials      262      262           

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

[viktorvanwijk]

Few design considerations:

Tried making the JSONDumpOptionsSerializer.required_metadata_variables field read_only, but then it won't be available in validated_data of the serializer, which is passed to the JSONDumpRegistration.register_submission. Thought about overwriting validated_data and adding the required_metadata_variables manually, but didn't seem like the right thing to do. Or adding a non-field constant for the default values of required_metadata_variables, so it can be accessed easily from the plugin without instantiating the serializer, but not sure if there are any best practises for that.

To show all metadata variables (additional and required) in the metadata selection box, and grey out all variables which are required by default, thought about adding the registration variables to the VariablesSelection component. But, because they are just static variables, they would all be added to this group in the drop-down menu. And afaik we cannot guarantee unique keys between regular static variables and registration variables (or registration variables of different plugins as well). So I would have to redo the grouping of variables in this component, and wasn't sure it would be worth it, or even desired behaviour.

[sergei-maertens]

Looks good, I think it's mostly polishing from here on :)

[sergei-maertens]

Neat!

One more thing that caught my attention in storybook is that your help texts for the form fields don't end with a <kbd>.</kbd>, which looks odd and is inconsistent with (most of) the other form fields.

So, form label can be without, help text/tooltip should be with period as they are typically actual sentences (or should be!).