-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add missing client types #234
Conversation
There are lots of new example types in contexture-elasticsearch that had not been accounted for in contexture-client.
🦋 Changeset detectedLatest commit: 18f8402 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Coverage after merging feature/add-missing-client-types into main will be
Coverage Report
|
@@ -360,4 +360,87 @@ export default F.stampKey('type', { | |||
search: null, | |||
}, | |||
}, | |||
dateIntervalGroupStats: { | |||
reactors: { | |||
groupField: 'self', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For my education, looking at the file I usually see self
, others
and all
as valid values, what do they mean?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These values tell contexture-client what to mark as "dirty" when that property changes
self
means mark the node the property belongs to as "dirty"others
means mark nodes that depend on the node the property belongs to as "dirty"all
is a combination of bothself
andothers
A node is a contexture tree node. For example one of these: https://github.com/smartprocure/contexture/blob/main/packages/client/src/listeners.test.js#L22-L27
If this all sounds confusing then you're not alone. It's not a complicated mental model, we just don't have TypeScript types or good enough documentation in these packages today.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love it! Could you clarify what do you mean by "dirty", or, when can we consider a node is "dirty"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Dirty means that we need to call the backend to get results for that node. The contexture-client library can either submit debounced backend requests when nodes are marked as "dirty" or it can wait for the user to click "Search" to send the request.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Confirming that by linking to contexture-client
, it works like a charm.
Screen.Recording.2024-06-24.at.11.14.26.mov
@JBezerra Thanks for the review! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to go!
There are lots of new example types in contexture-elasticsearch that had not been accounted for in contexture-client.