Skip to content

/ gutenberg

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

Jump to bottom

Improve the block and patterns search algorithm #25105

Merged
merged 9 commits into from Sep 7, 2020
Merged

Improve the block and patterns search algorithm #25105

merged 9 commits into from Sep 7, 2020

Conversation

@youknowriad
Copy link
Contributor

@youknowriad youknowriad commented Sep 7, 2020

closes #14868
closes #24651

This PR improves the search algorithm for blocks and patterns by implementing a rank-based search:

The blocks are ordered as follows:

  • Search term matches the title
  • Search term matches the start of the title
  • Other matches (keywords, category, collection)

Also, if the block is a "core" block, it has a bonus point.

Note that the search algorithm doesn't work properly for block variations, the issue there is not from the search algorithm but more from the inserter where we consider the variations and the blocks as a single "item". A separate refactoring should be done to improve that.
@youknowriad youknowriad requested a review from ellatrix as a code owner Sep 7, 2020
@youknowriad youknowriad self-assigned this Sep 7, 2020
@youknowriad
Improve the block and patterns search algorithm
Loading status checks…
6a15336
@youknowriad youknowriad force-pushed the update/better-search-algorithm branch to 6a15336 Sep 7, 2020
@youknowriad youknowriad requested review from mtias and ntsekouras Sep 7, 2020
@github-actions
Copy link

@github-actions github-actions bot commented Sep 7, 2020 •
edited

Size Change: +171 B (0%)

Total Size: 1.2 MB

Filename Size Change
build/block-editor/index.js 128 kB +206 B (0%)
build/block-library/style-rtl.css 7.59 kB -14 B (0%)
build/block-library/style.css 7.58 kB -14 B (0%)
build/data/index.js 8.55 kB -7 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/annotations/index.js 3.67 kB 0 B
build/api-fetch/index.js 3.41 kB 0 B
build/autop/index.js 2.82 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/index.js 8.5 kB 0 B
build/block-directory/style-rtl.css 953 B 0 B
build/block-directory/style.css 952 B 0 B
build/block-editor/style-rtl.css 11.1 kB 0 B
build/block-editor/style.css 11.1 kB 0 B
build/block-library/editor-rtl.css 8.64 kB 0 B
build/block-library/editor.css 8.64 kB 0 B
build/block-library/index.js 138 kB 0 B
build/block-library/theme-rtl.css 754 B 0 B
build/block-library/theme.css 754 B 0 B
build/block-serialization-default-parser/index.js 1.88 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/blocks/index.js 47.7 kB 0 B
build/components/index.js 200 kB 0 B
build/components/style-rtl.css 15.5 kB 0 B
build/components/style.css 15.5 kB 0 B
build/compose/index.js 9.67 kB 0 B
build/core-data/index.js 12.3 kB 0 B
build/data-controls/index.js 1.29 kB 0 B
build/date/index.js 31.9 kB 0 B
build/deprecated/index.js 772 B 0 B
build/dom-ready/index.js 568 B 0 B
build/dom/index.js 4.48 kB 0 B
build/edit-navigation/index.js 11.7 kB 0 B
build/edit-navigation/style-rtl.css 1.16 kB 0 B
build/edit-navigation/style.css 1.16 kB 0 B
build/edit-post/index.js 305 kB 0 B
build/edit-post/style-rtl.css 6.26 kB 0 B
build/edit-post/style.css 6.25 kB 0 B
build/edit-site/index.js 17.1 kB 0 B
build/edit-site/style-rtl.css 3.06 kB 0 B
build/edit-site/style.css 3.06 kB 0 B
build/edit-widgets/index.js 12 kB 0 B
build/edit-widgets/style-rtl.css 2.46 kB 0 B
build/edit-widgets/style.css 2.45 kB 0 B
build/editor/editor-styles-rtl.css 492 B 0 B
build/editor/editor-styles.css 493 B 0 B
build/editor/index.js 45.6 kB 0 B
build/editor/style-rtl.css 3.81 kB 0 B
build/editor/style.css 3.81 kB 0 B
build/element/index.js 4.64 kB 0 B
build/escape-html/index.js 733 B 0 B
build/format-library/index.js 7.71 kB 0 B
build/format-library/style-rtl.css 547 B 0 B
build/format-library/style.css 548 B 0 B
build/hooks/index.js 2.13 kB 0 B
build/html-entities/index.js 622 B 0 B
build/i18n/index.js 3.57 kB 0 B
build/is-shallow-equal/index.js 711 B 0 B
build/keyboard-shortcuts/index.js 2.52 kB 0 B
build/keycodes/index.js 1.94 kB 0 B
build/list-reusable-blocks/index.js 3.12 kB 0 B
build/list-reusable-blocks/style-rtl.css 476 B 0 B
build/list-reusable-blocks/style.css 476 B 0 B
build/media-utils/index.js 5.32 kB 0 B
build/notices/index.js 1.79 kB 0 B
build/nux/index.js 3.4 kB 0 B
build/nux/style-rtl.css 671 B 0 B
build/nux/style.css 668 B 0 B
build/plugins/index.js 2.56 kB 0 B
build/primitives/index.js 1.41 kB 0 B
build/priority-queue/index.js 789 B 0 B
build/redux-routine/index.js 2.85 kB 0 B
build/rich-text/index.js 13.9 kB 0 B
build/server-side-render/index.js 2.77 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/token-list/index.js 1.27 kB 0 B
build/url/index.js 4.06 kB 0 B
build/viewport/index.js 1.85 kB 0 B
build/warning/index.js 1.13 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action
@mtias
mtias reviewed Sep 7, 2020
View changes
packages/block-editor/src/components/inserter/search-items.js Outdated Show resolved Hide resolved
@mtias
mtias reviewed Sep 7, 2020
View changes
packages/block-editor/src/components/inserter/search-items.js Outdated Show resolved Hide resolved
@mcsf
mcsf approved these changes Sep 7, 2020
View changes
Copy link
Contributor

