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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
|
// Copyright (C) 2019 Google LLC
//
// 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
//
// http://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.
#include "icing/index/main/main-index-merger.h"
#include <cstdint>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "icing/text_classifier/lib3/utils/base/status.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
#include "icing/file/filesystem.h"
#include "icing/index/hit/hit.h"
#include "icing/index/lite/lite-index.h"
#include "icing/index/lite/term-id-hit-pair.h"
#include "icing/index/main/main-index.h"
#include "icing/index/term-id-codec.h"
#include "icing/legacy/index/icing-dynamic-trie.h"
#include "icing/legacy/index/icing-filesystem.h"
#include "icing/store/namespace-id.h"
#include "icing/testing/common-matchers.h"
#include "icing/testing/tmp-directory.h"
namespace icing {
namespace lib {
namespace {
using ::testing::UnorderedElementsAre;
class MainIndexMergerTest : public testing::Test {
protected:
void SetUp() override {
index_dir_ = GetTestTempDir() + "/test_dir";
ASSERT_TRUE(filesystem_.CreateDirectoryRecursively(index_dir_.c_str()));
std::string lite_index_file_name = index_dir_ + "/test_file.lite-idx.index";
LiteIndex::Options options(lite_index_file_name,
/*hit_buffer_want_merge_bytes=*/1024 * 1024,
/*hit_buffer_sort_at_indexing=*/true,
/*hit_buffer_sort_threshold_bytes=*/1024 * 8);
ICING_ASSERT_OK_AND_ASSIGN(lite_index_,
LiteIndex::Create(options, &icing_filesystem_));
ICING_ASSERT_OK_AND_ASSIGN(
term_id_codec_,
TermIdCodec::Create(
IcingDynamicTrie::max_value_index(IcingDynamicTrie::Options()),
IcingDynamicTrie::max_value_index(options.lexicon_options)));
}
void TearDown() override {
ASSERT_TRUE(filesystem_.DeleteDirectoryRecursively(index_dir_.c_str()));
}
std::string index_dir_;
Filesystem filesystem_;
IcingFilesystem icing_filesystem_;
std::unique_ptr<LiteIndex> lite_index_;
std::unique_ptr<TermIdCodec> term_id_codec_;
};
constexpr NamespaceId kNamespace0 = 0;
TEST_F(MainIndexMergerTest, TranslateTermNotAdded) {
// 1. Index two docs in the Lite Index:
// - Doc0 {"foot" is_in_prefix_section=FALSE}
// - Doc1 {"fool", is_in_prefix_section=FALSE}
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foot_tvi,
lite_index_->InsertTerm("foot", TermMatchType::PREFIX, kNamespace0));
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foot_term_id,
term_id_codec_->EncodeTvi(foot_tvi, TviType::LITE));
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t fool_tvi,
lite_index_->InsertTerm("fool", TermMatchType::PREFIX, kNamespace0));
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t fool_term_id,
term_id_codec_->EncodeTvi(fool_tvi, TviType::LITE));
Hit doc0_hit(/*section_id=*/0, /*document_id=*/0, /*term_frequency=*/57,
/*is_in_prefix_section=*/false, /*is_prefix_hit=*/false);
ICING_ASSERT_OK(lite_index_->AddHit(foot_term_id, doc0_hit));
Hit doc1_hit(/*section_id=*/0, /*document_id=*/1, Hit::kDefaultTermFrequency,
/*is_in_prefix_section=*/false, /*is_prefix_hit=*/false);
ICING_ASSERT_OK(lite_index_->AddHit(fool_term_id, doc1_hit));
// 2. Build up a fake LexiconMergeOutputs
// This is some made up number that doesn't matter for this test.
uint32_t foot_main_tvi = 5;
// Only create a mapping for 'foot'. Leave out the mapping for 'fool'
MainIndex::LexiconMergeOutputs lexicon_outputs;
lexicon_outputs.other_tvi_to_main_tvi.emplace(foot_tvi, foot_main_tvi);
// 3. TranslateAndExpand should fail because 'fool' doesn't have a main tvi
// mapping.
ASSERT_THAT(MainIndexMerger::TranslateAndExpandLiteHits(
*lite_index_, *term_id_codec_, lexicon_outputs),
StatusIs(libtextclassifier3::StatusCode::INTERNAL));
}
TEST_F(MainIndexMergerTest, PrefixExpansion) {
// 1. Index two docs in the Lite Index:
// - Doc0 {"foot" is_in_prefix_section=FALSE}
// - Doc1 {"fool", is_in_prefix_section=TRUE}
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foot_tvi,
lite_index_->InsertTerm("foot", TermMatchType::PREFIX, kNamespace0));
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foot_term_id,
term_id_codec_->EncodeTvi(foot_tvi, TviType::LITE));
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t fool_tvi,
lite_index_->InsertTerm("fool", TermMatchType::PREFIX, kNamespace0));
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t fool_term_id,
term_id_codec_->EncodeTvi(fool_tvi, TviType::LITE));
Hit doc0_hit(/*section_id=*/0, /*document_id=*/0, /*term_frequency=*/57,
/*is_in_prefix_section=*/false, /*is_prefix_hit=*/false);
ICING_ASSERT_OK(lite_index_->AddHit(foot_term_id, doc0_hit));
Hit doc1_hit(/*section_id=*/0, /*document_id=*/1, Hit::kDefaultTermFrequency,
/*is_in_prefix_section=*/true, /*is_prefix_hit=*/false);
ICING_ASSERT_OK(lite_index_->AddHit(fool_term_id, doc1_hit));
// 2. Build up a fake LexiconMergeOutputs
// This is some made up number that doesn't matter for this test.
uint32_t foo_main_tvi = 12;
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foo_term_id,
term_id_codec_->EncodeTvi(foo_main_tvi, TviType::MAIN));
Hit doc1_prefix_hit(/*section_id=*/0, /*document_id=*/1,
Hit::kDefaultTermFrequency,
/*is_in_prefix_section=*/true, /*is_prefix_hit=*/true);
uint32_t foot_main_tvi = 5;
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foot_main_term_id,
term_id_codec_->EncodeTvi(foot_main_tvi, TviType::MAIN));
uint32_t fool_main_tvi = 10;
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t fool_main_term_id,
term_id_codec_->EncodeTvi(fool_main_tvi, TviType::MAIN));
MainIndex::LexiconMergeOutputs lexicon_outputs;
// Map "fool" to it's prefix hit for "foo".
lexicon_outputs.other_tvi_to_prefix_main_tvis.emplace(fool_tvi,
std::make_pair(0, 1));
lexicon_outputs.prefix_tvis_buf.push_back(foo_main_tvi);
lexicon_outputs.other_tvi_to_main_tvi.emplace(foot_tvi, foot_main_tvi);
lexicon_outputs.other_tvi_to_main_tvi.emplace(fool_tvi, fool_main_tvi);
// 3. TranslateAndExpand should;
// a. Translate lite term ids to main term ids based on the map
// b. Expand 'fool' to have a hit for 'foo'
ICING_ASSERT_OK_AND_ASSIGN(
std::vector<TermIdHitPair> expanded_term_id_hit_pairs,
MainIndexMerger::TranslateAndExpandLiteHits(*lite_index_, *term_id_codec_,
lexicon_outputs));
EXPECT_THAT(
expanded_term_id_hit_pairs,
UnorderedElementsAre(TermIdHitPair(foot_main_term_id, doc0_hit),
TermIdHitPair(fool_main_term_id, doc1_hit),
TermIdHitPair(foo_term_id, doc1_prefix_hit)));
}
TEST_F(MainIndexMergerTest, DedupePrefixAndExactWithDifferentTermFrequencies) {
// 1. Index one doc in the Lite Index:
// - Doc0 {"foot" "foo" is_in_prefix_section=TRUE}
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foot_tvi,
lite_index_->InsertTerm("foot", TermMatchType::PREFIX, kNamespace0));
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foot_term_id,
term_id_codec_->EncodeTvi(foot_tvi, TviType::LITE));
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foo_tvi,
lite_index_->InsertTerm("foo", TermMatchType::PREFIX, kNamespace0));
ICING_ASSERT_OK_AND_ASSIGN(uint32_t foo_term_id,
term_id_codec_->EncodeTvi(foo_tvi, TviType::LITE));
Hit foot_doc0_hit(/*section_id=*/0, /*document_id=*/0, /*term_frequency=*/57,
/*is_in_prefix_section=*/true, /*is_prefix_hit=*/false);
ICING_ASSERT_OK(lite_index_->AddHit(foot_term_id, foot_doc0_hit));
Hit foo_doc0_hit(/*section_id=*/0, /*document_id=*/0,
Hit::kDefaultTermFrequency, /*is_in_prefix_section=*/true,
/*is_prefix_hit=*/false);
ICING_ASSERT_OK(lite_index_->AddHit(foo_term_id, foo_doc0_hit));
// 2. Build up a fake LexiconMergeOutputs
// This is some made up number that doesn't matter for this test.
uint32_t foo_main_tvi = 12;
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foo_main_term_id,
term_id_codec_->EncodeTvi(foo_main_tvi, TviType::MAIN));
// The prefix hit for 'foot' should have the same term frequency as the exact
// hit for 'foot'. The final prefix hit has term frequency equal to 58.
Hit doc0_prefix_hit(/*section_id=*/0, /*document_id=*/0,
/*term_frequency=*/58,
/*is_in_prefix_section=*/true, /*is_prefix_hit=*/true);
uint32_t foot_main_tvi = 5;
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foot_main_term_id,
term_id_codec_->EncodeTvi(foot_main_tvi, TviType::MAIN));
MainIndex::LexiconMergeOutputs lexicon_outputs;
// Map "foot" to it's prefix hit for "foo".
lexicon_outputs.other_tvi_to_prefix_main_tvis.emplace(foot_tvi,
std::make_pair(0, 1));
lexicon_outputs.prefix_tvis_buf.push_back(foo_main_tvi);
lexicon_outputs.other_tvi_to_main_tvi.emplace(foot_tvi, foot_main_tvi);
lexicon_outputs.other_tvi_to_main_tvi.emplace(foo_tvi, foo_main_tvi);
// 3. TranslateAndExpand should;
// a. Translate lite term ids to main term ids based on the map
// b. Expand 'foot' to have a hit for 'foo'
// c. Keep both the exact hit for 'foo' and the prefix hit for 'foot', the
// latter with term frequency as the sum of the term frequencies.
ICING_ASSERT_OK_AND_ASSIGN(
std::vector<TermIdHitPair> expanded_term_id_hit_pairs,
MainIndexMerger::TranslateAndExpandLiteHits(*lite_index_, *term_id_codec_,
lexicon_outputs));
EXPECT_THAT(
expanded_term_id_hit_pairs,
UnorderedElementsAre(TermIdHitPair(foot_main_term_id, foot_doc0_hit),
TermIdHitPair(foo_main_term_id, foo_doc0_hit),
TermIdHitPair(foo_main_term_id, doc0_prefix_hit)));
}
TEST_F(MainIndexMergerTest, DedupeWithExactSameTermFrequencies) {
// 1. Index one doc in the Lite Index:
// - Doc0 {"foot" "foo" is_in_prefix_section=TRUE}
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foot_tvi,
lite_index_->InsertTerm("foot", TermMatchType::PREFIX, kNamespace0));
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foot_term_id,
term_id_codec_->EncodeTvi(foot_tvi, TviType::LITE));
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foo_tvi,
lite_index_->InsertTerm("foo", TermMatchType::PREFIX, kNamespace0));
ICING_ASSERT_OK_AND_ASSIGN(uint32_t foo_term_id,
term_id_codec_->EncodeTvi(foo_tvi, TviType::LITE));
Hit foot_doc0_hit(/*section_id=*/0, /*document_id=*/0, /*term_frequency=*/57,
/*is_in_prefix_section=*/true, /*is_prefix_hit=*/false);
ICING_ASSERT_OK(lite_index_->AddHit(foot_term_id, foot_doc0_hit));
Hit foo_doc0_hit(/*section_id=*/0, /*document_id=*/0, /*term_frequency=*/57,
/*is_in_prefix_section=*/true, /*is_prefix_hit=*/false);
ICING_ASSERT_OK(lite_index_->AddHit(foo_term_id, foo_doc0_hit));
// The prefix hit should take the sum as term_frequency - 114.
Hit prefix_foo_doc0_hit(/*section_id=*/0, /*document_id=*/0,
/*term_frequency=*/114,
/*is_in_prefix_section=*/true,
/*is_prefix_hit=*/true);
// 2. Build up a fake LexiconMergeOutputs
// This is some made up number that doesn't matter for this test.
uint32_t foo_main_tvi = 12;
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foo_main_term_id,
term_id_codec_->EncodeTvi(foo_main_tvi, TviType::MAIN));
uint32_t foot_main_tvi = 5;
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foot_main_term_id,
term_id_codec_->EncodeTvi(foot_main_tvi, TviType::MAIN));
MainIndex::LexiconMergeOutputs lexicon_outputs;
// Map "foot" to it's prefix hit for "foo".
lexicon_outputs.other_tvi_to_prefix_main_tvis.emplace(foot_tvi,
std::make_pair(0, 1));
lexicon_outputs.prefix_tvis_buf.push_back(foo_main_tvi);
lexicon_outputs.other_tvi_to_main_tvi.emplace(foot_tvi, foot_main_tvi);
lexicon_outputs.other_tvi_to_main_tvi.emplace(foo_tvi, foo_main_tvi);
// 3. TranslateAndExpand should;
// a. Translate lite term ids to main term ids based on the map
// b. Expand 'foot' to have a hit for 'foo'
// c. Keep both the exact hit for 'foo' and the prefix hit for 'foot', the
// latter with term frequency as the sum of the term frequencies.
ICING_ASSERT_OK_AND_ASSIGN(
std::vector<TermIdHitPair> expanded_term_id_hit_pairs,
MainIndexMerger::TranslateAndExpandLiteHits(*lite_index_, *term_id_codec_,
lexicon_outputs));
EXPECT_THAT(expanded_term_id_hit_pairs,
UnorderedElementsAre(
TermIdHitPair(foot_main_term_id, foot_doc0_hit),
TermIdHitPair(foo_main_term_id, foo_doc0_hit),
TermIdHitPair(foo_main_term_id, prefix_foo_doc0_hit)));
}
TEST_F(MainIndexMergerTest, DedupePrefixExpansion) {
// 1. Index one doc in the Lite Index:
// - Doc0 {"foot" "fool" is_in_prefix_section=TRUE}
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foot_tvi,
lite_index_->InsertTerm("foot", TermMatchType::PREFIX, kNamespace0));
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foot_term_id,
term_id_codec_->EncodeTvi(foot_tvi, TviType::LITE));
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t fool_tvi,
lite_index_->InsertTerm("fool", TermMatchType::PREFIX, kNamespace0));
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t fool_term_id,
term_id_codec_->EncodeTvi(fool_tvi, TviType::LITE));
Hit foot_doc0_hit(/*section_id=*/0, /*document_id=*/0,
/*term_frequency=*/Hit::kMaxTermFrequency,
/*is_in_prefix_section=*/true, /*is_prefix_hit=*/false);
ICING_ASSERT_OK(lite_index_->AddHit(foot_term_id, foot_doc0_hit));
Hit fool_doc0_hit(/*section_id=*/0, /*document_id=*/0,
Hit::kDefaultTermFrequency,
/*is_in_prefix_section=*/true, /*is_prefix_hit=*/false);
ICING_ASSERT_OK(lite_index_->AddHit(fool_term_id, fool_doc0_hit));
// 2. Build up a fake LexiconMergeOutputs
// This is some made up number that doesn't matter for this test.
uint32_t foo_main_tvi = 12;
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foo_term_id,
term_id_codec_->EncodeTvi(foo_main_tvi, TviType::MAIN));
// The prefix hit should take the sum as term frequency - 256, capped at
// kMaxTermFrequency.
Hit doc0_prefix_hit(/*section_id=*/0, /*document_id=*/0,
/*term_frequency=*/Hit::kMaxTermFrequency,
/*is_in_prefix_section=*/true, /*is_prefix_hit=*/true);
uint32_t foot_main_tvi = 5;
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t foot_main_term_id,
term_id_codec_->EncodeTvi(foot_main_tvi, TviType::MAIN));
uint32_t fool_main_tvi = 10;
ICING_ASSERT_OK_AND_ASSIGN(
uint32_t fool_main_term_id,
term_id_codec_->EncodeTvi(fool_main_tvi, TviType::MAIN));
MainIndex::LexiconMergeOutputs lexicon_outputs;
// Map "fool" to it's prefix hit for "foo" and "foot" to it's prefix hit for
// "foo".
lexicon_outputs.other_tvi_to_prefix_main_tvis.emplace(fool_tvi,
std::make_pair(0, 1));
lexicon_outputs.prefix_tvis_buf.push_back(foo_main_tvi);
lexicon_outputs.other_tvi_to_prefix_main_tvis.emplace(foot_tvi,
std::make_pair(1, 1));
lexicon_outputs.prefix_tvis_buf.push_back(foo_main_tvi);
lexicon_outputs.other_tvi_to_main_tvi.emplace(foot_tvi, foot_main_tvi);
lexicon_outputs.other_tvi_to_main_tvi.emplace(fool_tvi, fool_main_tvi);
// 3. TranslateAndExpand should;
// a. Translate lite term ids to main term ids based on the map
// b. Expand 'foot' and 'fool' to have hits for 'foo'
// c. Merge the prefix hits from 'foot' and 'fool', taking the sum as
// term frequency.
ICING_ASSERT_OK_AND_ASSIGN(
std::vector<TermIdHitPair> expanded_term_id_hit_pairs,
MainIndexMerger::TranslateAndExpandLiteHits(*lite_index_, *term_id_codec_,
lexicon_outputs));
EXPECT_THAT(
expanded_term_id_hit_pairs,
UnorderedElementsAre(TermIdHitPair(foot_main_term_id, foot_doc0_hit),
TermIdHitPair(fool_main_term_id, fool_doc0_hit),
TermIdHitPair(foo_term_id, doc0_prefix_hit)));
}
} // namespace
} // namespace lib
} // namespace icing
|
