There is an issue when using orbit with a Samsung device. The device must use the Samsung keyboard and not an alternative one to reproduce this issue.

When using a Textfield that displays a value that is from a state and updates that value in the state by using the onValueChange value with orbits intent and reduce function, the Textfield value will randomly reset if the user is using a Samsung keyboard.

Example:

class MainActivity : ComponentActivity() {
    private val viewModel = ExampleViewModel()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContent {
            MyApplicationTheme {
                // A surface container using the 'background' color from the theme
                Surface(color = MaterialTheme.colors.background) {
                    Screen(viewModel)
                }
            }
        }
    }
}

@Composable
fun Screen(viewModel: ExampleViewModel) {

    val state = viewModel.container.stateFlow.collectAsState().value

    TextField(value = state.text, onValueChange = { it ->
        viewModel.updateText(it)
    })

}

data class ViewState(
    val text: String = ""
)

sealed class SideEffect

class ExampleViewModel : ContainerHost<ViewState, SideEffect>, ViewModel() {

    override val container = container<ViewState, SideEffect>(ViewState())

    fun updateText(text: String) = intent {

        reduce {
            state.copy(text = text)
        }
    }
}

Example project: https://github.com/DarrenMiddleton/orbit-mvi-keyboard-issue

At the moment all my simple syntax DSL methods like reduce and postSideEffect are marked with a red line with the following warning:

Is this a known issue and can I do something about that? It compiles and runs just fine, but all the warnings are triggering me 😂

I'm attempting to assert state changes when a certain intent is invoked.

This is my relevant testing code:

private val getCryptoAssetsUseCase = mockk<GetCryptoAssetsUseCase>()
private val testCoroutineDispatcher = StandardTestDispatcher()
private val assetName = "Bitcoin"
private val pagingData = PagingData.from(listOf(Asset(name = assetName)))

@Before
fun setUp() {
    coEvery { getCryptoAssetsUseCase() } returns(flowOf(pagingData))
}

@Test
fun getCryptoList_producesCorrectState() = runTest {
    val initialState = CryptoListState()
    val viewModel = CryptoListViewModel(getCryptoAssetsUseCase, testCoroutineDispatcher).test(
        initialState = initialState
    )

    viewModel.runOnCreate()

    viewModel.assert(initialState) {
        states(
            { copy(loading = true) },
            { copy(list = pagingData, loading = false) }
        )
    }
}

And this is my VM code:

@HiltViewModel
class CryptoListViewModel @Inject constructor(
    private val getCryptoAssetsUseCase: GetCryptoAssetsUseCase,
    @IoDispatcher private val coroutineDispatcher: CoroutineDispatcher
) : ContainerHost<CryptoListState, CryptoListSideEffect>, ViewModel() {

    override val container = container<CryptoListState, CryptoListSideEffect>(CryptoListState()) {
        getCryptoList()
    }

    private fun getCryptoList() = intent(registerIdling = false) {
        reduce { state.copy(loading = true) }
        withContext(coroutineDispatcher) {
            getCryptoAssetsUseCase().cachedIn(viewModelScope).collect {
                reduce { state.copy(list = it, loading = false) }
            }
        }
    }

    fun userSelectedAsset(assetName: String) = intent {
        postSideEffect(CryptoListSideEffect.NavigateToAssetDetail(assetName))
    }
}

However the test just hangs and never completes. I'm sure there's something funky I need to do with the testCoroutineDispatcher or something to force the Flow to complete, I'm just not sure what I'm doing wrong.

Hi ! The Orbit documentation said that Side effects are cached if there are no observers, guaranteeing critical events such as navigation are delivered after re-subscription.

But with this sample :

class MainActivity : ComponentActivity() {

    private val buttonViewModel: ButtonViewModel by viewModels()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContent {
            ButtonToClick(buttonViewModel, ::handleSideEffect)
        }
    }

    private fun handleSideEffect(sideEffect: ButtonSideEffect) {
        when (sideEffect) {
            is ButtonSideEffect -> Toast.makeText(this, sideEffect.message, Toast.LENGTH_LONG).show()
        }
    }
}

sealed class ButtonState
object IdleState: ButtonState()
object ClickedState: ButtonState()

data class ButtonSideEffect(val message: String)

@Composable
fun ButtonToClick(buttonViewModel: ButtonViewModel, handleSideEffect: (ButtonSideEffect) -> Unit = {}) {
    val buttonState = buttonViewModel.container.stateFlow.collectAsState().value

    LaunchedEffect(buttonViewModel) {
        launch {
            buttonViewModel.container.sideEffectFlow.collect { sideEffect ->
                handleSideEffect(sideEffect)
            }
        }
    }

    Button(onClick = { buttonViewModel.onButtonClicked() }, enabled = buttonState is IdleState){
        Text(text = "Click me")
    }
}

class ButtonViewModel: ViewModel(), ContainerHost<ButtonState, ButtonSideEffect> {
    override val container: Container<ButtonState, ButtonSideEffect> = container(IdleState){
        intent { reduce { IdleState } }
    }