@mcsf mcsf left a comment

:)
packages/block-editor/src/components/inserter/search-items.js Outdated Show resolved Hide resolved
packages/block-editor/src/components/inserter/search-items.js Outdated Show resolved Hide resolved
packages/block-editor/src/components/inserter/search-items.js Outdated Show resolved Hide resolved
packages/block-editor/src/components/inserter/search-items.js Outdated Show resolved Hide resolved
packages/block-editor/src/components/inserter/search-items.js Outdated Show resolved Hide resolved
youknowriad and others added 4 commits Sep 7, 2020
@youknowriad
Allow using the block name to match search terms
Loading status checks…
296854f
@youknowriad
clarify comments
Loading status checks…
450b9a8
@youknowriad @mcsf
typo
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
16d37e8 
Co-authored-by: Miguel Fonseca <[email protected]>
@youknowriad @mcsf
copy
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
208aa49 
Co-authored-by: Miguel Fonseca <[email protected]>
@ntsekouras
ntsekouras reviewed Sep 7, 2020
View changes
Copy link
Contributor

@ntsekouras ntsekouras left a comment

I would probably add a unit test searchItems new ordering. Other than that and some minor comments this looks good!
packages/block-editor/src/components/inserter/search-items.js Outdated Show resolved Hide resolved
packages/block-editor/src/components/inserter/search-items.js Outdated Show resolved Hide resolved
packages/block-editor/src/components/inserter/search-items.js Outdated Show resolved Hide resolved
packages/block-editor/src/components/inserter/search-items.js Outdated Show resolved Hide resolved
packages/block-editor/src/components/inserter/search-items.js Show resolved Hide resolved
packages/block-editor/src/components/inserter/search-items.js Outdated Show resolved Hide resolved
youknowriad added 2 commits Sep 7, 2020
@youknowriad
Rename
Loading status checks…
9687b7c
@youknowriad
Use startsWith instead of indexOf
d8d4fe6
@mcsf
mcsf reviewed Sep 7, 2020
View changes
packages/block-editor/src/components/inserter/search-items.js Outdated Show resolved Hide resolved
youknowriad added 2 commits Sep 7, 2020
@youknowriad
add unit test
Loading status checks…
b2643ff
@youknowriad
Extract default search helpers
Loading status checks…
cab940b
@ntsekouras
ntsekouras approved these changes Sep 7, 2020
View changes
Copy link
Contributor

@ntsekouras ntsekouras left a comment

Nice one! 💯
@youknowriad youknowriad merged commit 612acd3 into master Sep 7, 2020
15 checks passed
15 checks passed
Cancel Previous Runs
Details
Check Check
Details
build
Details
Admin - 1
Details
Compare performance with master
Details
pull-request-automation
Details
test (gutenberg-editor-gallery)
Details
test (gutenberg-editor-gallery)
Details
All
Details
JavaScript
Details
Admin - 2
Details
PHP
Details
Admin - 3
Details
Mobile
Details
Admin - 4
Details
@youknowriad youknowriad deleted the update/better-search-algorithm branch Sep 7, 2020
@github-actions github-actions bot added this to the Gutenberg 9.0 milestone Sep 7, 2020
@youknowriad youknowriad mentioned this pull request Sep 7, 2020
Closed
@sirreal sirreal mentioned this pull request Sep 8, 2020
Closed
@mtias mtias mentioned this pull request Sep 22, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mcsf mcsf

@mtias mtias

@ntsekouras ntsekouras

@ellatrix ellatrix

Assignees

@youknowriad youknowriad

Labels
[Feature] Inserter [Type] Enhancement
Projects
None yet
Milestone
Gutenberg 9.0
Linked issues

Successfully merging this pull request may close these issues.

Vanilla Gutenberg blocks should be listed first
Prioritise exact block name match higher than partial category match
4 participants
@youknowriad @mcsf @mtias @ntsekouras
You can’t perform that action at this time.