def _check_cache_results(self, indexpath, cachepath, cacheid, expected_results, num_results=10):
# set cache manager
cm = XapianCacheManager(cachepath, id=cacheid)
search_conn = SearchConnection(indexpath)
search_conn.set_cache_manager(cm)
query_id, query_term = (1, "term_a")
cache_query_id = cm.get_queryid(query_term) # obtain query_id from the cache
self.assertEqual(query_id, cache_query_id)
non_cached, cached = expected_results
query = search_conn.query_field("field", query_term)
base_result = [r.id for r in query.search(0, num_results)]
# see if the results without merging the query are ok
self.assertEqual(non_cached, base_result)
cached_query = query.merge_with_cached(query_id)
cached_result = [r.id for r in cached_query.search(0, num_results)]
# test the merged query result
self.assertEqual(cached, cached_result)
search_conn.close()
cm.close()
def _create_cache(self, cache_path, cache_id):
# create a cache
cm = XapianCacheManager(cache_path, id=cache_id)
cache_sample = CACHE_SAMPLES[cache_id]
for querydata in cache_sample:
cm.set_queryid(querydata["queryrepr"], querydata["queryid"])
cm.set_hits(querydata["queryid"], querydata["docids"])
cm.flush()
cm.close()
def test_multiple_cache(self):
with tempdir() as basepath:
# create an index
indexpath = os.path.join(basepath, "test_index")
self._create_index(indexpath)
base_cachepath = os.path.join(basepath, "cache")
os.makedirs(base_cachepath)
# create and apply cache 1
cachepath1 = os.path.join(base_cachepath, "1")
self._create_and_apply_cache(indexpath, cachepath1, "1")
# create and apply cache 2
cachepath2 = os.path.join(base_cachepath, "2")
self._create_and_apply_cache(indexpath, cachepath2, "cache2")
# test cache 1
self._check_cache_results(
indexpath, cachepath1, "1", [["5", "4", "3", "2", "1"], ["4", "2", "5", "3", "1"]]
)
# test cache 2
self._check_cache_results(
indexpath, cachepath2, "cache2", [["5", "4", "3", "2", "1"], ["3", "4", "1", "5", "2"]]
)
# the document whose docid is 4 is in both caches, we're
# testing here if replacing it with one cache manager set
# will change the result in the other cache. It must change.
# replace document
iconn = IndexerConnection(indexpath)
cm = XapianCacheManager(cachepath2, id="cache2")
iconn.set_cache_manager(cm)
docid, terms = ("4", [("term_a", 4), ("term_b", 2)])
pdoc = self._create_processed_doc(iconn, docid, terms)
iconn.replace(pdoc, xapid=int(docid))
iconn.flush()
iconn.close()
cm.close()
# check if the results in both caches are ok
self._check_cache_results(
indexpath, cachepath1, "1", [["5", "4", "3", "2", "1"], ["4", "2", "5", "3", "1"]]
)
self._check_cache_results(
indexpath, cachepath2, "cache2", [["5", "4", "3", "2", "1"], ["3", "4", "1", "5", "2"]]
)
# there are 2 code pathes when we deal with caches:
# 1. the cache has not enough results
# 2. the cache has enough results
# in the first case, the result will come from a mixed query
# against the index. In the second, the results will come from
# the cache_manger. So, the cache managers must be updated.
# When using multiple cache_manager, the deletion must be
# explicitly done in each cache, and then we must ask for the
# delete method to ignore cache (not try to update it). A better
# approach for this will be developed.
# remove document
iconn = IndexerConnection(indexpath)
cm = XapianCacheManager(cachepath1, id="1")
iconn.set_cache_manager(cm)
iconn._remove_cached_items(xapid=4)
cm = XapianCacheManager(cachepath2, id="cache2")
iconn.set_cache_manager(cm)
iconn._remove_cached_items(xapid=4)
cm.close()
iconn.delete(xapid=4, ignore_cache=True)
iconn.flush()
iconn.close()
# cache has not enough results
self._check_cache_results(indexpath, cachepath1, "1", [["5", "3", "2", "1"], ["2", "5", "3", "1"]])
self._check_cache_results(indexpath, cachepath2, "cache2", [["5", "3", "2", "1"], ["3", "1", "5", "2"]])
# cache has enough results
self._check_cache_results(indexpath, cachepath1, "1", [["5"], ["2"]], num_results=1)
self._check_cache_results(indexpath, cachepath2, "cache2", [["5", "3"], ["3", "1"]], num_results=2)
