Merge #597

597: Use task model for all settings helpers r=ellnix a=ellnix

Noticed that I messed up creating the new settings helpers, should have used `Model::Task` all along.

Co-authored-by: ellnix <[email protected]>

Author: meili-bors[bot]

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-01-10 14:26:27 UTC using RuboCop version 1.69.2.
+# on 2025-01-15 12:21:42 UTC using RuboCop version 1.69.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -10,12 +10,12 @@
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 702
+  Max: 693
 
 # Offense count: 4
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 480
+  Max: 492
 
 # Offense count: 1
 # Configuration parameters: Max, CountKeywordArgs.

lib/meilisearch/index.rb

@@ -609,11 +609,15 @@ def proximity_precision
     end
 
     def update_proximity_precision(proximity_precision_attribute)
-      http_put("/indexes/#{@uid}/settings/proximity-precision", proximity_precision_attribute)
+      response = http_put("/indexes/#{@uid}/settings/proximity-precision", proximity_precision_attribute)
+
+      Models::Task.new(response, task_endpoint)
     end
 
     def reset_proximity_precision
-      http_delete("/indexes/#{@uid}/settings/proximity-precision")
+      response = http_delete("/indexes/#{@uid}/settings/proximity-precision")
+
+      Models::Task.new(response, task_endpoint)
     end
 
     ### SETTINGS - SEARCH CUTOFF MS
@@ -623,11 +627,15 @@ def search_cutoff_ms
     end
 
     def update_search_cutoff_ms(search_cutoff_ms_attribute)
-      http_put("/indexes/#{@uid}/settings/search-cutoff-ms", search_cutoff_ms_attribute)
+      response = http_put("/indexes/#{@uid}/settings/search-cutoff-ms", search_cutoff_ms_attribute)
+
+      Models::Task.new(response, task_endpoint)
     end
 
     def reset_search_cutoff_ms
-      http_delete("/indexes/#{@uid}/settings/search-cutoff-ms")
+      response = http_delete("/indexes/#{@uid}/settings/search-cutoff-ms")
+
+      Models::Task.new(response, task_endpoint)
     end
 
     ### SETTINGS - LOCALIZED ATTRIBUTES
@@ -639,11 +647,15 @@ def localized_attributes
     def update_localized_attributes(new_localized_attributes)
       new_localized_attributes = Utils.transform_attributes(new_localized_attributes)
 
-      http_put("/indexes/#{@uid}/settings/localized-attributes", new_localized_attributes)
+      response = http_put("/indexes/#{@uid}/settings/localized-attributes", new_localized_attributes)
+
+      Models::Task.new(response, task_endpoint)
     end
 
     def reset_localized_attributes
-      http_delete("/indexes/#{@uid}/settings/localized-attributes")
+      response = http_delete("/indexes/#{@uid}/settings/localized-attributes")
+
+      Models::Task.new(response, task_endpoint)
     end
 
     ### SETTINGS - FACET SEARCH
@@ -653,11 +665,15 @@ def facet_search_setting
     end
 
     def update_facet_search_setting(new_facet_search_setting)
-      http_put("/indexes/#{@uid}/settings/facet-search", new_facet_search_setting)
+      response = http_put("/indexes/#{@uid}/settings/facet-search", new_facet_search_setting)
+
+      Models::Task.new(response, task_endpoint)
     end
 
     def reset_facet_search_setting
-      http_delete("/indexes/#{@uid}/settings/facet-search")
+      response = http_delete("/indexes/#{@uid}/settings/facet-search")
+
+      Models::Task.new(response, task_endpoint)
     end
 
     ### SETTINGS - PREFIX SEARCH
@@ -667,11 +683,15 @@ def prefix_search
     end
 
     def update_prefix_search(new_prefix_search_setting)
-      http_put("/indexes/#{@uid}/settings/prefix-search", new_prefix_search_setting)
+      response = http_put("/indexes/#{@uid}/settings/prefix-search", new_prefix_search_setting)
+
+      Models::Task.new(response, task_endpoint)
     end
 
     def reset_prefix_search
-      http_delete("/indexes/#{@uid}/settings/prefix-search")
+      response = http_delete("/indexes/#{@uid}/settings/prefix-search")
+
+      Models::Task.new(response, task_endpoint)
     end
 
     ### SETTINGS - EMBEDDERS
@@ -683,11 +703,15 @@ def embedders
     def update_embedders(new_embedders)
       new_embedders = Utils.transform_attributes(new_embedders)
 
-      http_patch("/indexes/#{@uid}/settings/embedders", new_embedders)
+      response = http_patch("/indexes/#{@uid}/settings/embedders", new_embedders)
+
+      Models::Task.new(response, task_endpoint)
     end
 
     def reset_embedders
-      http_delete("/indexes/#{@uid}/settings/embedders")
+      response = http_delete("/indexes/#{@uid}/settings/embedders")
+
+      Models::Task.new(response, task_endpoint)
     end
   end
 end

spec/meilisearch/index/settings_spec.rb

@@ -728,19 +728,15 @@
       end
 
       it 'updates proximity precision' do
-        update_task = index.update_proximity_precision('byAttribute')
-        client.wait_for_task(update_task['taskUid'])
-
+        index.update_proximity_precision('byAttribute').await
         expect(index.proximity_precision).to eq('byAttribute')
       end
 
       it 'resets proximity precision' do
