Reducing the number of paths of remote-change event

[hackerwins]

Description:

Reducing the number of paths of remote-change events.

Changes to the document are propagated to peers as remote-change events.
When inserting nested objects, there is a problem that the path becomes excessively large.

For example, inserting a nested object into one field will create paths for remote-change like this:

clientA inserts nested object.

doc.update((root) => {
  root.projects = [{
    id: 'id7fb51ad',
    _timestamp: 1641431282095,
    _time:834.9000000357628,
    visible:true,
    lock:false,
    selected:false,
    layers":[{
    ...
  }]
});

Currently clientB receives remote-change event.

{
  type: 'remote-change'
  value: {
    paths: [
      '$.projects',
      '$.projects.0',
      '$.projects.0.id',
      '$.projects.0._timestamp',
      '$.projects.0._time',
      '$.projects.0.visible',
      '$.projects.0.lock',
      '$.projects.0.selected',
      '$.projects.0.layers',
      '$.projects.0.layers.0',
      ...
    ]
  }
}

We can reduce paths by leaving only the top-level path when the nested object changes.

{
  type: 'remote-change'
  value: {
    paths: ['$.projects']
  }
}

Why:

Excessive accumulation of paths can lead to unnecessary resource usage.

[hunkim98]

✋ May I try this out? I have experienced this nuisance when creating a yorkie example on my own.

[hackerwins]

@hunkim98 Sure. 👍

[hackerwins]

This was solved by #691.