04 Feb 04:15

vietnguyentuan2019

56ba4d6

KRelay v2.0.0 - Instance API for Super Apps Latest

Latest

KRelay v2.0.0 - Instance API for Super Apps 🚀

We're excited to announce KRelay v2.0.0, a major update that brings powerful new capabilities while maintaining 100% backward compatibility.

🎯 What's New

Instance-Based API

Create isolated KRelay instances for true module independence:

// Create isolated instances
val rideKRelay = KRelay.create("Rides")
val foodKRelay = KRelay.create("Food")

// Each module has independent registry - no conflicts!
rideKRelay.register<ToastFeature>(RideToastImpl())
foodKRelay.register<ToastFeature>(FoodToastImpl())

Perfect for Super Apps

If you're building a "Super App" (like Grab or Gojek) with multiple independent modules, v2.0 solves the feature name conflict problem:

Before (v1.x):

// Problem: Both modules use same feature name
KRelay.register<ToastFeature>(RideToastImpl())
KRelay.register<ToastFeature>(FoodToastImpl()) // ❌ Overwrites!

After (v2.0):

// Solution: Each module has its own instance
val rideKRelay = KRelay.create("Rides")
val foodKRelay = KRelay.create("Food")

rideKRelay.register<ToastFeature>(RideToastImpl())
foodKRelay.register<ToastFeature>(FoodToastImpl()) // ✅ No conflict!

DI-Friendly Architecture

Perfect integration with dependency injection frameworks:

// Koin module
val rideModule = module {
    single { KRelay.create("RideModule") }
    viewModel { RideViewModel(krelay = get()) }
}

// ViewModel
class RideViewModel(private val krelay: KRelayInstance) : ViewModel() {
    fun bookRide() {
        krelay.dispatch<ToastFeature> { it.show("Booking...") }
    }
}

Configurable Instances

Use the builder pattern for custom configuration:

val instance = KRelay.builder("MyModule")
    .maxQueueSize(50)
    .actionExpiry(60_000L)
    .debugMode(true)
    .build()

✨ Improvements

Developer Experience

Duplicate Scope Name Detection: Get warnings in debug mode when creating instances with duplicate names
Input Validation: Builder parameters validated with clear error messages
Better Error Messages: Know exactly what went wrong

Quality & Reliability

10 New Isolation Tests: Comprehensive testing of multi-instance scenarios
100% Test Pass Rate: All 15 instance tests passing
<5% Performance Overhead: Instance API is just as fast as singleton
~800 bytes per Instance: Minimal memory footprint

📚 Documentation

Migration Guide - How to upgrade from v1.x
Super App Example - Complete architecture guide
DI Integration - Koin and Hilt examples
Technical Review - Deep dive analysis

🔄 Migration

Good news: Migration is optional!

✅ No Breaking Changes: All v1.x code works without modification
✅ Incremental Adoption: Migrate at your own pace
✅ Simple Apps: Can continue using singleton API
✅ New Projects: Start with instance API for better architecture

📦 Installation

// Gradle (build.gradle.kts)
dependencies {
    implementation("dev.brewkits:krelay:2.0.0")
}

🎓 Quick Start

Singleton API (Existing)

// Still works exactly as before
KRelay.dispatch<ToastFeature> { it.show("Hello!") }

Instance API (New)

// Create instance
val krelay = KRelay.create("MyScope")

// Use it
krelay.dispatch<ToastFeature> { it.show("Hello!") }

🏗️ Architecture

v2.0 uses a Facade Pattern:

Singleton API delegates to internal defaultInstance
Each instance has isolated registry, queue, and lock
Per-instance configuration
Thread-safe with fine-grained locking

🎯 Who Should Use v2.0 Instance API?

Highly Recommended for:

Super Apps with multiple independent modules
Projects using DI (Koin, Hilt)
Multi-team organizations
Large-scale apps with modular architecture

Optional for:

Simple single-module apps
Small to medium projects
Existing apps with singleton API (works fine)

