fix: update logic for default true configs in AM, Chartbeat, GA and GoogleAds #1693

yashasvibajpai · 2024-04-16T22:54:59Z

PR Description

In the integration SDK's constructor, where we retrieve values from the destination configuration object, we often define default values for some fields.

In some of the integrations, it is incorrectly done for the boolean fields.

const configFieldValue = config.someFieldName || true;

The above logic is in place to ensure that we use a default value true if the field's value is not defined. However, it'll still fall back to the default value even if the field's actual value is false due to the || true condition.

So, even if the user toggles the field to off in the UI, the integration will always treat is on. Essentially, the field's value is hardcoded.

Linear task (optional)

Resolves INT-1805

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 tracking of new campaigns in Amplitude integration.
Refactor
- Improved default value assignment in Amplitude, Chartbeat, GA, and Google Ads integrations to handle null or undefined values more accurately.

…oogleAds

coderabbitai · 2024-04-16T22:55:07Z

Walkthrough

The recent updates across various analytics integration packages focus on refining how default values are assigned in JavaScript. By replacing the logical OR operator (||) with the nullish coalescing operator (??), the code now more accurately handles cases where values are null or undefined, ensuring that defaults are applied only when necessary.

Changes

File Path	Change Summary
`.../Amplitude/browser.js`	Updated `trackNewCampaigns` assignment using `??` to better handle `null` or `undefined`.
`.../Chartbeat/browser.js`, `.../GA/browser.js`, `.../GoogleAds/browser.js`	Switched from `

🐇✨
In the land of code, where logic gates swing,
A rabbit hopped by, making updates sing.
With a flip of its tail, || became ??,
Ensuring no value was wrongly set.
Celebrate the tweaks, so wisely penned,
For defaults now hold, only when they intend. 🌟
🐇💻

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.
- @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.

codecov · 2024-04-16T23:03:01Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 53.93%. Comparing base (3543cc1) to head (d5f487d).
Report is 324 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #1693   +/-   ##
========================================
  Coverage    53.93%   53.93%           
========================================
  Files          461      461           
  Lines        15616    15616           
  Branches      3089     3097    +8     
========================================
  Hits          8422     8422           
+ Misses        5928     5878   -50     
- Partials      1266     1316   +50

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

github-actions · 2024-04-16T23:09:22Z

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.66 KB	7.66 KB (0%)	8 KB	✅
Core CJS - NPM	22.47 KB	22.47 KB (0%)	23 KB	✅
Core - NPM	22.56 KB	22.56 KB (0%)	23 KB	✅
Core Legacy - CDN	43 KB	43 KB (0%)	44 KB	✅
Core - CDN	22.71 KB	22.71 KB (0%)	23 KB	✅
Core (legacy build) - CDN - v1.1	31.57 KB	31.57 KB (0%)	32 KB	✅
Core - NPM - v1.1	31.56 KB	31.56 KB (0%)	32 KB	✅
Service Worker Module	22.64 KB	22.64 KB (0%)	24 KB	✅
All Integrations (legacy build) - CDN	98.48 KB	98.68 KB (+0.21% ▲)	105 KB	✅

sonarqubecloud · 2024-04-24T08:28:13Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
87.5% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

github-actions · 2024-05-15T00:19:00Z