com.landawn.abacus.http.HARUtil Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2024 HaiYang Li
 *
 * 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 com.landawn.abacus.http;

import java.io.File;
import java.util.List;
import java.util.Map;
import java.util.function.BiPredicate;
import java.util.function.Consumer;
import java.util.function.Predicate;

import com.landawn.abacus.logging.Logger;
import com.landawn.abacus.logging.LoggerFactory;
import com.landawn.abacus.util.Fn;
import com.landawn.abacus.util.IOUtil;
import com.landawn.abacus.util.Maps;
import com.landawn.abacus.util.N;
import com.landawn.abacus.util.Strings;
import com.landawn.abacus.util.Tuple;
import com.landawn.abacus.util.Tuple.Tuple2;
import com.landawn.abacus.util.Tuple.Tuple3;
import com.landawn.abacus.util.cs;
import com.landawn.abacus.util.u.Optional;
import com.landawn.abacus.util.stream.Stream;

@SuppressWarnings("JavadocLinkAsPlainText")
public final class HARUtil {

    private static final Logger logger = LoggerFactory.getLogger(HARUtil.class);

    private static final BiPredicate defaultHttpHeaderFilterForHARRequest = HttpUtil::isValidHttpHeader;

    private static final ThreadLocal> httpHeaderFilterForHARRequest_TL = ThreadLocal //NOSONAR
            .withInitial(() -> defaultHttpHeaderFilterForHARRequest);

    private static final Consumer defaultCurlLogHandler = curl -> {
        if (logger.isInfoEnabled()) {
            logger.info(curl);
        }
    };

    private static final ThreadLocal>> logRequestCurlForHARRequest_TL = ThreadLocal //NOSONAR
            .withInitial(() -> Tuple.of(false, '\'', defaultCurlLogHandler));

    /**
     *
     * @param httpHeaderFilterForHARRequest
     * @throws IllegalArgumentException
     */
    public static void setHttpHeaderFilterForHARRequest(final BiPredicate httpHeaderFilterForHARRequest)
            throws IllegalArgumentException {
        N.checkArgNotNull(httpHeaderFilterForHARRequest, cs.httpHeaderFilterForHARRequest);

        httpHeaderFilterForHARRequest_TL.set(httpHeaderFilterForHARRequest);
    }

    public static void resetHttpHeaderFilterForHARRequest() {
        httpHeaderFilterForHARRequest_TL.set(defaultHttpHeaderFilterForHARRequest);
    }

    /**
     *
     * @param logRequest
     */
    public static void logRequestCurlForHARRequest(final boolean logRequest) {
        logRequestCurlForHARRequest(logRequest, '\'');
    }

    /**
     *
     * @param logRequest
     * @param quoteChar
     */
    public static void logRequestCurlForHARRequest(final boolean logRequest, final char quoteChar) {
        logRequestCurlForHARRequest_TL.set(Tuple.of(logRequest, quoteChar, defaultCurlLogHandler));
    }

    /**
     *
     * @param logRequest
     * @param quoteChar
     * @param logHandler
     */
    public static void logRequestCurlForHARRequest(final boolean logRequest, final char quoteChar, final Consumer logHandler) {
        logRequestCurlForHARRequest_TL.set(Tuple.of(logRequest, quoteChar, logHandler));
    }

    /**
     * http://www.softwareishard.com/har/viewer/
     * 

     * https://confluence.atlassian.com/kb/generating-har-files-and-analyzing-web-requests-720420612.html
     *
     * @param har
     * @param targetUrl
     * @return
     */
    public static String sendRequestByHAR(final File har, final String targetUrl) {
        return sendRequestByHAR(har, Fn.equal(targetUrl));
    }

    /**
     * http://www.softwareishard.com/har/viewer/
     * 

     * https://confluence.atlassian.com/kb/generating-har-files-and-analyzing-web-requests-720420612.html
     *
     * @param har
     * @param filterForTargetUrl
     * @return
     */
    public static String sendRequestByHAR(final File har, final Predicate filterForTargetUrl) {
        return sendRequestByHAR(IOUtil.readAllToString(har), filterForTargetUrl);
    }