⚡ Performance

Instance creation: ~0.4ms
Dispatch overhead: +2% vs singleton (negligible)
Memory per instance: ~800 bytes
50 instances = ~40KB total

🙏 Acknowledgments

Thank you to the Kotlin Multiplatform community for feedback and support!

🔗 Links

Full Changelog: https://github.com/brewkits/KRelay/blob/main/CHANGELOG.md

Assets 2

28 Jan 06:03

vietnguyentuan2019

v1.1.0

bcb3531

v1.1.0 - Hardening Core

Thread Safety:

Replace pthread_mutex with NSRecursiveLock on iOS (ARC-managed, reentrant)
Add comprehensive stress tests (100k concurrent operations)
Validate thread safety on both platforms

Diagnostics & Monitoring:

Add dump() for visual debugging
Add getDebugInfo() for programmatic inspection
Add getRegisteredFeaturesCount() and getTotalPendingCount()
Add comprehensive diagnostic tests and demos

Developer Safety:

Add @MemoryLeakWarning annotation for lambda capture risks
Enhance documentation with memory management best practices
Update all guides to v1.1.0

Bug Fixes:

Fix main menu scroll issue
Fix toast overlap in update check demo
Replace fatalError with graceful degradation in Swift extensions

Test Coverage:

Android: 127/127 tests (100%)
iOS: 135/137 tests (98.5%)
Total: 262/264 tests (99.2%)

Breaking Changes: None - 100% backward compatible

Assets 2

23 Jan 12:33

vietnguyentuan2019

v1.0.1

309a4b2

v1.0.1 - iOS Platform Support

KRelay v1.0.1 - iOS Platform Support

This release adds separate Maven artifacts for iOS platforms to improve dependency resolution and build performance.

🆕 New Artifacts

krelay-iosarm64 - iOS devices (ARM64)
krelay-iossimulatorarm64 - iOS simulators on M1/M2 Macs (Apple Silicon)
krelay-iosx64 - iOS simulators on Intel Macs

📦 Installation

dependencies {
    implementation("dev.brewkits:krelay:1.0.1")
}

Gradle will automatically resolve the correct platform artifacts.

✨ Benefits

🚀 Faster builds (platform-specific dependencies only)
📦 Cleaner dependency resolution
🎯 Better IDE support
💾 Smaller download sizes per platform

📊 Bundle Details

File: krelay-1.0.1-bundle.zip (1.2MB)
Total Publications: 5 (base + android + 3 iOS platforms)
Total Files: 186 files (artifacts + checksums + GPG signatures)

🔄 Changelog

Add separate iOS platform publications for better dependency management
Maintain backward compatibility with v1.0.0
Generate complete Maven Central bundle with GPG signatures
Add comprehensive documentation for manual upload

📚 Documentation

🌐 Availability

Available on Maven Central:

Full Changelog: v1.0.0...v1.0.1

Assets 6

23 Jan 09:41

vietnguyentuan2019

v1.0.0

714c262

v1.0.0 - The Glue Code Standard

KRelay v1.0.0 - Production Ready 🎉

The Glue Code Standard for Kotlin Multiplatform

Safe, leak-free bridge between shared code and platform-specific APIs.

🚀 What's New

Core Features

✅ Safe Dispatch

WeakReference-based registry (zero memory leaks)
Automatic cleanup on lifecycle events
Main thread execution guarantee

✅ Sticky Queue

Preserves commands during configuration changes
Automatic replay when platform implementations register
Survives Activity/ViewController recreation

✅ Thread Safety

Platform-specific locks (ReentrantLock on Android, pthread_mutex on iOS)
Fine-grained synchronization
Zero data races

✅ Priority System

CRITICAL, HIGH, NORMAL, LOW priorities
Priority-based queue ordering
Emergency command support

✅ Performance Monitoring

Metrics collection (dispatch count, queue size, replay count)
Performance profiling tools
Debug logging

