Skip to content

Commit

Permalink
Merge b65ccd0 into b5b093e
Browse files Browse the repository at this point in the history
  • Loading branch information
@markushi
markushi authored Oct 4, 2024
2 parents b5b093e + b65ccd0 commit 4139c9c
Show file tree
Hide file tree
Showing 3 changed files with 103 additions and 27 deletions.
2 changes: 1 addition & 1 deletion sentry-android-ndk/build.gradle.kts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,6 @@ dependencies {

testImplementation(kotlin(Config.kotlinStdLib, KotlinCompilerVersion.VERSION))
testImplementation(Config.TestLibs.kotlinTestJunit)

testImplementation(Config.TestLibs.mockitoKotlin)
testImplementation(projects.sentryTestSupport)
}
90 changes: 64 additions & 26 deletions sentry-android-ndk/src/main/java/io/sentry/android/ndk/NdkScopeObserver.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,18 @@ public NdkScopeObserver(final @NotNull SentryOptions options) {
@Override
public void setUser(final @Nullable User user) {
try {
if (user == null) {
// remove user if its null
nativeScope.removeUser();
} else {
nativeScope.setUser(user.getId(), user.getEmail(), user.getIpAddress(), user.getUsername());
}
options
.getExecutorService()
.submit(
() -> {
if (user == null) {
// remove user if its null
nativeScope.removeUser();
} else {
nativeScope.setUser(
user.getId(), user.getEmail(), user.getIpAddress(), user.getUsername());
}
});
} catch (Throwable e) {
options.getLogger().log(SentryLevel.ERROR, e, "Scope sync setUser has an error.");
}
Expand All @@ -45,24 +51,36 @@ public void setUser(final @Nullable User user) {
@Override
public void addBreadcrumb(final @NotNull Breadcrumb crumb) {
try {
String level = null;
if (crumb.getLevel() != null) {
level = crumb.getLevel().name().toLowerCase(Locale.ROOT);
}
final String timestamp = DateUtils.getTimestamp(crumb.getTimestamp());
options
.getExecutorService()
.submit(
() -> {
String level = null;
if (crumb.getLevel() != null) {
level = crumb.getLevel().name().toLowerCase(Locale.ROOT);
}
final String timestamp = DateUtils.getTimestamp(crumb.getTimestamp());

String data = null;
try {
final Map<String, Object> dataRef = crumb.getData();
if (!dataRef.isEmpty()) {
data = options.getSerializer().serialize(dataRef);
}
} catch (Throwable e) {
options.getLogger().log(SentryLevel.ERROR, e, "Breadcrumb data is not serializable.");
}
String data = null;
try {
final Map<String, Object> dataRef = crumb.getData();
if (!dataRef.isEmpty()) {
data = options.getSerializer().serialize(dataRef);
}
} catch (Throwable e) {
options
.getLogger()
.log(SentryLevel.ERROR, e, "Breadcrumb data is not serializable.");
}

nativeScope.addBreadcrumb(
level, crumb.getMessage(), crumb.getCategory(), crumb.getType(), timestamp, data);
nativeScope.addBreadcrumb(
level,
crumb.getMessage(),
crumb.getCategory(),
crumb.getType(),
timestamp,
data);
});
} catch (Throwable e) {
options.getLogger().log(SentryLevel.ERROR, e, "Scope sync addBreadcrumb has an error.");
}
Expand All @@ -71,7 +89,12 @@ public void addBreadcrumb(final @NotNull Breadcrumb crumb) {
@Override
public void setTag(final @NotNull String key, final @NotNull String value) {
try {
nativeScope.setTag(key, value);
options
.getExecutorService()
.submit(
() -> {
nativeScope.setTag(key, value);
});
} catch (Throwable e) {
options.getLogger().log(SentryLevel.ERROR, e, "Scope sync setTag(%s) has an error.", key);
}
Expand All @@ -80,7 +103,12 @@ public void setTag(final @NotNull String key, final @NotNull String value) {
@Override
public void removeTag(final @NotNull String key) {
try {
nativeScope.removeTag(key);
options
.getExecutorService()
.submit(
() -> {
nativeScope.removeTag(key);
});
} catch (Throwable e) {
options.getLogger().log(SentryLevel.ERROR, e, "Scope sync removeTag(%s) has an error.", key);
}
Expand All @@ -89,7 +117,12 @@ public void removeTag(final @NotNull String key) {
@Override
public void setExtra(final @NotNull String key, final @NotNull String value) {
try {
nativeScope.setExtra(key, value);
options
.getExecutorService()
.submit(
() -> {
nativeScope.setExtra(key, value);
});
} catch (Throwable e) {
options.getLogger().log(SentryLevel.ERROR, e, "Scope sync setExtra(%s) has an error.", key);
}
Expand All @@ -98,7 +131,12 @@ public void setExtra(final @NotNull String key, final @NotNull String value) {
@Override
public void removeExtra(final @NotNull String key) {
try {
nativeScope.removeExtra(key);
options
.getExecutorService()
.submit(
() -> {
nativeScope.removeExtra(key);
});
} catch (Throwable e) {
options
.getLogger()
Expand Down
38 changes: 38 additions & 0 deletions sentry-android-ndk/src/test/java/io/sentry/android/ndk/NdkScopeObserverTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,13 @@ import io.sentry.JsonSerializer
import io.sentry.SentryLevel
import io.sentry.SentryOptions
import io.sentry.protocol.User
import io.sentry.test.DeferredExecutorService
import io.sentry.test.ImmediateExecutorService
import org.mockito.kotlin.any
import org.mockito.kotlin.anyOrNull
import org.mockito.kotlin.eq
import org.mockito.kotlin.mock
import org.mockito.kotlin.never
import org.mockito.kotlin.verify
import kotlin.test.Test

Expand All @@ -17,6 +22,7 @@ class NdkScopeObserverTest {
val nativeScope = mock<INativeScope>()
val options = SentryOptions().apply {
setSerializer(JsonSerializer(mock()))
executorService = ImmediateExecutorService()
}

fun getSut(): NdkScopeObserver {
Expand Down Expand Up @@ -111,4 +117,36 @@ class NdkScopeObserverTest {
eq(data)
)
}

@Test
fun `scope sync utilizes executor service`() {
val executorService = DeferredExecutorService()
fixture.options.executorService = executorService
val sut = fixture.getSut()

sut.setTag("a", "b")
sut.removeTag("a")
sut.setExtra("a", "b")
sut.removeExtra("a")
sut.setUser(User())
sut.addBreadcrumb(Breadcrumb())

// as long as the executor service is not run, the scope sync is not called
verify(fixture.nativeScope, never()).setTag(any(), any())
verify(fixture.nativeScope, never()).removeTag(any())
verify(fixture.nativeScope, never()).setExtra(any(), any())
verify(fixture.nativeScope, never()).removeExtra(any())
verify(fixture.nativeScope, never()).setUser(any(), any(), any(), any())
verify(fixture.nativeScope, never()).addBreadcrumb(any(), any(), any(), any(), any(), any())

// when the executor service is run, the scope sync is called
executorService.runAll()

verify(fixture.nativeScope).setTag(any(), any())
verify(fixture.nativeScope).removeTag(any())
verify(fixture.nativeScope).setExtra(any(), any())
verify(fixture.nativeScope).removeExtra(any())
verify(fixture.nativeScope).setUser(anyOrNull(), anyOrNull(), anyOrNull(), anyOrNull())
verify(fixture.nativeScope).addBreadcrumb(anyOrNull(), anyOrNull(), anyOrNull(), anyOrNull(), anyOrNull(), anyOrNull())
}
}

0 comments on commit 4139c9c

Please sign in to comment.