feat: fetch anonymous id by cookie name provided in load option

[MoumitaM]

PR Description

Introduced a load option to fetch anonymousId cookie set by external source and set it as rl_anonymousId.

• This will only happen during SDK load
• This is an optional load option if not provided fallback to existing logic
• If this option is set but no anonymousId is present in the cookie again it will fallback to existing logic

Linear task (optional)

https://linear.app/rudderstack/issue/SDK-1298/add-new-loadoption-externalanonymousidcookiename

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 the ability to set anonymousId from an external source via cookies, enhancing user session management.
• Tests
  • Added comprehensive tests for new functionalities in user session management, ensuring robustness and reliability.

[coderabbitai]

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

Walkthrough

The recent updates introduce the capability to set an anonymous ID for users from an external source via cookies, enhancing the flexibility and customization of user tracking in analytics. This is achieved through a new field in the LoadOptions type and extended logic in the UserSessionManager component, including fallback mechanisms and tests to ensure reliability and proper functionality under various scenarios.

Changes

File Path	Change Summary
.../types/LoadOptions.ts	Added externalAnonymousIdCookieName field of type string.
.../__tests__/components/userSessionManager/UserSessionManager.test.ts	Added tests for setting anonymousId from an external source and fallback logic.
.../src/components/userSessionManager/UserSessionManager.ts	Added logic to set anonymousId from an external cookie and implemented a getExternalAnonymousIdByCookieName method.

"In the realm of code, where data does hop,
A new trick's learned by the CodeRabbit, non-stop.
🍪 From cookies, it reads, a secret ID,
Anonymous yet known, in the vast data sea.
With a leap and a bound, it sets the pace,
Ensuring every user finds their rightful place.
🐾 Through tests and through types, it gracefully hops,
In the digital meadow, it never stops."

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
• Mastodon
• Reddit
• LinkedIn

---

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[github-actions]

size-limit report 📦

Name	Size (Base)	Size (Current)	Size Limit	Status
Common Code - No bundling	15.76 KB	15.76 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.64 KB	7.64 KB (0%)	8 KB	✅
Core CJS - NPM	22.36 KB	22.4 KB (+0.2% ▲)	23 KB	✅
Core - NPM	22.48 KB	22.56 KB (+0.36% ▲)	23 KB	✅
Core Legacy - CDN	42.76 KB	42.77 KB (+0.03% ▲)	44 KB	✅
Core - CDN	22.61 KB	22.67 KB (+0.28% ▲)	23 KB	✅
Core (legacy build) - CDN - v1.1	30.73 KB	30.73 KB (0%)	32 KB	✅
Core - NPM - v1.1	30.79 KB	30.79 KB (0%)	32 KB	✅
Service Worker Module	22.68 KB	22.68 KB (0%)	24 KB	✅
All Integrations (legacy build) - CDN	97.55 KB	97.55 KB (0%)	105 KB	✅

[codecov]

Codecov Report

Attention: Patch coverage is 90.00000% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 54.70%. Comparing base (a4c4fc0) to head (cd92147).

Files	Patch %	Lines
...omponents/userSessionManager/UserSessionManager.ts	90.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #1625      +/-   ##
===========================================
+ Coverage    54.68%   54.70%   +0.01%     
===========================================
  Files          581      581              
  Lines        17731    17740       +9     
  Branches      3269     3275       +6     
===========================================
+ Hits          9696     9704       +8     
- Misses        6568     6569       +1     
  Partials      1467     1467              

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

[MoumitaM]

@coderabbitai review

[coderabbitai]

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 3a3e0c0 and 79acc6a.

Files selected for processing (3)

• packages/analytics-js-common/src/types/LoadOptions.ts (1 hunks)
• packages/analytics-js/tests/components/userSessionManager/UserSessionManager.test.ts (2 hunks)
• packages/analytics-js/src/components/userSessionManager/UserSessionManager.ts (3 hunks)

Additional comments: 4

packages/analytics-js-common/src/types/LoadOptions.ts (1)

• 149-149: The addition of externalAnonymousIdCookieName to LoadOptions is aligned with the PR's objectives. However, consider adding documentation/comments explaining the purpose and usage of this new field to help developers understand its function within the SDK.

packages/analytics-js/src/components/userSessionManager/UserSessionManager.ts (3)

• 8-8: The addition of isDefinedAndNotNull enhances type checking. Ensure it's used consistently across the SDK for similar checks.
• 97-107: The logic to fetch externalAnonymousId from a cookie if externalAnonymousIdCookieName is provided and valid is correctly implemented. However, ensure that the fallback to existing logic when the cookie is not present or invalid is thoroughly tested.
• 366-372: The getExternalAnonymousIdByCookieName method is a crucial part of the new feature. It's implemented to fetch the anonymousId from a specified cookie. Ensure that edge cases, such as cookies being disabled or inaccessible due to browser policies, are handled gracefully.

[sonarcloud]

Quality Gate passed

Issues
0 New issues

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

See analysis details on SonarCloud