aboutsummaryrefslogtreecommitdiffstats
path: root/container-search/src/test/java/com/yahoo/search/querytransform/WandSearcherTestCase.java
blob: 207360ecc7d2cf461d3e01b4e1dcdc1f0c668c2a (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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.search.querytransform;

import com.yahoo.component.chain.Chain;
import com.yahoo.prelude.Index;
import com.yahoo.prelude.IndexFacts;
import com.yahoo.prelude.IndexModel;
import com.yahoo.prelude.SearchDefinition;
import com.yahoo.prelude.query.AndItem;
import com.yahoo.prelude.query.DotProductItem;
import com.yahoo.prelude.query.Item;
import com.yahoo.prelude.query.OrItem;
import com.yahoo.prelude.query.WandItem;
import com.yahoo.prelude.query.WeakAndItem;
import com.yahoo.prelude.query.WeightedSetItem;
import com.yahoo.prelude.query.WordItem;
import com.yahoo.processing.request.ErrorMessage;
import com.yahoo.search.Query;
import com.yahoo.search.Result;
import com.yahoo.search.Searcher;
import com.yahoo.search.searchchain.Execution;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import java.util.Collections;
import java.util.ListIterator;

import static com.yahoo.container.protect.Error.INVALID_QUERY_PARAMETER;
import static org.junit.jupiter.api.Assertions.*;

/**
 * Testing of WandSearcher.
 */
public class WandSearcherTestCase {

    private static final String VESPA_FIELD = "vespa-field";
    private static final double delta = 0.0000001;

    private Execution exec;

    @SuppressWarnings("deprecation")
    private IndexFacts buildIndexFacts() {
        SearchDefinition sd = new SearchDefinition("test");
        sd.addIndex(new Index(VESPA_FIELD));
        return new IndexFacts(new IndexModel(sd));
    }

    private Execution buildExec() {
        return new Execution(new Chain<Searcher>(new WandSearcher()),
                Execution.Context.createContextStub(buildIndexFacts()));
    }

    private Query buildQuery(String wandFieldName, String wandTokens, String wandHeapSize, String wandType, String wandScoreThreshold, String wandThresholdBoostFactor) {
        Query q = new Query("");
        q.properties().set("wand.field", wandFieldName);
        q.properties().set("wand.tokens", wandTokens);
        if (wandHeapSize != null) {
            q.properties().set("wand.heapSize", wandHeapSize);
        }
        if (wandType != null) {
            q.properties().set("wand.type", wandType);
        }
        if (wandScoreThreshold != null) {
            q.properties().set("wand.scoreThreshold", wandScoreThreshold);
        }
        if (wandThresholdBoostFactor != null) {
            q.properties().set("wand.thresholdBoostFactor", wandThresholdBoostFactor);
        }
        q.setHits(9);
        return q;
    }

    private Query buildDefaultQuery(String wandFieldName, String wandHeapSize) {
        return buildQuery(wandFieldName, "{a:1,b:2,c:3}", wandHeapSize, null, null, null);
    }

    private Query buildDefaultQuery() {
        return buildQuery(VESPA_FIELD, "{a:1,\"b\":2,c:3}", null, null, null, null);
    }

    private void assertWordItem(String expToken, String expField, int expWeight, Item item) {
        WordItem wordItem = (WordItem) item;
        assertEquals(expToken, wordItem.getWord());
        assertEquals(expField, wordItem.getIndexName());
        assertEquals(expWeight, wordItem.getWeight());
    }

    @BeforeEach
    public void setUp() throws Exception {
        exec = buildExec();
    }

    @Test
    void requireThatVespaWandCanBeSpecified() {
        Query q = buildDefaultQuery();
        Result r = exec.search(q);

        WeakAndItem root = (WeakAndItem) TestUtils.getQueryTreeRoot(r);
        assertEquals(100, root.getN());
        assertEquals(3, root.getItemCount());
        ListIterator<Item> itr = root.getItemIterator();
        assertWordItem("a", VESPA_FIELD, 1, itr.next());
        assertWordItem("b", VESPA_FIELD, 2, itr.next());
        assertWordItem("c", VESPA_FIELD, 3, itr.next());
        assertFalse(itr.hasNext());
    }

    @Test
    void requireThatVespaWandHeapSizeCanBeSpecified() {
        Query q = buildDefaultQuery(VESPA_FIELD, "50");
        Result r = exec.search(q);

        WeakAndItem root = (WeakAndItem) TestUtils.getQueryTreeRoot(r);
        assertEquals(50, root.getN());
    }

    @Test
    void requireThatWandCanBeSpecifiedTogetherWithNonAndQueryRoot() {
        Query q = buildDefaultQuery();
        q.getModel().getQueryTree().setRoot(new WordItem("foo", "otherfield"));
        Result r = exec.search(q);

        AndItem root = (AndItem) TestUtils.getQueryTreeRoot(r);
        assertEquals(2, root.getItemCount());
        ListIterator<Item> itr = root.getItemIterator();
        assertTrue(itr.next() instanceof WordItem);
        assertTrue(itr.next() instanceof WeakAndItem);
        assertFalse(itr.hasNext());
    }

    @Test
    void requireThatWandCanBeSpecifiedTogetherWithAndQueryRoot() {
        Query q = buildDefaultQuery();
        {
            AndItem root = new AndItem();
            root.addItem(new WordItem("foo", "otherfield"));
            root.addItem(new WordItem("bar", "otherfield"));
            q.getModel().getQueryTree().setRoot(root);
        }
        Result r = exec.search(q);

        AndItem root = (AndItem) TestUtils.getQueryTreeRoot(r);
        assertEquals(3, root.getItemCount());
        ListIterator<Item> itr = root.getItemIterator();
        assertTrue(itr.next() instanceof WordItem);
        assertTrue(itr.next() instanceof WordItem);
        assertTrue(itr.next() instanceof WeakAndItem);
        assertFalse(itr.hasNext());
    }


    @Test
    void requireThatNothingIsAddedWithoutWandPropertiesSet() {
        Query foo = new Query("");
        foo.getModel().getQueryTree().setRoot(new WordItem("foo", "otherfield"));
        Result r = exec.search(foo);

        WordItem root = (WordItem) TestUtils.getQueryTreeRoot(r);
        assertEquals("foo", root.getWord());
    }

    @Test
    void requireThatErrorIsReturnedOnInvalidTokenList() {
        Query q = buildQuery(VESPA_FIELD, "{a1,b:1}", null, null, null, null);
        Result r = exec.search(q);

        ErrorMessage msg = r.hits().getError();
        assertNotNull(msg);
        assertEquals(INVALID_QUERY_PARAMETER.code, msg.getCode());
        assertEquals("'{a1,b:1}' is not a legal sparse vector string: Expected ':' starting at position 3 but was ','", msg.getDetailedMessage());
    }

    @Test
    void requireThatErrorIsReturnedOnUnknownField() {
        Query q = buildDefaultQuery("unknown", "50");
        Result r = exec.search(q);
        ErrorMessage msg = r.hits().getError();
        assertNotNull(msg);
        assertEquals(INVALID_QUERY_PARAMETER.code, msg.getCode());
        assertEquals("Field 'unknown' was not found in index facts for search definitions [test]", msg.getDetailedMessage());
    }

    @Test
    void requireThatVespaOrCanBeSpecified() {
        Query q = buildQuery(VESPA_FIELD, "{a:1,b:2,c:3}", null, "or", null, null);
        Result r = exec.search(q);

        OrItem root = (OrItem) TestUtils.getQueryTreeRoot(r);
        assertEquals(3, root.getItemCount());
        ListIterator<Item> itr = root.getItemIterator();
        assertWordItem("a", VESPA_FIELD, 1, itr.next());
        assertWordItem("b", VESPA_FIELD, 2, itr.next());
        assertWordItem("c", VESPA_FIELD, 3, itr.next());
        assertFalse(itr.hasNext());
    }

    private void assertWeightedSetItem(WeightedSetItem item) {
        assertEquals(3, item.getNumTokens());
        assertEquals(Integer.valueOf(1), item.getTokenWeight("a"));
        assertEquals(Integer.valueOf(2), item.getTokenWeight("b"));
        assertEquals(Integer.valueOf(3), item.getTokenWeight("c"));
    }

    @Test
    void requireThatDefaultParallelWandCanBeSpecified() {
        Query q = buildQuery(VESPA_FIELD, "{a:1,b:2,c:3}", null, "parallel", null, null);
        Result r = exec.search(q);

        WandItem root = (WandItem) TestUtils.getQueryTreeRoot(r);
        assertEquals(VESPA_FIELD, root.getIndexName());
        assertEquals(100, root.getTargetNumHits());
        assertEquals(0.0, root.getScoreThreshold(), delta);
        assertEquals(1.0, root.getThresholdBoostFactor(), delta);
        assertWeightedSetItem(root);
    }

    @Test
    void requireThatParallelWandCanBeSpecified() {
        Query q = buildQuery(VESPA_FIELD, "{a:1,b:2,c:3}", "50", "parallel", "70.5", "2.3");
        Result r = exec.search(q);

        WandItem root = (WandItem) TestUtils.getQueryTreeRoot(r);
        assertEquals(VESPA_FIELD, root.getIndexName());
        assertEquals(50, root.getTargetNumHits());
        assertEquals(70.5, root.getScoreThreshold(), delta);
        assertEquals(2.3, root.getThresholdBoostFactor(), delta);
        assertWeightedSetItem(root);
    }

    @Test
    void requireThatDotProductCanBeSpecified() {
        Query q = buildQuery(VESPA_FIELD, "{a:1,b:2,c:3}", null, "dotProduct", null, null);
        Result r = exec.search(q);

        DotProductItem root = (DotProductItem) TestUtils.getQueryTreeRoot(r);
        assertEquals(VESPA_FIELD, root.getIndexName());
        assertWeightedSetItem(root);
    }

}