fix(clients): update browse iterator (#4058) (generated) [skip ci]

Co-authored-by: Thomas Raffray <[email protected]>

Author: algolia-bot

clients/algoliasearch-client-go/algolia/search/api_search.go

@@ -6126,6 +6126,10 @@ public GetApiKeyResponse waitForApiKey(String key, ApiKeyOperation operation) {
   public <T> Iterable<T> browseObjects(String indexName, BrowseParamsObject params, Class<T> innerType, RequestOptions requestOptions) {
     final Holder<String> currentCursor = new Holder<>();
 
+    if (params.getHitsPerPage() == null) {
+      params.setHitsPerPage(1000);
+    }
+
     return AlgoliaIterableHelper.createIterable(
       () -> {
         BrowseResponse<T> response = this.browse(indexName, params, innerType, requestOptions);
@@ -6175,7 +6179,7 @@ public Iterable<SynonymHit> browseSynonyms(String indexName, SearchSynonymsParam
     return AlgoliaIterableHelper.createIterable(
       () -> {
         SearchSynonymsResponse response = this.searchSynonyms(indexName, params, requestOptions);
-        currentPage.value = response.getNbHits() < params.getHitsPerPage() ? null : currentPage.value + 1;
+        currentPage.value = response.getHits().size() < params.getHitsPerPage() ? null : currentPage.value + 1;
         return response.getHits().iterator();
       },
       () -> currentPage.value != null
@@ -6217,7 +6221,7 @@ public Iterable<Rule> browseRules(String indexName, SearchRulesParams params, Re
     return AlgoliaIterableHelper.createIterable(
       () -> {
         SearchRulesResponse response = this.searchRules(indexName, params.setPage(currentPage.value), requestOptions);
-        currentPage.value = response.getNbHits() < hitsPerPage ? null : currentPage.value + 1;
+        currentPage.value = response.getHits().size() < hitsPerPage ? null : currentPage.value + 1;
         return response.getHits().iterator();
       },
       () -> currentPage.value != null

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/SearchClient.java

@@ -412,6 +412,7 @@ export function createSearchClient({
               indexName,
               browseParams: {
                 cursor: previousResponse ? previousResponse.cursor : undefined,
+                hitsPerPage: 1000,
                 ...browseParams,
               },
             },
@@ -456,7 +457,7 @@ export function createSearchClient({
             requestOptions,
           );
         },
-        validate: (response) => response.nbHits < params.hitsPerPage,
+        validate: (response) => response.hits.length < params.hitsPerPage,
         ...browseRulesOptions,
       });
     },
@@ -501,7 +502,7 @@ export function createSearchClient({
           params.page += 1;
           return resp;
         },
-        validate: (response) => response.nbHits < params.hitsPerPage,
+        validate: (response) => response.hits.length < params.hitsPerPage,
         ...browseSynonymsOptions,
       });
     },

clients/algoliasearch-client-javascript/packages/client-search/src/searchClient.ts

@@ -351,6 +351,7 @@ async def browse_objects(
         """
         Helper: Iterate on the `browse` method of the client to allow aggregating objects of an index.
         """
+        browse_params.hits_per_page = browse_params.hits_per_page or 1000
 
         async def _func(_prev: Optional[BrowseResponse]) -> BrowseResponse:
             if _prev is not None and _prev.cursor is not None:
@@ -392,7 +393,7 @@ async def _func(_prev: Optional[SearchRulesResponse]) -> SearchRulesResponse:
 
         return await create_iterable(
             func=_func,
-            validate=lambda _resp: _resp.nb_hits < hits_per_page,
+            validate=lambda _resp: len(_resp.hits) < hits_per_page,
             aggregator=aggregator,
         )
 
@@ -427,7 +428,7 @@ async def _func(
 
         return await create_iterable(
             func=_func,
-            validate=lambda _resp: _resp.nb_hits < hits_per_page,
+            validate=lambda _resp: len(_resp.hits) < hits_per_page,
             aggregator=aggregator,
         )
 
@@ -5362,6 +5363,7 @@ def browse_objects(
         """
         Helper: Iterate on the `browse` method of the client to allow aggregating objects of an index.
         """
+        browse_params.hits_per_page = browse_params.hits_per_page or 1000
 
         def _func(_prev: Optional[BrowseResponse]) -> BrowseResponse:
             if _prev is not None and _prev.cursor is not None:
@@ -5403,7 +5405,7 @@ def _func(_prev: Optional[SearchRulesResponse]) -> SearchRulesResponse:
 
         return create_iterable_sync(
             func=_func,
-            validate=lambda _resp: _resp.nb_hits < hits_per_page,
+            validate=lambda _resp: len(_resp.hits) < hits_per_page,
             aggregator=aggregator,
         )
 
@@ -5436,7 +5438,7 @@ def _func(_prev: Optional[SearchSynonymsResponse]) -> SearchSynonymsResponse:
 
         return create_iterable_sync(
             func=_func,
-            validate=lambda _resp: _resp.nb_hits < hits_per_page,
+            validate=lambda _resp: len(_resp.hits) < hits_per_page,
             aggregator=aggregator,
         )
 

clients/algoliasearch-client-python/algoliasearch/search/client.py

@@ -3201,6 +3201,8 @@ def wait_for_api_key(
     # @param request_options [Hash] the requestOptions to send along with the query, they will be forwarded to the `browse` method.
     # @param block [Proc] the block to execute on each object of the index.
     def browse_objects(index_name, browse_params = Search::BrowseParamsObject.new, request_options = {}, &block)
+      browse_params[:hits_per_page] = browse_params[:hits_per_page] || 1000
+
       hits = []
       loop do
         res = browse(index_name, browse_params, request_options)
@@ -3243,7 +3245,7 @@ def browse_rules(
         end
 
         search_rules_params.page += 1
-        break if res.nb_hits < search_rules_params.hits_per_page
+        break if res.hits.length < search_rules_params.hits_per_page
       end
 
       rules unless block_given?
@@ -3273,7 +3275,7 @@ def browse_synonyms(
         end
 
         search_synonyms_params.page += 1
-        break if res.nb_hits < search_synonyms_params.hits_per_page
+        break if res.hits.length < search_synonyms_params.hits_per_page
       end
 
       synonyms unless block_given?

clients/algoliasearch-client-ruby/lib/algolia/api/search_client.rb

@@ -245,7 +245,7 @@ public extension SearchClient {
     ) async throws -> BrowseResponse<T> {
         var updatedBrowseParams = browseParams
         if updatedBrowseParams.hitsPerPage == nil {
-          updatedBrowseParams.hitsPerPage = 1000
+            updatedBrowseParams.hitsPerPage = 1000
         }
 
         return try await createIterable(
@@ -302,7 +302,7 @@ public extension SearchClient {
                 )
             },
             validate: validate ?? { response in
-              response.hits.count < hitsPerPage
+                response.hits.count < hitsPerPage
             },
             aggregator: aggregator
         )
@@ -345,7 +345,7 @@ public extension SearchClient {
                 )
             },
             validate: validate ?? { response in
-              response.hits.count < hitsPerPage
+                response.hits.count < hitsPerPage
             },
             aggregator: aggregator
         )