This specification is maintained by the AgentRules Working Group. Have enhancements or want to claim maintainership?Submit Specification →
mobilecritical PriorityID: kmp-stateflow-swift-concurrency-bridge

Kotlin Multiplatform StateFlow to Swift Concurrency Bridge Invariants

Enforces non-blocking cooperative execution and bidirectional cancellation semantics when bridging Kotlin StateFlow/SharedFlow to Swift AsyncSequence. Prevents thread pool starvation in Darwin's cooperative thread pool and eliminates cyclic reference memory leaks across K/N Garbage Collector and Swift ARC boundaries.

Prohibited Anti-Pattern: Synchronous Interop Blocking and Unbridled Flow Subscription Leaks

Export Ready-to-Drop Configuration

Select format below to copy code or download file directly.

---
description: Kotlin Multiplatform StateFlow to Swift Concurrency Bridge Invariants - Enforces non-blocking cooperative execution and bidirectional cancellation semantics when bridging Kotlin StateFlow/SharedFlow to Swift AsyncSequence. Prevents thread pool starvation in Darwin's cooperative thread pool and eliminates cyclic reference memory leaks across K/N Garbage Collector and Swift ARC boundaries.
globs: iosApp/**/*.swift, shared/src/iosMain/**/*.kt, **/*FlowBridge*.swift, **/*ViewModel*.swift
alwaysApply: true
verified_by: "agentrules.org"
license: "CC-BY-4.0"
source: "https://agentrules.org/rules/kmp-stateflow-swift-concurrency-bridge"
---

# Kotlin Multiplatform StateFlow to Swift Concurrency Bridge Invariants

> **Severity**: CRITICAL | **Category**: mobile
> **Anti-Pattern Warning**: Synchronous Interop Blocking and Unbridled Flow Subscription Leaks

## System Constraints
You are a Principal Mobile Architect enforcing rock-solid concurrency and memory invariants across Kotlin Multiplatform (K/N) and Swift (Darwin). Never allow synchronous blocking bridges, unchecked Kotlin Coroutine Job leaks, or retain cycles between Swift closures and Kotlin Garbage Collection heaps.

## Strict Guidelines
- Engineers MUST ALWAYS bind Swift AsyncStream/AsyncSequence lifecycle to Kotlin Coroutine Job cancellation via continuation.onTermination or Task cancellation handlers.
- Engineers MUST NOT block Swift's cooperative thread pool using semaphores, dispatch group waits, or synchronous RunLoop execution waiting for Kotlin coroutines.
- Code SHOULD enforce weak reference captures ([weak self]) inside Swift observation closures passed into KMP completion blocks to break ARC-K/N cross-runtime cyclic references.
- Services MUST ensure Kotlin Native flows are collected on Dispatchers.Default or Dispatchers.Main.immediate and mapped to MainActor in Swift without nesting DispatchQueue.main.sync.
- Components NEVER bridge unbounded SharedFlow without explicit buffer overflow policies (BufferOverflow.DROP_OLDEST or backpressure handling), as rapid emissions can trigger memory exhaustion in Swift's interop layer.

## Bad vs Good Implementations
### Bridging Kotlin StateFlow to Swift AsyncStream with Lifecycle Cancellation

#### Bad Antipattern (AI Common Hallucination)
> **Why it fails**: Retaining 'self' strongly inside the Kotlin collector lambda creates an uncollectible cross-heap reference cycle between ARC and Kotlin/Native GC. Using DispatchQueue.main.sync risks deadlock on Darwin threads, and failing to hook into Task cancellation leaks active coroutines in the K/N runtime.
```swift
import Shared
import Foundation

final class LeakyStateBridge: ObservableObject {
    @Published var state: ViewState = .idle
    private var closer: Closeable? // or Kotlin Job

    func bind(flow: KotlinStateFlow<ViewState>) {
        // CRITICAL BUG: Strong self capture retains Swift class in Kotlin heap
        // No cancellation bridge when Task or UI scope is destroyed
        self.closer = flow.watch { state in
            DispatchQueue.main.sync { // CRITICAL BUG: sync call causes deadlock/thread pool starvation
                self.state = state
            }
        }
    }
}
```

#### Production Standard (Correct)
> **Standard**: The good example encapsulates flow consumption within an AsyncStream that hooks termination directly into Kotlin's Job cancellation. Weak reference capture prevents cross-runtime retain cycles, and consuming on the @MainActor ensures lock-free UI mutations without thread starvation.
```swift
import Shared
import Foundation

extension KotlinStateFlow {
    func asAsyncStream() -> AsyncStream<T> {
        AsyncStream(T.self) { continuation in
            // Spawn observation with deterministic job tracking
            let job = FlowAdapterKt.collectFlow(self) { item in
                continuation.yield(item)
            }
            
            // Invariant: Cancel Kotlin Job as soon as Swift stream terminates
            continuation.onTermination = { @Sendable _ in
                job.cancel(cause: nil)
            }
        }
    }
}

@MainActor
final class ResilientStateViewModel: ObservableObject {
    @Published private(set) var state: ViewState = .idle
    private var streamTask: Task<Void, Never>?

    func bind(flow: KotlinStateFlow<ViewState>) {
        streamTask?.cancel()
        streamTask = Task { [weak self] in
            for await item in flow.asAsyncStream() {
                guard !Task.isCancelled else { break }
                self?.state = item
            }
        }
    }

    deinit {
        streamTask?.cancel()
    }
}
```

