feat(SearchParameters): avoid undefined values #703

samouss · 2019-05-10T10:41:42Z

This PR updates the internals of the SearchParameters to avoid undefined values inside the search parameters. This change allows to easily merge multiple SearchParameters top-down since we don't have "ghost" value on the object. The outcome is the change of semantics for the parameters and setters:

query is omit: params does not have query e.g. searchBox not mounted
query: '': params does have an empty query e.g. searchBox mounted with initial state
query: 'Apple': params does have a query refinement e.g. searchBox mounted with refinement

setQuery(): omit the query e.g. widget.dispose
setQuery(''): sets the default value for the query e.g. widget.getConfiguration
setQuery('Apple'): sets the given value for the query e.g. widget.refine

src/SearchParameters/index.js

* refactor(SearchParameters): omit undefined values on mutation * refactor(SearchParameters): remove unused method mutateMe * test(setQueryParameters): simplify assertions * refactor(SearchParameters): omit undefined values on creation * refactor(SearchParameters): invert condition for known keys

* fix(merge): change implementation (#716) 29c2138 * chore: mention remaining changes f756947 * chore(deps): update circleci/node:8.15.1 docker digest to ef1a0c4 (#715) f4dab89 * chore(lodash): remove _.omit (#655) 7db8b4c * chore(lodash): remove lodash from dependency list (#705) a63ec6b, closes #552 * chore(release): allow canary release (#712) 3eb087c * chore(removeHierarchicalFacetRefinement): remove error if not refined (#747) e68ecfe * chore: merge develop into master (#750) 53c7c62 * chore: remove Bower support (#711) e7518e2 * chore(ts): add methods d051f79 * chore(ts): add ruleContexts to SP 4bdc4a4 * chore(ts): add searchOnlyWithDerivedHelpers (#739) c6aa31b * chore(ts): publish definition file too 1813462 * chore(TS): isNumericRefined has only one required argument cac8fc3 * chore(warn): remove unused function (lodash.bind) (#682) c59b7e3 * chore: update release command 0989880 * docs: add link to wiki 3598f2a * docs: update event signature (#701) bbe4634 * docs(migration): mention changed methods (#732) f95e680 * docs(next): add migration guide 8430137 * docs(serverUsed): mention getRankingInfo (#706) f258c2a, closes #500 * feat: implement dedicated reset page method (#673) 666501e * feat(getState): remove filter option (#707) ac52791 * feat(getState): remove getState (#708) 7de698c * feat(requestBuilder): prevent needless extra requests for empty refinements (#737) db0a392 * feat(search): allow the search only with Derived Helpers (#704) aa128fc * feat(SearchParameters): avoid undefined values (#703) 9757e0a * feat(typescript): move typings inline (#719) a12272e * fix(defaults): remove const 48a0c48 * fix(errors): remove isRefined (#731) 5761885 * fix(getConjunctiveRefinements): no error when requested facet is not conjunctive (#724) cf852e7 * fix(getDisjunctiveRefinements): remove error (#725) 211e390 * fix(getExcludeRefinements): replace error by default value (#726) 9d7ae87 * fix(getFacetStats): remove error (#721) 96b6ec8 * fix(getFacetValues): don't throw error when there's no facet (#720) e15e39e * fix(getHierarchicalFacetBreadcrumb): don't throw an error (#723) 40e1d61 * fix(isDisjunctiveFacetRefined): return false if not in disjunctiveFacets (#729) 13ec09b * fix(isExcludeRefined): remove error in favor of false (#728) 3f0ab6b * fix(isFacetRefined): return false if facet isn't declared (#727) 7151f56 * fix(isHierarchicalFacetRefined): return false if refinement isn't a facet (#730) 89fa010 * fix(lodash/intersection): replace with custom implementation (#718) 00dfb4e * fix(removeXFacet): make sure this fully removes empty arrays (#743) ea5a22a * fix(results): remove lodash looping over objects (#648) bb025c2, closes #258 * fix(sortBy): compare whole prefix instead of first character (#702) b85fb50, closes #702 * fix(toggleRefinement): keep an empty array when clearing (#738) 5b3fc11 * fix(types): add state.removeNumericRefinement (#742) e58c24a * refactor(addAgent): remove duplicate code (#657) d023efd * refactor(error): use object vs list of arguments (#700) 722eceb * refactor(lodash): compact (#689) 284efa5 * refactor(lodash): forOwn (#697) eae367a * refactor(lodash): intersection (#696) 25822a5 * refactor(lodash): map & trim (#679) 357fcb7 * refactor(lodash): merge (#694) 92bced4 * refactor(lodash): partial & partialRight (#693) 7ceea2f * refactor(lodash): remove filter (#685) 249d2e6 * refactor(lodash): remove flatten (#695) 9da0e08 * refactor(lodash): remove forEach (#674) 8c93765 * refactor(lodash): remove reduce (#678) 7907805 * refactor(lodash): remove simple functions (#656) c309ffa * refactor(lodash): remove startsWith (#690) bb00933 * refactor(lodash): replace defaults with pure alternative (#692) ee07132 * refactor(lodash): replace find & findIndex (#687) 92e7c23 * refactor(lodash): replace orderBy (#698) bb2b31e * refactor(lodash): sumBy (#688) a538bd9 * refactor(result): use object vs list of arguments (#699) 643f18e * refactor(search): emit object (#683) 46c7d7d * refactor(searchForFacetValues): use object vs list of arguments (#684) ab8e9c5 * refactor: remove getQueryParameter (#713) d9dfac4 * refactor(searchOnce): use object vs list of arguments (#681) 42b40d3 * refactor(SearchParameters): removes default values (#670) b15696b * refactor(url): remove url helpers (#652) 52e22f4 * test(sffv): no longer test impossible responses (#686) fd878e8 ### BREAKING CHANGE * getState(filters) is replaced my manually filtering the returned object * removed helper.isRefined, use helper.hasRefinements instead * SearchParameters.filter is removed * doc(filter): remove reference * use helper.state instead of helper.getState()

…-helper-js#703) * refactor(SearchParameters): omit undefined values on mutation * refactor(SearchParameters): remove unused method mutateMe * test(setQueryParameters): simplify assertions * refactor(SearchParameters): omit undefined values on creation * refactor(SearchParameters): invert condition for known keys

samouss requested a review from a team May 10, 2019 10:41

ghost requested review from francoischalifour and yannickcr and removed request for a team May 10, 2019 10:41

samouss force-pushed the feat/undefined branch from b3a698f to 4942fbd Compare May 10, 2019 11:56

Haroenv reviewed May 10, 2019

View reviewed changes

src/SearchParameters/index.js Show resolved Hide resolved

Haroenv reviewed May 10, 2019

View reviewed changes

src/SearchParameters/index.js Show resolved Hide resolved

samouss added 4 commits May 10, 2019 17:33

refactor(SearchParameters): omit undefined values on mutation

4587b2f

refactor(SearchParameters): omit undefined values on creation

0a5dde6

refactor(SearchParameters): remove unused method mutateMe

d031b35

test(setQueryParameters): simplify assertions

2da2b08

samouss force-pushed the feat/undefined branch from 4942fbd to 2da2b08 Compare May 10, 2019 15:34

francoischalifour approved these changes May 13, 2019

View reviewed changes

src/SearchParameters/index.js Outdated Show resolved Hide resolved

src/SearchParameters/index.js Show resolved Hide resolved

refactor(SearchParameters): invert condition for known keys

6e70524

samouss merged commit 33ffc63 into next May 14, 2019

samouss deleted the feat/undefined branch May 14, 2019 07:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(SearchParameters): avoid undefined values #703

feat(SearchParameters): avoid undefined values #703

samouss commented May 10, 2019 •

edited

Loading

feat(SearchParameters): avoid undefined values #703

feat(SearchParameters): avoid undefined values #703

Conversation

samouss commented May 10, 2019 • edited Loading

samouss commented May 10, 2019 •

edited

Loading