    fun onButtonClicked() = intent {
        reduce { ClickedState }

        delay(5000)
        postSideEffect(ButtonSideEffect("Button clicked"))

        reduce { IdleState }
    }
}

When I :

1. Click the button
2. Turn off my phone screen
3. Wait for 5 second
4. Turn it back on

the Toast doesn't appear.

In my "real world" scenario the SideEffect is a navigation event happening on a loading screen. The loading take a while and if the user put is phone aside and come back later, he's stuck on the loading screen.

Am I doing someting wrong with the collection of the side effects ?

Hello, The company I work for is organizing a donation wave to support projects/teams that are doing a tremendous job helping out the open source community. Orbit-Mvi it's one of these, no doubt.

I've talked already with @mattmook on slack, but I'll leave this "issue" open to better track it's progress.

Are you open for donations/sponsorship?

Regards

I was trying to use it in my project and found out any life cycle events call only once. After button click it does nothing and stateFlow from fragment does not return anything.

I can't find an example in the documentation how I am supposed to use the intent syntax with a coroutine Flow.

For example, how would i wrap the following code:

    fun test() {
        job?.cancel()
        job = viewModelScope.launch { 
            testFlow.collect{
                //set state here
            }
        }
    }

If I understand it correctly, if I put intent directly after test(), then my collect{} function will always get the same state as it was when the function was first called. Do I put the intent inside the collect{}block?

And how would I do this with the strict syntax? (Especially the cancelling part)

Thanks!

In my test ViewModel

    private val _testFlow = MutableStateFlow(0)
    val testFlow: StateFlow<Int> = _testFlow.asStateFlow()

    fun testFlow() {
        viewModelScope.launch {
            val values = repository.getAllItems()
            _testFlow.emit(values.count())
        }
    }

    fun testIntent() = intent() {
        reduce { state.copyToLoading() }
        val values = repository.getAllItems()
        reduce {
            state.copyToSuccess(values)
        }
    }

DAO looks like

@Dao
interface TestDao {
  @Query("SOME SQL WITH INNER JOIN")
  suspend fun getAllItems(): List<TestView>
}

in first case with testFlow repository.getAllItems returns 3 records from the Room, but second case with testIntent returns 0 records.

It's look like i incorrect use intents with suspend functions. Could you help me?

This PR adds StateFlowExtesions. This necessity was born from #122 where the author asks if it is possible to "hide" the ContainerHost. And It is, by doing:

/**
 * Just to keep it internal without public access.
 * @param initialState The initial state of the container.
 */
internal fun <STATE : Any, SIDE_EFFECT : Any> CoroutineScope.containerHostVisibilityWrapper(initialState: STATE) =
    object : ContainerHost<STATE, SIDE_EFFECT> {
        override val container = [email protected]<STATE, SIDE_EFFECT>(initialState)
    }

using it like:

data class MyState(val message: String = "")

class MyViewModel : ViewModel() {
    private val host = viewModelScope.containerHostVisibilityWrapper<MyState, Nothing>(MyState())
    val stateFlow = host.container.stateFlow
}

But unfortunately, we need a ContainerHost<STATE, SIDE_EFFECT> to use compose extensions: collectSideEffect, collectState and collectAsState.

With this PR, we're able to use them - collectSideEffectLifecycleAware, collectStateLifecycleAware, collectAsStateLifecycleAware -, like:

@Composable
fun Screen(viewModel: MyViewModel) {
    with(viewModel.stateFlow.collectAsStateLifecycleAware().value) {
         ...
    }
}

I really would like to thank you all for the amazing library that makes our life easier. I'm trying to manage Compose state following the state-hoisting concept as recommended by Google. The problem is that makes TextField writing or clearing lagging. check my code:

@Composable
fun LoginScreen(viewModel: LoginViewModel = hiltViewModel()) {
    val localFocusManager = LocalFocusManager.current
    val spacing = LocalSpacing.current
    val state = viewModel.collectAsState().value
    Column(
        modifier = Modifier.fillMaxSize(),
        verticalArrangement = Arrangement.Center,
        horizontalAlignment = Alignment.CenterHorizontally
    ) {
        Username(
            localFocusManager = localFocusManager,
            username = state.username,
            onUsernameChange = { viewModel.onUsernameChanged(it) })
        Spacer(modifier = Modifier.height(spacing.spaceMedium))
        OutlinedTextField(
            value = state.password,
            onValueChange = { viewModel.onPasswordChanged(password = it) },
            label = { Text(stringResource(id = R.string.password)) },
            visualTransformation = PasswordVisualTransformation(),
            keyboardOptions = KeyboardOptions(
                keyboardType = KeyboardType.Password,
                imeAction = ImeAction.Done
            ),
            keyboardActions = KeyboardActions(onDone = { localFocusManager.clearFocus() })
        )
        Spacer(modifier = Modifier.height(spacing.spaceMedium))
        Button(onClick = { viewModel.login() }) {
            Text(text = stringResource(id = R.string.login))
        }
    }
}

