feat: datafiles action type json

[nitrosx]

Description

This PR add the option to create a datafile action in json format.
It will submit a request to the specified URL with the payload in json format in the body. The results from the request will be saved by the browser in a file with the named specified in the action configuration.
The structure of the payload can be specified in configuration

There is the matching backend PR to update the frontend config file: 1800

Motivation

sciwyrm (Jupiter notebook generator) accepts only requests formatted as json.
ESS is currently deploying it in their infrastructure.

Changes:

Please provide a list of the changes implemented by this PR

• datafiles actions controller

Tests included

• Included for each change/fix?
• Passing? (Merge will not be approved unless this is checked)

Documentation

• swagger documentation updated [required]
• official documentation updated [nice-to-have] - in progress

official documentation info

If you have updated the official documentation, please provide PR # and URL of the pages where the updates are included

Backend version

• Does it require a specific version of the backend
• which version of the backend is required:

Summary by Sourcery

New Features:

• Introduces a new 'json-download' action type for datafiles, enabling requests to be sent with a JSON payload.

[sourcery-ai]

Hey @nitrosx - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding error handling to the fetch call in type_json.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

suggestion (bug_risk): Consider handling the fetch promise to manage asynchronous errors.

The current implementation calls fetch without awaiting its result or handling potential errors. This might lead to unhandled rejections or race conditions if the response is used later. Consider refactoring this method as an async function and using async/await, or at least adding a .then/.catch to deal with the promise resolution.

Suggested implementation:

  async handleAction() {

    try {
      const response = await fetch(this.actionConfig.url, {
        method: this.actionConfig.method || "POST",
        headers: { "Content-Type": "application/json" },
        body: JSON.stringify(data),
      });

      if (!response.ok) {
        throw new Error(`Network response was not ok: ${response.statusText}`);
      }

      return true;
    } catch (error) {
      console.error("Fetch error:", error);
      return false;
    }

Ensure that any callers of handleAction() are updated to handle the Promise returned by this async method.

[bpedersen2]

Yes, I am looking forward, as this makes writing action consumers much easier.

[bpedersen2]

The ai comments are not related to this change, but should probably be considered fr a separate change.