feat: add `sentry_value_new_user` #1228

JoshuaMoelans · 2025-05-06T14:44:02Z

Came up in discussion of #1225 ; when creating a user object, it's not immediately obvious which fields are expected and how they should be cased. Hence we add a sentry_value_new_user(id, username, email, ip_address) function that constructs the user object with the correct keys (as defined in the develop docs).

The function should be used as follows:

sentry_value_t user = sentry_value_new_user(NULL, "John Doe", "[email protected]", NULL);
sentry_value_set_by_key(user, "custom_key", sentry_value_new_string("custom_value"));
sentry_set_user(user);

ToDo:

implement function
add tests
add to docs feat(native): update set_user calls to use new new_user function output sentry-docs#13624

github-actions · 2025-05-06T14:44:26Z

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Generated by 🚫 dangerJS against 80e6839

src/sentry_value.c

src/sentry_core.c

Copilot

Pull Request Overview

This PR introduces a new function, sentry_value_new_user, to construct a user object with the correct key casing as defined in the documentation. Key changes include implementation of the user object creation functions in src/sentry_value.c, test case additions in tests/unit/test_value.c, and updates in related examples and documentation files.

Reviewed Changes

Copilot reviewed 6 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
tests/unit/test_value.c	Added tests to validate new user object creation, including edge cases.
tests/assertions.py	Updated expected user id type from integer to string.
src/sentry_value.c	Implemented sentry_value_new_user and helper function sentry_value_new_user_n.
include/sentry.h	Added API prototypes and documentation for the new user functions.
examples/example.c	Updated usage example to reflect string type for user id.
CHANGELOG.md	Updated changelog to document the new feature.

Files not reviewed (1)

tests/unit/tests.inc: Language not supported

Copilot · 2025-05-07T10:21:59Z

tests/unit/test_value.c

+    TEST_CHECK(sentry_value_is_null(user_null));
+    sentry_value_decref(user_null);
+
+    sentry_value_t user_empty_str = sentry_value_new_user("", "", "", "");


[nitpick] Consider adding an inline comment explaining that providing empty strings as parameters should result in a null user, to clarify the expected behavior in this test.

Suggested change

sentry_value_t user_empty_str = sentry_value_new_user("", "", "", "");

sentry_value_t user_empty_str = sentry_value_new_user("", "", "", "");

// Providing empty strings as parameters should result in a null user.

Copilot · 2025-05-07T10:22:00Z

src/sentry_value.c

+    if (ip_address && ip_address_len) {
+        sentry_value_set_by_key(
+            rv, "ip_address", sentry_value_new_string(ip_address));
+    }


[nitpick] It would be beneficial to add a comment describing the criteria under which the user object is considered invalid (i.e. when all parameters are empty or null), clarifying why the function returns null.

Suggested change

}

}

// If none of the provided parameters (id, username, email, ip_address) are valid

// (i.e., all are null or empty), the user object is considered invalid.

// In this case, a warning is logged, and a null value is returned.

supervacuus · 2025-05-07T10:42:50Z

The only thing left is updating the docs to eliminate manual key-setting.

…output (#13624)  Relevant vercel preview pages - https://sentry-docs-plsrr24j2.sentry.dev/platforms/native/enriching-events/scopes/#configuring-the-scope - https://sentry-docs-plsrr24j2.sentry.dev//platforms/native/enriching-events/identify-user/ - https://sentry-docs-plsrr24j2.sentry.dev/platforms/native/data-management/sensitive-data/#examples ## DESCRIBE YOUR PR Related to the change in getsentry/sentry-native#1228 From now on, we provide the `sentry_value_new_user(id, username, email, ip_address)` function that fills out the correct keys. This should reduce user error & confusion with what keys are processed by Sentry (see the [original issue](getsentry/sentry-native#1225) the function was added for). ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.):  - [ ] Other deadline:  - [x] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [x] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) --------- Co-authored-by: Mischan Toosarani-Hausberger <[email protected]>

JoshuaMoelans added 4 commits May 6, 2025 16:10

add sentry_value_new_user

9105945

add test

873acfa

add comment

17bd9fa

add test scenario

d2e8592

CHANGELOG.md

bda688b

JoshuaMoelans commented May 6, 2025

View reviewed changes

src/sentry_value.c Outdated Show resolved Hide resolved

JoshuaMoelans changed the title ~~feat: add user object creation helper function~~ feat: add sentry_value_new_user May 6, 2025

JoshuaMoelans marked this pull request as ready for review May 6, 2025 15:00

supervacuus reviewed May 6, 2025

View reviewed changes

src/sentry_value.c Outdated Show resolved Hide resolved

supervacuus reviewed May 6, 2025

View reviewed changes

src/sentry_core.c Outdated Show resolved Hide resolved

JoshuaMoelans added 2 commits May 7, 2025 11:28

update user.id to be string

6aac851

cleanup + add new_user_n implementation

0f8a363

JoshuaMoelans requested a review from Copilot May 7, 2025 10:21

Copilot AI reviewed May 7, 2025

View reviewed changes

supervacuus approved these changes May 7, 2025

View reviewed changes

use string_n instead

f05e7f8

JoshuaMoelans mentioned this pull request May 7, 2025

feat(native): update set_user calls to use new new_user function output getsentry/sentry-docs#13624

Merged

6 tasks

changelog formatting

80e6839

JoshuaMoelans merged commit 8755115 into master May 7, 2025
33 checks passed

JoshuaMoelans deleted the joshua/feat/user_creation branch May 7, 2025 15:40

BrewTestBot mentioned this pull request May 14, 2025

sentry-native 0.8.5 Homebrew/homebrew-core#223442

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: add `sentry_value_new_user` #1228

feat: add `sentry_value_new_user` #1228

Uh oh!

JoshuaMoelans commented May 6, 2025 •

edited

Loading

Uh oh!

github-actions bot commented May 6, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI May 7, 2025

Uh oh!

Copilot AI May 7, 2025

Uh oh!

supervacuus commented May 7, 2025

Uh oh!

Uh oh!

Uh oh!

	sentry_value_t user_empty_str = sentry_value_new_user("", "", "", "");
	sentry_value_t user_empty_str = sentry_value_new_user("", "", "", "");
	// Providing empty strings as parameters should result in a null user.

-    }
+    }
+    // If none of the provided parameters (id, username, email, ip_address) are valid
+    // (i.e., all are null or empty), the user object is considered invalid.
+    // In this case, a warning is logged, and a null value is returned.

Uh oh!

feat: add sentry_value_new_user #1228

feat: add sentry_value_new_user #1228

Uh oh!

Conversation

JoshuaMoelans commented May 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ToDo:

Uh oh!

github-actions bot commented May 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 7, 2025

Choose a reason for hiding this comment

Uh oh!

supervacuus commented May 7, 2025

Uh oh!

Uh oh!

Uh oh!

feat: add `sentry_value_new_user` #1228

feat: add `sentry_value_new_user` #1228

JoshuaMoelans commented May 6, 2025 •

edited

Loading

github-actions bot commented May 6, 2025 •

edited

Loading