aboutsummaryrefslogtreecommitdiffstats
path: root/config-model/src/main/java/com/yahoo/searchdefinition/processing/SummaryDiskAccessValidator.java
blob: d30006a753ee00b428b8b7d081d3066b3d170107 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
package com.yahoo.searchdefinition.processing;

import com.yahoo.config.application.api.DeployLogger;
import com.yahoo.searchdefinition.RankProfileRegistry;
import com.yahoo.searchdefinition.Search;
import com.yahoo.searchdefinition.derived.SummaryClass;
import com.yahoo.searchdefinition.document.ImmutableSDField;
import com.yahoo.vespa.documentmodel.DocumentSummary;
import com.yahoo.vespa.documentmodel.SummaryField;
import com.yahoo.vespa.model.container.search.QueryProfiles;

import java.util.Optional;
import java.util.logging.Level;

/**
 * Emits a warning for summaries which accesses disk.
 *
 * @author bratseth
 */
public class SummaryDiskAccessValidator extends Processor {

    public SummaryDiskAccessValidator(Search search,
                                      DeployLogger deployLogger,
                                      RankProfileRegistry rankProfileRegistry,
                                      QueryProfiles queryProfiles) {
        super(search, deployLogger, rankProfileRegistry, queryProfiles);
    }


    @Override
    public void process(boolean validate, boolean documentsOnly) {
        if ( ! validate) return;
        if (documentsOnly) return;

        for (DocumentSummary summary : search.getSummaries().values()) {
            for (SummaryField summaryField : summary.getSummaryFields()) {
                for (SummaryField.Source source : summaryField.getSources()) {
                    ImmutableSDField field = search.getField(source.getName());
                    if (field == null)
                        field = findFieldProducingSummaryField(source.getName(), search).orElse(null);
                    if (field == null && ! source.getName().equals(SummaryClass.DOCUMENT_ID_FIELD))
                        throw new IllegalArgumentException(summaryField + " in " + summary + " references " +
                                                           source + ", but this field does not exist");
                    if ( ! isInMemory(field) && ! summary.isFromDisk()) {
                        // TODO: Set to warning on vespa 7
                        deployLogger.log(Level.FINE, summaryField + " in " + summary + " references " +
                                                     source + ", which is not an attribute: Using this " +
                                                     "summary will cause disk accesses. " +
                                                     "Set 'from-disk' on this summary class to silence this warning.");
                    }
                }
            }
        }
    }

    private boolean isInMemory(ImmutableSDField field) {
        if (field == null) return false; // For DOCUMENT_ID_FIELD, which may be implicit, but is then not in memory
        return field.doesAttributing();
    }

    private Optional<ImmutableSDField> findFieldProducingSummaryField(String name, Search search) {
        return search.allFields().filter(field -> field.getSummaryFields().get(name) != null).findAny();
    }

}