take ownership

Author: jpnurmi

include/sentry.h

@@ -1512,16 +1512,9 @@ typedef struct sentry_scope_s sentry_scope_t;
 
 /**
  * Creates a local scope.
- *
- * The return value must be freed with `sentry_scope_free`.
  */
 SENTRY_API sentry_scope_t *sentry_local_scope_new(void);
 
-/**
- * Deallocates previously allocated scope.
- */
-SENTRY_API void sentry_scope_free(sentry_scope_t *scope);
-
 /**
  * Sends a sentry event.
  *
@@ -1530,6 +1523,12 @@ SENTRY_API void sentry_scope_free(sentry_scope_t *scope);
  * be used to send transactions.
  */
 SENTRY_API sentry_uuid_t sentry_capture_event(sentry_value_t event);
+
+/**
+ * Sends a sentry event with a local scope.
+ *
+ * Takes ownership of `scope`.
+ */
 SENTRY_API sentry_uuid_t sentry_capture_event_with_scope(
     sentry_value_t event, sentry_scope_t *scope);
 

src/sentry_core.c

@@ -576,6 +576,7 @@ sentry__prepare_event(const sentry_options_t *options, sentry_value_t event,
         SENTRY_DEBUG("merging local scope into event");
         sentry_scope_mode_t mode = SENTRY_SCOPE_BREADCRUMBS;
         sentry__scope_apply_to_event(local_scope, options, event, mode);
+        sentry__scope_free(local_scope);
     }
 
     SENTRY_WITH_SCOPE (scope) {

src/sentry_scope.c

@@ -166,7 +166,7 @@ sentry_local_scope_new(void)
 }
 
 void
-sentry_scope_free(sentry_scope_t *scope)
+sentry__scope_free(sentry_scope_t *scope)
 {
     if (!scope) {
         return;

src/sentry_scope.h

@@ -71,6 +71,11 @@ void sentry__scope_cleanup(void);
  */
 void sentry__scope_flush_unlock(void);
 
+/**
+ * Deallocates a (local) scope.
+ */
+void sentry__scope_free(sentry_scope_t *scope);
+
 /**
  * This will merge the requested data which is in the given `scope` to the given
  * `event`.

tests/unit/test_scope.c

@@ -89,7 +89,7 @@ SENTRY_TEST(scope_contexts)
         TEST_CHECK_CONTEXT_EQUAL(event, "local", "local");
         TEST_CHECK_CONTEXT_EQUAL(event, "scope", "local");
 
-        sentry_scope_free(local_scope);
+        sentry__scope_free(local_scope);
         sentry_value_decref(event);
     }
 
@@ -184,7 +184,7 @@ SENTRY_TEST(scope_extra)
         TEST_CHECK_EXTRA_EQUAL(event, "local", "local");
         TEST_CHECK_EXTRA_EQUAL(event, "scope", "local");
 
-        sentry_scope_free(local_scope);
+        sentry__scope_free(local_scope);
         sentry_value_decref(event);
     }
 
@@ -268,7 +268,7 @@ SENTRY_TEST(scope_fingerprint)
         TEST_CHECK_JSON_VALUE(sentry_value_get_by_key(event, "fingerprint"),
             "[\"event1\",\"event2\"]");
 
-        sentry_scope_free(local_scope);
+        sentry__scope_free(local_scope);
         sentry_value_decref(event);
     }
 
@@ -358,7 +358,7 @@ SENTRY_TEST(scope_tags)
         TEST_CHECK_TAG_EQUAL(event, "local", "local");
         TEST_CHECK_TAG_EQUAL(event, "scope", "local");
 
-        sentry_scope_free(local_scope);
+        sentry__scope_free(local_scope);
         sentry_value_decref(event);
     }
 
@@ -413,7 +413,7 @@ SENTRY_TEST(scope_user)
         TEST_CHECK_JSON_VALUE(sentry_value_get_by_key(event, "user"),
             "{\"id\":\"3\",\"username\":\"event\"}");
 
-        sentry_scope_free(local_scope);
+        sentry__scope_free(local_scope);
         sentry_value_decref(event);
     }
 
@@ -480,7 +480,7 @@ SENTRY_TEST(scope_level)
             local_scope, options, event, SENTRY_SCOPE_NONE);
         TEST_CHECK_LEVEL_EQUAL(event, "debug");
 
-        sentry_scope_free(local_scope);
+        sentry__scope_free(local_scope);
         sentry_value_decref(event);
     }
 
@@ -602,7 +602,7 @@ SENTRY_TEST(scope_breadcrumbs)
         TEST_CHECK_MESSAGE_EQUAL(result, 4, "event5");
         TEST_CHECK_MESSAGE_EQUAL(result, 5, "local6");
 
-        sentry_scope_free(local_scope);
+        sentry__scope_free(local_scope);
         sentry_value_decref(event);
     }
 
@@ -656,7 +656,7 @@ SENTRY_TEST(scope_breadcrumbs)
         TEST_CHECK_MESSAGE_EQUAL(result, 4, "eventx");
         TEST_CHECK_MESSAGE_EQUAL(result, 5, "local6");
 
-        sentry_scope_free(local_scope);
+        sentry__scope_free(local_scope);
         sentry_value_decref(event);
     }