ref(apple)!: Rename the cinterop package prefix from cocoapods to cocoa

buenaflor · claude · buenaflor · commit 90a6b6d9d8ac · 2026-06-11T15:00:53.000+02:00
The bundled Sentry Cocoa cinterop package was named after the delivery
mechanism, which became a misnomer once the Apple build moved from the
Kotlin CocoaPods plugin to SwiftPM. Rename the prefix to cocoa, naming
the platform SDK instead. This also disambiguates the bundled binding
from a consumer's own pod("Sentry") cinterop, which always generates
cocoapods.Sentry and previously collided with ours.

BREAKING CHANGE: Code importing cocoapods.Sentry.* directly in Apple
source sets must import cocoa.Sentry.* instead. Code using public SDK
types such as SentryPlatformOptions is unaffected.

Co-Authored-By: Claude Fable 5 &lt;noreply@anthropic.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,10 +2,14 @@
 
 ## Unreleased
 
+### Breaking Changes
+
+- Rename the bundled Sentry Cocoa cinterop package prefix from `cocoapods` to `cocoa` ([#557](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/557))
+  - If you imported `cocoapods.Sentry.*` directly in Apple source sets, replace it with `cocoa.Sentry.*`. Code using public SDK types such as `SentryPlatformOptions` is unaffected.
+
 ### Internal
 
 - Build the Apple SDK against Sentry Cocoa via SwiftPM (spm4Kmp) instead of the Kotlin CocoaPods plugin ([#557](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/557))
-  - The published klibs keep the `cocoapods.Sentry` import prefix, so no changes are required for consumers
 
 ### Dependencies
 
diff --git a/sentry-kotlin-multiplatform/build.gradle.kts b/sentry-kotlin-multiplatform/build.gradle.kts
@@ -159,9 +159,9 @@ kotlin {
 
         appleTargets.forEach { target ->
             target.swiftPackageConfig(cinteropName = "sentryCocoa") {
-                // Keep the legacy Kotlin CocoaPods `cocoapods.Sentry.*` import prefix so
-                // published klib symbols stay identical.
-                packageDependencyPrefix = "cocoapods"
+                // Part of the published klib API: consumers can import `cocoa.Sentry.*` directly,
+                // so renaming this prefix is a breaking change.
+                packageDependencyPrefix = "cocoa"
                 minIos = Config.Cocoa.iosDeploymentTarget
                 minMacos = Config.Cocoa.osxDeploymentTarget
                 minTvos = Config.Cocoa.tvosDeploymentTarget
diff --git a/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/SentryApple.kt b/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/SentryApple.kt
@@ -2,7 +2,7 @@ package io.sentry.kotlin.multiplatform
 
 import Internal.Sentry.SentryCrashMonitorTypeCPPException
 import Internal.Sentry.SentryDependencyContainer
-import cocoapods.Sentry.SentrySDK
+import cocoa.Sentry.SentrySDK
 import io.sentry.kotlin.multiplatform.nsexception.setSentryUnhandledExceptionHook
 
 /** Convenience extension to setup unhandled exception hook */
diff --git a/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/SentryBridge.apple.kt b/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/SentryBridge.apple.kt
@@ -2,7 +2,7 @@ package io.sentry.kotlin.multiplatform
 
 import Internal.Sentry.PrivateSentrySDKOnly
 import Internal.Sentry.kSentryLevelError
-import cocoapods.Sentry.SentrySDK
+import cocoa.Sentry.SentrySDK
 import io.sentry.kotlin.multiplatform.extensions.toCocoaBreadcrumb
 import io.sentry.kotlin.multiplatform.extensions.toCocoaUser
 import io.sentry.kotlin.multiplatform.extensions.toCocoaUserFeedback
diff --git a/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/TypeAliases.apple.kt b/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/TypeAliases.apple.kt
@@ -1,16 +1,16 @@
 package io.sentry.kotlin.multiplatform
 
-import cocoapods.Sentry.SentryAttachment
-import cocoapods.Sentry.SentryBreadcrumb
-import cocoapods.Sentry.SentryEvent
-import cocoapods.Sentry.SentryException
-import cocoapods.Sentry.SentryId
-import cocoapods.Sentry.SentryLevel
-import cocoapods.Sentry.SentryMessage
-import cocoapods.Sentry.SentryOptions
-import cocoapods.Sentry.SentryScope
-import cocoapods.Sentry.SentryUser
-import cocoapods.Sentry.SentryUserFeedback
+import cocoa.Sentry.SentryAttachment
+import cocoa.Sentry.SentryBreadcrumb
+import cocoa.Sentry.SentryEvent
+import cocoa.Sentry.SentryException
+import cocoa.Sentry.SentryId
+import cocoa.Sentry.SentryLevel
+import cocoa.Sentry.SentryMessage
+import cocoa.Sentry.SentryOptions
+import cocoa.Sentry.SentryScope
+import cocoa.Sentry.SentryUser
+import cocoa.Sentry.SentryUserFeedback
 
 internal typealias CocoaUser = SentryUser
 internal typealias CocoaBreadcrumb = SentryBreadcrumb
@@ -23,4 +23,4 @@ internal typealias CocoaUserFeedback = SentryUserFeedback
 internal typealias CocoaSentryEvent = SentryEvent
 internal typealias CocoaMessage = SentryMessage
 internal typealias CocoaSentryException = SentryException
-internal typealias CocoaSentryLogger = cocoapods.Sentry.SentryLogger
+internal typealias CocoaSentryLogger = cocoa.Sentry.SentryLogger
diff --git a/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/extensions/SentryEventExtensions.apple.kt b/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/extensions/SentryEventExtensions.apple.kt
@@ -1,6 +1,6 @@
 package io.sentry.kotlin.multiplatform.extensions
 
-import cocoapods.Sentry.SentryId
+import cocoa.Sentry.SentryId
 import io.sentry.kotlin.multiplatform.CocoaSentryEvent
 import io.sentry.kotlin.multiplatform.SentryEvent
 
diff --git a/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/extensions/SentryLevelExtensions.apple.kt b/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/extensions/SentryLevelExtensions.apple.kt
@@ -2,7 +2,7 @@ package io.sentry.kotlin.multiplatform.extensions
 
 import io.sentry.kotlin.multiplatform.SentryLevel
 import kotlinx.cinterop.convert
-import cocoapods.Sentry.SentryLevel as CocoaSentryLevel
+import cocoa.Sentry.SentryLevel as CocoaSentryLevel
 
 internal fun SentryLevel.toCocoaSentryLevel() = this.toInt().convert<CocoaSentryLevel>()
 
diff --git a/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/extensions/SentryOptionsExtensions.apple.kt b/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/extensions/SentryOptionsExtensions.apple.kt
@@ -1,7 +1,7 @@
 package io.sentry.kotlin.multiplatform.extensions
 
-import cocoapods.Sentry.SentryHttpStatusCodeRange
-import cocoapods.Sentry.experimental
+import cocoa.Sentry.SentryHttpStatusCodeRange
+import cocoa.Sentry.experimental
 import io.sentry.kotlin.multiplatform.CocoaSentryOptions
 import io.sentry.kotlin.multiplatform.SentryEvent
 import io.sentry.kotlin.multiplatform.SentryOptions
diff --git a/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/log/CocoaSentryLoggerAdapter.kt b/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/log/CocoaSentryLoggerAdapter.kt
@@ -1,7 +1,7 @@
 package io.sentry.kotlin.multiplatform.log
 
 import io.sentry.kotlin.multiplatform.SentryAttributes
-import cocoapods.Sentry.SentryLogger as CocoaSentryLogger
+import cocoa.Sentry.SentryLogger as CocoaSentryLogger
 
 /**
  * Adapter that bridges KMP [SentryLogger] to the Cocoa SDK's [CocoaSentryLogger].
diff --git a/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/log/SentryLogConverters.apple.kt b/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/log/SentryLogConverters.apple.kt
@@ -1,12 +1,12 @@
 package io.sentry.kotlin.multiplatform.log
 
-import cocoapods.Sentry.SentryStructuredLogAttribute
+import cocoa.Sentry.SentryStructuredLogAttribute
 import io.sentry.kotlin.multiplatform.SentryAttributeValue
 import kotlinx.cinterop.convert
 import platform.Foundation.NSNumber
 import platform.Foundation.timeIntervalSince1970
-import cocoapods.Sentry.SentryLog as CocoaSentryLog
-import cocoapods.Sentry.SentryLogLevel as CocoaSentryLogLevel
+import cocoa.Sentry.SentryLog as CocoaSentryLog
+import cocoa.Sentry.SentryLogLevel as CocoaSentryLogLevel
 import io.sentry.kotlin.multiplatform.SentryAttributes as KmpSentryAttributes
 
 /**
diff --git a/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/nsexception/SentryUnhandledExceptions.kt b/sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/nsexception/SentryUnhandledExceptions.kt
@@ -26,15 +26,15 @@ private typealias InternalSentrySDK = Internal.Sentry.SentrySDKInternal
 private typealias InternalSentryDependencyContainer = Internal.Sentry.SentryDependencyContainer
 private typealias InternalSentryThreadInspector = Internal.Sentry.SentryThreadInspector
 
-private typealias CocoapodsSentryEvent = cocoapods.Sentry.SentryEvent
-private typealias CocoapodsSentrySDK = cocoapods.Sentry.SentrySDK
-private typealias CocoapodsSentryStacktrace = cocoapods.Sentry.SentryStacktrace
-private typealias CocoapodsSentryException = cocoapods.Sentry.SentryException
-private typealias CocoapodsSentryMechanism = cocoapods.Sentry.SentryMechanism
-private typealias CocoapodsSentryThread = cocoapods.Sentry.SentryThread
-private typealias CocoapodsSentryEnvelope = cocoapods.Sentry.SentryEnvelope
-private typealias CocoapodsSentryEnvelopeHeader = cocoapods.Sentry.SentryEnvelopeHeader
-private typealias CocoapodsSentryEnvelopeItem = cocoapods.Sentry.SentryEnvelopeItem
+private typealias CocoapodsSentryEvent = cocoa.Sentry.SentryEvent
+private typealias CocoapodsSentrySDK = cocoa.Sentry.SentrySDK
+private typealias CocoapodsSentryStacktrace = cocoa.Sentry.SentryStacktrace
+private typealias CocoapodsSentryException = cocoa.Sentry.SentryException
+private typealias CocoapodsSentryMechanism = cocoa.Sentry.SentryMechanism
+private typealias CocoapodsSentryThread = cocoa.Sentry.SentryThread
+private typealias CocoapodsSentryEnvelope = cocoa.Sentry.SentryEnvelope
+private typealias CocoapodsSentryEnvelopeHeader = cocoa.Sentry.SentryEnvelopeHeader
+private typealias CocoapodsSentryEnvelopeItem = cocoa.Sentry.SentryEnvelopeItem
 
 /**
  * Drops the Kotlin crash that follows an unhandled Kotlin exception except our custom SentryEvent.
@@ -89,14 +89,14 @@ private fun Throwable.asSentryEnvelope(): CocoapodsSentryEnvelope {
         hub.getClient()
             ?.prepareEvent(event, hub.scope, alwaysAttachStacktrace = false, isFatalEvent = true)
     } ?: event
-    val item = CocoapodsSentryEnvelopeItem(event = preparedEvent as cocoapods.Sentry.SentryEvent)
+    val item = CocoapodsSentryEnvelopeItem(event = preparedEvent as cocoa.Sentry.SentryEvent)
     // TODO: pass traceState when enabling performance monitoring for KMP SDK
     val header = CocoapodsSentryEnvelopeHeader(id = preparedEvent.eventId)
     return CocoapodsSentryEnvelope(header, listOf(item))
 }
 
 /**
- * Converts `this` [Throwable] to a [cocoapods.Sentry.SentryEvent].
+ * Converts `this` [Throwable] to a [cocoa.Sentry.SentryEvent].
  *
  * @param level The Sentry level (e.g., kSentryLevelFatal for crashes, kSentryLevelError for handled)
  * @param isHandled Whether this is a handled exception (false for crashes, true for captured exceptions)
diff --git a/sentry-kotlin-multiplatform/src/appleTest/kotlin/io/sentry/kotlin/multiplatform/BaseSentryScopeTest.kt b/sentry-kotlin-multiplatform/src/appleTest/kotlin/io/sentry/kotlin/multiplatform/BaseSentryScopeTest.kt
@@ -1,6 +1,6 @@
 package io.sentry.kotlin.multiplatform
 
-import cocoapods.Sentry.SentryScope as CocoaScope
+import cocoa.Sentry.SentryScope as CocoaScope
 
 actual abstract class BaseSentryScopeTest {
     actual fun initializeScope(): Scope {
diff --git a/sentry-kotlin-multiplatform/src/appleTest/kotlin/io/sentry/kotlin/multiplatform/log/SentryLogConvertersTest.kt b/sentry-kotlin-multiplatform/src/appleTest/kotlin/io/sentry/kotlin/multiplatform/log/SentryLogConvertersTest.kt
@@ -3,7 +3,7 @@ package io.sentry.kotlin.multiplatform.log
 import kotlinx.cinterop.convert
 import kotlin.test.Test
 import kotlin.test.assertEquals
-import cocoapods.Sentry.SentryLogLevel as CocoaSentryLogLevel
+import cocoa.Sentry.SentryLogLevel as CocoaSentryLogLevel
 
 /** Tests for Apple/Cocoa log level conversion functions in SentryLogConverters.apple.kt. */
 class SentryLogConvertersTest {
diff --git a/sentry-kotlin-multiplatform/src/commonTvWatchMacOsMain/kotlin/io/sentry/kotlin/multiplatform/SentryPlatformInstance.tvwatchmacos.kt b/sentry-kotlin-multiplatform/src/commonTvWatchMacOsMain/kotlin/io/sentry/kotlin/multiplatform/SentryPlatformInstance.tvwatchmacos.kt
@@ -1,6 +1,6 @@
 package io.sentry.kotlin.multiplatform
 
-import cocoapods.Sentry.SentrySDK
+import cocoa.Sentry.SentrySDK
 
 internal actual class SentryPlatformInstance : SentryInstance {
     actual override fun init(configuration: PlatformOptionsConfiguration) {
diff --git a/sentry-kotlin-multiplatform/src/commonTvWatchMacOsMain/kotlin/io/sentry/kotlin/multiplatform/SentryPlatformOptions.tvwatchmacos.kt b/sentry-kotlin-multiplatform/src/commonTvWatchMacOsMain/kotlin/io/sentry/kotlin/multiplatform/SentryPlatformOptions.tvwatchmacos.kt
@@ -2,7 +2,7 @@ package io.sentry.kotlin.multiplatform
 
 import io.sentry.kotlin.multiplatform.extensions.toCocoaOptionsConfiguration
 
-public actual typealias SentryPlatformOptions = cocoapods.Sentry.SentryOptions
+public actual typealias SentryPlatformOptions = cocoa.Sentry.SentryOptions
 
 internal actual fun SentryOptions.toPlatformOptionsConfiguration(): PlatformOptionsConfiguration =
     toCocoaOptionsConfiguration()
diff --git a/sentry-kotlin-multiplatform/src/iosMain/kotlin/io/sentry/kotlin/multiplatform/SentryPlatformInstance.ios.kt b/sentry-kotlin-multiplatform/src/iosMain/kotlin/io/sentry/kotlin/multiplatform/SentryPlatformInstance.ios.kt
@@ -1,6 +1,6 @@
 package io.sentry.kotlin.multiplatform
 
-import cocoapods.Sentry.SentrySDK
+import cocoa.Sentry.SentrySDK
 
 internal actual class SentryPlatformInstance : SentryInstance {
     actual override fun init(configuration: PlatformOptionsConfiguration) {
diff --git a/sentry-kotlin-multiplatform/src/iosMain/kotlin/io/sentry/kotlin/multiplatform/SentryPlatformOptions.ios.kt b/sentry-kotlin-multiplatform/src/iosMain/kotlin/io/sentry/kotlin/multiplatform/SentryPlatformOptions.ios.kt
@@ -2,7 +2,7 @@ package io.sentry.kotlin.multiplatform
 
 import io.sentry.kotlin.multiplatform.extensions.toIosOptionsConfiguration
 
-public actual typealias SentryPlatformOptions = cocoapods.Sentry.SentryOptions
+public actual typealias SentryPlatformOptions = cocoa.Sentry.SentryOptions
 
 internal actual fun SentryOptions.toPlatformOptionsConfiguration(): PlatformOptionsConfiguration =
     toIosOptionsConfiguration()
diff --git a/sentry-kotlin-multiplatform/src/iosMain/kotlin/io/sentry/kotlin/multiplatform/extensions/SentryOptionsExtensions.ios.kt b/sentry-kotlin-multiplatform/src/iosMain/kotlin/io/sentry/kotlin/multiplatform/extensions/SentryOptionsExtensions.ios.kt
@@ -1,6 +1,6 @@
 package io.sentry.kotlin.multiplatform.extensions
 
-import cocoapods.Sentry.SentryReplayOptions
+import cocoa.Sentry.SentryReplayOptions
 import io.sentry.kotlin.multiplatform.CocoaSentryOptions
 import io.sentry.kotlin.multiplatform.SentryOptions
 
diff --git a/sentry-kotlin-multiplatform/src/iosTest/kotlin/io/sentry/kotlin/multiplatform/PlatformOptions.ios.kt b/sentry-kotlin-multiplatform/src/iosTest/kotlin/io/sentry/kotlin/multiplatform/PlatformOptions.ios.kt
@@ -1,6 +1,6 @@
 package io.sentry.kotlin.multiplatform
 
-import cocoapods.Sentry.SentryReplayOptions
+import cocoa.Sentry.SentryReplayOptions
 import io.sentry.kotlin.multiplatform.extensions.toIosOptionsConfiguration
 import kotlin.test.assertEquals
 
