repeatWhenでfilterを使ってもonCompletedは呼ばれない

このエントリーをはてなブックマークに追加

掲題の通りです

TL;DR

Observable#repeatWhen使って複雑な繰り返し判定するときはObservable#filterじゃなくてObservable#takeWhileを使うとonCompletedまで呼ばれる


大量のデータをローカルに同期するAPIがあって、ページングの要領で複数回APIを叩いてすべてのデータを同期するとします。
こんな感じのコードなら動きます。

boolean isLoading = false;

public Completable sync() {  
    return Observable.defer(() -> {
        if (isLoading) {
          return Observable.empty();
        }
        isLoading = true;
        return syncData() 
    })
        .repeatWhen(observable -> {
            return observable.flatMap(aVoid -> isSyncCompleted().first())
                .takeWhile(completed -> !completed)
                .doOnCompleted(() -> Timber.d("sync completed")
                .doOnNext(completed -> Timber.d("should request next data");
        })
        .doOnCompleted(() -> isLoading = false)
        .toCompletable();
}

これ最初気づかなくて悩んだのですが、ここでtakeWhileの代わりにfilterを使うとObservable#doOnCompletedが呼ばれません。

boolean isLoading = false;

public Completable sync() {  
    return Observable.defer(() -> {
        if (isLoading) {
          return Observable.empty();
        }
        isLoading = true;
        return syncData() 
    })
        .repeatWhen(observable -> {
            return observable.map(aVoid -> isSyncCompleted())
                // これだとdoOnCompletedが呼ばれない
                .filter(completed -> !completed)
                .doOnCompleted(() -> Timber.d("sync completed")
                .doOnNext(completed -> Timber.d("should request next data");
        })
        .doOnCompleted(() -> isLoading = false)
        .toCompletable();
}

なのでこのコードだとisSyncCompletedがtrueを返したとしてもisLoadingが更新されず、再度sync()を呼ばれた時に必ずreturn Observable.empty()のルートに入ってしまいます。

Observable#repeatWhenのjavadocを読むと、以下のように書かれています。

Returns an Observable that emits the same values as the source Observable with the exception of an {@code onCompleted}. An {@code onCompleted} notification from the source will result in the emission of a {@code void} item to the Observable provided as an argument to the {@code notificationHandler} function. If that Observable calls {@code onComplete} or {@code onError} then {@code repeatWhen} will call {@code onCompleted} or {@code onError} on the child subscription. Otherwise, this Observable will resubscribe to the source observable.

なるほど

An {@code onCompleted} notification from the source will result in the emission of a {@code void} item to the Observable provided as an argument to the {@code notificationHandler} function.

元のObservableでonCompletedが呼ばれると、notificationHandlerが渡してくるObservableのonNextが呼ばれるようです。

If that Observable calls {@code onComplete} or {@code onError} then {@code repeatWhen} will call {@code onCompleted} or {@code onError} on the child subscription. Otherwise, this Observable will resubscribe to the source observable.

onCompleteonErrorが呼ばれないとresubscribeしてしまうようです。

いつ自動的にonCompletedになるのか、という記述がありませんし、notificationHandlerの引数のObservableは、文字通り元のObservableでonCompletedが呼ばれた時にVoidをemitするだけのObservableなのでしょう。とりあえずonCompletedが呼ばれるようにfilterをやめてtakeWhileに変えてみたら意図した通りの動作になった次第です。

if文で分岐してempty返したりしてもイケるとは思いますが、とりあえずはこんな感じで。


参考: