Changes related to the new task API (#276)

* First verison of the new task API

* Create task.rb

* Fix linter error

* Add tests for client.wait_for_task

* Fix linter errors

Author: curquiza

.code-samples.meilisearch.yaml

@@ -44,9 +44,9 @@ delete_documents_1: |-
 search_post_1: |-
   client.index('movies').search('american ninja')
 get_update_1: |-
-  client.index('movies').get_update_status(1)
+  client.index('movies').task(1)
 get_all_updates_1: |-
-  client.index('movies').get_all_update_status
+  client.index('movies').tasks
 get_keys_1: |-
   client.keys
 get_settings_1: |-

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-11-21 21:31:55 UTC using RuboCop version 1.23.0.
+# on 2021-12-13 22:26:31 UTC using RuboCop version 1.23.0.
 # 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
@@ -20,23 +20,23 @@ Layout/HeredocIndentation:
   Exclude:
     - 'spec/meilisearch/index/documents_spec.rb'
 
-# Offense count: 32
+# Offense count: 33
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 # IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 512
+  Max: 557
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 289
+  Max: 278
 
 # Offense count: 1
 # Configuration parameters: Max, CountKeywordArgs.
 Metrics/ParameterLists:
   MaxOptionalParameters: 4
 
-# Offense count: 2
+# Offense count: 1
 Naming/AccessorMethodName:
   Exclude:
     - 'lib/meilisearch/index.rb'

README.md

@@ -92,10 +92,10 @@ documents = [
   { id: 6, title: 'Philadelphia', genres: ['Drama'] },
 ]
 # If the index 'movies' does not exist, MeiliSearch creates it when you first add the documents.
-index.add_documents(documents) # => { "updateId": 0 }
+index.add_documents(documents) # => { "uid": 0 }
 ```
 
-With the `updateId`, you can check the status (`enqueued`, `processing`, `processed` or `failed`) of your documents addition using the [update endpoint](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status).
+With the `uid`, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [update endpoint](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status).
 
 💡 To customize the `Client`, for example, increasing the default timeout, please check out [this section](https://github.com/meilisearch/meilisearch-ruby/wiki/Client-Options) of the Wiki.
 

lib/meilisearch.rb

@@ -2,6 +2,7 @@
 
 require 'meilisearch/version'
 require 'meilisearch/utils'
+require 'meilisearch/task'
 require 'meilisearch/client'
 require 'meilisearch/index'
 

lib/meilisearch/client.rb

@@ -22,35 +22,41 @@ def indexes
     def create_index(index_uid, options = {})
       body = Utils.transform_attributes(options.merge(uid: index_uid))
 
-      index_hash = http_post '/indexes', body
-      index_object(index_hash['uid'], index_hash['primaryKey'])
+      http_post '/indexes', body
     end
 
-    def get_or_create_index(index_uid, options = {})
-      begin
-        index_instance = fetch_index(index_uid)
-      rescue ApiError => e
-        raise e unless e.code == 'index_not_found'
-
-        index_instance = create_index(index_uid, options)
-      end
-      index_instance
+    # Synchronous version of create_index.
+    # Waits for the task to be achieved, be careful when using it.
+    def create_index!(index_uid, options = {})
+      task = create_index(index_uid, options)
+      wait_for_task(task['uid'])
     end
 
+    # def get_or_create_index(index_uid, options = {})
+    #   begin
+    #     index_instance = fetch_index(index_uid)
+    #   rescue ApiError => e
+    #     raise e unless e.code == 'index_not_found'
+
+    #     index_instance = create_index(index_uid, options)
+    #   end
+    #   index_instance
+    # end
+
     def delete_index(index_uid)
       index_object(index_uid).delete
     end
 
-    # Usage:
-    # client.delete_index_if_exists('indexUID')
-    def delete_index_if_exists(index_uid)
-      index_object(index_uid).delete
-      true
-    rescue ApiError => e
-      raise e if e.code != 'index_not_found'
+    # # Usage:
+    # # client.delete_index_if_exists('indexUID')
+    # def delete_index_if_exists(index_uid)
+    #   index_object(index_uid).delete
+    #   true
+    # rescue ApiError => e
+    #   raise e if e.code != 'index_not_found'
 
-      false
-    end
+    #   false
+    # end
 
     # Usage:
     # client.index('indexUID')
@@ -107,10 +113,28 @@ def dump_status(dump_uid)
     end
     alias get_dump_status dump_status
 
+    ### TASKS
+
+    def tasks
+      task_endpoint.global_tasks
+    end
+
+    def task(task_uid)
+      task_endpoint.global_task(task_uid)
+    end
+
+    def wait_for_task(task_uid, timeout_in_ms = 5000, interval_in_ms = 50)
+      task_endpoint.wait_for_task(task_uid, timeout_in_ms, interval_in_ms)
+    end
+
     private
 
     def index_object(uid, primary_key = nil)
       Index.new(uid, @base_url, @api_key, primary_key, @options)
     end
+
+    def task_endpoint
+      Task.new(@base_url, @api_key, @options)
+    end
   end
 end

lib/meilisearch/index.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 require 'meilisearch/http_request'
-require 'timeout'
 
 module MeiliSearch
   class Index < HTTPRequest
     attr_reader :uid, :primary_key, :created_at, :updated_at
 
     def initialize(index_uid, url, api_key = nil, primary_key = nil, options = {})
+      @url = url
       @uid = index_uid
       @primary_key = primary_key
       super(url, api_key, options)
@@ -31,10 +31,7 @@ def fetch_raw_info
     end
 
     def update(body)
-      index_hash = http_put indexes_path(id: @uid), Utils.transform_attributes(body)
-      set_base_properties index_hash
-
-      self
+      http_put indexes_path(id: @uid), Utils.transform_attributes(body)
     end
 
     alias update_index update
@@ -78,8 +75,8 @@ def add_documents(documents, primary_key = nil)
     alias add_or_replace_documents add_documents
 
     def add_documents!(documents, primary_key = nil)
-      update = add_documents(documents, primary_key)
-      wait_for_pending_update(update['updateId'])
+      task = add_documents(documents, primary_key)
+      wait_for_task(task['uid'])
     end
     alias replace_documents! add_documents!
     alias add_or_replace_documents! add_documents!
@@ -112,41 +109,41 @@ def update_documents(documents, primary_key = nil)
     alias add_or_update_documents update_documents
 
     def update_documents!(documents, primary_key = nil)
-      update = update_documents(documents, primary_key)
-      wait_for_pending_update(update['updateId'])
+      task = update_documents(documents, primary_key)
+      wait_for_task(task['uid'])
     end
     alias add_or_update_documents! update_documents!
 
     def add_documents_in_batches(documents, batch_size = 1000, primary_key = nil)
-      update_ids = []
+      tasks = []
       documents.each_slice(batch_size) do |batch|
-        update_ids.append(add_documents(batch, primary_key))
+        tasks.append(add_documents(batch, primary_key))
       end
-      update_ids
+      tasks
     end
 
     def add_documents_in_batches!(documents, batch_size = 1000, primary_key = nil)
-      update_ids = add_documents_in_batches(documents, batch_size, primary_key)
+      tasks = add_documents_in_batches(documents, batch_size, primary_key)
       responses = []
-      update_ids.each do |update_object|
-        responses.append(wait_for_pending_update(update_object['updateId']))
+      tasks.each do |task_obj|
+        responses.append(wait_for_task(task_obj['uid']))
       end
       responses
     end
 
     def update_documents_in_batches(documents, batch_size = 1000, primary_key = nil)
-      update_ids = []
+      tasks = []
       documents.each_slice(batch_size) do |batch|
-        update_ids.append(update_documents(batch, primary_key))
+        tasks.append(update_documents(batch, primary_key))
       end
-      update_ids
+      tasks
     end
 
     def update_documents_in_batches!(documents, batch_size = 1000, primary_key = nil)
-      update_ids = update_documents_in_batches(documents, batch_size, primary_key)
+      tasks = update_documents_in_batches(documents, batch_size, primary_key)
       responses = []
-      update_ids.each do |update_object|
-        responses.append(wait_for_pending_update(update_object['updateId']))
+      tasks.each do |task_obj|
+        responses.append(wait_for_task(task_obj['uid']))
       end
       responses
     end
@@ -161,8 +158,8 @@ def delete_documents(documents_ids)
     alias delete_multiple_documents delete_documents
 
     def delete_documents!(documents_ids)
-      update = delete_documents(documents_ids)
-      wait_for_pending_update(update['updateId'])
+      task = delete_documents(documents_ids)
+      wait_for_task(task['uid'])
     end
     alias delete_multiple_documents! delete_documents!
 
@@ -173,8 +170,8 @@ def delete_document(document_id)
     alias delete_one_document delete_document
 
     def delete_document!(document_id)
-      update = delete_document(document_id)
-      wait_for_pending_update(update['updateId'])
+      task = delete_document(document_id)
+      wait_for_task(task['uid'])
     end
     alias delete_one_document! delete_document!
 
@@ -183,8 +180,8 @@ def delete_all_documents
     end
 
     def delete_all_documents!
-      update = delete_all_documents
-      wait_for_pending_update(update['updateId'])
+      task = delete_all_documents
+      wait_for_task(task['uid'])
     end
 
     ### SEARCH
@@ -195,31 +192,23 @@ def search(query, options = {})
       http_post "/indexes/#{@uid}/search", parsed_options
     end
 
-    ### UPDATES
+    ### TASKS
 
-    def get_update_status(update_id)
-      http_get "/indexes/#{@uid}/updates/#{update_id}"
+    def task_endpoint
+      Task.new(@url, @api_key, @options)
     end
+    private :task_endpoint
 
-    def get_all_update_status
-      http_get "/indexes/#{@uid}/updates"
+    def task(task_uid)
+      task_endpoint.index_task(@uid, task_uid)
     end
 
-    def achieved_upate?(update)
-      update['status'] != 'enqueued' && update['status'] != 'processing'
+    def tasks
+      task_endpoint.index_tasks(@uid)
     end
 
-    def wait_for_pending_update(update_id, timeout_in_ms = 5000, interval_in_ms = 50)
-      Timeout.timeout(timeout_in_ms.to_f / 1000) do
-        loop do
-          get_update = get_update_status(update_id)
-          return get_update if achieved_upate?(get_update)
-
-          sleep interval_in_ms.to_f / 1000
-        end
-      end
-    rescue Timeout::Error
-      raise MeiliSearch::TimeoutError
+    def wait_for_task(task_uid, timeout_in_ms = 5000, interval_in_ms = 50)
+      task_endpoint.wait_for_task(task_uid, timeout_in_ms, interval_in_ms)
     end
 
     ### STATS
@@ -236,10 +225,6 @@ def indexing?
       stats['isIndexing']
     end
 
-    def last_update
-      stats['lastUpdate']
-    end
-
     def field_distribution
       stats['fieldDistribution']
     end

lib/meilisearch/task.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'meilisearch/http_request'
+require 'timeout'
+
+module MeiliSearch
+  class Task < HTTPRequest
+    def global_tasks
+      http_get '/tasks/'
+    end
+
+    def global_task(task_uid)
+      http_get "/tasks/#{task_uid}"
+    end
+
+    def index_tasks(index_uid)
+      http_get "/indexes/#{index_uid}/tasks"
+    end
+
+    def index_task(index_uid, task_uid)
+      http_get "/indexes/#{index_uid}/tasks/#{task_uid}"
+    end
+
+    def wait_for_task(task_uid, timeout_in_ms = 5000, interval_in_ms = 50)
+      Timeout.timeout(timeout_in_ms.to_f / 1000) do
+        loop do
+          task = global_task(task_uid)
+          return task if achieved_task?(task)
+
+          sleep interval_in_ms.to_f / 1000
+        end
+      end
+    rescue Timeout::Error
+      raise MeiliSearch::TimeoutError
+    end
+
+    private
+
+    def achieved_task?(task)
+      task['status'] != 'enqueued' && task['status'] != 'processing'
+    end
+  end
+end