search

rudderlabs / rudder-sdk-js

JavaScript SDK for RudderStack - the Customer Data Platform for Developers.
https://www.rudderstack.com
Other
143 stars 82 forks source link

fix: userId in braze hyrbrid #1835

Closed aashishmalik closed 1 month ago

aashishmalik commented 2 months ago

PR Description

Please include a summary of the change along with the relevant motivation and context.

Linear task (optional)

Linear task link

Cross Browser Tests

Please confirm you have tested for the following browsers:

Sanity Suite

Security

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The changes involve modifications to the Braze integration's `identify` method, specifically for hybrid mode functionality. The test suite now expects the `window.braze.changeUser` method to be called once during an identify operation, reflecting a new requirement for user identification processes. The implementation was updated to include a conditional check for hybrid mode, ensuring that user identification is triggered appropriately. ## Changes | Files | Change Summary | |---------------------------------------------------|-------------------------------------------------------------------------------------------------------------| | `packages/analytics-js-integrations/__tests__/integrations/Braze/browser.test.js`, `packages/analytics-js-integrations/src/integrations/Braze/browser.js` | The test suite now asserts that `window.braze.changeUser` should be called once during identify operations. The `identify` method in the `Braze` class was modified to check for hybrid mode, calling `window.braze.changeUser(userId)` if active, and streamlining variable declarations. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant Rudder participant Braze User->>Rudder: Identify User Rudder->>Braze: Identify(userId) alt Hybrid Mode Enabled Braze->>Braze: Call window.braze.changeUser(userId) Braze-->>Rudder: Early Return else Hybrid Mode Disabled Braze->>Braze: Process User Traits end ```
📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between c1a7bd39036f9bf4e35691d45980294d1e8d3b87 and 3d9714aef24d4c9a256b42f5a412f2cffa49bba8.
📒 Files selected for processing (2) * packages/analytics-js-integrations/__tests__/integrations/Braze/browser.test.js (2 hunks) * packages/analytics-js-integrations/src/integrations/Braze/browser.js (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2) * packages/analytics-js-integrations/__tests__/integrations/Braze/browser.test.js * packages/analytics-js-integrations/src/integrations/Braze/browser.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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 56.85%. Comparing base (ed32560) to head (c1a7bd3).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #1835 +/- ## =========================================== - Coverage 57.12% 56.85% -0.27% =========================================== Files 476 476 Lines 16231 16233 +2 Branches 3240 3244 +4 =========================================== - Hits 9272 9230 -42 - Misses 5726 5735 +9 - Partials 1233 1268 +35 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

sonarcloud[bot] commented 2 months ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

github-actions[bot] commented 2 months ago

size-limit report 📦

Name Size (Base) Size (Current) Size Limit Status
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 ✅
Plugins Module Federation Mapping - Legacy - CDN 332 B 332 B (0%) 512 B ✅
Plugins - Legacy - CDN 15.46 KB 15.46 KB (0%) 16 KB ✅
Plugins Module Federation Mapping - Modern - CDN 331 B 331 B (0%) 512 B ✅
Plugins - Modern - CDN 7.19 KB 7.19 KB (0%) 7.5 KB ✅
Common - No bundling 16.2 KB 16.2 KB (0%) 16.5 KB ✅
Service Worker - Legacy - NPM (ESM) 30.42 KB 30.42 KB (0%) 31 KB ✅
Service Worker - Legacy - NPM (CJS) 30.64 KB 30.64 KB (0%) 31 KB ✅
Service Worker - Legacy - NPM (UMD) 30.42 KB 30.42 KB (0%) 31 KB ✅
Service Worker - Modern - NPM (ESM) 25.49 KB 25.49 KB (0%) 26 KB ✅
Service Worker - Modern - NPM (CJS) 25.76 KB 25.76 KB (0%) 26 KB ✅
Service Worker - Modern - NPM (UMD) 25.5 KB 25.5 KB (0%) 26 KB ✅
Core (v1.1) - NPM (ESM) 30 KB 30 KB (0%) 32 KB ✅
Core (v1.1) - NPM (CJS) 30.14 KB 30.14 KB (0%) 32 KB ✅
Core (v1.1) - NPM (UMD) 30.09 KB 30.09 KB (0%) 32 KB ✅
Core (Content Script - v1.1) - NPM (ESM) 29.58 KB 29.58 KB (0%) 30 KB ✅
Core (Content Script - v1.1) - NPM (CJS) 29.7 KB 29.7 KB (0%) 30 KB ✅
Core (Content Script - v1.1) - NPM (UMD) 29.64 KB 29.64 KB (0%) 30 KB ✅
Core - Legacy - CDN 47.31 KB 47.31 KB (0%) 48 KB ✅
Core - Modern - CDN 24.27 KB 24.27 KB (0%) 24.5 KB ✅
Load Snippet 778 B 778 B (0%) 1 KB ✅
Core - Legacy - NPM (ESM) 47.24 KB 47.24 KB (0%) 48 KB ✅
Core - Legacy - NPM (CJS) 47.47 KB 47.47 KB (0%) 48 KB ✅
Core - Legacy - NPM (UMD) 47.25 KB 47.25 KB (0%) 48 KB ✅
Core - Modern - NPM (ESM) 24.01 KB 24.01 KB (0%) 24.5 KB ✅
Core - Modern - NPM (CJS) 24.24 KB 24.24 KB (0%) 24.5 KB ✅
Core - Modern - NPM (UMD) 24.03 KB 24.03 KB (0%) 24.5 KB ✅
Core (Bundled) - Legacy - NPM (ESM) 47.24 KB 47.24 KB (0%) 48 KB ✅
Core (Bundled) - Legacy - NPM (CJS) 47.51 KB 47.51 KB (0%) 48 KB ✅
Core (Bundled) - Legacy - NPM (UMD) 47.25 KB 47.25 KB (0%) 48 KB ✅
Core (Bundled) - Modern - NPM (ESM) 38.55 KB 38.55 KB (0%) 39 KB ✅
Core (Bundled) - Modern - NPM (CJS) 38.82 KB 38.82 KB (0%) 39.5 KB ✅
Core (Bundled) - Modern - NPM (UMD) 38.59 KB 38.59 KB (0%) 39 KB ✅
Core (Content Script) - Legacy - NPM (ESM) 46.73 KB 46.73 KB (0%) 48 KB ✅
Core (Content Script) - Legacy - NPM (CJS) 46.98 KB 46.98 KB (0%) 47.5 KB ✅
Core (Content Script) - Legacy - NPM (UMD) 46.74 KB 46.74 KB (0%) 47.5 KB ✅
Core (Content Script) - Modern - NPM (ESM) 38.06 KB 38.06 KB (0%) 38.5 KB ✅
Core (Content Script) - Modern - NPM (CJS) 38.35 KB 38.35 KB (0%) 38.5 KB ✅
Core (Content Script) - Modern - NPM (UMD) 38.08 KB 38.08 KB (0%) 38.5 KB ✅
All Integrations - Legacy - CDN 94.36 KB 94.6 KB (+0.26% ▲) 95.3 KB ✅
All Integrations - Modern - CDN 89.53 KB 89.54 KB (+0.02% ▲) 91 KB ✅
github-actions[bot] commented 1 month ago

Hello! This PR has been open for 20 days without any activity. Therefore, it's considered as stale and is scheduled to be closed in 10 days. If you're still working on this, please remove the 'Stale' label or add a comment to keep it open. Thanks for your contribution!

sonarcloud[bot] commented 1 month ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud