[JAY-749] Add the #all method to Elasticsearch::Tasks

sergio-bobillier · sergio-bobillier · commit 222c8fb8b100 · 2026-03-09T18:17:15.000+01:00
The method returns a Hash with information about the tasks running on
the Elasticsearch cluster.

The method accepts an optional argument to filter the tasks by their
action type and a boolean argument that causes Elasticsearch to add
detailed information about each task to the response when set to true.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,8 @@ Please mark backwards incompatible changes with an exclamation mark at the start
 - The `#task_by_id` method of the `Elasticsearch::Client` class.
 
 ### Added
+- The `#all` method to `JayAPI::Elasticsearch::Tasks`. The method returns the
+  status of all running tasks on the Elasticsearch cluster.
 - The `#tasks` method to `JayAPI::Elasticsearch::Client`. The method returns an
   instance of `JayAPI::Elasticsearch::Tasks`, which gives the user access to the
   status of the tasks running on the Elasticsearch cluster.
diff --git a/lib/jay_api/elasticsearch/tasks.rb b/lib/jay_api/elasticsearch/tasks.rb
@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_support'
+require 'active_support/core_ext/enumerable'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'forwardable'
 
@@ -10,7 +11,6 @@ module JayAPI
   module Elasticsearch
     # Represents Elasticsearch tasks. Returns information about the tasks
     # currently executing in the cluster.
-    # TODO: Add #all [JAY-593]
     class Tasks
       extend Forwardable
       include ::JayAPI::Elasticsearch::Mixins::RetriableRequests
@@ -25,6 +25,28 @@ def initialize(client:)
         @client = client
       end
 
+      # Gets the list of tasks running on the Elasticsearch cluster.
+      # For more information about this endpoint and the parameters please see:
+      # https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-tasks-list
+      # @param [Array<String>] actions A list of actions. Only tasks matching
+      #   these actions will be returned, if no task matches the result will be
+      #   empty.
+      # @param [Boolean] detailed Whether or not the result should include task
+      #   details or not.
+      # @return [Hash] A hash with the list of tasks running on the
+      #   Elasticsearch cluster.
+      def all(actions: nil, detailed: false)
+        retry_request do
+          # Needed because unlike many Elasticsearch methods Tasks#list doesn't
+          # call #listify over +actions+.
+          actions = actions&.then do |value|
+            value.is_a?(Array) ? value.join(',') : value
+          end
+
+          tasks_client.list({ actions:, detailed: }.compact_blank)
+        end
+      end
+
       # Retrieves info about the task with the passed +task_id+
       # For more information on how to build the query please refer to the
       # Elasticsearch DSL documentation:
@@ -38,9 +60,17 @@ def initialize(client:)
       #   query fails.
       def by_id(task_id)
         retry_request do
-          transport_client.tasks.get(task_id:, wait_for_completion: true).deep_symbolize_keys
+          tasks_client.get(task_id:, wait_for_completion: true).deep_symbolize_keys
         end
       end
+
+      private
+
+      # @return [Elasticsearch::API::Tasks::TasksClient] The client used to
+      #   access tasks-related information.
+      def tasks_client
+        @tasks_client ||= transport_client.tasks
+      end
     end
   end
 end
diff --git a/spec/jay_api/elasticsearch/tasks_spec.rb b/spec/jay_api/elasticsearch/tasks_spec.rb
@@ -3,12 +3,13 @@
 require 'jay_api/elasticsearch/tasks'
 
 RSpec.describe JayAPI::Elasticsearch::Tasks do
-  subject(:tasks) { described_class.new(client: client) }
+  subject(:tasks) { described_class.new(client:) }
 
   let(:tasks_client) do
     instance_double(
       Elasticsearch::API::Tasks::TasksClient,
-      get: transport_response
+      get: transport_response,
+      list: transport_response
     )
   end
 
@@ -29,6 +30,162 @@
     )
   end
 
