[RUM-8674] Mandatory user id in setUserInfo API by sbarrio · Pull Request #818 · DataDog/dd-sdk-reactnative

sbarrio · 2025-03-12T11:59:25Z

What does this PR do?

This PR modifies the serUserInfo API to make the user id mandatory at React Native level.

It also streamlines and aligns the setUserInfo and addUserExtraInfo methods with their native counterparts, while adding a new batch of tests for them all.

Method alignment

ON the React Native SDK, the current api exposes setUser only. This does then natively call the equivalent setUserInfo on both Android and iOS. However, due to the implementation of the Typescript-level UserInfoSingleton, this allows users to avoid the id enforcement by allowing to pass a Dictionary with any key to setUser. This is then passed down to its native counterparts by extracting id, name and email keys separately and properly assigning them to their respective parameter, while appending every other key to the extraInfo dictionary parameter.

This means, that with the current API, even if we enforce id as a mandatory property at UserInfoSingleton level, it won't make much difference as it can be rewritten by any other key that gets appended after it.

For this reason, and also to move forward to an aligned API with consisten method names I've opted to mark setUser as deprecated but allowing it to still work with the UserInfoSingleton in the same way as before, but adding a new setUserInfo method, that enforces the id, and that also respects the native parameter structure, and only allows for extra keys if they are provided inside the extraInfo object property.

Apart from this, I've also exposed addUserExtraInfo, that directly calls it's native counterpart and allows the user to add new fields to the extraInfo dictionary.

Motivation

User id is becoming a mandatory parameter, therefore public APIs must enforce it.

Additional Notes

Current status of API:

React Native	iOS	Android	Notes
setUser	setUserInfo (optional id)	setUserInfo (optional id)	Non-matching name with native call. Allows rewriting mandatory parameters. To be deprecated
setUserInfo	setUserInfo (mandatory and optional id versions)	setUserInfo (mandatory and optional id versions)	1:1 with native call. Should stop calling optional version of the native API once setUser is deprecated and UserInfoSingleton modified to enforce user id
addUserExtraInfo	addUserExtraInfo	addUserProperties	Match with iOS. Android exposes addUserProperties instead

Tests

Tested on Android and iOS on both old and new architecture.

Review checklist (to be filled by reviewers)

Feature or bugfix MUST have appropriate tests
Make sure you discussed the feature or bugfix with the maintaining team in an Issue
Make sure each commit and the PR mention the Issue number (cf the CONTRIBUTING doc)
If this PR is auto-generated, please make sure also to manually update the code related to the change

sbarrio · 2025-03-12T12:37:04Z

+        id: string;
+        name?: string;
+        email?: string;
+        extraInfo?: Record<string, unknown>;


This userInfo type should become the new type used by the UserInfoSingleton once setUser gets deprecated.

sbarrio · 2025-03-12T12:39:00Z

+    readonly extraInfo?: Record<string, unknown>;
+    readonly [
+        key: string
+    ]: unknown /** @deprecated To be removed alongside DdSdkReactnative.setUser */;


This should be removed once setUser is deprecated as it "breaks" the parameter structure and contract with its native counterparts.

datadog-datadog-prod-us1 · 2025-03-12T12:59:46Z

Datadog Report

Branch report: sbarrio/RUM-8674/make-user-id-mandatory-in-setUserInfo-API
Commit report: 0fd95f5
Test service: dd-sdk-reactnative

✅ 0 Failed, 653 Passed, 1 Skipped, 12.03s Total Time

marco-saia-datadog

Looks good! Nice work. I have left some minor suggestions.

marco-saia-datadog · 2025-03-18T09:52:07Z

     * nested up to 8 levels deep. Keys using more than 8 levels will be sanitized by SDK.
     */