    /**
     * http://www.softwareishard.com/har/viewer/
     * 

     * https://confluence.atlassian.com/kb/generating-har-files-and-analyzing-web-requests-720420612.html
     *
     * @param har
     * @param targetUrl
     * @return
     */
    public static String sendRequestByHAR(final String har, final String targetUrl) {
        return sendRequestByHAR(har, Fn.equal(targetUrl));
    }

    /**
     * http://www.softwareishard.com/har/viewer/
     * 

     * https://confluence.atlassian.com/kb/generating-har-files-and-analyzing-web-requests-720420612.html
     *
     * @param har
     * @param filterForTargetUrl
     * @return
     */
    @SuppressWarnings("rawtypes")
    public static String sendRequestByHAR(final String har, final Predicate filterForTargetUrl) {
        final Map map = N.fromJson(har, Map.class);
        final List entries = Maps.getByPath(map, "log.entries"); //NOSONAR

        //noinspection resource
        return Stream.of(entries) //
                .map(m -> (Map) m.get("request")) //NOSONAR
                // .peek(m -> N.println(m.get("url")))
                .filter(m -> filterForTargetUrl.test((String) m.get("url")))
                .map(requestEntry -> sendRequestByRequestEntry(requestEntry, String.class))
                .first()
                .orElseThrow();

    }

    /**
     * http://www.softwareishard.com/har/viewer/
     * 

     * https://confluence.atlassian.com/kb/generating-har-files-and-analyzing-web-requests-720420612.html
     *
     * @param har
     * @param filterForTargetUrl
     * @return
     */
    public static List sendMultiRequestsByHAR(final File har, final Predicate filterForTargetUrl) {
        return sendMultiRequestsByHAR(IOUtil.readAllToString(har), filterForTargetUrl);
    }

    /**
     * http://www.softwareishard.com/har/viewer/
     * 

     * https://confluence.atlassian.com/kb/generating-har-files-and-analyzing-web-requests-720420612.html
     *
     * @param har
     * @param filterForTargetUrl
     * @return
     */
    @SuppressWarnings("rawtypes")
    public static List sendMultiRequestsByHAR(final String har, final Predicate filterForTargetUrl) {
        final Map map = N.fromJson(har, Map.class);
        final List entries = Maps.getByPath(map, "log.entries");

        //noinspection resource
        return Stream.of(entries) //
                .map(m -> (Map) m.get("request"))
                // .peek(m -> N.println(m.get("url")))
                .filter(m -> filterForTargetUrl.test((String) m.get("url")))
                .map(requestEntry -> sendRequestByRequestEntry(requestEntry, String.class))
                .toList();

    }

    /**
     * http://www.softwareishard.com/har/viewer/
     * 

     * https://confluence.atlassian.com/kb/generating-har-files-and-analyzing-web-requests-720420612.html
     *
     * @param har
     * @param filterForTargetUrl
     * @return first element in the returned {@code Tuple2} is {@code url}. The second element is HttpResponse.
     */
    public static Stream, HttpResponse>> streamMultiRequestsByHAR(final File har,
            final Predicate filterForTargetUrl) {
        return streamMultiRequestsByHAR(IOUtil.readAllToString(har), filterForTargetUrl);
    }

    /**
     * http://www.softwareishard.com/har/viewer/
     * 

     * https://confluence.atlassian.com/kb/generating-har-files-and-analyzing-web-requests-720420612.html
     *
     * @param har
     * @param filterForTargetUrl
     * @return first element in the returned {@code Tuple2} is {@code url}. The second element is HttpResponse.
     */
    @SuppressWarnings("rawtypes")
    public static Stream, HttpResponse>> streamMultiRequestsByHAR(final String har,
            final Predicate filterForTargetUrl) {
        final Map map = N.fromJson(har, Map.class);
        final List entries = Maps.getByPath(map, "log.entries");

        //noinspection resource
        return Stream.of(entries) //
                .map(m -> (Map) m.get("request"))
                // .peek(m -> N.println(m.get("url")))
                .filter(m -> filterForTargetUrl.test((String) m.get("url")))
                .map(requestEntry -> Tuple.of(requestEntry, sendRequestByRequestEntry(requestEntry, HttpResponse.class)));

    }

