Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: gtm messageId support for track and page #1709

Merged
merged 2 commits into from
May 16, 2024
Merged

Conversation

shrouti1507
Copy link
Contributor

@shrouti1507 shrouti1507 commented May 8, 2024

PR Description

user ask : to support messageId in track and page call in order to deduplicate events.
ref : https://developers.google.com/tag-platform/tag-manager/datalayer#one_push_multiple_variables

Linear task (optional)

Resolves INT-2092

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

  • New Features
    • Enhanced Google Tag Manager integration to include messageId in event properties, improving tracking precision.
  • Tests
    • Added comprehensive tests for Google Tag Manager integration, covering initialization, user identification, event tracking, and page views.

Copy link
Contributor

coderabbitai bot commented May 8, 2024

Walkthrough

The recent updates focus on enhancing the Google Tag Manager integration within a JavaScript analytics framework. New test cases have been added for various functionalities including event tracking and user identification. Additionally, the sendEventToGTM method in the Google Tag Manager class now includes a messageId property, improving tracking precision.

Changes

File Path Change Summary
.../analytics-js-integrations/__tests__/.../browser.test.js Introduced test cases for Google Tag Manager integration, covering initialization, event tracking, user identification, and page views.
.../analytics-js-integrations/src/.../browser.js Enhanced the sendEventToGTM method by adding messageId to the properties sent to GTM.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@shrouti1507 shrouti1507 added the enhancement New feature or request label May 8, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between f62b758 and a386726.
Files selected for processing (2)
  • packages/analytics-js-integrations/tests/integrations/GoogleTagManager/browser.test.js (1 hunks)
  • packages/analytics-js-integrations/src/integrations/GoogleTagManager/browser.js (2 hunks)
Additional comments not posted (5)
packages/analytics-js-integrations/src/integrations/GoogleTagManager/browser.js (2)

61-61: The addition of messageId to the track method supports event deduplication effectively.


91-91: The inclusion of messageId in the page method is correctly implemented to support event deduplication.

packages/analytics-js-integrations/__tests__/integrations/GoogleTagManager/browser.test.js (3)

44-48: The test for the init method correctly verifies that loadNativeSdk is called with the appropriate parameters.


88-114: The test for the track method adequately checks that the correct properties, including messageId, are sent to the dataLayer.


117-165: The tests for the page method are comprehensive and correctly verify that the correct properties, including messageId, are sent to the dataLayer for different scenarios.

Copy link

codecov bot commented May 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.41%. Comparing base (6d4ccbc) to head (c7cd5e3).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1709      +/-   ##
===========================================
+ Coverage    54.27%   54.41%   +0.14%     
===========================================
  Files          462      462              
  Lines        15655    15655              
  Branches      3096     3107      +11     
===========================================
+ Hits          8497     8519      +22     
+ Misses        5877     5845      -32     
- Partials      1281     1291      +10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

github-actions bot commented May 8, 2024

size-limit report 📦

Name Size (Base) Size (Current) Size Limit Status
Common Code - No bundling 15.78 KB 15.78 KB (0%) 16.5 KB
Remote Module Federation Mapping - CDN 330 B 330 B (0%) 512 B
Remote Module Federated Plugins - CDN 5.71 KB 5.71 KB (0%) 6 KB
Core ESM - NPM 7.68 KB 7.68 KB (0%) 8 KB
Core CJS - NPM 22.89 KB 22.89 KB (0%) 23 KB
Core - NPM 23.02 KB 23.02 KB (0%) 23.5 KB
Core Legacy - CDN 43.37 KB 43.37 KB (0%) 44 KB
Core - CDN 23.16 KB 23.16 KB (0%) 23.5 KB
Core (legacy build) - CDN - v1.1 31.53 KB 31.53 KB (0%) 32 KB
Core - NPM - v1.1 31.55 KB 31.55 KB (0%) 32 KB
Service Worker Module 22.64 KB 22.64 KB (0%) 24 KB
All Integrations (legacy build) - CDN 98.69 KB 98.62 KB (-0.08% ▼) 105 KB

Copy link
Member

@saikumarrs saikumarrs left a comment

Choose a reason for hiding this comment

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

The integration changes LGTM. However, I did not review the test suite.

Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@shrouti1507 shrouti1507 merged commit 90df013 into develop May 16, 2024
9 checks passed
@shrouti1507 shrouti1507 deleted the enhance.gtm branch May 16, 2024 05:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants