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

fix: ga4 allow zero #1915

Merged
merged 6 commits into from
Nov 15, 2024
Merged

fix: ga4 allow zero #1915

merged 6 commits into from
Nov 15, 2024

Conversation

aanshi07
Copy link
Contributor

@aanshi07 aanshi07 commented Nov 11, 2024

PR Description

This PR allows customers to pass a value of 0, resolving the previous restriction.

Linear task (optional)

Resolves INT-2844

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

    • Introduced a new utility function for enhanced validation of payload values, improving error handling for missing required data.
  • Bug Fixes

    • Improved robustness of the validation process, leading to more accurate data structure validation without altering existing functionality.
  • Tests

    • Added a new test suite for the prepareStandardEventParams function to ensure correct handling of various input scenarios, including zero and mixed data types.

@aanshi07 aanshi07 self-assigned this Nov 11, 2024
@aanshi07 aanshi07 requested a review from a team as a code owner November 11, 2024 12:06
Copy link
Contributor

coderabbitai bot commented Nov 11, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes introduce a new utility function isDefinedAndNotNull from the commonUtils module to enhance the validation logic in the prepareStandardEventParams function within the GA4 integration. This function improves the validation process by checking if a required value in the payload is defined and not null, replacing a previous truthy check. The import statement for commonUtils has been updated to include this new function, while the overall structure and functionality of the integration remain unchanged.

Changes

File Path Change Summary
packages/analytics-js-integrations/src/integrations/GA4/utils.js Added isDefinedAndNotNull function from commonUtils for improved validation in prepareStandardEventParams. Updated import statement accordingly.
packages/analytics-js-integrations/tests/integrations/GA4/utils.test.js Introduced a new test suite for prepareStandardEventParams to verify handling of zero values in properties.

Suggested reviewers

  • saikumarrs

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b96f603 and c675615.

