Allow setting sdk_name at runtime

CHANGELOG.md

@@ -5,6 +5,7 @@
 **Features**:
 
 - Extend API with ptr/len-string interfaces. ([#827](https://github.com/getsentry/sentry-native/pull/827))
+- Allow setting sdk_name at runtime ([#834](https://github.com/getsentry/sentry-native/pull/834))
 
 ## 0.6.1
 

include/sentry.h

@@ -1008,6 +1008,32 @@ SENTRY_API void sentry_options_set_transport_thread_name_n(
 SENTRY_API const char *sentry_options_get_transport_thread_name(
     const sentry_options_t *opts);
 
+/*
+ * Configures the name of the sentry SDK. Returns 0 on success.
+ */
+SENTRY_API int sentry_options_set_sdk_name(
+    sentry_options_t *opts, const char *sdk_name);
+
+/*
+ * Configures the name of the sentry SDK. Returns 0 on success.
+ */
+SENTRY_API int sentry_options_set_sdk_name_n(
+    sentry_options_t *opts, const char *sdk_name, size_t sdk_name_len);
+
+/**
+ * Returns the configured sentry SDK name. Unless overwritten this defaults to
+ * SENTRY_SDK_NAME.
+ */
+SENTRY_API const char *sentry_options_get_sdk_name(
+    const sentry_options_t *opts);
+
+/**
+ * Returns the user agent. Unless overwritten this defaults to
+ * "SENTRY_SDK_NAME / SENTRY_SDK_VERSION".
+ */
+SENTRY_API const char *sentry_options_get_user_agent(
+    const sentry_options_t *opts);
+
 /**
  * Enables or disables debug printing mode.
  */
@@ -1983,12 +2009,14 @@ SENTRY_EXPERIMENTAL_API int sentry_clear_crashed_last_run(void);
 SENTRY_EXPERIMENTAL_API const char *sentry_sdk_version(void);
 
 /**
- * Sentry SDK name.
+ * Sentry SDK name set during build time.
+ * Deprecated: Please use sentry_options_get_sdk_name instead.
  */
 SENTRY_EXPERIMENTAL_API const char *sentry_sdk_name(void);
 
 /**
- * Sentry SDK User-Agent.
+ * Sentry SDK User-Agent set during build time.
+ * Deprecated: Please use sentry_options_get_user_agent instead.
  */
 SENTRY_EXPERIMENTAL_API const char *sentry_sdk_user_agent(void);
 

src/backends/sentry_backend_crashpad.cpp

@@ -311,7 +311,8 @@ sentry__crashpad_backend_startup(
     data->db = crashpad::CrashReportDatabase::Initialize(database).release();
 
     crashpad::CrashpadClient client;
-    char *minidump_url = sentry__dsn_get_minidump_url(options->dsn);
+    char *minidump_url
+        = sentry__dsn_get_minidump_url(options->dsn, options->user_agent);
     SENTRY_TRACEF("using minidump url \"%s\"", minidump_url);
     std::string url = minidump_url ? std::string(minidump_url) : std::string();
     sentry_free(minidump_url);

src/sentry_options.c

@@ -36,6 +36,7 @@ sentry_options_new(void)
     if (!opts->environment) {
         opts->environment = sentry__string_clone("production");
     }
+    sentry_options_set_sdk_name(opts, SENTRY_SDK_NAME);
     opts->max_breadcrumbs = SENTRY_BREADCRUMBS_MAX;
     opts->user_consent = SENTRY_USER_CONSENT_UNKNOWN;
     opts->auto_session_tracking = true;
@@ -295,6 +296,51 @@ sentry_options_get_transport_thread_name(const sentry_options_t *opts)
     return opts->transport_thread_name;
 }
 
+int
+sentry_options_set_sdk_name(sentry_options_t *opts, const char *sdk_name)
+{
+    if (!opts || !sdk_name) {
+        return 1;
+    }
+    const size_t sdk_name_len = strlen(sdk_name);
+    return sentry_options_set_sdk_name_n(opts, sdk_name, sdk_name_len);
+}
+
+int
+sentry_options_set_sdk_name_n(
+    sentry_options_t *opts, const char *sdk_name, size_t sdk_name_len)
+{
+    if (!opts || !sdk_name) {
+        return 1;
+    }
+
+    sentry_free(opts->sdk_name);
+    opts->sdk_name = sentry__string_clone_n(sdk_name, sdk_name_len);
+
+    sentry_stringbuilder_t sb;
+    sentry__stringbuilder_init(&sb);
+    sentry__stringbuilder_append(&sb, opts->sdk_name);
+    sentry__stringbuilder_append(&sb, "/");
+    sentry__stringbuilder_append(&sb, SENTRY_SDK_VERSION);
+
+    sentry_free(opts->user_agent);
+    opts->user_agent = sentry__stringbuilder_into_string(&sb);
+
+    return 0;
+}
+
+const char *
+sentry_options_get_sdk_name(const sentry_options_t *opts)
+{
+    return opts->sdk_name;
+}
+
+const char *
+sentry_options_get_user_agent(const sentry_options_t *opts)
+{
+    return opts->user_agent;
+}
+
 void
 sentry_options_set_debug(sentry_options_t *opts, int debug)
 {

src/sentry_options.h

@@ -38,6 +38,8 @@ typedef struct sentry_options_s {
     char *http_proxy;
     char *ca_certs;
     char *transport_thread_name;
+    char *sdk_name;
+    char *user_agent;
     sentry_path_t *database_path;
     sentry_path_t *handler_path;
     sentry_logger_t logger;

src/sentry_scope.c

@@ -29,8 +29,10 @@ get_client_sdk(void)
 {
     sentry_value_t client_sdk = sentry_value_new_object();
 
-    sentry_value_t name = sentry_value_new_string(SENTRY_SDK_NAME);
-    sentry_value_set_by_key(client_sdk, "name", name);
+    SENTRY_WITH_OPTIONS (options) {
+        sentry_value_t sdk_name = sentry_value_new_string(options->sdk_name);
+        sentry_value_set_by_key(client_sdk, "name", sdk_name);
+    }
 
     sentry_value_t version = sentry_value_new_string(SENTRY_SDK_VERSION);
     sentry_value_set_by_key(client_sdk, "version", version);

src/sentry_transport.c

@@ -189,7 +189,9 @@ sentry__prepare_http_request(sentry_envelope_t *envelope,
     sentry_prepared_http_header_t *h;
     h = &req->headers[req->headers_len++];
     h->key = "x-sentry-auth";
-    h->value = sentry__dsn_get_auth_header(dsn);
+    SENTRY_WITH_OPTIONS (options) {
+        h->value = sentry__dsn_get_auth_header(dsn, options->user_agent);
+    }
 
     h = &req->headers[req->headers_len++];
     h->key = "content-type";

src/sentry_utils.c

@@ -312,17 +312,17 @@ sentry__dsn_decref(sentry_dsn_t *dsn)
 }
 
 char *
-sentry__dsn_get_auth_header(const sentry_dsn_t *dsn)
+sentry__dsn_get_auth_header(const sentry_dsn_t *dsn, const char *user_agent)
 {
-    if (!dsn || !dsn->is_valid) {
+    if (!dsn || !dsn->is_valid || !user_agent) {
         return NULL;
     }
     sentry_stringbuilder_t sb;
     sentry__stringbuilder_init(&sb);
     sentry__stringbuilder_append(&sb, "Sentry sentry_key=");
     sentry__stringbuilder_append(&sb, dsn->public_key);
-    sentry__stringbuilder_append(
-        &sb, ", sentry_version=7, sentry_client=" SENTRY_SDK_USER_AGENT);
+    sentry__stringbuilder_append(&sb, ", sentry_version=7, sentry_client=");
+    sentry__stringbuilder_append(&sb, user_agent);
     return sentry__stringbuilder_into_string(&sb);
 }
 
@@ -353,15 +353,16 @@ sentry__dsn_get_envelope_url(const sentry_dsn_t *dsn)
 }
 
 char *
-sentry__dsn_get_minidump_url(const sentry_dsn_t *dsn)
+sentry__dsn_get_minidump_url(const sentry_dsn_t *dsn, const char *user_agent)
 {
-    if (!dsn || !dsn->is_valid) {
+    if (!dsn || !dsn->is_valid || !user_agent) {
         return NULL;
     }
     sentry_stringbuilder_t sb;
     init_string_builder_for_url(&sb, dsn);
-    sentry__stringbuilder_append(
-        &sb, "/minidump/?sentry_client=" SENTRY_SDK_USER_AGENT "&sentry_key=");
+    sentry__stringbuilder_append(&sb, "/minidump/?sentry_client=");
+    sentry__stringbuilder_append(&sb, user_agent);
+    sentry__stringbuilder_append(&sb, "&sentry_key=");
     sentry__stringbuilder_append(&sb, dsn->public_key);
     return sentry__stringbuilder_into_string(&sb);
 }

src/sentry_utils.h

@@ -80,7 +80,8 @@ void sentry__dsn_decref(sentry_dsn_t *dsn);
  * described here:
  * https://docs.sentry.io/development/sdk-dev/overview/#authentication
  */
-char *sentry__dsn_get_auth_header(const sentry_dsn_t *dsn);
+char *sentry__dsn_get_auth_header(
+    const sentry_dsn_t *dsn, const char *user_agent);
 
 /**
  * Returns the envelope endpoint url used for normal uploads as a newly
@@ -92,7 +93,8 @@ char *sentry__dsn_get_envelope_url(const sentry_dsn_t *dsn);
  * Returns the minidump endpoint url used for uploads done by the out-of-process
  * crashpad backend as a newly allocated string.
  */
-char *sentry__dsn_get_minidump_url(const sentry_dsn_t *dsn);
+char *sentry__dsn_get_minidump_url(
+    const sentry_dsn_t *dsn, const char *user_agent);
 
 /**
  * Returns the number of milliseconds since the unix epoch.

tests/unit/CMakeLists.txt

@@ -28,6 +28,7 @@ add_executable(sentry_test_unit
 	test_logger.c
 	test_modulefinder.c
 	test_mpack.c
+	test_options.c
 	test_path.c
 	test_ratelimiter.c
 	test_sampling.c

tests/unit/test_options.c

@@ -0,0 +1,65 @@
+#include "sentry_options.h"
+#include "sentry_string.h"
+#include "sentry_testsupport.h"
+
+#include "sentry_options.h"
+#include "sentry_string.h"
+#include "sentry_testsupport.h"
+
+SENTRY_TEST(options_sdk_name_defaults)
+{
+    sentry_options_t *options = sentry_options_new();
+    // when nothing is set
+
+    // then both sdk name and user agent should default to the build time
+    // directives
+    TEST_CHECK_STRING_EQUAL(
+        sentry_options_get_sdk_name(options), SENTRY_SDK_NAME);
+    TEST_CHECK_STRING_EQUAL(
+        sentry_options_get_user_agent(options), SENTRY_SDK_USER_AGENT);
+
+    sentry_options_free(options);
+}
+
+SENTRY_TEST(options_sdk_name_custom)
+{
+    sentry_options_t *options = sentry_options_new();
+
+    // when the sdk name is set to a custom string
+    const char *sdk_name = "sentry.native.android.flutter";
+    const int result = sentry_options_set_sdk_name(options, sdk_name);
+
+    // both the sdk_name and user_agent should reflect this change
+    TEST_CHECK_INT_EQUAL(result, 0);
+    TEST_CHECK_STRING_EQUAL(sentry_options_get_sdk_name(options), sdk_name);
+
+    sentry_stringbuilder_t sb;
+    sentry__stringbuilder_init(&sb);
+    sentry__stringbuilder_append(&sb, sdk_name);
+    sentry__stringbuilder_append(&sb, "/");
+    sentry__stringbuilder_append(&sb, SENTRY_SDK_VERSION);
+    const char *expected_user_agent = sentry__stringbuilder_into_string(&sb);
+
+    TEST_CHECK_STRING_EQUAL(
+        sentry_options_get_user_agent(options), expected_user_agent);
+
+    sentry_options_free(options);
+}
+
+SENTRY_TEST(options_sdk_name_invalid)
+{
+    sentry_options_t *options = sentry_options_new();
+
+    // when the sdk name is set to an invalid value
+    const char *sdk_name = NULL;
+    const int result = sentry_options_set_sdk_name(options, sdk_name);
+
+    // then the value should should be ignored
+    TEST_CHECK_INT_EQUAL(result, 1);
+    TEST_CHECK_STRING_EQUAL(
+        sentry_options_get_sdk_name(options), SENTRY_SDK_NAME);
+    TEST_CHECK_STRING_EQUAL(
+        sentry_options_get_user_agent(options), SENTRY_SDK_USER_AGENT);
+
+    sentry_options_free(options);
+}

tests/unit/test_utils.c

@@ -152,7 +152,7 @@ SENTRY_TEST(dsn_store_url_with_path)
     TEST_CHECK_STRING_EQUAL(
         url, "http://example.com:80/foo/bar/api/42/envelope/");
     sentry_free(url);
-    url = sentry__dsn_get_minidump_url(dsn);
+    url = sentry__dsn_get_minidump_url(dsn, SENTRY_SDK_USER_AGENT);
     TEST_CHECK_STRING_EQUAL(url,
         "http://example.com:80/foo/bar/api/42/minidump/"
         "?sentry_client=" SENTRY_SDK_USER_AGENT "&sentry_key=username");
@@ -168,14 +168,26 @@ SENTRY_TEST(dsn_store_url_without_path)
     url = sentry__dsn_get_envelope_url(dsn);
     TEST_CHECK_STRING_EQUAL(url, "http://example.com:80/api/42/envelope/");
     sentry_free(url);
-    url = sentry__dsn_get_minidump_url(dsn);
+    url = sentry__dsn_get_minidump_url(dsn, SENTRY_SDK_USER_AGENT);
     TEST_CHECK_STRING_EQUAL(url,
         "http://example.com:80/api/42/minidump/"
         "?sentry_client=" SENTRY_SDK_USER_AGENT "&sentry_key=username");
     sentry_free(url);
     sentry__dsn_decref(dsn);
 }
 
+SENTRY_TEST(dsn_store_url_custom_agent)
+{
+    sentry_dsn_t *dsn
+        = sentry__dsn_new("http://username:password@example.com/42?x=y#z");
+    char *url = sentry__dsn_get_minidump_url(dsn, "custom_user_agent");
+    TEST_CHECK_STRING_EQUAL(url,
+        "http://example.com:80/api/42/minidump/"
+        "?sentry_client=custom_user_agent&sentry_key=username");
+    sentry_free(url);
+    sentry__dsn_decref(dsn);
+}
+
 SENTRY_TEST(page_allocator)
 {
 #ifndef SENTRY_PLATFORM_UNIX

tests/unit/tests.inc

@@ -29,6 +29,7 @@ XX(distributed_headers)
 XX(drop_unfinished_spans)
 XX(dsn_parsing_complete)
 XX(dsn_parsing_invalid)
+XX(dsn_store_url_custom_agent)
 XX(dsn_store_url_with_path)
 XX(dsn_store_url_without_path)
 XX(dsn_with_ending_forward_slash_will_be_cleaned)
@@ -51,6 +52,9 @@ XX(mpack_newlines)
 XX(mpack_removed_tags)
 XX(multiple_inits)
 XX(multiple_transactions)
+XX(options_sdk_name_custom)
+XX(options_sdk_name_defaults)
+XX(options_sdk_name_invalid)
 XX(os)
 XX(overflow_spans)
 XX(page_allocator)