-        update_task = index.update_proximity_precision('byAttribute')
-        client.wait_for_task(update_task['taskUid'])
-
-        reset_task = index.reset_proximity_precision
-        client.wait_for_task(reset_task['taskUid'])
+        index.update_proximity_precision('byAttribute').await
+        expect(index.proximity_precision).to eq('byAttribute')
 
+        index.reset_proximity_precision.await
         expect(index.proximity_precision).to eq('byWord')
       end
     end
@@ -757,21 +753,15 @@
     end
 
     it '#update_search_cutoff_ms updates default value' do
-      update_task = index.update_search_cutoff_ms(800)
-      client.wait_for_task(update_task['taskUid'])
-
+      index.update_search_cutoff_ms(800).await
       expect(index.search_cutoff_ms).to eq(800)
     end
 
     it '#reset_search_cutoff_ms resets search cutoff ms' do
-      update_task = index.update_search_cutoff_ms(300)
-      client.wait_for_task(update_task['taskUid'])
-
+      index.update_search_cutoff_ms(300).await
       expect(index.search_cutoff_ms).to eq(300)
 
-      reset_task = index.reset_search_cutoff_ms
-      client.wait_for_task(reset_task['taskUid'])
-
+      index.reset_search_cutoff_ms.await
       expect(index.search_cutoff_ms).to eq(default_search_cutoff_ms)
     end
   end
@@ -787,21 +777,25 @@
     end
 
     it '#update_localized_attributes updates default value' do
-      update_task = index.update_localized_attributes([{ attribute_patterns: ['title'], locales: ['eng'] }])
-      client.wait_for_task(update_task['taskUid'])
+      index.update_localized_attributes(
+        [{ attribute_patterns: ['title'], locales: ['eng'] }]
+      ).await
 
-      expect(index.localized_attributes).to eq([{ 'attributePatterns' => ['title'], 'locales' => ['eng'] }])
+      expect(index.localized_attributes).to eq(
+        [{ 'attributePatterns' => ['title'], 'locales' => ['eng'] }]
+      )
     end
 
     it '#reset_localized_attributes resets localized attributes' do
-      update_task = index.update_localized_attributes([{ attribute_patterns: ['title'], locales: ['eng'] }])
-      client.wait_for_task(update_task['taskUid'])
-
-      expect(index.localized_attributes).to eq([{ 'attributePatterns' => ['title'], 'locales' => ['eng'] }])
+      index.update_localized_attributes(
+        [{ attribute_patterns: ['title'], locales: ['eng'] }]
+      ).await
 
-      reset_task = index.reset_localized_attributes
-      client.wait_for_task(reset_task['taskUid'])
+      expect(index.localized_attributes).to eq(
+        [{ 'attributePatterns' => ['title'], 'locales' => ['eng'] }]
+      )
 
+      index.reset_localized_attributes.await
       expect(index.localized_attributes).to eq(default_localized_attributes)
     end
   end
@@ -817,21 +811,15 @@
     end
 
     it '#update_facet_search_setting updates default value' do
-      update_task = index.update_facet_search_setting(false)
-      client.wait_for_task(update_task['taskUid'])
-
+      index.update_facet_search_setting(false).await
       expect(index.facet_search_setting).to eq(false)
     end
 
     it '#reset_facet_search_setting resets facet search' do
-      update_task = index.update_facet_search_setting(false)
-      client.wait_for_task(update_task['taskUid'])
-
+      index.update_facet_search_setting(false).await
       expect(index.facet_search_setting).to eq(false)
 
-      reset_task = index.reset_facet_search_setting
-      client.wait_for_task(reset_task['taskUid'])
-
+      index.reset_facet_search_setting.await
       expect(index.facet_search_setting).to eq(default_facet_search_setting)
     end
   end
@@ -847,21 +835,15 @@
     end
 
     it '#update_prefix_search updates default value' do
-      update_task = index.update_prefix_search('disabled')
-      client.wait_for_task(update_task['taskUid'])
-
+      index.update_prefix_search('disabled').await
       expect(index.prefix_search).to eq('disabled')
     end
 
     it '#reset_prefix_search resets prefix search' do
-      update_task = index.update_prefix_search('disabled')
-      client.wait_for_task(update_task['taskUid'])
-
+      index.update_prefix_search('disabled').await
       expect(index.prefix_search).to eq('disabled')
 
-      reset_task = index.reset_prefix_search
-      client.wait_for_task(reset_task['taskUid'])
-
+      index.reset_prefix_search.await
       expect(index.prefix_search).to eq(default_prefix_search)
     end
   end
@@ -878,31 +860,27 @@
     end
 
     it '#update_embedders updates default value' do
-      update_task = index.update_embedders(
+      index.update_embedders(
         custom: {
           source: 'userProvided',
           dimensions: 3
         }
-      )
-      client.wait_for_task(update_task['taskUid'])
+      ).await
 
       expect(index.embedders).to have_key('custom')
     end
 
     it '#reset_embedders resets embedders to nil' do
-      update_task = index.update_embedders(
+      index.update_embedders(
         custom: {
           source: 'userProvided',
           dimensions: 3
         }
-      )
-      client.wait_for_task(update_task['taskUid'])
+      ).await
 
       expect(index.embedders).to have_key('custom')
 
-      reset_task = index.reset_embedders
-      client.wait_for_task(reset_task['taskUid'])
-
+      index.reset_embedders.await
       expect(index.embedders).to eq(default_embedders)
     end
   end