Skip to content

feat: track search usage#62

Open
barinali wants to merge 1 commit intointroduce-trackingfrom
track-search
Open

feat: track search usage#62
barinali wants to merge 1 commit intointroduce-trackingfrom
track-search

Conversation

@barinali
Copy link
Contributor

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:

  • Contribution meets our definition of done
  • Pull request establishes context
    • Link to related issue(s), i.e. Closes {LINK_TO_ISSUE} or Related to {LINK_TO_ISSUE}
    • Brief textual description of the changes
    • Screenshots or short videos showing UI/UX changes
    • Steps to try out, i.e. using the @bpmn-io/sr tool

@barinali barinali self-assigned this Mar 20, 2026
Copilot AI review requested due to automatic review settings March 20, 2026 21:33
@bpmn-io-tasks bpmn-io-tasks bot added the needs review Review pending label Mar 20, 2026
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:searched tracking 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-dash as a runtime dependency to use its debounce helper.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs review Review pending

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants