MutableLiveData: Cannot invoke setValue on a background thread from Coroutine

Question

I'm trying to trigger an update on LiveData from a coroutine:

object AddressList: MutableLiveData<List<Address>>()
fun getAddressesLiveData(): LiveData<List<Address>> {
    AddressList.value = listOf()
    GlobalScope.launch {
        AddressList.value = getAddressList()
    }
    return AddressList
}

but I get the following error:

IllegalStateException: Cannot invoke setValue on a background thread

Is there a way to make it work with coroutines?

Solution 1

Use liveData.postValue(value) instead of liveData.value = value. It called asynchronous.

From documentation:

postValue - Posts a task to a main thread to set the given value.

Solution 2

You can do one of the following :

object AddressList: MutableLiveData<List<Address>>()
fun getAddressesLiveData(): LiveData<List<Address>> {
    AddressList.value = listOf()
    GlobalScope.launch {
        AddressList.postValue(getAddressList())
    }

return AddressList
}

or

fun getAddressesLiveData(): LiveData<List<Address>> {
    AddressList.value = listOf()
    GlobalScope.launch {
        val adresses = getAddressList()
        withContext(Dispatchers.Main) {
            AddressList.value = adresses
        }
    }
    return AddressList
}

Solution 3

I just figured out that it's possible by using withContext(Dispatchers.Main){}:

object AddressList: MutableLiveData<List<Address>>()
fun getAddressesLiveData(): LiveData<List<Address>> {
    GlobalScope.launch {
        withContext(Dispatchers.Main){ AddressList.value = getAddressList() }
    }
    return AddressList
}

Solution 4

Although others have pointed out that, in this case, the library provides its own method to post an operation to the main thread, coroutines provide a general solution that works regardless of a given library's functionality.

The first step is to stop using GlobalScope for background jobs, doing this will lead to leaks where your activity, or scheduled job, or whatever unit of work you invoke this from, may get destroyed, and yet your job will continue in the background and even submit its results to the main thread. Here's what the official documentation on GlobalScope states:

Application code usually should use application-defined CoroutineScope, using async or launch on the instance of GlobalScope is highly discouraged.

You should define your own coroutine scope and its coroutineContext property should contain Dispatchers.Main as the dispatcher. Furthermore, the whole pattern of launching jobs within a function call and returning LiveData (which is basically another kind of Future), isn't the most convenient way to use coroutines. Instead you should have

suspend fun getAddresses() = withContext(Dispatchers.Default) { getAddressList() }

and at the call site you should launch a coroutine, within which you can now freely call getAddresses() as if it was a blocking method and get the addresses directly as a return value.

Solution 5

If you want to updated UI by using Coroutines, there are 2 ways to achieve this

GlobalScope.launch(Dispatchers.Main):

GlobalScope.launch(Dispatchers.Main) {
    delay(1000)     // 1 sec delay
    // call to UI thread
}

And if you want some work to be done in background but after that you want to update UI, this can be achieved by the following:

withContext(Dispatchers.Main)

GlobalScope.launch {
    delay(1000)     // 1 sec delay

    // do some background task

    withContext(Dispatchers.Main) {
            // call to UI thread
    }
}

View more solutions

Comments

[pdegand59]

Don't call getAdresseList() inside the withContext(Dispatchers.Main) block because this will be run on the main thread. Call it outside so it's properly dispatched by Dispatchers.Default and use only the result on the main thread

[kike]

Actually, I think this is the perfect postValue() usage scenario. There is no need to force Main Thread context.

[Undefined function]

You just literally return your heavy task to run in UI thread

[Ho Binh]

work with me, thanks

[Tanveer Hasan]

save my time, thanks a lot

[Moustafa EL-Saghier]

thank you a lot you are awesome bro <3