Expose count_workflow_executions on the temporal client

examples/spec/integration/count_workflows_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+describe 'Temporal.count_workflow_executions', :integration do
+  it 'returns the number of workflows matching the provided query' do
+    workflow_id = SecureRandom.uuid
+    run_id = Temporal.start_workflow(
+      HelloWorldWorkflow,
+      'Test',
+      options: { workflow_id: workflow_id }
+    )
+
+    Temporal.await_workflow_result(
+      HelloWorldWorkflow,
+      workflow_id: workflow_id,
+      run_id: run_id
+    )
+
+    query = "WorkflowType = \"HelloWorldWorkflow\" AND WorkflowId = \"#{workflow_id}\""
+
+    # This is a workaround for the fact that this API hits the visibility store and there's a lag
+    # before the workflow gets indexed
+    result = nil
+
+    5.times do
+      result = Temporal.count_workflow_executions(
+        'ruby-samples', query: query
+      )
+
+      break if result.count.positive?
+
+      sleep 1
+    end
+
+    expect(result.count).to eq(1)
+  end
+end

lib/temporal.rb

@@ -30,6 +30,7 @@ module Temporal
                  :list_open_workflow_executions,
                  :list_closed_workflow_executions,
                  :query_workflow_executions,
+                 :count_workflow_executions,
                  :add_custom_search_attributes,
                  :list_custom_search_attributes,
                  :remove_custom_search_attributes,

lib/temporal/client.rb

@@ -4,6 +4,7 @@
 require 'temporal/activity/async_token'
 require 'temporal/workflow'
 require 'temporal/workflow/context_helpers'
+require 'temporal/workflow/count_workflows_result'
 require 'temporal/workflow/history'
 require 'temporal/workflow/execution_info'
 require 'temporal/workflow/executions'
@@ -425,6 +426,17 @@ def query_workflow_executions(namespace, query, filter: {}, next_page_token: nil
       Temporal::Workflow::Executions.new(connection: connection, status: :all, request_options: { namespace: namespace, query: query, next_page_token: next_page_token, max_page_size: max_page_size }.merge(filter))
     end
 
+    # Count the number of workflows matching the provided query
+    # 
+    # @param namespace [String]
+    # @param query [String]
+    #
+    # @return [Temporal::Workflow::CountWorkflowAggregation] an integer count of workflows matching the query
+    def count_workflow_executions(namespace, query: nil)
+      response = connection.count_workflow_executions(namespace: namespace, query: query)
+      Workflow::CountWorkflowsResult.new(count: response.count)
+    end
+
     # @param attributes [Hash[String, Symbol]] name to symbol for type, see INDEXED_VALUE_TYPE above
     # @param namespace String, required for SQL enhanced visibility, ignored for elastic search
     def add_custom_search_attributes(attributes, namespace: nil)

lib/temporal/workflow/count_workflows_result.rb

@@ -0,0 +1,11 @@
+module Temporal
+  class Workflow
+    class CountWorkflowsResult
+      def initialize(count:)
+        @count = count
+      end
+
+      attr_reader :count
+    end
+  end
+end

spec/unit/lib/temporal/client_spec.rb

@@ -1102,4 +1102,28 @@ class NamespacedWorkflow < Temporal::Workflow
       end
     end
   end
+
+  describe '#count_workflow_executions' do
+    let(:response) do
+      Temporalio::Api::WorkflowService::V1::CountWorkflowExecutionsResponse.new(
+        count: 5
+      )
+    end
+
+    before do
+      allow(connection)
+        .to receive(:count_workflow_executions)
+        .and_return(response)
+    end
+
+    it 'returns the count' do
+      resp = subject.count_workflow_executions(namespace, query: 'ExecutionStatus="Running"')
+
+      expect(connection)
+        .to have_received(:count_workflow_executions)
+        .with(namespace: namespace, query: 'ExecutionStatus="Running"')
+
+      expect(resp.count).to eq(5)
+    end
+  end
 end