com.yahoo.vespa.model.application.validation.ComplexFieldsWithStructFieldAttributesValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of config-model Show documentation
There is a newer version: 8.409.18
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.model.application.validation;

import com.yahoo.config.application.api.DeployLogger;
import com.yahoo.schema.Schema;
import com.yahoo.schema.derived.SchemaInfo;
import com.yahoo.schema.document.ComplexAttributeFieldUtils;
import com.yahoo.schema.document.GeoPos;
import com.yahoo.schema.document.ImmutableSDField;
import com.yahoo.vespa.model.application.validation.Validation.Context;
import com.yahoo.vespa.model.search.SearchCluster;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.stream.Collectors;

/**
 * Validates that complex fields (of type struct or map) that have struct field attributes are supported.
 *
 * Only applies for indexed search clusters.
 *
 * @author geirst
 */
public class ComplexFieldsWithStructFieldAttributesValidator implements Validator {

    @Override
    public void validate(Context context) {
        List searchClusters = context.model().getSearchClusters();
        for (SearchCluster cluster : searchClusters) {
            for (SchemaInfo spec : cluster.schemas().values()) {
                if (spec.getIndexMode() == SchemaInfo.IndexMode.INDEX) {
                    validateComplexFields(context, cluster.getClusterName(), spec.fullSchema(), context.deployState().getDeployLogger());
                }
            }
        }
    }

    private static void validateComplexFields(Context context, String clusterName, Schema schema, DeployLogger logger) {
        String unsupportedFields = validateComplexFields(schema);
        if (!unsupportedFields.isEmpty()) {
            context.illegal(getErrorMessage(clusterName, schema, unsupportedFields));
        }
    }

    private static String validateComplexFields(Schema schema) {
        return schema.allFields()
                .filter(field -> isUnsupportedComplexField(field))
                .map(ComplexFieldsWithStructFieldAttributesValidator::toString)
                .collect(Collectors.joining(", "));
    }

    private static String getErrorMessage(String clusterName, Schema schema, String unsupportedFields) {
        return String.format("For cluster '%s', search '%s': The following complex fields do not support using struct field attributes: %s. " +
                             "Only supported for the following complex field types: array or map of struct with primitive types, map of primitive types. " +
                             "The supported primitive types are: byte, int, long, float, double and string",
                             clusterName, schema.getName(), unsupportedFields);
    }

    private static boolean isUnsupportedComplexField(ImmutableSDField field) {
        return (field.usesStructOrMap() &&
                !isSupportedComplexField(field) &&
                hasStructFieldAttributes(field.getStructFields()));
    }

    private static boolean isSupportedComplexField(ImmutableSDField field) {
        return (ComplexAttributeFieldUtils.isSupportedComplexField(field) ||
                GeoPos.isAnyPos(field));
    }

    private static String toString(ImmutableSDField field) {
        return field.getName() + " (" + String.join(", ", getStructFieldAttributes(field.getStructFields(), false)) + ")";
    }

    private static boolean hasStructFieldAttributes(Collection structFields) {
        return !getStructFieldAttributes(structFields, true).isEmpty();
    }

    private static List getStructFieldAttributes(Collection structFields,
                                                         boolean returnAllTypes) {
        var result = new ArrayList();
        for (var structField : structFields) {
            for (var attr : structField.getAttributes().values()) {
                if (returnAllTypes || !ComplexAttributeFieldUtils.isPrimitiveType(attr)) {
                    result.add(attr.getName());
                }
            }
            if (structField.usesStructOrMap() && structField.wasConfiguredToDoAttributing()) {
                result.add(structField.getName());
            }
            // If we encounter struct field attributes underneath this level, those are not supported and should be returned.
            result.addAll(getStructFieldAttributes(structField.getStructFields(), true));
        }
        return result;
    }
}