Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds debounced analytics tracking for variable search interactions in the Variable Outline UI, integrating with the existing bpmn-js-tracking hook/service pattern.
Changes:
- Add a debounced
variableOutline:searchedtracking event when the search input is used (without sending the query). - Add test coverage to verify debounce behavior, privacy (no term), and no-op behavior when tracking is absent.
- Add
min-dashas a runtime dependency to use itsdebouncehelper.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| package.json | Adds min-dash dependency required for debounce. |
| package-lock.json | Locks min-dash as a production dependency (not dev-only). |
| lib/components/Search/Search.jsx | Implements debounced tracking on non-empty search input changes and cancels on clear/unmount. |
| lib/components/Search/test/Search.spec.jsx | Adds tracking-focused tests (debounce, collapsing keystrokes, clearing, privacy, absence). |
| CHANGELOG.md | Documents the new feature entry. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or 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
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.
Proposed Changes
This pull request aims to introduce a tracking event for the search action. We are currently not debouncing the search function, but debouncing the tracking function is something we should already have.
I plan to test some diagrams with 500-1000 variables in the list and search among them to see if it makes sense to also debounce the search function to smoothen the user-experience if needed.
Checklist
Ensure you provide everything we need to review your contribution:
Closes {LINK_TO_ISSUE}orRelated to {LINK_TO_ISSUE}@bpmn-io/srtool