/*
 * Copyright 2012-2020 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
 *
 *      https://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.boot.actuate.metrics.web.reactive.client;

import java.io.IOException;
import java.util.regex.Pattern;

import io.micrometer.core.instrument.Tag;

import org.springframework.boot.actuate.metrics.http.Outcome;
import org.springframework.http.client.reactive.ClientHttpRequest;
import org.springframework.web.reactive.function.client.ClientRequest;
import org.springframework.web.reactive.function.client.ClientResponse;
import org.springframework.web.reactive.function.client.WebClient;

Factory methods for creating Tags related to a request-response exchange performed by a WebClient. 
Author:
Brian Clozel, Nishant Raut
Since:
2.1.0/**
 * Factory methods for creating {@link Tag Tags} related to a request-response exchange
 * performed by a {@link WebClient}.
 *
 * @author Brian Clozel
 * @author Nishant Raut
 * @since 2.1.0
 */
public final class WebClientExchangeTags {

	private static final String URI_TEMPLATE_ATTRIBUTE = WebClient.class.getName() + ".uriTemplate";

	private static final Tag IO_ERROR = Tag.of("status", "IO_ERROR");

	private static final Tag CLIENT_ERROR = Tag.of("status", "CLIENT_ERROR");

	private static final Pattern PATTERN_BEFORE_PATH = Pattern.compile("^https?://[^/]+/");

	private static final Tag CLIENT_NAME_NONE = Tag.of("clientName", "none");

	private WebClientExchangeTags() {
	}

	
Creates a method Tag for the 
method of the given request. 
Params:
request – the request
Returns:
the method tag/**
	 * Creates a {@code method} {@code Tag} for the {@link ClientHttpRequest#getMethod()
	 * method} of the given {@code request}.
	 * @param request the request
	 * @return the method tag
	 */
	public static Tag method(ClientRequest request) {
		return Tag.of("method", request.method().name());
	}

	
Creates a uri Tag for the URI path of the given request. 
Params:
request – the request
Returns:
the uri tag/**
	 * Creates a {@code uri} {@code Tag} for the URI path of the given {@code request}.
	 * @param request the request
	 * @return the uri tag
	 */
	public static Tag uri(ClientRequest request) {
		String uri = (String) request.attribute(URI_TEMPLATE_ATTRIBUTE).orElseGet(() -> request.url().toString());
		return Tag.of("uri", extractPath(uri));
	}

	private static String extractPath(String url) {
		String path = PATTERN_BEFORE_PATH.matcher(url).replaceFirst("");
		return (path.startsWith("/") ? path : "/" + path);
	}

	
Creates a status Tag derived from the statusCode.statusCode() of the given response if available, the thrown exception otherwise, or considers the request as Cancelled as a last resort. 
Params:
response – the response
throwable – the exception
Returns:
the status tag
Since:
2.3.0/**
	 * Creates a {@code status} {@code Tag} derived from the
	 * {@link ClientResponse#statusCode()} of the given {@code response} if available, the
	 * thrown exception otherwise, or considers the request as Cancelled as a last resort.
	 * @param response the response
	 * @param throwable the exception
	 * @return the status tag
	 * @since 2.3.0
	 */
	public static Tag status(ClientResponse response, Throwable throwable) {
		if (response != null) {
			return Tag.of("status", String.valueOf(response.rawStatusCode()));
		}
		if (throwable != null) {
			return (throwable instanceof IOException) ? IO_ERROR : CLIENT_ERROR;
		}
		return CLIENT_ERROR;
	}

	
Creates a status Tag derived from the statusCode.statusCode() of the given response. 
Params:
response – the response
Returns:
the status tag
Deprecated:
since 2.3.0 in favor of status(ClientResponse, Throwable)/**
	 * Creates a {@code status} {@code Tag} derived from the
	 * {@link ClientResponse#statusCode()} of the given {@code response}.
	 * @param response the response
	 * @return the status tag
	 * @deprecated since 2.3.0 in favor of {@link #status(ClientResponse, Throwable)}
	 */
	@Deprecated
	public static Tag status(ClientResponse response) {
		return Tag.of("status", String.valueOf(response.rawStatusCode()));
	}

	
Creates a status Tag derived from the exception thrown by the client. 
Params:
throwable – the exception
Returns:
the status tag
Deprecated:
since 2.3.0 in favor of status(ClientResponse, Throwable)/**
	 * Creates a {@code status} {@code Tag} derived from the exception thrown by the
	 * client.
	 * @param throwable the exception
	 * @return the status tag
	 * @deprecated since 2.3.0 in favor of {@link #status(ClientResponse, Throwable)}
	 */
	@Deprecated
	public static Tag status(Throwable throwable) {
		return (throwable instanceof IOException) ? IO_ERROR : CLIENT_ERROR;
	}

	
Create a clientName Tag derived from the host of the URL of the given request. 
Params:
request – the request
Returns:
the clientName tag/**
	 * Create a {@code clientName} {@code Tag} derived from the
	 * {@link java.net.URI#getHost host} of the {@link ClientRequest#url() URL} of the
	 * given {@code request}.
	 * @param request the request
	 * @return the clientName tag
	 */
	public static Tag clientName(ClientRequest request) {
		String host = request.url().getHost();
		if (host == null) {
			return CLIENT_NAME_NONE;
		}
		return Tag.of("clientName", host);
	}

	
Creates an outcome Tag derived from the status of the given response. 
Params:
response – the response
Returns:
the outcome tag
Since:
2.2.0/**
	 * Creates an {@code outcome} {@code Tag} derived from the
	 * {@link ClientResponse#rawStatusCode() status} of the given {@code response}.
	 * @param response the response
	 * @return the outcome tag
	 * @since 2.2.0
	 */
	public static Tag outcome(ClientResponse response) {
		Outcome outcome = (response != null) ? Outcome.forStatus(response.rawStatusCode()) : Outcome.UNKNOWN;
		return outcome.asTag();
	}

}