feat(analytics-controller): add optional invocation options for track, identify, view#8701
Open
gauthierpetetin wants to merge 3 commits into
Open
feat(analytics-controller): add optional invocation options for track, identify, view#8701gauthierpetetin wants to merge 3 commits into
gauthierpetetin wants to merge 3 commits into
Conversation
…, identify, view Forward AnalyticsInvocationOptions (context, callback, messageId, timestamp) from AnalyticsController to AnalyticsPlatformAdapter for trackEvent, identify, and trackView. Extend adapter method signatures with optional third argument. Export AnalyticsContext and AnalyticsInvocationCallback. Co-authored-by: Cursor <cursoragent@cursor.com>
gauthierpetetin
force-pushed
the
feat/analytics-invocation-options
branch
from
7a3f783 to
002a571
Compare
gauthierpetetin
temporarily deployed
to
default-branch
GitHub Actions
Inactive
Co-authored-by: Cursor <cursoragent@cursor.com>
| /** | ||
| * Optional context object attached to the invocation. | ||
| */ | ||
| context?: AnalyticsContext; |
Contributor
There was a problem hiding this comment.
Q: there's already a context attached by Segment SDK, how does this interfere with it?
| /** | ||
| * Optional callback when the invocation completes or fails. | ||
| */ | ||
| callback?: AnalyticsInvocationCallback; |
Contributor
There was a problem hiding this comment.
Q: What are the use cases of this? The tracking should never block or interfere with UX, so it's best effort and errors are handled inside controller, right?
| /** | ||
| * Optional stable identifier for deduplication or tracing. | ||
| */ | ||
| messageId?: string; |
Contributor
There was a problem hiding this comment.
Q; we already have a message ID in the Segment payload. How is this different?
| /** | ||
| * Optional event time. ISO strings, Unix timestamps in milliseconds, or Date values are typical. | ||
| */ | ||
| timestamp?: Date | number | string; |
Contributor
There was a problem hiding this comment.
Q: we already have a timestamp in Segment payload. How is this different?
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
2 participants
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.
Explanation
Add the possibility to forward
context,callback,messageId, andtimestampto AnalyticsController for trackEvent, identify, and trackView functions, , as this is needed in Extension.References
NA
Checklist
Note
Medium Risk
Changes the
AnalyticsPlatformAdapterinterface and controller method signatures to accept a new options object, which may require updates in downstream adapter implementations. Also adjusts event-splitting behavior to mutatemessageIdfor anonymous/sensitive events, which could affect deduplication/tracing semantics.Overview
Adds support for forwarding invocation metadata through
AnalyticsController.trackEvent,identify, andtrackViewintoAnalyticsPlatformAdaptercalls via a newAnalyticsInvocationOptionstype (includescontext,callback,messageId,timestamp).When anonymous-event splitting is enabled and an invocation
messageIdis provided, the controller now derives a distinctmessageIdfor the anonymous/sensitive counterpart to avoid SDK deduping. Tests, exports, and changelog were updated accordingly.Reviewed by Cursor Bugbot for commit 5f45ca2. Bugbot is set up for automated code reviews on this repo. Configure here.