+  shared_examples_for '#tasks_client' do
+    it 'gets the Transport::Client from the given Client' do
+      expect(client).to receive(:transport_client).ordered
+      expect(transport_client).to receive(:tasks).ordered
+      method_call
+    end
+  end
+
+  describe '#all' do
+    subject(:method_call) { tasks.all(**method_params) }
+
+    let(:method_params) { {} }
+
+    let(:transport_response) do
+      { 'nodes' =>
+         { 'S13zyUneSa2Brl5XRNoD7Q' =>
+            { 'name' => 'c8f5b1ae733a17bf05b35c66032e72e7',
+              'roles' => %w[data ingest master remote_cluster_client],
+              'tasks' =>
+               { 'S13zyUneSa2Brl5XRNoD7Q:170466185' =>
+                  { 'node' => 'S13zyUneSa2Brl5XRNoD7Q',
+                    'id' => 170_466_185,
+                    'type' => 'direct',
+                    'action' => 'cluster:monitor/tasks/lists[n]',
+                    'start_time_in_millis' => 1_773_072_735_568,
+                    'running_time_in_nanos' => 13_000_011,
+                    'cancellable' => false,
+                    'cancelled' => false,
+                    'parent_task_id' => 'S13zyUneSa2Brl5XRNoD7Q:170466184',
+                    'headers' => {} },
+                 'S13zyUneSa2Brl5XRNoD7Q:170466184' =>
+                  { 'node' => 'S13zyUneSa2Brl5XRNoD7Q',
+                    'id' => 170_466_184,
+                    'type' => 'transport',
+                    'action' => 'cluster:monitor/tasks/lists',
+                    'start_time_in_millis' => 1_773_072_735_557,
+                    'running_time_in_nanos' => 29_102_229,
+                    'cancellable' => false,
+                    'cancelled' => false,
+                    'headers' => {} } } },
+           '2MqUhOT_Sdi6ZJ8P04aUtg' =>
+            { 'name' => '224b01c103d31d5f520636719d930944',
+              'roles' => %w[data ingest master remote_cluster_client],
+              'tasks' =>
+               { '2MqUhOT_Sdi6ZJ8P04aUtg:80324869' =>
+                  { 'node' => '2MqUhOT_Sdi6ZJ8P04aUtg',
+                    'id' => 80_324_869,
+                    'type' => 'transport',
+                    'action' => 'cluster:monitor/tasks/lists[n]',
+                    'start_time_in_millis' => 1_773_072_735_582,
+                    'running_time_in_nanos' => 23_474_179,
+                    'cancellable' => false,
+                    'cancelled' => false,
+                    'parent_task_id' => 'S13zyUneSa2Brl5XRNoD7Q:170466184',
+                    'headers' => {} } } } } }
+    end
+
+    shared_examples_for '#all' do
+      it 'directly returns the response' do
+        expect(method_call).to be(transport_response)
+      end
+    end
+
+    shared_examples_for '#all when no parameters are given' do
+      it_behaves_like '#tasks_client'
+
+      it 'forwards the call to the Elasticsearch client, with the expected parameter' do
+        expect(tasks_client).to receive(:list).with({})
+        method_call
+      end
+
+      it_behaves_like '#all'
+    end
+
+    context 'when no parameters are given' do
+      let(:method_params) { {} }
+
+      it_behaves_like '#all when no parameters are given'
+    end
+
+    context 'when actions are provided as a single string' do
+      let(:method_params) { { actions: '*forcemerge' } }
+
+      it_behaves_like '#tasks_client'
+
+      it 'forwards the call to the Elasticsearch client, with the expected parameters' do
+        expect(tasks_client).to receive(:list).with({ actions: '*forcemerge' })
+        method_call
+      end
+
+      it_behaves_like '#all'
+    end
+
+    context 'when actions are provided as an array of strings' do
+      let(:method_params) { { actions: %w[*forcemerge *byquery] } }
+
+      it_behaves_like '#tasks_client'
+
+      it 'forwards the call to the Elasticsearch client, with the expected parameters' do
+        expect(tasks_client).to receive(:list).with({ actions: '*forcemerge,*byquery' })
+        method_call
+      end
+
+      it_behaves_like '#all'
+    end
+
+    context 'when no tasks match the given actions' do
+      let(:method_params) { { actions: %w[*ingest] } }
+
+      let(:transport_response) do
+        { 'nodes' => {} }
+      end
+
+      it_behaves_like '#tasks_client'
+
+      it 'forwards the call to the Elasticsearch client, with the expected parameters' do
+        expect(tasks_client).to receive(:list).with({ actions: '*ingest' })
+        method_call
+      end
+
+      it_behaves_like '#all'
+    end
+
+    context "when 'detailed' is given as false" do
+      let(:method_params) { { detailed: false } }
+
+      it_behaves_like '#all when no parameters are given'
+    end
+
+    context "when 'detailed' is given as true" do
+      let(:method_params) { { detailed: true } }
+
+      it_behaves_like '#tasks_client'
+
+      it 'forwards the call to the Elasticsearch client, with the expected parameters' do
+        expect(tasks_client).to receive(:list).with({ detailed: true })
+        method_call
+      end
+
+      it_behaves_like '#all'
+    end
+
+    context "when both 'actions' and 'detailed' are given" do
+      let(:method_params) { { actions: '*forcemerge', detailed: true } }
+
+      it_behaves_like '#tasks_client'
+
+      it 'forwards the call to the Elasticsearch client, with the expected parameters' do
+        expect(tasks_client).to receive(:list).with({ actions: '*forcemerge', detailed: true })
+        method_call
+      end
+
+      it_behaves_like '#all'
+    end
+  end
+
   describe '#by_id' do
     subject(:method_call) { tasks.by_id(task_id) }
 
@@ -94,11 +251,7 @@
       }
     end
 
-    it 'gets the Transport::Client from the given Client' do
-      expect(client).to receive(:transport_client).ordered
-      expect(transport_client).to receive(:tasks).ordered
-      method_call
-    end
+    it_behaves_like '#tasks_client'
 
     it 'uses the TasksClient to fetch the task with the given ID' do
       expect(tasks_client).to receive(:get).with(task_id:, wait_for_completion: true).ordered
