Проверка буферизации и завершения AsyncStream для iOS

Проверка буферизации и завершения AsyncStream для iOS

Проверка буферизации и завершения AsyncStream для iOS

Ваш экран iOS получает события прогресса через AsyncStream: при редких действиях всё работает, но при серии быстрых запусков промежуточные состояния пропускаются. После ухода с экрана нижележащий слушатель продолжает работать. Не спешите увеличивать задержки. На облачном Mac VPSPull зафиксируйте порядок генерации и потребления событий, а затем отдельно проверьте контракты буферизации, завершения и очистки ресурсов. Так найти причину проще, чем раз за разом нажимать кнопки через удалённый рабочий стол.

Определите, какие события допустимо терять

Для процентов выполнения обычно достаточно последнего состояния, а вот подтверждения оплаты или записи о передаче файлов нельзя терять произвольно. Сначала зафиксируйте три условия для потока: какие значения обязательно должны дойти до потребителя, как обрабатывать накопившиеся события и кто отвечает за остановку производителя. Не позволяйте политике буферизации по умолчанию принимать решения за бизнес-логику.

unbounded сохраняет ещё не потреблённые элементы, но при непрерывной генерации событий потребление памяти может расти без ограничений; bufferingNewest(2) сохраняет два самых новых элемента; bufferingOldest(2) сохраняет два самых старых элемента, ожидающих обработки. Ёмкость здесь измеряется количеством элементов, а не байтами: крупные объекты всё равно могут занимать много памяти.

Ограниченный буфер — не механизм обратного давления. Вызов yield у AsyncStream не ждёт, пока потребитель освободит место. Если бизнес-логике нужна передача без потерь, необходимо отдельно предусмотреть подтверждения, ограничение скорости или сохранение в постоянное хранилище.

Начните с проверки одного потребителя. Если несколько задач потребляют один и тот же поток, это нельзя автоматически считать моделью широковещательной рассылки, в которой каждый подписчик получает все события.

Создайте тестовую оснастку, не зависящую от случайного порядка выполнения

В терминале с уже настроенным набором инструментов Swift выполните:

mkdir StreamContract
cd StreamContract
swift package init --type library --name StreamContract
swift --version

Замените содержимое сгенерированного тестового файла приведённым ниже тестом XCTest. Файл должен находиться по пути Tests/StreamContractTests/StreamContractTests.swift. Если шаблон создал другие тестовые файлы, сначала удалите из них демонстрационные тесты, чтобы посторонние результаты не попали в отчёт.

import XCTest

final class StreamContractTests: XCTestCase {
    func testNewestBufferDrainsAfterFinish() async {
        let pair = AsyncStream<Int>.makeStream(
            bufferingPolicy: .bufferingNewest(2)
        )

        pair.continuation.yield(1)
        pair.continuation.yield(2)

        switch pair.continuation.yield(3) {
        case .dropped(let value):
            XCTAssertEqual(value, 1)
        default:
            XCTFail("Expected the oldest buffered value to be dropped")
        }

        pair.continuation.finish()

        var iterator = pair.stream.makeAsyncIterator()
        let first = await iterator.next()
        let second = await iterator.next()
        let end = await iterator.next()

        XCTAssertEqual(first, 2)
        XCTAssertEqual(second, 3)
        XCTAssertNil(end)

        switch pair.continuation.yield(4) {
        case .terminated:
            break
        default:
            XCTFail("Expected a terminated stream")
        }
    }
}

Затем выполните swift test. Этот тест сначала генерирует элементы, а уже потом потребляет их, намеренно вызывая переполнение буфера. Не нужно угадывать порядок выполнения задач с помощью пауз. Если в вашей версии инструментов нет makeStream, сначала проверьте версию Swift либо получите continuation через замыкание инициализатора. Удалять проверку переполнения ради «совместимости» нельзя.

Проверяйте отброшенные значения, а не только результат потребления

Недостаточно проверить, что в итоге получены 2, 3: ошибочная реализация может сама отфильтровать 1 и случайно дать тот же результат. Только проверка возвращаемого yield значения .dropped подтверждает, что потеря произошла именно на уровне политики буферизации.