    /**
     *
     * @param 
     * @param requestEntry
     * @param responseClass
     * @return
     */
    public static  T sendRequestByRequestEntry(final Map requestEntry, final Class responseClass) {
        final String url = getUrlByRequestEntry(requestEntry);
        final HttpMethod httpMethod = getHttpMethodByRequestEntry(requestEntry);

        final HttpHeaders httpHeaders = getHeadersByRequestEntry(requestEntry);

        final String requestBody = Maps.getByPath(requestEntry, "postData.text");
        final String bodyType = Maps.getByPath(requestEntry, "postData.mimeType");

        if (Strings.isNotEmpty(requestBody)) {
            WebUtil.setContentTypeByRequestBodyType(bodyType, httpHeaders);
        }

        final Tuple3> tp = logRequestCurlForHARRequest_TL.get();

        if (tp._1 && (tp._3 != defaultCurlLogHandler || logger.isInfoEnabled())) {
            tp._3.accept(WebUtil.buildCurl(httpMethod.name(), url, httpHeaders.toMap(), requestBody, bodyType, tp._2));
        }

        return HttpRequest.url(url).headers(httpHeaders).body(requestBody).execute(httpMethod, responseClass);
    }

    /**
     *
     * @param har
     * @param filterForTargetUrl
     * @return
     */
    public static Optional> getRequestEntryByUrlFromHAR(final File har, final Predicate filterForTargetUrl) {
        return getRequestEntryByUrlFromHAR(IOUtil.readAllToString(har), filterForTargetUrl);
    }

    /**
     *
     * @param har
     * @param filterForTargetUrl
     * @return
     */
    @SuppressWarnings("rawtypes")
    public static Optional> getRequestEntryByUrlFromHAR(final String har, final Predicate filterForTargetUrl) {
        final Map map = N.fromJson(har, Map.class);
        final List entries = Maps.getByPath(map, "log.entries");

        //noinspection resource
        return Stream.of(entries) //
                .map(m -> (Map) m.get("request"))
                .filter(m -> filterForTargetUrl.test((String) m.get("url")))
                .first();
    }

    /**
     *
     * @param requestEntry
     * @return
     */
    public static String getUrlByRequestEntry(final Map requestEntry) {
        return (String) requestEntry.get("url");
    }

    /**
     *
     * @param requestEntry
     * @return
     */
    public static HttpMethod getHttpMethodByRequestEntry(final Map requestEntry) {
        return HttpMethod.valueOf(requestEntry.get("method").toString().toUpperCase());
    }

    /**
     *
     * @param requestEntry
     * @return
     */
    public static HttpHeaders getHeadersByRequestEntry(final Map requestEntry) {
        final BiPredicate httpHeaderValidatorForHARRequest = httpHeaderFilterForHARRequest_TL.get();
        final HttpHeaders httpHeaders = HttpHeaders.create();
        final List> headers = (List>) requestEntry.get("headers");
        String headerName = null;
        String headerValue = null;

        for (final Map m : headers) {
            headerName = m.get("name");
            headerValue = m.get("value");

            if (httpHeaderValidatorForHARRequest.test(headerName, headerValue)) {
                httpHeaders.set(headerName, headerValue);
            }
        }

        return httpHeaders;
    }

    /**
     *
     * @param requestEntry
     * @return
     */
    public static Tuple2 getBodyAndMimeTypeByRequestEntry(final Map requestEntry) {
        final String requestBody = Maps.getByPath(requestEntry, "postData.text");
        final String bodyType = Maps.getByPath(requestEntry, "postData.mimeType");

        return Tuple.of(requestBody, bodyType);
    }

    private HARUtil() {
        // Utility class.
    }
}