Send Rudder eventId/event_id/messageId as TikTok event_id #2568

mgryszko · 2025-11-04T14:38:44Z

PR Description

TikTok Pageview events are missing event_id, which makes them harder to inspect and correlate to RudderStack page calls.

If the PR is approved, please update the documentation for TikTok Ads Device Mode Integration, Page section.

Linear task (optional)

Cross Browser Tests

Please confirm you have tested for the following browsers:

Chrome
Firefox
IE11

Sanity Suite

All sanity suite test cases pass locally

Security

The code changed/added as part of this pull request won't create any security issues with how the software is being used.

Summary by CodeRabbit

Release Notes

New Features
- Enhanced TikTok Ads integration with improved page event tracking, properly extracting event_id from multiple sources with priority handling and including partner information.
Tests
- Added comprehensive test coverage for page event handling and event_id source prioritization to ensure reliable data mapping.

coderabbitai · 2025-11-04T14:38:59Z

📝 Walkthrough

Walkthrough

This pull request adds page-level event tracking to the TikTok Ads integration. A new pageMapping constant is introduced to configure event_id source resolution, a getPageResponse utility function prepares page event properties, and the page handler is updated to use this utility with partner name enrichment.

Changes

Cohort / File(s)	Summary
Test Suite Updates `packages/analytics-js-integrations/__tests__/integrations/TikTokAds/browser.test.js`	Renamed test descriptions for consistency (tiktokads → TikTokAds); replaced single "send pageview" test with multiple tests validating event_id extraction from properties.eventId, properties.event_id, and messageId with priority ordering; extended assertions to verify window.ttq.page is called with event_id and partner_name.
Constants Definition `packages/analytics-js-integrations/src/integrations/TiktokAds/constants.js`	Added new `pageMapping` constant mirroring `trackMapping` structure to map page-level event_id sources (properties.eventId, properties.event_id, messageId); updated exports to include `pageMapping`.
Utility Functions `packages/analytics-js-integrations/src/integrations/TiktokAds/util.js`	Added `getPageResponse(message)` function to build page event properties using `pageMapping` and append partner_name; updated exports to include `getPageResponse` alongside `getTrackResponse`.
Browser Integration `packages/analytics-js-integrations/src/integrations/TiktokAds/browser.js`	Updated page handler to import and use `getPageResponse` utility; changed from direct `window.ttq.page()` call to computing `updatedProperties` via `getPageResponse(message)` before passing to page method.

Sequence Diagram

sequenceDiagram
    participant App as Application
    participant Browser as browser.js
    participant Util as util.js
    participant Constants as constants.js
    participant SDK as window.ttq

    App->>Browser: page(rudderElement)
    Browser->>Util: getPageResponse(message)
    Util->>Constants: pageMapping
    Constants-->>Util: pageMapping config
    Util->>Util: Extract event_id from<br/>properties.eventId,<br/>properties.event_id,<br/>or messageId
    Util->>Util: Add partner_name<br/>Remove undefined values
    Util-->>Browser: updatedProperties
    Browser->>SDK: window.ttq.page(updatedProperties)
    SDK-->>App: Event tracked

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

The changes follow consistent patterns established by existing track functionality, with pageMapping directly mirroring trackMapping and getPageResponse mirroring getTrackResponse. Test additions are homogeneous and repetitive. The integration in browser.js is straightforward method refactoring.

Pre-merge checks

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and accurately summarizes the main change: sending Rudder event identifiers (eventId/event_id/messageId) as TikTok event_id, which is the primary objective of this PR.
Description check	✅ Passed	The pull request description includes all required sections with proper completion: PR Description explaining the problem and solution, Cross Browser Tests confirmed for all three required browsers (Chrome, Firefox, IE11), Sanity Suite confirmed passed, and Security assessment completed.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/analytics-js-integrations/src/integrations/TiktokAds/constants.js (1)
74-79: Consider extracting the common event_id mapping to reduce duplication.

The event_id mapping in pageMapping (lines 74-78) is identical to the first entry in trackMapping (lines 19-23). While the separation of page and track mappings is reasonable for clarity, you could extract the common event_id mapping entry to reduce duplication.

For example:
+const eventIdMapping = {
+  destKey: 'event_id',
+  sourceKeys: ['properties.eventId', 'properties.event_id', 'messageId'],
+};
+
 const trackMapping = [
-  {
-    destKey: 'event_id',
-    sourceKeys: ['properties.eventId', 'properties.event_id', 'messageId'],
-  },
+  eventIdMapping,
   {
     destKey: 'test_event_code',
     sourceKeys: 'testEventCode',
   },
   // ... rest of mappings
 ];

-const pageMapping = [
-  {
-    destKey: 'event_id',
-    sourceKeys: ['properties.eventId', 'properties.event_id', 'messageId'],
-  },
-];
+const pageMapping = [eventIdMapping];

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e143bf6 and 62adf95.

📒 Files selected for processing (4)

packages/analytics-js-integrations/__tests__/integrations/TikTokAds/browser.test.js (4 hunks)
packages/analytics-js-integrations/src/integrations/TiktokAds/browser.js (2 hunks)
packages/analytics-js-integrations/src/integrations/TiktokAds/constants.js (2 hunks)
packages/analytics-js-integrations/src/integrations/TiktokAds/util.js (2 hunks)

🧰 Additional context used

📓 Path-based instructions (6)

**/*.{js,jsx,ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/002-javascript-typescript.mdc)

Code must work in browsers AND service workers (no Node.js APIs)

Files:

packages/analytics-js-integrations/src/integrations/TiktokAds/util.js
packages/analytics-js-integrations/src/integrations/TiktokAds/browser.js
packages/analytics-js-integrations/src/integrations/TiktokAds/constants.js
packages/analytics-js-integrations/__tests__/integrations/TikTokAds/browser.test.js

packages/*/src/**