Затем скопируйте тест и замените политику на bufferingOldest(2). Третий вызов yield должен сообщить об отбрасывании 3, а потребитель должен получить 1, 2. Оформите эти ожидания как отдельные тесты с соответствующими именами. Не подстраивайте ожидаемый результат внутри теста под фактический вывод.

Добавьте ещё один граничный случай: если ёмкость равна нулю и нет потребителя, ожидающего следующий элемент, переданное в yield значение отбрасывается. Нулевая ёмкость не гарантирует синхронную передачу. Если тест запускает потребителя заранее, нужен сигнал синхронизации, подтверждающий, что тот уже ждёт. Иначе результат будет зависеть от планирования задач.

Для реальных объектов достаточно сохранять стабильные идентификаторы событий. Не записывайте в журнал всю полезную нагрузку. При больших объёмах данных для анализа достаточно идентификаторов, числа отброшенных событий и политики буферизации.

Проверяйте finish, отмену и досрочный выход отдельно

finish() означает, что новые элементы больше не принимаются, но не требует немедленно отбрасывать уже накопленные в буфере. Приведённый выше тест специально проверяет, что сначала читаются 2, 3, а затем next возвращает nil. Вызов yield после завершения должен вернуть .terminated.

Для проверки отмены создайте отдельную тестовую оснастку: переведите задачу-потребителя в ожидание next, отмените её и дождитесь выхода задачи. С помощью потокобезопасного счётчика или тестового ожидания зафиксируйте вызов onTermination, проверьте, что причиной завершения стала отмена, и убедитесь, что нижележащий слушатель остановлен. Конечный тайм-аут нужен лишь для защиты от зависания теста, а не как доказательство корректности бизнес-логики.

Для досрочного выхода нужен явный владелец

break внутри цикла лишь завершает цикл. Если другие объекты по-прежнему удерживают поток или continuation, нельзя на этом основании утверждать, что слушатель освобождён. Предусмотрите у адаптера явный stop, который вызывает владелец — экран или сервис, — а затем проверяйте число снятий регистрации.

onTermination может выполняться в конкурентном контексте. Состояние, захваченное замыканием очистки, должно поддерживать конкурентный доступ. Не изменяйте напрямую объекты интерфейса, доступ к которым разрешён только из главного потока. Также не вызывайте finish, удерживая внутреннюю блокировку, если затем обработчик завершения должен захватить ту же блокировку.

Завершите проверку матрицей сбоев, а не увеличением задержек

В итоговом наборе оставьте как минимум четыре вида проверок: вытеснение старых значений при сохранении самых новых, отклонение новых значений при сохранении самых старых, опустошение буфера при штатном завершении и остановка генерации после отмены. В каждом случае проверяйте значения, состояние завершения и число операций очистки, чтобы тесты не проходили при всё ещё работающих ресурсах.

Затем с помощью поддельного слушателя воспроизведите гонку при остановке: после stop вызовите обратный вызов ещё раз. Адаптер должен безопасно проигнорировать его либо получить terminated, но не доставлять бизнес-событие повторно. Повторные вызовы stop также должны оставаться идемпотентными и не снимать регистрацию одного и того же дескриптора слушателя несколько раз.

При сдаче изменений сохраните вместе с ними версию инструментов, команду запуска тестов и имена упавших тестовых случаев. Если тесты с фиксированным порядком стабильны, а на реальном экране события всё ещё теряются, следующим шагом проверьте адаптер источника событий и скорость обработки потребителем. Если нестабильна сама тестовая оснастка, сначала исправьте синхронизацию, а не прячьте гонку за более длительными паузами.

Часто задаваемые вопросы

Заставляет ли bufferingNewest производителя ждать потребителя?

Нет. При заполнении буфера вытесняется старое значение, а yield сообщает о потере. Для ограниченной передачи без потерь нужен отдельный механизм подтверждений или управления потоком.

Освобождает ли break слушателя немедленно?

Не обязательно. break завершает цикл, но поток и continuation могут оставаться в памяти. Владелец должен явно останавливать слушателя; отмену, остановку и нормальное завершение проверяют отдельно.

Проверьте свой рабочий процесс на выделенном Mac

Сначала проверьте модель, узел и срок аренды, затем протестируйте работу в течение дня. Актуальный статус доступности смотрите в консоли.