Fix: preventing KeyError("_highlightResult")

algoliasearch/iterators.py

@@ -35,6 +35,8 @@ def __iter__(self):
 
 
 class PaginatorIterator(Iterator):
+    nbHits = 0
+
     def __init__(self, transporter, index_name, request_options=None):
         # type: (Transporter, str, Optional[Union[dict, RequestOptions]]) -> None  # noqa: E501
 
@@ -48,16 +50,16 @@ def __init__(self, transporter, index_name, request_options=None):
 
     def __next__(self):
         # type: () -> dict
-
         if self._raw_response:
+
             if len(self._raw_response["hits"]):
                 hit = self._raw_response["hits"].pop(0)
 
                 hit.pop("_highlightResult")
 
                 return hit
 
-            if self._raw_response["nbHits"] < self._data["hitsPerPage"]:
+            if self.nbHits < self._data["hitsPerPage"]:
                 self._raw_response = {}
                 self._data = {
                     "hitsPerPage": 1000,
@@ -68,6 +70,7 @@ def __next__(self):
         self._raw_response = self._transporter.read(
             Verb.POST, self.get_endpoint(), self._data, self._request_options
         )
+        self.nbHits = len(self._raw_response["hits"])
 
         self._data["page"] += 1
 

algoliasearch/iterators_async.py

@@ -10,6 +10,8 @@
 
 
 class PaginatorIteratorAsync(Iterator):
+    nbHits = 0
+
     def __init__(self, transporter, index_name, request_options=None):
         # type: (Transporter, str, Optional[Union[dict, RequestOptions]]) -> None  # noqa: E501
 
@@ -38,7 +40,7 @@ def __anext__(self):  # type: ignore
 
                 return hit
 
-            if self._raw_response["nbHits"] < self._data["hitsPerPage"]:
+            if self.nbHits < self._data["hitsPerPage"]:
                 self._raw_response = {}
                 self._data = {
                     "hitsPerPage": 1000,
@@ -49,6 +51,7 @@ def __anext__(self):  # type: ignore
         self._raw_response = yield from self._transporter.read(
             Verb.POST, self.get_endpoint(), self._data, self._request_options
         )
+        self.nbHits = len(self._raw_response["hits"])
 
         self._data["page"] += 1
 

tests/features/test_search_index.py

@@ -1,12 +1,18 @@
 # -*- coding: utf-8 -*-
 import sys
 import unittest
+import json
+import requests
+
+from requests.models import Response
 
 from algoliasearch.exceptions import RequestException, ObjectNotFoundException
 from algoliasearch.responses import MultipleResponse
+from algoliasearch.search_client import SearchClient
 from algoliasearch.search_index import SearchIndex
 from tests.helpers.factory import Factory as F
 from tests.helpers.misc import Unicode, rule_without_metadata
+from unittest.mock import MagicMock
 
 
 class TestSearchIndex(unittest.TestCase):
@@ -450,6 +456,41 @@ def test_synonyms(self):
         # and check that the number of returned synonyms is equal to 0
         self.assertEqual(self.index.search_synonyms("")["nbHits"], 0)
 
+    def test_browse_rules(self):
+        def side_effect(req, **kwargs):
+            hits = [{"objectID": i, "_highlightResult": None} for i in range(0, 1000)]
+            page = json.loads(req.body)["page"]
+
+            if page == 3:
+                hits = hits[0:800]
+
+            response = Response()
+            response.status_code = 200
+            response._content = str.encode(
+                json.dumps(
+                    {
+                        "hits": hits,
+                        "nbHits": 3800,
+                        "page": page,
+                        "nbPages": 3,
+                    }
+                )
+            )
+
+            return response
+
+        client = SearchClient.create("foo", "bar")
+        client._transporter._requester._session = requests.Session()
+        client._transporter._requester._session.send = MagicMock(name="send")
+        client._transporter._requester._session.send.side_effect = side_effect
+        index = F.index(client, "test")
+
+        rules = index.browse_rules()
+
+        len_rules = len(list(rules))
+
+        self.assertEqual(len_rules, 3800)
+
     def test_rules(self):
         responses = MultipleResponse()