refactor(core): move options diff to core #5908
Draft
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
Still open questions - how to do `insights` (does middleware need update option too?) (do we handle anything other than init props) - how to warn/error for routing/onStateChange (or do we handle it?) - test that it works properly of course - should some of the code in constructor be moved to update?
dhayab
reviewed
Oct 26, 2023
Comment on lines
+910
to
+927
| // TODO: implement update in middleware | ||
| // TODO: can this be simplified? | ||
| // if (!dequal(this._insights, options.insights)) { | ||
| // this._insights = options.insights; | ||
| // const existing = this.middleware.find( | ||
| // (m) => m.instance.$$type === 'ais.insights' && m.instance.$$internal | ||
| // ); | ||
| // if (options.insights && existing) { | ||
| // // TODO: update existing middleware somehow (or maybe remount it) | ||
| // } else if (options.insights && !existing) { | ||
| // const insightsOptions = | ||
| // typeof options.insights === 'boolean' ? {} : options.insights; | ||
| // insightsOptions.$$internal = true; | ||
| // this.use(createInsightsMiddleware(insightsOptions)); | ||
| // } else if (!options.insights && existing) { | ||
| // this.unuse(existing.creator); | ||
| // } | ||
| // } |
There was a problem hiding this comment.
I'd love for middlewares to remove some of the load from this method. Maybe we could iterate over middlewares, call their update() method, and get a returned value (boolean? object?) which could tell InstantSearch.update() to unuse them.
There was a problem hiding this comment.
in this case probably existing.update(options.insights) and handling that somehow in the middleware indeed was best, wasn't sure whether the api was worth the coals
dhayab
reviewed
Oct 26, 2023
Comment on lines
+931
to
+937
| // Updating the `routing` prop is not supported because InstantSearch.js | ||
| // doesn't let us change it. This might not be a problem though, because `routing` | ||
| // shouldn't need to be dynamic. | ||
| // If we find scenarios where `routing` needs to change, we can always expose | ||
| // it privately on the InstantSearch instance. Another way would be to | ||
| // manually inject the routing middleware in this library, and not rely | ||
| // on the provided `routing` prop. |
There was a problem hiding this comment.
Still can't see why routing would need to change during the lifecycle of an InstantSearch app 😅.
There was a problem hiding this comment.
yeah I'd rather ignore or show an error than handling it
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.
Summary
We deal with updating of parameters of InstantSearch in both React InstantSearch and Vue InstantSearch, in different ways. This PR aims to fix that, by moving the updating to core.
Result
search.update(props: Partial<Options>)Still open questions:
insights(does middleware need update option too?) (do we handle anything other than init props)