Flow invariant is violated: две причины и две починки

Приложение падает на ровном месте, в логе — исключение, которое начинается так:

java.lang.IllegalStateException: Flow invariant is violated:

Дальше текст расходится на два разных варианта, и починка у них тоже разная. Разберём оба.

Вариант первый: сменили контекст внутри flow

Продолжение сообщения выглядит примерно так:

Flow was collected in [..., Dispatchers.Main],
but emission happened in [..., Dispatchers.IO].
Please refer to 'flow' documentation or use 'flowOn' instead

Код, который к этому приводит, выглядит совершенно разумно — мы же просто ушли в фон почитать базу:

fun observeUsers(): Flow<List<User>> = flow {
    withContext(Dispatchers.IO) {       // вот здесь
        emit(dao.getAll())
    }
}

Правило, которое нарушено, называется прозрачностью контекста: билдер flow { } обязан отдавать значения в том же контексте, в котором на него подписались. Менять контекст внутри него нельзя — иначе подписчик, рассчитывающий на главный поток, внезапно получит значение из фонового.

Чинится заменой withContext на оператор flowOn, который меняет контекст всей части цепочки выше по течению и делает это легально:

fun observeUsers(): Flow<List<User>> = flow {
    emit(dao.getAll())
}.flowOn(Dispatchers.IO)

Вариант второй: эмиссия из другой корутины

Второе продолжение сообщения:

Emission from another coroutine is detected.
FlowCollector is not thread-safe and concurrent emissions are prohibited.
To mitigate this restriction please use 'channelFlow' builder instead of 'flow'

Здесь причина другая: внутри flow { } запустили корутины и отдаёте значения из них:

fun merged(): Flow<Item> = flow {
    coroutineScope {
        launch { emit(fromNetwork()) }   // другая корутина
        launch { emit(fromCache()) }     // и ещё одна
    }
}

Сборщик значений не потокобезопасен, одновременные эмиссии запрещены. Сообщение само подсказывает выход — channelFlow. Этот билдер рассчитан ровно на такой случай: внутри него можно запускать корутины, а отправлять значения через send:

fun merged(): Flow<Item> = channelFlow {
    launch { send(fromNetwork()) }
    launch { send(fromCache()) }
}

Платить за это приходится производительностью: под капотом появляется канал с буфером, и channelFlow заметно дороже обычного flow. Поэтому брать его стоит тогда, когда конкурентные эмиссии действительно нужны, а не вместо того, чтобы разобраться.

Как не нарваться снова

  • внутри flow { } не вызывать withContext — для смены контекста есть flowOn;
  • внутри flow { } не запускать корутины — если нужны, берите channelFlow;
  • flowOn влияет только на то, что выше по цепочке, — порядок операторов имеет значение;
  • если значения приходят из колбэка внешней библиотеки, нужен не flow, а callbackFlow.

Родственное сообщение Flow exception transparency is violated про то же самое семейство правил, только про исключения: оно появляется, когда внутри билдера эмиссию обернули в try/catch. Для обработки ошибок в потоке есть оператор catch.

Холодные потоки и операторы разобраны в руководстве по корутинам.