io.micronaut.openapi.visitor.EndpointsConfiguration Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2023 original 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 io.micronaut.openapi.visitor;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import io.micronaut.core.util.StringUtils;
import io.micronaut.inject.visitor.VisitorContext;
import io.micronaut.openapi.OpenApiUtils;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import io.swagger.v3.oas.models.servers.Server;
import io.swagger.v3.oas.models.tags.Tag;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;

import static io.micronaut.openapi.visitor.ContextUtils.warn;
import static io.micronaut.openapi.visitor.StringUtil.COMMA;

/**
 * Endpoints configuration.
 *
 * @author croudet
 */
public class EndpointsConfiguration {

    private static final TypeReference> TYPE_SERVERS_LIST = new TypeReference<>() { };
    private static final TypeReference> TYPE_SECURITY_REQUIREMENTS_LIST = new TypeReference<>() { };
    private static final String ENDPOINTS_PREFIX = "endpoints.";

    public static final String ENDPOINTS_ENABLED = ENDPOINTS_PREFIX + "enabled";
    public static final String ENDPOINTS_TAGS = ENDPOINTS_PREFIX + "tags";
    public static final String ENDPOINTS_PATH = ENDPOINTS_PREFIX + "path";
    public static final String ENDPOINTS_SERVERS = ENDPOINTS_PREFIX + "servers";
    public static final String ENDPOINTS_SECURITY_REQUIREMENTS = ENDPOINTS_PREFIX + "security-requirements";

    private final boolean enabled;
    private String path;
    private List tags;
    private List servers;
    private List securityRequirements;
    private Map endpoints;

    /**
     * List of Endpoints to process.
     *
     * @param context The VisitorContext.
     * @param properties The properties to process.
     */
    EndpointsConfiguration(VisitorContext context, Properties properties) {
        String enabledStr = ConfigUtils.getConfigProperty(ENDPOINTS_ENABLED, context);
        enabled = StringUtils.hasText(enabledStr) && Boolean.parseBoolean(enabledStr);
        if (!enabled) {
            return;
        }
        path = parsePath(ConfigUtils.getConfigProperty(ENDPOINTS_PATH, context));
        tags = parseTags(ConfigUtils.getConfigProperty(ENDPOINTS_TAGS, context));
        servers = parseServers(ConfigUtils.getConfigProperty(ENDPOINTS_SERVERS, context), context);
        securityRequirements = parseSecurityRequirements(ConfigUtils.getConfigProperty(ENDPOINTS_SECURITY_REQUIREMENTS, context), context);
        endpoints = new LinkedHashMap<>();
        var map = new HashMap(properties.size());
        properties.forEach((key, value) -> map.put((String) key, (String) value));
        map.entrySet().stream()
            .filter(EndpointsConfiguration::validEntry)
            .forEach(entry -> {
                int idx = entry.getKey().lastIndexOf('.');
                if (idx <= 0 || idx == entry.getKey().length() - 1 || entry.getValue() == null) {
                    return;
                }
                String entryType = entry.getKey().substring(idx + 1);
                String name = entry.getKey().substring(ENDPOINTS_PREFIX.length(), idx);
                Endpoint endpoint = endpoints.computeIfAbsent(name, key -> new Endpoint());
                switch (entryType) {
                    case "security-requirements" -> endpoint.setSecurityRequirements(parseSecurityRequirements(entry.getValue(), context));
                    case "servers" -> endpoint.setServers(parseServers(entry.getValue(), context));
                    case "tags" -> endpoint.setTags(parseTags(entry.getValue()));
                    case "class" -> endpoint.setClassElement(ContextUtils.getClassElement(entry.getValue(), context));
                    default -> warn("Unknown value " + entryType, context);
                }
            });
    }

    /**
     * Returns the base path for all Endpoints.
     *
     * @return A path.
     */
    String getPath() {
        return path;
    }

    /**
     * Returns true if processing of Endpoints is enabled.
     *
     * @return true if processing of Endpoints is enabled.
     */
    boolean isEnabled() {
        return enabled;
    }

    /**
     * The list of global tags to add to all Endpoints.
     *
     * @return the list of global tags to add to all Endpoints.
     */
    List getTags() {
        return tags;
    }

    /**
     * The Endpoints to process.
     *
     * @return The Endpoints to process.
     */
    Map getEndpoints() {
        return endpoints;
    }

    /**
     * The list of global servers to add to all Endpoints.
     *
     * @return the list of global servers to add to all Endpoints.
     */
    List getServers() {
        return servers;
    }

    /**
     * The list of global security requirements to add to all Endpoints.
     *
     * @return the list of global security requirements to add to all Endpoints.
     */
    List getSecurityRequirements() {
        return securityRequirements;
    }

    private static List parseServers(String servers, VisitorContext context) {
        return parseModel(servers, context, TYPE_SERVERS_LIST);
    }

    private static List parseSecurityRequirements(String securityRequirements, VisitorContext context) {
        return parseModel(securityRequirements, context, TYPE_SECURITY_REQUIREMENTS_LIST);
    }

    private static  List parseModel(String s, VisitorContext context, TypeReference> typeReference) {
        if (StringUtils.isEmpty(s) || (!s.startsWith("[") && !s.endsWith("]"))) {
            return Collections.emptyList();
        }
        try {
            return OpenApiUtils.getConvertJsonMapper().readValue(s, typeReference);
        } catch (JsonProcessingException e) {
            warn("Fail to parse " + typeReference.getType().toString() + ": " + s + " - " + e.getMessage(), context);
        }
        return Collections.emptyList();
    }

    private static boolean validEntry(Map.Entry entry) {
        return entry.getKey().startsWith(ENDPOINTS_PREFIX)
            && !entry.getKey().equals(ENDPOINTS_ENABLED)
            && !entry.getKey().equals(ENDPOINTS_TAGS)
            && !entry.getKey().equals(ENDPOINTS_SERVERS)
            && !entry.getKey().equals(ENDPOINTS_SECURITY_REQUIREMENTS)
            && !entry.getKey().equals(ENDPOINTS_PATH);
    }

    private static List parseTags(String stringTagsStr) {

        if (StringUtils.isEmpty(stringTagsStr)) {
            return Collections.emptyList();
        }
        String[] stringTags = stringTagsStr.split(COMMA);
        if (stringTags.length == 0) {
            return Collections.emptyList();
        }
        var tags = new ArrayList(stringTags.length);
        for (String name : stringTags) {
            if (StringUtils.isEmpty(name)) {
                continue;
            }
            var tag = new Tag();
            tag.setName(name);
            tags.add(tag);
        }
        return tags;
    }

    private static String parsePath(String path) {
        if (StringUtils.isNotEmpty(path) && !path.endsWith(StringUtil.SLASH)) {
            return path + StringUtil.SLASH;
        } else {
            return path;
        }
    }

    @Override
    public String toString() {
        return "EndpointsConfiguration [enabled=" + enabled + ", path=" + path + ", tags=" + tags + ", endpoints="
            + endpoints + "]";
    }
}