Recommended MCP Servers (mcp-serverlist.com)

Equip agent with system tools to verify code for this stack.

Recommended Agent Skills (askills.dev)

Ready-to-use executable skill functions tailored to this stack.

Architectural Specification & Invariant Rationale

Architectural Invariant Design: Kotlin Multiplatform StateFlow to Swift Concurrency Bridge Invariants

Kotlin Multiplatform StateFlow to Swift Concurrency Bridge Invariants defines an industrial-grade behavioral standard for mobile engineering. Enforces non-blocking cooperative execution and bidirectional cancellation semantics when bridging Kotlin StateFlow/SharedFlow to Swift AsyncSequence. Prevents thread pool starvation in Darwin's cooperative thread pool and eliminates cyclic reference memory leaks across K/N Garbage Collector and Swift ARC boundaries. 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: Synchronous Interop Blocking and Unbridled Flow Subscription Leaks 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 ModeAI Symptom (The Anti-Pattern)SeverityProduction Impact & Remedy
AI Hallucination & Deprecation DriftSynchronous Interop Blocking and Unbridled Flow Subscription LeaksCritical
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 InconsistencyAI 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:

1

Engineers MUST ALWAYS bind Swift AsyncStream/AsyncSequence lifecycle to Kotlin Coroutine Job cancellation via continuation.onTermination or Task cancellation handlers.

Engineers MUST ALWAYS bind Swift AsyncStream/AsyncSequence lifecycle to Kotlin Coroutine Job cancellation via continuation.onTermination or Task cancellation handlers.

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.
Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.
2

Engineers MUST NOT block Swift's cooperative thread pool using semaphores, dispatch group waits, or synchronous RunLoop execution waiting for Kotlin coroutines.

Engineers MUST NOT block Swift's cooperative thread pool using semaphores, dispatch group waits, or synchronous RunLoop execution waiting for Kotlin coroutines.

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.
Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.
3

Code SHOULD enforce weak reference captures ([weak self]) inside Swift observation closures passed into KMP completion blocks to break ARC-K/N cross-runtime cyclic references.

Code SHOULD enforce weak reference captures ([weak self]) inside Swift observation closures passed into KMP completion blocks to break ARC-K/N cross-runtime cyclic references.

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.
Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.
4

Services MUST ensure Kotlin Native flows are collected on Dispatchers.Default or Dispatchers.Main.immediate and mapped to MainActor in Swift without nesting DispatchQueue.main.sync.

Services MUST ensure Kotlin Native flows are collected on Dispatchers.Default or Dispatchers.Main.immediate and mapped to MainActor in Swift without nesting DispatchQueue.main.sync.

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.
Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.
5

Components NEVER bridge unbounded SharedFlow without explicit buffer overflow policies (BufferOverflow.DROP_OLDEST or backpressure handling), as rapid emissions can trigger memory exhaustion in Swift's interop layer.

Components NEVER bridge unbounded SharedFlow without explicit buffer overflow policies (BufferOverflow.DROP_OLDEST or backpressure handling), as rapid emissions can trigger memory exhaustion in Swift's interop layer.

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.
Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.
Technical Questions & Answers

Frequently Asked Technical Questions

Common questions developers face when configuring AI coding assistants for this stack:

Q:Why is Kotlin Multiplatform StateFlow to Swift Concurrency Bridge Invariants critical for AI coding assistants?

Enforces non-blocking cooperative execution and bidirectional cancellation semantics when bridging Kotlin StateFlow/SharedFlow to Swift AsyncSequence. Prevents thread pool starvation in Darwin's cooperative thread pool and eliminates cyclic reference memory leaks across K/N Garbage Collector and Swift ARC boundaries. Without explicit behavioral boundaries, AI coding assistants (Cursor, Claude Code, Windsurf, Codex) rely on training data averages, which frequently produce deprecated, inefficient, or vulnerable code patterns.

Q:How does adopting this rule prevent AI hallucinations?

This rule explicitly declares what the AI must avoid (Synchronous Interop Blocking and Unbridled Flow Subscription Leaks) and prescribes verified positive examples. Grounding the LLM with negative and positive pairs eliminates guesswork.

Q:Which AI coding environments are supported?

This specification is multi-platform compatible: Cursor (.cursor/rules/*.mdc & .cursorrules), Anthropic Claude Code (CLAUDE.md), Windsurf (.windsurfrules), Codex / Cline (AGENTS.md), and GitHub Copilot (.github/copilot-instructions.md).

Q:Can I combine this rule with other technology stacks?

Yes. Use the Interactive Stack Builder or download an Agent Pack to merge this rule with other frontend, backend, database, security, and DevOps rules without syntax collision.

Open Specification · CC BY 4.0·Free for Personal, Team & Commercial In-Repo Use

Citation & Open Source Attribution Guidelines

This specification is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0). You are completely free to adapt and share this rule in your workspace. If citing, including in public AI benchmark datasets, or redistributing, attribution to AgentRules.org is required.

Related MOBILE Rules

View all rules →
1 Rule in Stack

Kotlin