-    fun setUserInfo(
+    @Deprecated("UserInfo id property is now mandatory.")


See my previous comment 🔝

marco-saia-datadog · 2025-03-18T09:52:38Z

     * @param user The user object (use builtin attributes: 'id', 'email', 'name', and/or any custom
     * attribute).
     */
+    @Deprecated("UserInfo id property is now mandatory.")


See my previous comment 🔝

marco-saia-datadog · 2025-03-18T09:53:04Z

     * @param user The user object (use builtin attributes: 'id', 'email', 'name', and/or any custom
     * attribute).
     */
+    @Deprecated("UserInfo id property is now mandatory.")


See my previous comment 🔝

marco-saia-datadog · 2025-03-18T09:53:11Z

     * @param user The user object (use builtin attributes: 'id', 'email', 'name', and/or any custom
     * attribute).
     */
+    @Deprecated("UserInfo id property is now mandatory.")


See my previous comment 🔝

marco-saia-datadog · 2025-03-18T09:58:26Z

+     */
+


MINOR: Extra new line here

Changes at 0a63f08

datadog-datadog-prod-us1 Bot reviewed Mar 12, 2025

View reviewed changes

Comment thread packages/core/src/specs/NativeDdSdk.ts

Comment thread packages/core/src/specs/NativeDdSdk.ts

sbarrio commented Mar 12, 2025

View reviewed changes

sbarrio force-pushed the sbarrio/RUM-8674/make-user-id-mandatory-in-setUserInfo-API branch from a1353f9 to 518b97e Compare March 12, 2025 12:55

sbarrio force-pushed the sbarrio/RUM-8674/make-user-id-mandatory-in-setUserInfo-API branch from 518b97e to 060b2bb Compare March 12, 2025 16:26

sbarrio marked this pull request as ready for review March 12, 2025 16:28

sbarrio requested a review from a team as a code owner March 12, 2025 16:28

sbarrio force-pushed the sbarrio/RUM-8674/make-user-id-mandatory-in-setUserInfo-API branch from 060b2bb to 1705fa7 Compare March 12, 2025 16:31

sbarrio changed the title ~~RUM-8674 Mandatory UserId in setUserInfo API~~ RUM-8674 Mandatory user id in setUserInfo API Mar 13, 2025

marco-saia-datadog previously approved these changes Mar 18, 2025

View reviewed changes

sbarrio dismissed marco-saia-datadog’s stale review via 0fd95f5 March 18, 2025 11:56

sbarrio force-pushed the sbarrio/RUM-8674/make-user-id-mandatory-in-setUserInfo-API branch from 1705fa7 to 0fd95f5 Compare March 18, 2025 11:56

datadog-datadog-prod-us1 Bot reviewed Mar 18, 2025

View reviewed changes

Comment thread packages/react-native-apollo-client/__mocks__/react-native.ts

Comment thread packages/codepush/__mocks__/react-native.ts

sbarrio marked this pull request as draft March 18, 2025 12:00

sbarrio force-pushed the sbarrio/RUM-8674/make-user-id-mandatory-in-setUserInfo-API branch from 0fd95f5 to 0a63f08 Compare March 18, 2025 12:02

sbarrio marked this pull request as ready for review March 18, 2025 12:02

sbarrio requested a review from marco-saia-datadog March 18, 2025 12:20

sbarrio changed the title ~~RUM-8674 Mandatory user id in setUserInfo API~~ [RUM-8674] Mandatory user id in setUserInfo API Mar 21, 2025

sbarrio force-pushed the sbarrio/RUM-8674/make-user-id-mandatory-in-setUserInfo-API branch from 0a63f08 to 743a63b Compare March 21, 2025 16:41

Expose new setUserInfo and addUserExtraInfo APIs

4637bef

sbarrio force-pushed the sbarrio/RUM-8674/make-user-id-mandatory-in-setUserInfo-API branch from 743a63b to 4637bef Compare March 24, 2025 15:36

sbarrio self-assigned this Mar 26, 2025

marco-saia-datadog approved these changes Mar 27, 2025

View reviewed changes

sbarrio merged commit df73f3f into develop Mar 28, 2025

sbarrio deleted the sbarrio/RUM-8674/make-user-id-mandatory-in-setUserInfo-API branch March 28, 2025 10:22

marco-saia-datadog mentioned this pull request Apr 10, 2025

[RELEASE] React Native SDK v2.6.5 #846

Merged

jhssilva mentioned this pull request Apr 24, 2025

[RUM] React Native - Update setUser method to setUserInfo DataDog/documentation#28949

Merged

1 task

Uh oh!

Conversation

sbarrio commented Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Method alignment

Motivation

Additional Notes

Tests

Review checklist (to be filled by reviewers)

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

datadog-datadog-prod-us1 Bot commented Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Datadog Report

Uh oh!

marco-saia-datadog left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sbarrio commented Mar 12, 2025 •

edited

Loading

datadog-datadog-prod-us1 Bot commented Mar 12, 2025 •

edited

Loading