feat: Apply data enhancement to realtime results for specific doctypes #1411
Conversation
| * @returns {null} The component does not display anything. | ||
| */ | ||
| const RealTimeQueries = ({ doctype }) => { | ||
| const RealTimeQueries = ({ doctype, customNormalization }) => { |
There was a problem hiding this comment.
Nice! Maybe we should have the ability to customize the "normalization" by event (create / update / delete).
Also, I would have done that outside of the normalization step, because here it's not a normalization anymore, it's a "business logical" before dispatching the result.
I didn't have a good naming yet, but :
customComputeDocumentFromRealtime can be more appropriated?
In fact, we already have this computeDocumentFromRealtime without knowing it... :
{ ...couchDBDoc, _deleted: true },
So this one cas ben the default on deleteEvent.
cballevre
force-pushed
the
feat/custom-normalization-realtime-queries
branch
from
9c74f68
to
7b9d75a
Compare
cballevre
force-pushed
the
feat/custom-normalization-realtime-queries
branch
from
7b9d75a
to
68a7512
Compare
| @@ -0,0 +1,39 @@ | |||
| import { Q } from '../queries/dsl' | |||
| import CozyClient from '../CozyClient' | |||
There was a problem hiding this comment.
nit: Prefer absolute path rather than relative 😉
| const handleDeleted = data => { | ||
| let options = {} | ||
| if (doctype === 'io.cozy.files') { | ||
| options.computeDeletedDoc = ensureFilePath |
There was a problem hiding this comment.
It's a detail, but I'm not sure it's worth naming differently each method with "delete", "create", "update"
There was a problem hiding this comment.
There's no advantage in doing this in-house now 👍
| @@ -54,9 +47,23 @@ const dispatchChange = ( | |||
| * @param {object} client - CozyClient instance | |||
| * @param {import("../types").Doctype} doctype - Doctype of the document to create | |||
| * @param {import("../types").CouchDBDocument} couchDBDoc - Document to create | |||
| * @param {object} [options] Options | |||
| * @param {function} [options.computeCreatedDoc] Optional function to transform the normalized document before dispatch | |||
There was a problem hiding this comment.
computeCreatedDoc sounds ok, but maybe a applyAttributeComputation would be clearer: it better suggests that it is a function, you can reuse it whether it is a create/update/delete, and it explicit mention it is used for attribute computation.
There was a problem hiding this comment.
Good point 👍 I used the term enhance to mean the improvement of an existing object. @paultranvan does it seems more clearer ?
cballevre
changed the title
This enrichment closes the gap between the results of queries from the cozy-stack and realtime. In fact, realtime returns the document directly from the database, unlike the stack, which can add computed fields. Without them, it can lead to instable behaviour in applications. Some applications fix some issue by reimplementing the RealTimeQueries component. This commit aims to provide unifed api to avoid duplicated code. It can also be used as a reference when we want to close the gap.
cballevre
force-pushed
the
feat/custom-normalization-realtime-queries
branch
from
68a7512
to
7bd3a29
Compare
This enrichment closes the gap between the results of queries from the cozy-stack and realtime. In fact, realtime returns the document directly from the database, unlike the stack, which can add computed fields. Without them, it can lead to instable behaviour in applications. Some applications fix some issue by reimplementing the RealTimeQueries component.
This commit aims to provide unifed api to avoid duplicated code. It can also be used as a reference when we want to close the gap.
Applications reimplementation :
Note :
A function similar to
ensureFilePathexists in the models, but I chose to implement a new one to avoid dependencies with the models because we want to extract them from cozy-client