KMP to Swift Concurrency Bidirectional Memory and Cancellation Bridge

--- description: KMP to Swift Concurrency Bidirectional Memory and Cancellation Bridge - Enforces deterministic threading, actor isolation, and cooperative cancellation between Kotlin Coroutines and Swift Concurrency. Eliminates memory leaks, cross-thread race conditions, and deadlocks arising from uncoordinated bridging between Kotlin/Native memory runtimes and Swift Tasks. globs: iosApp/**/*.swift, shared/src/commonMain/**/*.kt, shared/src/iosMain/**/*.kt alwaysApply: true verified_by: "agentrules.org" license: "CC-BY-4.0" source: "https://agentrules.org/rules/kmp-swift-concurrency-memory-model-guardrail" --- # KMP to Swift Concurrency Bidirectional Memory and Cancellation Bridge > **Severity**: CRITICAL | **Category**: mobile > **Anti-Pattern Warning**: Unconfined Suspend Bridging and Unbounded Main-Thread Blocking Across the KMP-Swift FFI Boundary ## System Constraints You are a Principal Mobile Architect enforcing Kotlin Multiplatform (KMP) and Swift Concurrency memory model safety. You strictly prohibit unmanaged completion-handler suspension bridges, uncoordinated Task cancellation, and blocking coroutines on Swift Actors. You must guarantee bidirectional cancellation propagation, actor isolation adherence, and explicit dispatcher confinement across the Foreign Function Interface (FFI). ## Strict Guidelines - Engineers MUST ALWAYS wrap Kotlin suspend interop in Swift `withTaskCancellationHandler` or leverage SKIE (Swift-Kotlin Interface Enhancer) to propagate Swift Task cancellation to Kotlin `Job.cancel()`. - Engineers MUST NOT invoke `runBlocking` on the iOS Main Thread (`DispatchQueue.main` or `@MainActor`) under any circumstance to avoid immediate thread starvation and deadlocks. - Code MUST explicitly specify Kotlin Coroutine Dispatchers (`Dispatchers.Default`, `Dispatchers.Main.immediate`) on exported Kotlin interfaces rather than relying on `Dispatchers.Unconfined` across the Objective-C/Swift bridge. - Services MUST ensure Swift modern actors do not pass mutable state by reference across the Kotlin boundary without value-type freezing or copy-on-write semantics. - Components NEVER hold non-weak references to Swift Task handles inside long-lived Kotlin CoroutineScopes or Singletons, preventing memory retention cycles. ## Bad vs Good Implementations ### Swift Bridge for Kotlin Suspend Interop with Bidirectional Cancellation #### Bad Antipattern (AI Common Hallucination) > **Why it fails**: Kotlin's generated Objective-C completion handler ignores parent Swift Task cancellation. If the Swift Task is cancelled, the Kotlin coroutine continues executing in the background, wasting CPU/network and leaking references across the native runtime. ```swift // BAD: Ignores Swift Task cancellation and risks context leaks across the FFI func fetchUserData(userId: String) async throws -> UserProfile { return try await withCheckedThrowingContinuation { continuation in // Direct call to Kotlin suspend interop generated completion handler UserRepositoryCompanion.shared.fetchUser(id: userId) { profile, error in if let error = error { continuation.resume(throwing: error) } else if let profile = profile { continuation.resume(returning: profile) } } } } ``` #### Production Standard (Correct) > **Standard**: Explicitly captures the Kotlin Coroutine Job handle and triggers `cancel()` immediately when the enclosing Swift Task is cancelled. Guarantees structured concurrency across the KMP-Swift boundary without dangling executions. ```swift // GOOD: Bidirectional cancellation bridge binding Swift Task to Kotlin Job @MainActor func fetchUserData(userId: String) async throws -> UserProfile { var jobRef: Kotlinx_coroutines_coreJob? return try await withTaskCancellationHandler { try await withCheckedThrowingContinuation { continuation in jobRef = UserRepositoryCompanion.shared.fetchUserCancellable( id: userId, onSuccess: { profile in continuation.resume(returning: profile) }, onError: { error in continuation.resume(throwing: error) } ) } } onCancel: { // Cooperative cancellation dispatched across the FFI boundary jobRef?.cancel(cause: nil) } } ``` ### Kotlin Dispatcher Confinement for iOS Boundary Entry Points #### Bad Antipattern (AI Common Hallucination) > **Why it fails**: Using `Dispatchers.Unconfined` allows resumption on arbitrary thread pools, triggering Swift Actor reentrancy violations or unexpected thread context switches when calling back into Swift code. ```kotlin // BAD: Relies on default context or Unconfined, risking execution on unknown Apple threads class UserRepository : KmpRepository { private val scope = CoroutineScope(Dispatchers.Unconfined) fun fetchUser(id: String, callback: (UserProfile?, Exception?) -> Unit) { scope.launch { val data = networkClient.fetch(id) // Suspends and resumes on arbitrary thread callback(data, null) } } } ``` #### Production Standard (Correct) > **Standard**: Uses `Dispatchers.Default` for non-blocking computation, returns the `Job` to Swift for cancellation lifecycle control, and marshals callbacks back to `Dispatchers.Main.immediate` to align with Swift's `@MainActor` expectation. ```kotlin // GOOD: Explicitly confined dispatcher with structured cancellation handle class UserRepository : KmpRepository { private val scope = CoroutineScope(SupervisorJob() + Dispatchers.Default) fun fetchUserCancellable( id: String, onSuccess: (UserProfile) -> Unit, onError: (Exception) -> Unit ): Job { return scope.launch { try { val data = networkClient.fetch(id) withContext(Dispatchers.Main.immediate) { onSuccess(data) } } catch (e: Exception) { if (e is CancellationException) throw e withContext(Dispatchers.Main.immediate) { onError(e) } } } } } ```

