Skip to content

Tracking event hardening#1459

Merged
korgon merged 3 commits intodevelopfrom
tracking-event-hardening
Mar 6, 2026
Merged

Tracking event hardening#1459
korgon merged 3 commits intodevelopfrom
tracking-event-hardening

Conversation

@korgon
Copy link
Contributor

@korgon korgon commented Mar 6, 2026

  • harden tracking events (prevent events from running when responseId not found in controller)
  • update beacon.js package version
  • update some documentation around beacon in tracker

Copilot AI review requested due to automatic review settings March 6, 2026 01:46
@korgon korgon linked an issue Mar 6, 2026 that may be closed by this pull request
@korgon korgon requested a review from dkonieczek March 6, 2026 01:46
Copy link
Contributor

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 defensive guard checks to tracking event methods across all three controller types (Search, Recommendation, Autocomplete) to prevent runtime errors when a responseId is not found in the controller's event tracking state. It also bumps the @athoscommerce/beacon dependency from 1.0.1 to 1.1.0 and updates documentation to point to the correct repository and uncomment previously-TODO sections.

Changes:

  • Added !this.events[responseId] guard checks in all tracking event methods (impression, click, clickThrough, addToCart) across SearchController, RecommendationController, and AutocompleteController to prevent events from firing when the responseId is not found.
  • Updated @athoscommerce/beacon from 1.0.1 to 1.1.0, which no longer depends on @searchspring/snap-toolbox.
  • Updated documentation in README.md and docs/documents.js to reference the correct athoscommerce/beacon.js GitHub repository and uncomment event method documentation.

Reviewed changes

Copilot reviewed 6 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
packages/snap-tracker/package.json Bumps @athoscommerce/beacon from 1.0.1 to 1.1.0
packages/snap-tracker/README.md Updates beacon.js links to athoscommerce org and uncomments events documentation
packages/snap-controller/src/Search/SearchController.ts Adds responseId guard checks to all 7 tracking event methods
packages/snap-controller/src/Recommendation/RecommendationController.ts Adds responseId guard checks to all 4 tracking event methods
packages/snap-controller/src/Autocomplete/AutocompleteController.ts Adds responseId guard checks to all 7 tracking event methods
package-lock.json Reflects beacon version bump and removed @searchspring/snap-toolbox transitive dependency
docs/documents.js Removes commented-out TODO links for beacon.js docs

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@korgon korgon merged commit 7397393 into develop Mar 6, 2026
1 check passed
@korgon korgon deleted the tracking-event-hardening branch March 6, 2026 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tracking Warnings

3 participants