feat: Expose real time dispatch changes function #1532
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zatteo
requested review from
Merkur39,
paultranvan and
cballevre
as code owners
paultranvan
approved these changes
Sep 18, 2024
zatteo
force-pushed
the
feat/realtime-direct-update
branch
from
dc17427
to
6026040
Compare
When in a React environment, we use the RealTimeQueries component to subscribe to a doctype changes and keep the internal store updated. To be able to do the same thing manually for non React environment, we expose the underlaying functions : dispatchCreate, dispatchCreate, dispatchDelete.
zatteo
force-pushed
the
feat/realtime-direct-update
branch
from
6026040
to
fb807e0
Compare
If `CozyClient` is imported into those files, then unit tests fail.
Using `@param {import('../CozyClient').default} client` syntax
doesn't work either as this syntax is not handled by `jsdoc`.
Jsdoc seems to support this syntax in later versions but then
node engine should be updated.
So client will be temporarily typed as `object` until a better solution
is found.
paultranvan
reviewed
Sep 18, 2024
| @@ -1,6 +1,5 @@ | |||
| import { Mutations } from '../queries/dsl' | |||
There was a problem hiding this comment.
This is really nitpicking, but why the plural in realtimes.js? There is only one, right?
There was a problem hiding this comment.
Yeah... I should change it. It was because other file were plurals in the folder...
| @@ -22,7 +21,7 @@ const normalizeDoc = (couchDBDoc, doctype) => { | |||
| /** | |||
| * DispatchChange | |||
| * | |||
| * @param {CozyClient} client CozyClient instane | |||
| * @param {object} client CozyClient instane | |||
There was a problem hiding this comment.
Why removing the CozyClient type?
There was a problem hiding this comment.
I had issues with tests when moving the functions in the a file that is imported and exported in /store/index. I found other commit fixing the same issue. Here is the explanation.
If `CozyClient` is imported into those files, then unit tests fail.
Using `@param {import('../CozyClient').default} client` syntax
doesn't work either as this syntax is not handled by `jsdoc`.
Jsdoc seems to support this syntax in later versions but then
node engine should be updated.
So client will be temporarily typed as `object` until a better solution
is found.
d77999a
to
981a4c2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When in a React environment, we use the RealTimeQueries component to subscribe to a doctype changes and keep the internal store updated.
To be able to do the same thing manually for non React environment, we expose the underlaying functions : dispatchCreate, dispatchCreate, dispatchDelete.