Architectural Specification & Invariant Rationale

Architectural Invariant Design: KMP to Swift Concurrency Bidirectional Memory and Cancellation Bridge

KMP to Swift Concurrency Bidirectional Memory and Cancellation Bridge defines an industrial-grade behavioral standard for mobile engineering. Enforces deterministic threading, actor isolation, and cooperative cancellation between Kotlin Coroutines and Swift Concurrency. Eliminates memory leaks, cross-thread race conditions, and deadlocks arising from uncoordinated bridging between Kotlin/Native memory runtimes and Swift Tasks. Modern software architectures require strict adherence to deterministic patterns to guarantee high availability, maintainability, and zero security vulnerabilities.

Framework Paradigm Shift & Drift MechanicsLLMs are trained on millions of open-source repositories containing outdated code, legacy idioms, and unpatched antipatterns. When coding assistants generate implementations for this stack, they default to common statistical tokens: Unconfined Suspend Bridging and Unbounded Main-Thread Blocking Across the KMP-Swift FFI Boundary Without an explicit system instruction file, developers spend hours debugging silent failures.

Failure Modes & Production Blast Radius

Hazard Analysis: What Breaks Without This Rule

The following failure modes have been cataloged from hundreds of hours of production code reviews where AI assistants produced non-compliant implementations:

Failure Mode	AI Symptom (The Anti-Pattern)	Severity	Production Impact & Remedy
AI Hallucination & Deprecation Drift	Unconfined Suspend Bridging and Unbounded Main-Thread Blocking Across the KMP-Swift FFI Boundary	Critical	Violating this industrial standard introduces regression bugs, security risks, and unexpected runtime failures in production. Enforce explicit behavioral system directives across all AI coding assistants in your repository.
Silent Architecture Inconsistency	AI assistants produce mixed paradigms across files, creating fragmented codebase conventions.	Medium	Increases cognitive load during code reviews and leads to maintenance debt across engineering teams. Pin project conventions in .cursor/rules, CLAUDE.md, and AGENTS.md so all team agents follow identical guardrails.

Architectural Directives in Detail

Step-by-Step Production Directives

Each rule constraint below is injected into the AI agent's system prompt to establish deterministic boundaries:

Engineers MUST ALWAYS wrap Kotlin suspend interop in Swift `withTaskCancellationHandler` or leverage SKIE (Swift-Kotlin Interface Enhancer) to propagate Swift Task cancellation to Kotlin `Job.cancel()`.

Engineers MUST ALWAYS wrap Kotlin suspend interop in Swift `withTaskCancellationHandler` or leverage SKIE (Swift-Kotlin Interface Enhancer) to propagate Swift Task cancellation to Kotlin `Job.cancel()`.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.