📒 Files selected for processing (1)
  • packages/analytics-js-integrations/__tests__/integrations/GA4/utils.test.js (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/analytics-js-integrations/tests/integrations/GA4/utils.test.js

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

Copy link

codecov bot commented Nov 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 57.54%. Comparing base (07909cf) to head (c675615).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1915      +/-   ##
===========================================
+ Coverage    57.52%   57.54%   +0.02%     
===========================================
  Files          485      485              
  Lines        16505    16506       +1     
  Branches      3315     3305      -10     
===========================================
+ Hits          9494     9498       +4     
- Misses        5732     5757      +25     
+ Partials      1279     1251      -28     

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

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

🧹 Outside diff range and nitpick comments (1)
packages/analytics-js-integrations/src/integrations/GA4/utils.js (1)

11-11: Well-structured changes with good architectural choices.

The implementation:

  1. Makes a precise improvement to validation logic
  2. Maintains clean separation of concerns
  3. Follows existing patterns in the codebase
  4. Properly handles error cases with logging

As mentioned in the PR objectives, please ensure cross-browser testing in Chrome, Firefox, and IE11 to verify the behavior of this validation change.

Also applies to: 300-300

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b4c9ffa and 93fc704.

📒 Files selected for processing (1)
  • packages/analytics-js-integrations/src/integrations/GA4/utils.js (2 hunks)
🔇 Additional comments (2)
packages/analytics-js-integrations/src/integrations/GA4/utils.js (2)

11-11: LGTM: Import statement updated appropriately.

The addition of isDefinedAndNotNull to the commonUtils imports is well-placed and aligns with its usage in the validation logic.


300-300: Validation logic improvement correctly handles zero values.

The change from a truthy check to isDefinedAndNotNull is a good improvement that allows zero values while maintaining proper validation for undefined/null values. This aligns with the PR objective to allow customers to pass a value of 0.

Let's verify the behavior with different edge cases:

coderabbitai[bot]
coderabbitai bot previously approved these changes Nov 11, 2024
Copy link

github-actions bot commented Nov 11, 2024

size-limit report 📦

Name Size (Base) Size (Current) Size Limit Status
Plugins Module Federation Mapping - Legacy - CDN 332 B 332 B (0%) 512 B
Plugins - Legacy - CDN 15.71 KB 15.71 KB (0%) 16 KB
Plugins Module Federation Mapping - Modern - CDN 331 B 331 B (0%) 512 B
Plugins - Modern - CDN 7.2 KB 7.2 KB (0%) 7.5 KB
Common - No bundling 16.27 KB 16.27 KB (0%) 16.5 KB
Cookies Utils - Legacy - NPM (ESM) 1.54 KB 1.54 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (CJS) 1.75 KB 1.75 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (UMD) 1.53 KB 1.53 KB (0%) 2 KB
Cookies Utils - Modern - NPM (ESM) 1.17 KB 1.17 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (CJS) 1.4 KB 1.4 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (UMD) 1.16 KB 1.16 KB (0%) 1.5 KB
Load Snippet 778 B 778 B (0%) 1 KB
Core (v1.1) - NPM (ESM) 30.32 KB 30.32 KB (0%) 32 KB
Core (v1.1) - NPM (CJS) 30.52 KB 30.52 KB (0%) 32 KB
Core (v1.1) - NPM (UMD) 30.34 KB 30.34 KB (0%) 32 KB
Core (Content Script - v1.1) - NPM (ESM) 29.89 KB 29.89 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (CJS) 30.04 KB 30.04 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (UMD) 29.98 KB 29.98 KB (0%) 30 KB
Core - Legacy - CDN 48.51 KB 48.51 KB (0%) 49 KB
Core - Modern - CDN 24.75 KB 24.75 KB (0%) 25 KB
Service Worker - Legacy - NPM (ESM) 30.56 KB 30.56 KB (0%) 31 KB
Service Worker - Legacy - NPM (CJS) 30.83 KB 30.83 KB (0%) 31 KB
Service Worker - Legacy - NPM (UMD) 30.65 KB 30.65 KB (0%) 31 KB
Service Worker - Modern - NPM (ESM) 25.74 KB 25.74 KB (0%) 26 KB
Service Worker - Modern - NPM (CJS) 26 KB 26 KB (0%) 26.5 KB
Service Worker - Modern - NPM (UMD) 25.75 KB 25.75 KB (0%) 26 KB
Core - Legacy - NPM (ESM) 48.33 KB 48.33 KB (0%) 48.5 KB
Core - Legacy - NPM (CJS) 48.6 KB 48.6 KB (0%) 49 KB
Core - Legacy - NPM (UMD) 48.36 KB 48.36 KB (0%) 48.5 KB
Core - Modern - NPM (ESM) 24.5 KB 24.5 KB (0%) 25 KB
Core - Modern - NPM (CJS) 24.74 KB 24.74 KB (0%) 25 KB
Core - Modern - NPM (UMD) 24.53 KB 24.53 KB (0%) 25 KB
Core (Bundled) - Legacy - NPM (ESM) 48.33 KB 48.33 KB (0%) 48.5 KB
Core (Bundled) - Legacy - NPM (CJS) 48.58 KB 48.58 KB (0%) 49 KB
Core (Bundled) - Legacy - NPM (UMD) 48.36 KB 48.36 KB (0%) 48.5 KB
Core (Bundled) - Modern - NPM (ESM) 39.48 KB 39.48 KB (0%) 40 KB
Core (Bundled) - Modern - NPM (CJS) 39.75 KB 39.75 KB (0%) 40 KB
Core (Bundled) - Modern - NPM (UMD) 39.49 KB 39.49 KB (0%) 40 KB
Core (Content Script) - Legacy - NPM (ESM) 47.83 KB 47.83 KB (0%) 48 KB
Core (Content Script) - Legacy - NPM (CJS) 48.06 KB 48.06 KB (0%) 48.5 KB
Core (Content Script) - Legacy - NPM (UMD) 47.8 KB 47.8 KB (0%) 48 KB
Core (Content Script) - Modern - NPM (ESM) 38.96 KB 38.96 KB (0%) 39.5 KB
Core (Content Script) - Modern - NPM (CJS) 39.2 KB 39.2 KB (0%) 40 KB
Core (Content Script) - Modern - NPM (UMD) 38.93 KB 38.93 KB (0%) 39 KB
All Integrations - Legacy - CDN 94.83 KB 94.73 KB (-0.11% ▼) 95.3 KB
All Integrations - Modern - CDN 89.92 KB 90.01 KB (+0.1% ▲) 91 KB

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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 93fc704 and 8b890c7.

📒 Files selected for processing (2)
  • packages/analytics-js-integrations/__tests__/integrations/GA4/utils.test.js (2 hunks)
  • packages/analytics-js-integrations/src/integrations/GA4/utils.js (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/analytics-js-integrations/src/integrations/GA4/utils.js
🔇 Additional comments (2)
packages/analytics-js-integrations/__tests__/integrations/GA4/utils.test.js (2)

13-13: LGTM: Import statement follows existing patterns

The addition of prepareStandardEventParams to the imports is consistent with the existing import structure.


383-410: Verify cross-browser compatibility and GA4 requirements

Since this PR requires cross-browser testing and involves GA4 integration:

  1. Ensure the test suite runs successfully across Chrome, Firefox, and IE11
  2. Verify that zero values are accepted by GA4's API

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

🧹 Outside diff range and nitpick comments (1)
packages/analytics-js-integrations/__tests__/integrations/GA4/utils.test.js (1)

406-409: Remove redundant comments

The inline comments are redundant as the test description and assertions already make it clear that we're testing zero values.

-        total: 0, // Total is 0 but should pass without failure
-        value: 0, // Value is 0 but should pass without failure
-        revenue: 0, // Revenue is 0 but should pass without failure
-        price: 0, // Price is 0 but should pass without failure
+        total: 0,
+        value: 0,
+        revenue: 0,
+        price: 0,
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8b890c7 and b96f603.

📒 Files selected for processing (1)
  • packages/analytics-js-integrations/__tests__/integrations/GA4/utils.test.js (2 hunks)
🔇 Additional comments (3)
packages/analytics-js-integrations/__tests__/integrations/GA4/utils.test.js (3)

13-13: LGTM!

The import statement is correctly updated to include the new utility function.


342-387: LGTM! Comprehensive test coverage for PII handling

The test cases effectively cover:

  • Multiple PII fields
  • Edge cases (undefined, empty object)
  • Different data types

393-538: LGTM! Comprehensive test coverage

The test suite thoroughly covers various scenarios:

  • Zero values handling
  • Mixed data types
  • Optional fields
  • Negative values
  • Complex scenarios with metadata

The tests are well-structured with clear setup, execution, and assertion phases.

coderabbitai[bot]
coderabbitai bot previously approved these changes Nov 15, 2024
Copy link

sonarcloud bot commented Nov 15, 2024

@aanshi07 aanshi07 merged commit 9ebbab9 into develop Nov 15, 2024
12 checks passed
@aanshi07 aanshi07 deleted the fix.ga4_allow_zero branch November 15, 2024 10:06
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.

3 participants