/*
 * Copyright 2002-2017 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.test.web.reactive.server;

import java.time.Duration;

import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

/**
 * {@code ExchangeResult} variant with the response body decoded as
 * {@code Flux<T>} but not yet consumed.
 *
 * @param <T> the type of elements in the response body
 *
 * @author Rossen Stoyanchev
 * @since 5.0
 * @see EntityExchangeResult
 */
public class FluxExchangeResult<T> extends ExchangeResult {

	private static final IllegalStateException TIMEOUT_ERROR =
			new IllegalStateException("Response timeout: for infinite streams " +
					"use getResponseBody() first with explicit cancellation, e.g. via take(n).");


	private final Flux<T> body;

	private final Duration timeout;


	FluxExchangeResult(ExchangeResult result, Flux<T> body, Duration timeout) {
		super(result);
		this.body = body;
		this.timeout = timeout;
	}


	/**
	 * Return the response body as a {@code Flux<T>} of decoded elements.
	 *
	 * <p>The response body stream can then be consumed further with the
	 * "reactor-test" {@code StepVerifier} and cancelled when enough elements have been
	 * consumed from the (possibly infinite) stream:
	 *
	 * <pre>
	 * FluxExchangeResult<Person> result = this.client.get()
	 * 	.uri("/persons")
	 * 	.accept(TEXT_EVENT_STREAM)
	 * 	.exchange()
	 * 	.expectStatus().isOk()
	 * 	.expectHeader().contentType(TEXT_EVENT_STREAM)
	 * 	.expectBody(Person.class)
	 * 	.returnResult();
	 *
	 * StepVerifier.create(result.getResponseBody())
	 * 	.expectNext(new Person("Jane"), new Person("Jason"))
	 * 	.expectNextCount(4)
	 * 	.expectNext(new Person("Jay"))
	 * 	.thenCancel()
	 * 	.verify();
	 * </pre>
	 */
	public Flux<T> getResponseBody() {
		return this.body;
	}

	/**
	 * {@inheritDoc}
	 * <p><strong>Note:</strong> this method should typically be called after
	 * the response has been consumed in full via {@link #getResponseBody()}.
	 * Calling it first will cause the response {@code Flux<T>} to be consumed
	 * via {@code getResponseBody.ignoreElements()}.
	 */
	@Override
	public byte[] getResponseBodyContent() {
		return this.body.ignoreElements()
				.timeout(this.timeout, Mono.error(TIMEOUT_ERROR))
				.then(Mono.defer(() -> Mono.just(super.getResponseBodyContent())))
				.block();
	}

}