config-model/src/main/java/com/yahoo/searchdefinition/processing/ReservedMacroNames.java


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

// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.searchdefinition.processing;

import com.google.common.collect.ImmutableSet;
import com.yahoo.config.application.api.DeployLogger;
import com.yahoo.searchdefinition.RankProfile;
import com.yahoo.searchdefinition.RankProfileRegistry;
import com.yahoo.searchdefinition.Search;
import com.yahoo.searchlib.rankingexpression.parser.RankingExpressionParserConstants;
import com.yahoo.vespa.model.container.search.QueryProfiles;

import java.util.HashSet;
import java.util.Set;
import java.util.logging.Level;

/**
 * Issues a warning if some macro has a reserved name. This is not necessarily
 * an error, as a macro can shadow a built-in function.
 *
 * @author lesters
 */
public class ReservedMacroNames extends Processor {
    private static Set<String> reservedNames = getReservedNames();

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

    @Override
    public void process() {
        for (RankProfile rp : rankProfileRegistry.allRankProfiles()) {
            for (String macroName : rp.getMacros().keySet()) {
                if (reservedNames.contains(macroName)) {
                    deployLogger.log(Level.WARNING, "Macro \"" + macroName + "\" " +
                            "in rank profile \"" + rp.getName() + "\" " +
                            "has a reserved name. This might mean that the macro shadows " +
                            "the built-in function with the same name."
                    );
                }
            }
        }
    }

    private static ImmutableSet<String> getReservedNames() {
        ImmutableSet.Builder<String> names = ImmutableSet.builder();
        for (String token : RankingExpressionParserConstants.tokenImage) {
            String tokenWithoutQuotes = token.substring(1, token.length()-1);
            names.add(tokenWithoutQuotes);
        }
        return names.build();
    }
}