✨ [Frontend] Event-driven PATCH trigger

[odeimaiz]

What do these changes do?

This PR changes the timing of when the PATCHES to the backend are triggered.

We currently, every 3", serialize and deep-compare the frontend's current study JSON state to the one in the backend (the frontend keeps a copy of it). This diff is curated and the backend updates its state. The drawbacks of this approach are that:

• it's not very efficient because deep comparisons can be expensive (~50ms in our case)
• unnecessary diffs even when there are no changes
• it is not collaborative friendly

Now, and only when WEBSERVER_REALTIME_COLLABORATION is enabled, we move to an event-driven patching system, where we listen to changes in the study and trigger the patching process. For now, no changes in the patching process: we still compute the diff and send it to the backend. Since we don't want to overload the backend with patches that can happen in chain, there is a throttling mechanism that will wait 500ms and then patch. Even though the frontend still doesn't send the atomic patch data, it does generate the patch model proposed in here and we might eventually move there.

We listen to changes on

name
description
thumbnail
workbench
  {nodeId}
    key
    version
    label
    inputs
    inputNodes
    inputsRequired
    inputsUnits
    outputs // only file-picker and parameter
    bootOptions
    progress // only file-picker
ui
  workbench
    {nodeId}
      position
      marker
  slideshow
  currentNodeId // this is personal, so eventually this won't be patched or the backend won't broadcast it
  mode // this is personal, so eventually this won't be patched or the backend won't broadcast it
  annotations
    {annotationId}
      position
      attributes
      color
dev
templateType

Demos:

Changes: study.name, study.workbench.$nodeId.[label, inputNodes, bootOptions] and study.ui.workbench.$nodeId.position

Changes: study.workbench.$nodeId.inputs

Changes: Study.ui.workbench.$nodeId.marker and Study.ui.annotations/$annotationId

Related issue/s

• related to Simultaneous access to a pipeline in view-only mode (Aug.) osparc-issues#1647

How to test

Dev-ops

[odeimaiz]

@mergify queue

[mergify]

queue

✅ The pull request has been merged automatically

The pull request has been merged automatically at 3ecd9de

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[matusdrobuliak66]

🚀