Use search #2235

nikku · 2024-09-13T14:48:50Z

Proposed Changes

This plugs into the new search utility shipped with bpmn-io/diagram-js#916 / diagram-js@14.11.0, now updated and fixed via bpmn-io/diagram-js#932:

Try out via

npx @bpmn-io/sr bpmn-io/bpmn-js#use-search

Checklist

To ensure you provided everything we need to look at your PR:

Brief textual description of the changes present
Visual demo attached
Steps to try out present, i.e. using the @bpmn-io/sr tool
Related issue linked via Closes {LINK_TO_ISSUE} or Related to {LINK_TO_ISSUE}

Depends on bpmn-io/diagram-js#932

We ensure that for every entry that is a match we _always_ provide tokens. This ensures that a user can rely on these tokens being there, i.e. to render the results. Related to bpmn-io/bpmn-js#2235

This ensures we properly handle fuzzy results (again), i.e. when providing multiple search strings, return results that match on a best effort basis, rather than being overly strict: items = [ 'foo', 'bar' ] search = 'foo bar' result = [ 'foo', 'bar' ] The tokens allow folks to make sense of the actual parts of the results matched, and allow them to refine the search as they see fit. Along with this results are still scored, i.e. most reasonable results are first shown to the users. Related to bpmn-io/bpmn-js#2235

We ensure that for every entry that is a match we _always_ provide tokens. This ensures that a user can rely on these tokens being there, i.e. to render the results. Related to bpmn-io/bpmn-js#2235

This ensures we properly handle fuzzy results (again), i.e. when providing multiple search strings, return results that match on a best effort basis, rather than being overly strict: items = [ 'foo', 'bar' ] search = 'foo bar' result = [ 'foo', 'bar' ] The tokens allow folks to make sense of the actual parts of the results matched, and allow them to refine the search as they see fit. Along with this results are still scored, i.e. most reasonable results are first shown to the users. Related to bpmn-io/bpmn-js#2235

We ensure that for every entry that is a match we _always_ provide tokens. This ensures that a user can rely on these tokens being there, i.e. to render the results. Related to bpmn-io/bpmn-js#2235

This ensures we properly handle fuzzy results (again), i.e. when providing multiple search strings, return results that match on a best effort basis, rather than being overly strict: items = [ 'foo', 'bar' ] search = 'foo bar' result = [ 'foo', 'bar' ] The tokens allow folks to make sense of the actual parts of the results matched, and allow them to refine the search as they see fit. Along with this results are still scored, i.e. most reasonable results are first shown to the users. Related to bpmn-io/bpmn-js#2235

nikku · 2024-11-01T12:20:41Z

Upstream fixes most described isses: bpmn-io/diagram-js#932.

Try out the changes via

npx @bpmn-io/sr bpmn-io/bpmn-js#use-search

CC @lmbateman

This ensures we properly handle fuzzy results (again), where parts of the search is matched across different keys. This ensures we're not overly strict in filtering things. Related to bpmn-io/bpmn-js#2235

We ensure that for every entry that is a match we _always_ provide tokens. This ensures that a user can rely on these tokens being there, i.e. to render the results. Related to bpmn-io/bpmn-js#2235

This ensures we properly handle fuzzy results (again), where parts of the search is matched across different keys. This ensures we're not overly strict in filtering things. Related to bpmn-io/bpmn-js#2235

We ensure that for every entry that is a match we _always_ provide tokens. This ensures that a user can rely on these tokens being there, i.e. to render the results. Related to bpmn-io/bpmn-js#2235

This ensures we properly handle fuzzy results (again), where parts of the search is matched across different keys. This ensures we're not overly strict in filtering things. Related to bpmn-io/bpmn-js#2235

We ensure that for every entry that is a match we _always_ provide tokens. This ensures that a user can rely on these tokens being there, i.e. to render the results. Related to bpmn-io/bpmn-js#2235

This ensures we properly handle fuzzy results (again), where parts of the search is matched across different keys. This ensures we're not overly strict in filtering things. Related to bpmn-io/bpmn-js#2235

nikku · 2024-11-04T20:49:22Z

Previous observations, addressed by this PR as well as bpmn-io/diagram-js#932:

Some observations:

The search syntax and what is required by search-pad are incompatible, and require manual conversion. This is inconvenient. I do regard the new format (token = { value, matched: boolean }) to be supperior. Maybe we could make SearchPadProvider compatible with it?
search only returns tokens where they exist. This is inconvenient and requires me to manually check if tokens are return. Example: I test objects of the form { name: string } for the key label, and expect the result to contain { tokens: { label: [ ... ] } } regardless of whether any of the objects had a label property. Today, undefined is returned and must be accounted for.
We only return matched tokens, and do not return what did not match. This leads to changes in the output (it does no longer show previously visible information (i.e. the ID, whether or not it matched):

Overall we can see that this is quite an improvement, removing the heavy matching / tokenization from implementors. Great job 🎖️

This ensures we build upon the new search abstraction, built via bpmn-io/diagram-js#916.

Integrates improved search. Cf. https://github.com/bpmn-io/diagram-js/blob/develop/CHANGELOG.md#1510

philippfromme

Great stuff! Glad to see this in bpmn-js finally! 🥇

# Changes Siehe Changelog: https://github.com/bpmn-io/bpmn-js/blob/develop/CHANGELOG.md ## 18.1.2 * `FIX`: canvas `autoFocus` must explicitly be enabled ([bpmn-io/diagram-js#956](bpmn-io/diagram-js#956)) * `FIX`: properly integrate `zoomscroll` with canvas focus ([bpmn-io/diagram-js#956](bpmn-io/diagram-js#956)) * `FIX`: properly integrate `movecanvas` with canvas focus ([bpmn-io/diagram-js#956](bpmn-io/diagram-js#956)) ## 18.1.1 * `FIX`: adjust search to prioritize start of word and exact matches ([bpmn-io/diagram-js#953](bpmn-io/diagram-js#953)) * `FIX`: ignore whitespace when searching ([bpmn-io/diagram-js#954](bpmn-io/diagram-js#954)) ## 18.1.0 * `FIX`: clear selection when opening search pad ([bpmn-io/diagram-js#947](bpmn-io/diagram-js#947)) * `FIX`: correct dangling selection after search pad interaction ([bpmn-io/diagram-js#947](bpmn-io/diagram-js#947)) * `DEPS`: update to `diagram-js@15.2.2` ## 18.0.0 * `FEAT`: remove `outline` from `Viewer` modules ([bpmn-io#2135](bpmn-io#2135)) * `FEAT`: make `Canvas` a focusable element ([bpmn-io/diagram-js#662](bpmn-io/diagram-js#662)) * `FEAT`: implicit keyboard binding ([bpmn-io/diagram-js#662](bpmn-io/diagram-js#662)) * `FEAT`: integrate with global `search` ([bpmn-io#2235](bpmn-io#2235)) * `FEAT`: integrate `popup-menu` with `search` ([bpmn-io/diagram-js#932](bpmn-io/diagram-js#932)) * `FEAT`: recognize modern `search` tokens in `search-pad` ([bpmn-io/diagram-js#932](bpmn-io/diagram-js#932)) * `FIX`: correctly handle duplicate entries and whitespace in `search` ([bpmn-io/diagram-js#932](bpmn-io/diagram-js#932)) * `FIX`: find `search` terms across all keys ([bpmn-io/diagram-js#932](bpmn-io/diagram-js#932)) * `FIX`: `search` always returns tokens for matched items ([bpmn-io/diagram-js#932](bpmn-io/diagram-js#932)) * `FIX`: prevent crash during label adjustment ([bpmn-io#2239](bpmn-io#2239)) * `FIX`: keep existing loop characteristics when toggling through the replace menu ([bpmn-io#2251](bpmn-io#2251)) * `FIX`: prevent covering multi selection with black box in `Viewer` ([bpmn-io#2135](bpmn-io#2135)) * `FIX`: generate types for main entry ([`986e2bb`](bpmn-io@986e2bb)) * `FIX`: correct handling of group name with whitespace only ([bpmn-io#2231](bpmn-io#2231)) * `DEPS`: update to `bpmn-moddle@9` ([bpmn-io#2114](bpmn-io#2114)) * `DEPS`: update to `diagram-js@15.1.0` * `DEPS`: update to `diagram-js-direct-editing@3.2.0` ### Breaking Changes * Require `Node >= 20` * `Canvas` is now a focusable element and provides better support for native browser behaviors. Focus can be controlled with new `focus` and `restoreFocus` APIs ([bpmn-io/diagram-js#662](bpmn-io/diagram-js#662)). * Keyboard is now implicitly bound to canvas SVG element. Calls to `keyboard.bind` and `keyboard.bindTo` now result with a descriptive console error and have no effect ([bpmn-io/diagram-js#662](bpmn-io/diagram-js#662)). ## 17.11.1 * `FIX`: handle searching elements without labels ([bpmn-io#2232](bpmn-io#2232), [bpmn-io#2234](bpmn-io#2234)) ## 17.11.0 * `FEAT`: align search styles with other popups ([bpmn-io#2187](bpmn-io#2187)) * `FEAT`: prioritize start of tokens in search results ([bpmn-io#2187](bpmn-io#2187)) * `FIX`: do not commit viewport changes on `ESC` ([bpmn-io#2189](bpmn-io#2189), [bpmn-io#2187](bpmn-io#2187)) * `DEPS`: update to `diagram-js@14.10.0` ## 17.10.0 * `CHORE`: correct various type hints ([bpmn-io#2228](bpmn-io#2228)) * `FIX`: pasting compensation activity without boundary event ([bpmn-io#2070](bpmn-io#2070)) * `FIX`: lane resize constraints for se and nw direction ([bpmn-io#2209](bpmn-io#2209)) * `FIX`: auto place elements vertically in sub-processes ([bpmn-io#2127](bpmn-io#2127)) * `FIX`: hide lane label during direct editing * `DEPS`: update to `diagram-js@14.9.0` ## 17.9.2 * `FIX`: keep direction when collapsing pools ([bpmn-io#2208](bpmn-io#2208))

bpmn-io-tasks bot added the in progress Currently worked on label Sep 13, 2024

nikku requested a review from philippfromme September 13, 2024 14:48

bpmn-io-tasks bot assigned nikku Sep 13, 2024

nikku force-pushed the use-search branch from 7c7ae48 to 8211c1d Compare September 13, 2024 14:50

This comment was marked as outdated.

Sign in to view

nikku mentioned this pull request Sep 13, 2024

Popup menu search bpmn-io/diagram-js#916

Merged

This comment was marked as outdated.

Sign in to view

nikku requested a review from lmbateman October 10, 2024 14:03

This comment was marked as outdated.

Sign in to view

nikku mentioned this pull request Oct 10, 2024

Improve search (make fuzzy again and more robust) bpmn-io/diagram-js#932

Merged

4 tasks

nikku added the ready Ready to be worked on label Oct 11, 2024 — with bpmn-io-tasks

nikku removed the in progress Currently worked on label Oct 11, 2024

nikku force-pushed the use-search branch from 8211c1d to 595641d Compare November 1, 2024 12:19

nikku force-pushed the use-search branch from 595641d to 7091520 Compare November 1, 2024 13:03

nikku added the needs review Review pending label Nov 1, 2024 — with bpmn-io-tasks

nikku removed the ready Ready to be worked on label Nov 1, 2024

nikku added the fixed upstream Requires integration of upstream change label Nov 1, 2024 — with bpmn-io-tasks

nikku removed the needs review Review pending label Nov 1, 2024

nikku force-pushed the use-search branch from 7091520 to 8e65b11 Compare November 4, 2024 19:55

nikku force-pushed the use-search branch from 4c5fe89 to 918e836 Compare November 4, 2024 20:47

nikku added the needs review Review pending label Nov 4, 2024 — with bpmn-io-tasks

nikku removed the fixed upstream Requires integration of upstream change label Nov 4, 2024

nikku marked this pull request as ready for review November 4, 2024 20:48

nikku added the ux label Nov 4, 2024

nikku requested review from a team, jarekdanielak and abdul99ahad and removed request for a team November 4, 2024 20:54

nikku added 4 commits November 4, 2024 22:40

feat(search): integrate with unified search

824fa1c

This ensures we build upon the new search abstraction, built via bpmn-io/diagram-js#916.

test(draw): cleanup left over log statement

7e9c41f

deps: update to diagram-js@15.1.0

1693355

Integrates improved search. Cf. https://github.com/bpmn-io/diagram-js/blob/develop/CHANGELOG.md#1510

chore(CHANGELOG): update

28c1c2a

nikku force-pushed the use-search branch from 918e836 to 28c1c2a Compare November 4, 2024 21:44

philippfromme approved these changes Nov 5, 2024

View reviewed changes

nikku merged commit 911dbae into develop Nov 5, 2024
12 checks passed

bpmn-io-tasks bot removed the needs review Review pending label Nov 5, 2024

nikku deleted the use-search branch November 5, 2024 12:25

ElRaptorus mentioned this pull request Jan 9, 2025

Bump to 18.1.2 5minds/bpmn-js#9

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use search #2235

Use search #2235

nikku commented Sep 13, 2024 •

edited

Loading

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

nikku commented Nov 1, 2024 •

edited

Loading

nikku commented Nov 4, 2024

philippfromme left a comment

Use search #2235

Use search #2235

Conversation

nikku commented Sep 13, 2024 • edited Loading

Proposed Changes

Checklist

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

nikku commented Nov 1, 2024 • edited Loading

nikku commented Nov 4, 2024

philippfromme left a comment

Choose a reason for hiding this comment

nikku commented Sep 13, 2024 •

edited

Loading

nikku commented Nov 1, 2024 •

edited

Loading