@Composable
fun Username(
    localFocusManager: FocusManager,
    username: String,
    onUsernameChange: (String) -> Unit
) {
    OutlinedTextField(
        value = username,
        onValueChange = onUsernameChange,
        label = { Text(stringResource(id = R.string.username)) },
        keyboardOptions = KeyboardOptions(imeAction = ImeAction.Next),
        keyboardActions = KeyboardActions(onNext = { localFocusManager.moveFocus(FocusDirection.Down) })
    )
}

ViewModel:

@HiltViewModel
class LoginViewModel @Inject constructor(
    savedStateHandle: SavedStateHandle,
    private val loginUseCase: LoginUseCase
) : ViewModel(), ContainerHost<LoginState, LoginSideEffect> {

    override val container by lazy {
        container<LoginState, LoginSideEffect>(
            initialState = LoginState(),
            savedStateHandle = savedStateHandle
        )
    }

    fun onUsernameChanged(username: String) = intent {
        reduce { state.copy(username = username) }
    }

    fun onPasswordChanged(password: String) = intent {
        reduce { state.copy(password = password) }
    }

    fun login() = intent {
        val loginResult = loginUseCase.invoke(LoginParams(state.username, state.password))
        reduce { state.copy(loginResult = loginResult) }
    }

}

LoginState:

@Parcelize
data class LoginState(
    val username: String = "",
    val password: String = "",
    val loginResult: Result<UserEntity>? = null
) : Parcelable

It happens when I write long text and then click and hold on the X button on the keyboard it supposes to clear all characters but it stops after clearing a number of characters. Any suggestion to solve this without using var username by remember { mutableStateOf("") }?

Based on #97, just fixed detekt

See https://kotlinlang.org/docs/mpp-share-on-platforms.html#target-shortcuts-and-arm64-apple-silicon-simulators for details.

This is needed so projects using Orbit can run on the iOS Simulators on Apple Silicon (M1) Macs.

Bumps loader-utils from 2.0.2 to 2.0.4.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Adds new testing API that uses Turbine under the hood.

• Improved, flexible API
• No more "magic" - everything is explicit
• No assertions to maintain

I am using M1 Pro. With org.jetbrains.kotlin:kotlin-gradle-plugin:1.6.20 which give the following error when executing target iosApp with iosSimulatorArm64() profile Here is my common setting info:

plugins {
    kotlin("multiplatform")
    kotlin("native.cocoapods")
    kotlin("kapt")
    id("com.android.library")
    id("kotlin-parcelize")
    kotlin("plugin.serialization") version "1.5.21"
    id("org.orbit-mvi.orbit.swift") version "0.1.0"
}

// CocoaPods requires the podspec to have a version.

kotlin {
    android()
    ios()
    iosSimulatorArm64()
    cocoapods {
        version = "1.0.0"
        summary = "test"
        homepage = "https://test.com/"
        ios.deploymentTarget = "14.1"
        podfile = project.file("../iosApp/Podfile")
        framework {
            baseName = "shared"
        }
    }

    sourceSets {

        @Suppress("UnusedPrivateMember")
        val commonMain by getting {
            dependencies {
                api("org.orbit-mvi:orbit-core:4.3.2")
                api("dev.icerock.moko:mvvm-core:0.13.0") // only ViewModel, EventsDispatcher, Dispatchers.UI
                implementation("dev.icerock.moko:parcelize:0.8.0")

                implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.2")

                implementation("io.ktor:ktor-client-core:1.6.8")
                implementation("io.ktor:ktor-client-serialization:1.6.8")

                implementation("io.insert-koin:koin-core:3.1.6")
            }
        }
        @Suppress("UnusedPrivateMember")
        val commonTest by getting {
            dependencies {
                implementation(kotlin("test-common"))
                implementation(kotlin("test-annotations-common"))
            }
        }
        @Suppress("UnusedPrivateMember")
        val androidMain by getting {
            dependencies {
                implementation("io.ktor:ktor-client-android:1.6.8")

                implementation("org.orbit-mvi:orbit-viewmodel:4.3.2")

                implementation("androidx.lifecycle:lifecycle-viewmodel-ktx:2.4.0-alpha03")

                // Dependency Injection
                implementation("io.insert-koin:koin-android:3.1.2")
            }
        }
//        @Suppress("UnusedPrivateMember")
//        val androidTest by getting {
//            dependencies {
//                implementation(kotlin("test-junit"))
//                implementation("junit:junit:4.13.2")
//            }
//        }
        @Suppress("UnusedPrivateMember")
        val iosMain by getting {
            dependencies {
                implementation("io.ktor:ktor-client-ios:1.6.8")
            }
        }
        @Suppress("UnusedPrivateMember")
        val iosTest by getting
    }
}

android {
    compileSdk = 30
    sourceSets["main"].manifest.srcFile("src/androidMain/AndroidManifest.xml")
    defaultConfig {
        minSdk = 23
        targetSdk = 30
    }
}

Fixes #117

So the checks aren't duplicated I've had to make debugModeContainerHostVerification public.

This PR only introduces a guardrail for ensuring container uses a backing field

For example https://airbnb.io/mavericks/#/debug-checks

We've seen a few bug reports where ppl have not stored the container in a backing field and it would be great to spot that rather than have an issue raised against the project

Calling intent from outside of a container host