Merge branch 'master' into feature/coroutines-1.8.0

Author: rickclephas

.github/workflows/release-swift.yaml

@@ -13,7 +13,7 @@ jobs:
       - name: Setup Xcode
         uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: '13.4.1'
+          xcode-version: '15.0'
       - name: Publish KMMViewModelCoreObjC
         run: pod trunk push KMMViewModelCoreObjC.podspec --synchronous
         env:

KMMViewModelCore.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name       = 'KMMViewModelCore'
-  s.version    = '1.0.0-ALPHA-16'
+  s.version    = '1.0.0-ALPHA-18'
   s.summary    = 'Library to share Kotlin ViewModels with Swift'
 
   s.homepage   = 'https://github.com/rickclephas/KMM-ViewModel'

KMMViewModelCore/ObservableViewModelPublisher.swift

@@ -13,14 +13,14 @@ public final class ObservableViewModelPublisher: Publisher {
     public typealias Output = Void
     public typealias Failure = Never
 
-    internal weak var viewModelScope: ViewModelScope?
+    internal weak var viewModel: (any KMMViewModel)?
 
     private let publisher = ObservableObjectPublisher()
     private var objectWillChangeCancellable: AnyCancellable? = nil
 
-    internal init(_ viewModelScope: ViewModelScope, _ objectWillChange: ObservableObjectPublisher) {
-        self.viewModelScope = viewModelScope
-        viewModelScope.setSendObjectWillChange { [weak self] in
+    internal init(_ viewModel: any KMMViewModel, _ objectWillChange: ObservableObjectPublisher) {
+        self.viewModel = viewModel
+        viewModel.viewModelScope.setSendObjectWillChange { [weak self] in
             self?.publisher.send()
         }
         objectWillChangeCancellable = objectWillChange.sink { [weak self] _ in
@@ -29,12 +29,16 @@ public final class ObservableViewModelPublisher: Publisher {
     }
 
     public func receive<S>(subscriber: S) where S : Subscriber, Never == S.Failure, Void == S.Input {
-        viewModelScope?.increaseSubscriptionCount()
+        viewModel?.viewModelScope.increaseSubscriptionCount()
         publisher.receive(subscriber: ObservableViewModelSubscriber(self, subscriber))
     }
 
     deinit {
-        viewModelScope?.cancel()
+        guard let viewModel else { return }
+        if let cancellable = viewModel as? Cancellable {
+            cancellable.cancel()
+        }
+        viewModel.viewModelScope.cancel()
     }
 }
 
@@ -85,6 +89,6 @@ private class ObservableViewModelSubscription: Subscription {
         subscription.cancel()
         guard !cancelled else { return }
         cancelled = true
-        publisher.viewModelScope?.decreaseSubscriptionCount()
+        publisher.viewModel?.viewModelScope.decreaseSubscriptionCount()
     }
 }

KMMViewModelCore/ObservableViewModelPublishers.swift

@@ -26,7 +26,7 @@ internal func observableViewModelPublishers<ViewModel: KMMViewModel>(
             fatalError("ObservableViewModel has been deallocated")
         }()
     } else {
-        let publisher = ObservableViewModelPublisher(viewModel.viewModelScope, viewModel.objectWillChange)
+        let publisher = ObservableViewModelPublisher(viewModel, viewModel.objectWillChange)
         publishers = ObservableViewModelPublishers(publisher)
         let object = WeakObservableViewModelPublishers(publishers)
         objc_setAssociatedObject(viewModel, &observableViewModelPublishersKey, object, .OBJC_ASSOCIATION_RETAIN_NONATOMIC)

KMMViewModelCoreObjC.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name       = 'KMMViewModelCoreObjC'
-  s.version    = '1.0.0-ALPHA-16'
+  s.version    = '1.0.0-ALPHA-18'
   s.summary    = 'Library to share Kotlin ViewModels with Swift'
 
   s.homepage   = 'https://github.com/rickclephas/KMM-ViewModel'

KMMViewModelSwiftUI.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name       = 'KMMViewModelSwiftUI'
-  s.version    = '1.0.0-ALPHA-16'
+  s.version    = '1.0.0-ALPHA-18'
   s.summary    = 'Library to share Kotlin ViewModels with SwiftUI'
 
   s.homepage   = 'https://github.com/rickclephas/KMM-ViewModel'

README.md

@@ -4,13 +4,14 @@ A library that allows you to share ViewModels between Android and iOS.
 
 ## Compatibility
 
-The latest version of the library uses Kotlin version `1.9.21`.  
+The latest version of the library uses Kotlin version `1.9.22`.  
 Compatibility versions for older and/or preview Kotlin versions are also available:
 
 | Version        | Version suffix      |   Kotlin    | Coroutines | AndroidX Lifecycle |
 |----------------|---------------------|:-----------:|:----------:|:------------------:|
-| _latest_       | -kotlin-2.0.0-Beta1 | 2.0.0-Beta1 |   1.7.3    |       2.6.2        |
-| **_latest_**   | **_no suffix_**     | **1.9.21**  | **1.7.3**  |     **2.6.2**      |
+| _latest_       | -kotlin-2.0.0-Beta3 | 2.0.0-Beta3 | 1.8.0-RC2  |       2.6.2        |
+| **_latest_**   | **_no suffix_**     | **1.9.22**  | **1.7.3**  |     **2.6.2**      |
+| 1.0.0-ALPHA-16 | _no suffix_         |   1.9.21    |   1.7.3    |       2.6.2        |
 | 1.0.0-ALPHA-15 | _no suffix_         |   1.9.20    |   1.7.3    |       2.6.2        |
 | 1.0.0-ALPHA-14 | _no suffix_         |   1.9.10    |   1.7.3    |       2.6.1        |
 | 1.0.0-ALPHA-13 | _no suffix_         |    1.9.0    |   1.7.3    |       2.6.1        |
@@ -33,7 +34,7 @@ kotlin {
         }
         commonMain {
             dependencies {
-                api("com.rickclephas.kmm:kmm-viewmodel-core:1.0.0-ALPHA-16")
+                api("com.rickclephas.kmm:kmm-viewmodel-core:1.0.0-ALPHA-18")
             }
         }
     }
@@ -143,7 +144,7 @@ class TimeTravelFragment: Fragment(R.layout.fragment_time_travel) {
 Add the Swift package to your `Package.swift` file:
 ```swift
 dependencies: [
-    .package(url: "https://github.com/rickclephas/KMM-ViewModel.git", from: "1.0.0-ALPHA-16")
+    .package(url: "https://github.com/rickclephas/KMM-ViewModel.git", from: "1.0.0-ALPHA-18")
 ]
 ```
 
@@ -155,7 +156,7 @@ Or add it in Xcode by going to `File` > `Add Packages...` and providing the URL:
 
 If you like you can also use CocoaPods instead of SPM:
 ```ruby
-pod 'KMMViewModelSwiftUI', '1.0.0-ALPHA-16'
+pod 'KMMViewModelSwiftUI', '1.0.0-ALPHA-18'
 ```
 </p>
 </details>
@@ -224,3 +225,46 @@ This will prevent your Swift view models from being deallocated too soon.
 
 > [!NOTE]
 > For lists, sets and dictionaries containing view models there is `childViewModels(at:)`.
+
+### Cancellable ViewModel
+
+When subclassing your Kotlin ViewModel in Swift you might experience some issues in the way those ViewModels are cleared.
+
+An example of such an issue is when you are using a Combine publisher to observe a Flow through KMP-NativeCoroutines:
+```swift
+import Combine
+import KMPNativeCoroutinesCombine
+import shared // This should be your shared KMM module
+
+class TimeTravelViewModel: shared.TimeTravelViewModel {
+
+    private var cancellables = Set<AnyCancellable>()
+
+    override init() {
+        super.init()
+        createPublisher(for: currentTimeFlow)
+            .assertNoFailure()
+            .sink { time in print("It's \(time)") }
+            .store(in: &cancellables)
+    }
+}
+```
+
+Since `currentTimeFlow` is a StateFlow we don't ever expect it to fail, which is why we are using the `assertNoFailure`.
+However, in this case you'll notice that the publisher will fail with a `JobCancellationException`.
+
+The problem here is that before the `TimeTravelViewModel` is deinited it will already be cleared.
+Meaning the `viewModelScope` is cancelled and `onCleared` is called.
+This results in the Combine publisher outliving the underlying StateFlow collection.
+
+To solve such issues you should have your Swift ViewModel conform to `Cancellable` 
+and perform the required cleanup in the `cancel` function:
+```swift
+class TimeTravelViewModel: shared.TimeTravelViewModel, Cancellable {
+    func cancel() {
+        cancellables = []
+    }
+}
+```
+
+KMM-ViewModel will make sure to call the `cancel` function before the ViewModel is being cleared.

build.gradle.kts

@@ -19,7 +19,7 @@ buildscript {
 
 allprojects {
     group = "com.rickclephas.kmm"
-    version = "1.0.0-ALPHA-16"
+    version = "1.0.0-ALPHA-18"
 
     repositories {
         mavenCentral()

gradle/libs.versions.toml

@@ -5,9 +5,9 @@ android = "7.4.2"
 androidx-lifecycle = "2.6.2"
 
 # Sample versions
-androidx-compose = "2023.06.01"
-androidx-compose-compiler = "1.5.5-dev-k1.9.21-163bb051fe5"
-androidx-fragment = "1.6.1"
+androidx-compose = "2023.10.01"
+androidx-compose-compiler = "1.5.8-dev-k1.9.22-42b6ec2b037"
+androidx-fragment = "1.6.2"
 ksp = "1.9.22-1.0.16"
 nativecoroutines = "1.0.0-ALPHA-24"
 

sample/androidApp/build.gradle.kts

@@ -7,7 +7,7 @@ plugins {
 
 android {
     namespace = "com.rickclephas.kmm.viewmodel.sample"
-    compileSdk = 33
+    compileSdk = 34
     defaultConfig {
         applicationId = "com.rickclephas.kmm.viewmodel.sample"
         minSdk = 28