Do not add facet limit unless it is known. #1989
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
dkinzer
force-pushed
the
only-add-known-facet-to-query
branch
2 times, most recently
from
6d71659
to
82f5462
Compare
dkinzer
added a commit
to tulibraries/tul_cob
that referenced
this pull request
Oct 23, 2018
REF BL-712 REF projectblacklight/blacklight#1989 ## Issue Description After some QA testing, Jackie and I were talking further about the persistence of filters between Articles and the Solr menu options, and realized that there were some issues with this. For instance, even when there is a field match (author, topic, resource type), each index uses different vocabularies such that the values frequently don't match, leading to no results. We also felt that it might be confusing if some filters persisted (ex. date) while others didn't. So as a result, we'd like to scale this back and have just the basic query persist between Articles and the other options. Even in cases where the user has switched the basic query for "All Fields" to something else (ex. Title), it will revert back to All Fields. The relationship between Books, Journals, and More will remain as is, however. ## Implementation Description This issue is a result of the upstream code being promiscuous with respect to allowing any facet like user parameter to be turned into a facet filter for the query. Thus, it is not possible to have multiple facet url parameters that should not be shared with all searches. By adding a check at the search build level that skips adding a facet if the facet field in the parameter is not known (via configuration), then multiple searches can co-exist in the same URL and not clash. An upstream PR has been submitted to fix this issue at the root, hopefully it will be accepted.
sensei100
pushed a commit
to tulibraries/tul_cob
that referenced
this pull request
Oct 23, 2018
REF BL-712 REF projectblacklight/blacklight#1989 ## Issue Description After some QA testing, Jackie and I were talking further about the persistence of filters between Articles and the Solr menu options, and realized that there were some issues with this. For instance, even when there is a field match (author, topic, resource type), each index uses different vocabularies such that the values frequently don't match, leading to no results. We also felt that it might be confusing if some filters persisted (ex. date) while others didn't. So as a result, we'd like to scale this back and have just the basic query persist between Articles and the other options. Even in cases where the user has switched the basic query for "All Fields" to something else (ex. Title), it will revert back to All Fields. The relationship between Books, Journals, and More will remain as is, however. ## Implementation Description This issue is a result of the upstream code being promiscuous with respect to allowing any facet like user parameter to be turned into a facet filter for the query. Thus, it is not possible to have multiple facet url parameters that should not be shared with all searches. By adding a check at the search build level that skips adding a facet if the facet field in the parameter is not known (via configuration), then multiple searches can co-exist in the same URL and not clash. An upstream PR has been submitted to fix this issue at the root, hopefully it will be accepted.
dkinzer
force-pushed
the
only-add-known-facet-to-query
branch
7 times, most recently
from
d5ba820
to
2c0de14
Compare
|
@dkinzer this is just sanity checking then, right? If the facet isn't defined, i.e. a bad config/typo in facet setting, then don't add it to the query? |
|
@cdmo effectively yes. If we are passing some facets over URL params the app shouldn't just pass these to solr backend if they are not actually defined / configured at the controller level. |
dkinzer
force-pushed
the
only-add-known-facet-to-query
branch
from
eacdab9
to
7854cb6
Compare
barmintor
force-pushed
the
only-add-known-facet-to-query
branch
from
7854cb6
to
b03929b
Compare
|
I think these changes are effectively in-place via other refactors, but I have rebased against |
This commit updates the code that adds facet limits from user supplied parameters so that facets are only added if they have been configured as facet fields. This is done to allow for multiple faceted searches to be defined in the same URL while still keeping the facets separate.
barmintor
force-pushed
the
only-add-known-facet-to-query
branch
from
b03929b
to
a9031a1
Compare
barmintor
reviewed
Apr 27, 2022
spec/features/search_spec.rb
Outdated
|
|
||
| it "sanitizes searches with unconfigured facet parameters" do | ||
| visit root_path f: { missing_s: [1] } | ||
| expect(page).not_to have_text "Missing S" |
There was a problem hiding this comment.
I think this is a useful thing to check, but I'm wary of "page doesn't have text" tests - high likelihood of false passes. I wonder if we could now re-implement this as a ConstraintsComponent test?
There was a problem hiding this comment.
@dkinzer I've added a spec against the ConstraintsComponent that exercises this expectation in context. Okay to remove this feature spec?
barmintor
approved these changes
Apr 27, 2022
|
Waiting on CI to merge, thanks for this work @dkinzer |
cbeer
pushed a commit
that referenced
this pull request
Jul 31, 2022
* Verify search builder not adding facet limit unless it is configured. This commit updates the code that adds facet limits from user supplied parameters so that facets are only added if they have been configured as facet fields. This is done to allow for multiple faceted searches to be defined in the same URL while still keeping the facets separate. * verify constraints component does not render unconfigured facets Co-authored-by: Benjamin Armintor <armintor@gmail.com>
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.
REF: #1990
This commit updates the code that adds facet limits from user supplied
parameters so that facets are only added if they have been configured
as facet fields. This is done to allow for multiple faceted searches to
be defined in the same URL while still keeping the facets separate.