Platform Support

✅ Android (API 24+)
✅ iOS (iOS 13+)

Integrations

Tested with popular KMP libraries:

✅ Voyager (navigation)
✅ Decompose (navigation)
✅ Moko Permissions
✅ Moko Biometry
✅ Peekaboo (image picker)

📦 Installation

Add to your commonMain dependencies:

dependencies {
    implementation("dev.brewkits:krelay:1.0.0")
}

Maven Central: Publishing in progress. Manual upload required for first release.

🎯 Quick Start

// 1. Define feature interface
interface ToastFeature : RelayFeature {
    fun show(message: String)
}

// 2. Implement on platform
class AndroidToast(context: Context) : ToastFeature {
    override fun show(message: String) {
        Toast.makeText(context, message, Toast.LENGTH_SHORT).show()
    }
}

// 3. Register in Activity/ViewController
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    KRelay.register<ToastFeature>(AndroidToast(this))
}

// 4. Dispatch from shared code
class LoginViewModel {
    fun onLoginSuccess() {
        KRelay.dispatch<ToastFeature> { it.show("Welcome!") }
    }
}

📚 Documentation

README - Quick introduction
Architecture - Technical deep dive
Integration Guides - Voyager, Moko, Decompose
Testing Guide - How to test
Roadmap - Future plans

⚠️ Important Notes

Use Cases

✅ Perfect For:

Toast/Snackbar messages
Navigation commands
Permission requests
Haptic feedback
Analytics events (non-critical)

❌ Not For:

Returning values (use expect/actual)
State management (use StateFlow)
Critical operations (use WorkManager)
Background processing (use Dispatchers.IO)

Process Death

Important: KRelay queue does NOT survive process death (lambdas can't be serialized).

✅ Safe for UI commands (Toast, Navigation)
❌ Unsafe for critical operations (Payments, Data writes)

See ARCHITECTURE.md for detailed limitations.

🧪 Demo App

Run the demo app to see KRelay in action:

# Android
./gradlew :composeApp:installDebug

# iOS
open iosApp/iosApp.xcodeproj

Demo includes:

Basic features (Toast, Navigation)
Decompose integration (full navigation demo)
Real library integrations (Moko, Peekaboo)

🛠️ For Library Authors

KRelay is ideal for creating clean KMP library APIs:

Before (tightly coupled):

class MyViewModel(private val platformFeature: PlatformFeature) {
    // ViewModel depends on platform interface
}

After (clean separation):

class MyViewModel {
    fun doSomething() {
        KRelay.dispatch<PlatformFeature> { it.action() }
    }
}

🙏 Acknowledgments

Special thanks to:

Kotlin Multiplatform team
Compose Multiplatform team
Voyager, Decompose, Moko library authors
Early adopters and contributors

📝 Changelog

Added

Safe dispatch with WeakReference registry
Sticky queue with automatic replay
Thread-safe operations with platform locks
Priority-based action queue (CRITICAL, HIGH, NORMAL, LOW)
Performance metrics and monitoring
Queue management (max size, expiry)
Comprehensive test suite (90%+ coverage)
Integration demos (Voyager, Decompose, Moko)
Complete documentation

Fixed

Memory leaks from strong references
Lost commands during lifecycle changes
Thread safety issues
iOS Toast display on simulator

Documentation

Architecture guide
Integration guides for popular libraries
Testing guide with examples
Anti-patterns guide
Roadmap for future development

🚀 What's Next

v1.1.0 (Q2 2026): Desktop Support (Windows, macOS, Linux)

v1.2.0 (Q2 2026): Web/JS Support (Kotlin/JS, Wasm)

v2.0.0 (Q4 2026): Instance-based API for modularization

See ROADMAP.md for details.

📄 License

Apache License 2.0

Made with ❤️ by Nguyễn Tuấn Việt at Brewkits

Support: datacenter111@gmail.com • Community: GitHub Issues

Assets 2

Releases: brewkits/KRelay