fix(core): various fixes and improvements to studio search [v2] #4704
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
… _id from whole word score generation
…ons and weighting
…UNSTABLE_SEARCH_DEPTH environment variable
…isplay skipped paths in generated search specs
…d support for defining MAX_UNIQUE_ATTRIBUTES via env var
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
…exclude _id from whole word score generation
robinpyon
force-pushed
the
fix/2.x-weightedSearch
branch
from
1e14b70
to
1004aa7
Compare
robinpyon
changed the title
RitaDias
reviewed
Jul 18, 2023
bjoerge
approved these changes
Jul 19, 2023
There was a problem hiding this comment.
Really excellent work @robinpyon!
Left a few comments inline, nothing big, so good to merge from what I can tell.
| if (childType.jsonType === 'string') { | ||
| return [...acc, {path, weight: 1}] | ||
| } | ||
| if (isPortableTextArray(childType)) { |
There was a problem hiding this comment.
good catch - should we "forwardport" this to current?
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.
Description
This PR brings a number of fixes and minor improvements to studio search in v2. Please refer to the internal slack thread for more context.
Search path generation:
SEARCH_DEPTH_LIMIT) has increased significantly (now 15, up from 4)SEARCH_PATH_LIMIT) generated per root-level object (defaults to 500)These changes help ensure that deeper fields are more easily searchable, whilst the path limit per object ensures a reasonable cap when dealing with recursive structures, preventing the client from hanging when generating these on studio initialisation.
Search query generation:
SEARCH_ATTR_LIMIT) included in search queries (defaults to 1000).__experimental_searchpaths are always included, regardless of the limit defined above_idand_typefields twice in object projections, also reducing response sizes slightlycreateSearchQueryfunction (in addition to the existingcreateWeightedSearch)Combined with the changes to search path generation, this should mean that type-constrained searches (e.g. filtering by document types) should be able to access much more deeply nested fields. In most 'regular' cases (i.e. studio schema without recursive / circular structures), users should be able to search beyond the original 4 level limit we had before, even when searching across all document types.
Search weighting / scoring:
storiesincluded in eachWeightedHitnow also includesindices– a value which indicates any matching array indices, where applicable. Custom search implementations can use this to visually surface additional context.__experimental_searchNew unstable environment variables (which override the above):
SANITY_STUDIO_UNSTABLE_SEARCH_ATTR_LIMITSANITY_STUDIO_UNSTABLE_SEARCH_DEPTH_LIMITSANITY_STUDIO_UNSTABLE_SEARCH_PATH_LIMITWhat to review
fo,teson the test studio) – these should now be ordered much more intuitivelyNotes for release