Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: cocoa crash handling due to sdkInfo removal in cocoa sdk #68

Merged
merged 5 commits into from
Apr 6, 2023
Merged

fix: cocoa crash handling due to sdkInfo removal in cocoa sdk #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
23de3e4
remove sdkInfo from SentryEnvelopHeader init
buenaflor Mar 31, 2023
40108ac
add test for creating envelopes
buenaflor Mar 31, 2023
4ba841a
remove test
buenaflor Mar 31, 2023
8038076
Update CHANGELOG.md
buenaflor Mar 31, 2023
0500a64
Merge branch 'main' into fix/cocoa-crash-handling
buenaflor Mar 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
### Fixes

- ref: use explicit api & add code consistency ([#63](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/63))
- fix: cocoa crash handling due to sdkInfo removal in cocoa sdk ([#68](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/68))

## 0.0.3

Expand Down
4 changes: 1 addition & 3 deletions ...mmonAppleMain/kotlin/io/sentry/kotlin/multiplatform/extensions/SentryOptionsExtensions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ internal fun CocoaSentryOptions.applyCocoaBaseOptions(options: SentryOptions) {
this.maxAttachmentSize = options.maxAttachmentSize.convert()
this.maxBreadcrumbs = options.maxBreadcrumbs.convert()
this.beforeSend = { event ->
dropKotlinCrashEvent(event as NSExceptionSentryEvent?) as SentryEvent?

val cocoaName = BuildKonfig.SENTRY_COCOA_PACKAGE_NAME
val cocoaVersion = BuildKonfig.SENTRY_COCOA_VERSION

Expand All @@ -50,7 +48,7 @@ internal fun CocoaSentryOptions.applyCocoaBaseOptions(options: SentryOptions) {
sdk?.set("packages", packages)

event?.sdk = sdk
event
dropKotlinCrashEvent(event as NSExceptionSentryEvent?) as SentryEvent?
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since beforeSend is based on the lambda result we have to put dropKotlinCrashEvent at the end.

}

val sdkName = options.sdk?.name ?: BuildKonfig.SENTRY_KMP_COCOA_SDK_NAME
Expand Down
8 changes: 3 additions & 5 deletions ...nAppleMain/kotlin/io/sentry/kotlin/multiplatform/nsexception/SentryUnhandledExceptions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ import NSException.Sentry.SentryThreadInspector
import NSException.Sentry.currentHub
import NSException.Sentry.isCrashEvent
import NSException.Sentry.kSentryLevelFatal
import NSException.Sentry.options
import NSException.Sentry.prepareEvent
import NSException.Sentry.sdkInfo
import NSException.Sentry.storeEnvelope
import NSException.Sentry.threadInspector
import kotlinx.cinterop.UnsafeNumber
Expand Down Expand Up @@ -66,19 +64,19 @@ internal fun setSentryUnhandledExceptionHook(): Unit = wrapUnhandledExceptionHoo
/**
* Tag used to mark the Kotlin termination crash.
*/
private const val kotlinCrashedTag = "nsexceptionkt.kotlin_crashed"
internal const val kotlinCrashedTag = "nsexceptionkt.kotlin_crashed"

/**
* Converts `this` [Throwable] to a [SentryEnvelope].
*/
private fun Throwable.asSentryEnvelope(): SentryEnvelope {
internal fun Throwable.asSentryEnvelope(): SentryEnvelope {
val event = asSentryEvent()
val preparedEvent = SentrySDK.currentHub().let { hub ->
hub.getClient()?.prepareEvent(event, hub.scope, alwaysAttachStacktrace = false, isCrashEvent = true)
} ?: event
val item = SentryEnvelopeItem(preparedEvent)
// TODO: pass traceState when enabling performance monitoring for KMP SDK
val header = SentryEnvelopeHeader(preparedEvent.eventId, SentrySDK.options?.sdkInfo, null)
val header = SentryEnvelopeHeader(preparedEvent.eventId, null)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

M: why is the sdkInfo removed?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does that mean that events dont have the SDK info anymore?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's removed because the cocoa sdk deprecated sdkInfo. So SentryEnvelopeHeader does not have a param in the constructor with sdkInfo anymore.

The sdkInfo is still being set in beforeSend with PrivateSentrySDKOnly.setSdkName(sdkName, sdkVersion)

return SentryEnvelope(header, listOf(item))
}

Expand Down
3 changes: 1 addition & 2 deletions ...atform/src/commonAppleMain/kotlin/io/sentry/kotlin/multiplatform/nsexception/Throwable.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,8 @@ package io.sentry.kotlin.multiplatform.nsexception
internal val Throwable.causes: List<Throwable> get() = buildList {
val causes = mutableSetOf<Throwable>()
var cause = cause
while (cause != null && cause !in causes) {
while (cause != null && causes.add(cause)) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this just an optimization? can causes.add return false for some reason?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup, just a minor optimization - add(...) will return false on elements that are already in a set.

add(cause)
causes.add(cause)
cause = cause.cause
}
}
Expand Down
11 changes: 5 additions & 6 deletions sentry-kotlin-multiplatform/src/nativeInterop/cinterop/Sentry.NSException.def
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
language = Objective-C
headers = SentryClient.h SentryDebugImageProvider.h SentryDebugMeta.h SentryDefines.h SentryEnvelope.h SentryEvent.h \
SentryException.h SentryHub.h SentryId.h SentryMechanism.h SentryMechanism+NSExceptionKt.h SentryOptions.h \
SentryScope.h SentrySDK.h SentrySdkInfo.h SentryStacktrace.h SentryThread.h SentryThread+NSExceptionKt.h \
Private/SentryClient.h Private/SentryCrashMonitor_NSException.h Private/SentryCrashMonitor_NSException+NSExceptionKt.h \
Private/SentryCrashStackCursor.h Private/SentryDependencyContainer.h Private/SentryEvent.h Private/SentryHook.h \
Private/SentryOptions.h Private/SentrySDK.h Private/SentryStacktraceBuilder.h Private/SentryThreadInspector.h \
Private/SentryTraceContext.h
SentryException.h SentryHub.h SentryId.h SentryMechanism.h SentryMechanism+NSExceptionKt.h SentryOptions.h \
SentryScope.h SentrySDK.h SentryStacktrace.h SentryThread.h SentryThread+NSExceptionKt.h Private/SentryClient.h \
Private/SentryCrashMonitor_NSException.h Private/SentryCrashMonitor_NSException+NSExceptionKt.h \
Private/SentryCrashStackCursor.h Private/SentryDependencyContainer.h Private/SentryEvent.h Private/SentryHook.h \
Private/SentrySDK.h Private/SentryStacktraceBuilder.h Private/SentryThreadInspector.h Private/SentryTraceContext.h
26 changes: 0 additions & 26 deletions ...kotlin-multiplatform/src/nativeInterop/cinterop/SentryNSException/Private/SentryOptions.h
View file
Open in desktop

This file was deleted.

4 changes: 1 addition & 3 deletions sentry-kotlin-multiplatform/src/nativeInterop/cinterop/SentryNSException/SentryEnvelope.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,11 @@
#import <Private/SentryTraceContext.h>
#import <SentryEvent.h>
#import <SentryId.h>
#import <SentrySdkInfo.h>

@interface SentryEnvelopeHeader : NSObject

- (instancetype)initWithId:(nullable SentryId *)eventId
sdkInfo:(nullable SentrySdkInfo *)sdkInfo
traceContext:(nullable SentryTraceContext *)traceContext NS_DESIGNATED_INITIALIZER;
traceContext:(nullable SentryTraceContext *)traceContext;

@end

Expand Down
23 changes: 0 additions & 23 deletions sentry-kotlin-multiplatform/src/nativeInterop/cinterop/SentryNSException/SentrySdkInfo.h
View file
Open in desktop

This file was deleted.