temporalio 0.1.1 → 0.2.0

data/lib/temporalio/internal/client/implementation.rb

@@ -0,0 +1,525 @@
+# frozen_string_literal: true
+
+require 'google/protobuf/well_known_types'
+require 'securerandom'
+require 'temporalio/api'
+require 'temporalio/client/activity_id_reference'
+require 'temporalio/client/async_activity_handle'
+require 'temporalio/client/connection'
+require 'temporalio/client/interceptor'
+require 'temporalio/client/workflow_execution'
+require 'temporalio/client/workflow_execution_count'
+require 'temporalio/client/workflow_handle'
+require 'temporalio/common_enums'
+require 'temporalio/converters'
+require 'temporalio/error'
+require 'temporalio/error/failure'
+require 'temporalio/internal/proto_utils'
+require 'temporalio/runtime'
+require 'temporalio/search_attributes'
+
+module Temporalio
+  module Internal
+    module Client
+      class Implementation < Temporalio::Client::Interceptor::Outbound
+        def initialize(client)
+          super(nil)
+          @client = client
+        end
+
+        def start_workflow(input)
+          # TODO(cretz): Signal/update with start
+          req = Api::WorkflowService::V1::StartWorkflowExecutionRequest.new(
+            request_id: SecureRandom.uuid,
+            namespace: @client.namespace,
+            workflow_type: Api::Common::V1::WorkflowType.new(name: input.workflow.to_s),
+            workflow_id: input.workflow_id,
+            task_queue: Api::TaskQueue::V1::TaskQueue.new(name: input.task_queue.to_s),
+            input: @client.data_converter.to_payloads(input.args),
+            workflow_execution_timeout: ProtoUtils.seconds_to_duration(input.execution_timeout),
+            workflow_run_timeout: ProtoUtils.seconds_to_duration(input.run_timeout),
+            workflow_task_timeout: ProtoUtils.seconds_to_duration(input.task_timeout),
+            identity: @client.connection.identity,
+            workflow_id_reuse_policy: input.id_reuse_policy,
+            workflow_id_conflict_policy: input.id_conflict_policy,
+            retry_policy: input.retry_policy&.to_proto,
+            cron_schedule: input.cron_schedule,
+            memo: ProtoUtils.memo_to_proto(input.memo, @client.data_converter),
+            search_attributes: input.search_attributes&.to_proto,
+            workflow_start_delay: ProtoUtils.seconds_to_duration(input.start_delay),
+            request_eager_execution: input.request_eager_start,
+            header: input.headers
+          )
+
+          # Send request
+          begin
+            resp = @client.workflow_service.start_workflow_execution(
+              req,
+              rpc_retry: true,
+              rpc_metadata: input.rpc_metadata,
+              rpc_timeout: input.rpc_timeout
+            )
+          rescue Error::RPCError => e
+            # Unpack and raise already started if that's the error, otherwise default raise
+            if e.code == Error::RPCError::Code::ALREADY_EXISTS && e.grpc_status.details.first
+              details = e.grpc_status.details.first.unpack(
+                Api::ErrorDetails::V1::WorkflowExecutionAlreadyStartedFailure
+              )
+              if details
+                raise Error::WorkflowAlreadyStartedError.new(
+                  workflow_id: req.workflow_id,
+                  workflow_type: req.workflow_type.name,
+                  run_id: details.run_id
+                )
+              end
+            end
+            raise
+          end
+
+          # Return handle
+          Temporalio::Client::WorkflowHandle.new(
+            client: @client,
+            id: input.workflow_id,
+            run_id: nil,
+            result_run_id: resp.run_id,
+            first_execution_run_id: resp.run_id
+          )
+        end
+
+        def list_workflows(input)
+          Enumerator.new do |yielder|
+            req = Api::WorkflowService::V1::ListWorkflowExecutionsRequest.new(
+              namespace: @client.namespace,
+              query: input.query || ''
+            )
+            loop do
+              resp = @client.workflow_service.list_workflow_executions(
+                req,
+                rpc_retry: true,
+                rpc_metadata: input.rpc_metadata,
+                rpc_timeout: input.rpc_timeout
+              )
+              resp.executions.each do |raw_info|
+                yielder << Temporalio::Client::WorkflowExecution.new(raw_info, @client.data_converter)
+              end
+              break if resp.next_page_token.empty?
+
+              req.next_page_token = resp.next_page_token
+            end
+          end
+        end
+
+        def count_workflows(input)
+          resp = @client.workflow_service.count_workflow_executions(
+            Api::WorkflowService::V1::CountWorkflowExecutionsRequest.new(
+              namespace: @client.namespace,
+              query: input.query || ''
+            ),
+            rpc_retry: true,
+            rpc_metadata: input.rpc_metadata,
+            rpc_timeout: input.rpc_timeout
+          )
+          Temporalio::Client::WorkflowExecutionCount.new(
+            resp.count,
+            resp.groups.map do |group|
+              Temporalio::Client::WorkflowExecutionCount::AggregationGroup.new(
+                group.count,
+                group.group_values.map { |payload| SearchAttributes.value_from_payload(payload) }
+              )
+            end
+          )
+        end
+
+        def describe_workflow(input)
+          resp = @client.workflow_service.describe_workflow_execution(
+            Api::WorkflowService::V1::DescribeWorkflowExecutionRequest.new(
+              namespace: @client.namespace,
+              execution: Api::Common::V1::WorkflowExecution.new(
+                workflow_id: input.workflow_id,
+                run_id: input.run_id || ''
+              )
+            ),
+            rpc_retry: true,
+            rpc_metadata: input.rpc_metadata,
+            rpc_timeout: input.rpc_timeout
+          )
+          Temporalio::Client::WorkflowExecution::Description.new(resp, @client.data_converter)
+        end
+
+        def fetch_workflow_history_events(input)
+          Enumerator.new do |yielder|
+            req = Api::WorkflowService::V1::GetWorkflowExecutionHistoryRequest.new(
+              namespace: @client.namespace,
+              execution: Api::Common::V1::WorkflowExecution.new(
+                workflow_id: input.workflow_id,
+                run_id: input.run_id || ''
+              ),
+              wait_new_event: input.wait_new_event,
+              history_event_filter_type: input.event_filter_type,
+              skip_archival: input.skip_archival
+            )
+            loop do
+              resp = @client.workflow_service.get_workflow_execution_history(
+                req,
+                rpc_retry: true,
+                rpc_metadata: input.rpc_metadata,
+                rpc_timeout: input.rpc_timeout
+              )
+              resp.history&.events&.each { |event| yielder << event }
+              break if resp.next_page_token.empty?
+
+              req.next_page_token = resp.next_page_token
+            end
+          end
+        end
+
+        def signal_workflow(input)
+          @client.workflow_service.signal_workflow_execution(
+            Api::WorkflowService::V1::SignalWorkflowExecutionRequest.new(
+              namespace: @client.namespace,
+              workflow_execution: Api::Common::V1::WorkflowExecution.new(
+                workflow_id: input.workflow_id,
+                run_id: input.run_id || ''
+              ),
+              signal_name: input.signal,
+              input: @client.data_converter.to_payloads(input.args),
+              header: input.headers,
+              identity: @client.connection.identity,
+              request_id: SecureRandom.uuid
+            ),
+            rpc_retry: true,
+            rpc_metadata: input.rpc_metadata,
+            rpc_timeout: input.rpc_timeout
+          )
+          nil
+        end
+
+        def query_workflow(input)
+          begin
+            resp = @client.workflow_service.query_workflow(
+              Api::WorkflowService::V1::QueryWorkflowRequest.new(
+                namespace: @client.namespace,
+                execution: Api::Common::V1::WorkflowExecution.new(
+                  workflow_id: input.workflow_id,
+                  run_id: input.run_id || ''
+                ),
+                query: Api::Query::V1::WorkflowQuery.new(
+                  query_type: input.query,
+                  query_args: @client.data_converter.to_payloads(input.args),
+                  header: input.headers
+                ),
+                query_reject_condition: input.reject_condition || 0
+              ),
+              rpc_retry: true,
+              rpc_metadata: input.rpc_metadata,
+              rpc_timeout: input.rpc_timeout
+            )
+          rescue Error::RPCError => e
+            # If the status is INVALID_ARGUMENT, we can assume it's a query failed
+            # error
+            raise Error::WorkflowQueryFailedError, e.message if e.code == Error::RPCError::Code::INVALID_ARGUMENT
+
+            raise
+          end
+          unless resp.query_rejected.nil?
+            raise Error::WorkflowQueryRejectedError.new(status: ProtoUtils.enum_to_int(
+              Api::Enums::V1::WorkflowExecutionStatus, resp.query_rejected.status
+            ))
+          end
+
+          results = @client.data_converter.from_payloads(resp.query_result)
+          warn("Expected 0 or 1 query result, got #{results.size}") if results.size > 1
+          results&.first
+        end
+
+        def start_workflow_update(input)
+          if input.wait_for_stage == Temporalio::Client::WorkflowUpdateWaitStage::ADMITTED
+            raise ArgumentError, 'ADMITTED wait stage not supported'
+          end
+
+          req = Api::WorkflowService::V1::UpdateWorkflowExecutionRequest.new(
+            namespace: @client.namespace,
+            workflow_execution: Api::Common::V1::WorkflowExecution.new(
+              workflow_id: input.workflow_id,
+              run_id: input.run_id || ''
+            ),
+            request: Api::Update::V1::Request.new(
+              meta: Api::Update::V1::Meta.new(
+                update_id: input.update_id,
+                identity: @client.connection.identity
+              ),
+              input: Api::Update::V1::Input.new(
+                name: input.update,
+                args: @client.data_converter.to_payloads(input.args),
+                header: input.headers
+              )
+            ),
+            wait_policy: Api::Update::V1::WaitPolicy.new(
+              lifecycle_stage: input.wait_for_stage
+            )
+          )
+
+          # Repeatedly try to invoke start until the update reaches user-provided
+          # wait stage or is at least ACCEPTED (as of the time of this writing,
+          # the user cannot specify sooner than ACCEPTED)
+          # @type var resp: untyped
+          resp = nil
+          loop do
+            resp = @client.workflow_service.update_workflow_execution(
+              req,
+              rpc_retry: true,
+              rpc_metadata: input.rpc_metadata,
+              rpc_timeout: input.rpc_timeout
+            )
+
+            # We're only done if the response stage is after the requested stage
+            # or the response stage is accepted
+            if resp.stage >= req.wait_policy.lifecycle_stage ||
+               resp.stage >= Temporalio::Client::WorkflowUpdateWaitStage::ACCEPTED
+              break
+            end
+          rescue Error::RPCError => e
+            # Deadline exceeded or cancel is a special error type
+            if e.code == Error::RPCError::Code::DEADLINE_EXCEEDED || e.code == Error::RPCError::Code::CANCELLED
+              raise Error::WorkflowUpdateRPCTimeoutOrCanceledError
+            end
+
+            raise
+          end
+
+          # If the user wants to wait until completed, we must poll until outcome
+          # if not already there
+          if input.wait_for_stage == Temporalio::Client::WorkflowUpdateWaitStage::COMPLETED && !resp.outcome
+            resp.outcome = @client._impl.poll_workflow_update(
+              Temporalio::Client::Interceptor::PollWorkflowUpdateInput.new(
+                workflow_id: input.workflow_id,
+                run_id: input.run_id,
+                update_id: input.update_id,
+                rpc_metadata: input.rpc_metadata,
+                rpc_timeout: input.rpc_timeout
+              )
+            )
+          end
+
+          Temporalio::Client::WorkflowUpdateHandle.new(
+            client: @client,
+            id: input.update_id,
+            workflow_id: input.workflow_id,
+            workflow_run_id: input.run_id,
+            known_outcome: resp.outcome
+          )
+        end
+
+        def poll_workflow_update(input)
+          req = Api::WorkflowService::V1::PollWorkflowExecutionUpdateRequest.new(
+            namespace: @client.namespace,
+            update_ref: Api::Update::V1::UpdateRef.new(
+              workflow_execution: Api::Common::V1::WorkflowExecution.new(
+                workflow_id: input.workflow_id,
+                run_id: input.run_id || ''
+              ),
+              update_id: input.update_id
+            ),
+            identity: @client.connection.identity,
+            wait_policy: Api::Update::V1::WaitPolicy.new(
+              lifecycle_stage: Temporalio::Client::WorkflowUpdateWaitStage::COMPLETED
+            )
+          )
+
+          # Continue polling as long as we have no outcome
+          loop do
+            resp = @client.workflow_service.poll_workflow_execution_update(
+              req,
+              rpc_retry: true,
+              rpc_metadata: input.rpc_metadata,
+              rpc_timeout: input.rpc_timeout
+            )
+            return resp.outcome if resp.outcome
+          rescue Error::RPCError => e
+            # Deadline exceeded or cancel is a special error type
+            if e.code == Error::RPCError::Code::DEADLINE_EXCEEDED || e.code == Error::RPCError::Code::CANCELLED
+              raise Error::WorkflowUpdateRPCTimeoutOrCanceledError
+            end
+
+            raise
+          end
+        end
+
+        def cancel_workflow(input)
+          @client.workflow_service.request_cancel_workflow_execution(
+            Api::WorkflowService::V1::RequestCancelWorkflowExecutionRequest.new(
+              namespace: @client.namespace,
+              workflow_execution: Api::Common::V1::WorkflowExecution.new(
+                workflow_id: input.workflow_id,
+                run_id: input.run_id || ''
+              ),
+              first_execution_run_id: input.first_execution_run_id,
+              identity: @client.connection.identity,
+              request_id: SecureRandom.uuid
+            ),
+            rpc_retry: true,
+            rpc_metadata: input.rpc_metadata,
+            rpc_timeout: input.rpc_timeout
+          )
+          nil
+        end
+
+        def terminate_workflow(input)
+          @client.workflow_service.terminate_workflow_execution(
+            Api::WorkflowService::V1::TerminateWorkflowExecutionRequest.new(
+              namespace: @client.namespace,
+              workflow_execution: Api::Common::V1::WorkflowExecution.new(
+                workflow_id: input.workflow_id,
+                run_id: input.run_id || ''
+              ),
+              reason: input.reason || '',
+              first_execution_run_id: input.first_execution_run_id,
+              details: @client.data_converter.to_payloads(input.details),
+              identity: @client.connection.identity
+            ),
+            rpc_retry: true,
+            rpc_metadata: input.rpc_metadata,
+            rpc_timeout: input.rpc_timeout
+          )
+          nil
+        end
+
+        def heartbeat_async_activity(input)
+          resp = if input.task_token_or_id_reference.is_a?(Temporalio::Client::ActivityIDReference)
+                   @client.workflow_service.record_activity_task_heartbeat_by_id(
+                     Api::WorkflowService::V1::RecordActivityTaskHeartbeatByIdRequest.new(
+                       workflow_id: input.task_token_or_id_reference.workflow_id,
+                       run_id: input.task_token_or_id_reference.run_id,
+                       activity_id: input.task_token_or_id_reference.activity_id,
+                       namespace: @client.namespace,
+                       identity: @client.connection.identity,
+                       details: @client.data_converter.to_payloads(input.details)
+                     ),
+                     rpc_retry: true,
+                     rpc_metadata: input.rpc_metadata,
+                     rpc_timeout: input.rpc_timeout
+                   )
+                 else
+                   @client.workflow_service.record_activity_task_heartbeat(
+                     Api::WorkflowService::V1::RecordActivityTaskHeartbeatRequest.new(
+                       task_token: input.task_token_or_id_reference,
+                       namespace: @client.namespace,
+                       identity: @client.connection.identity,
+                       details: @client.data_converter.to_payloads(input.details)
+                     ),
+                     rpc_retry: true,
+                     rpc_metadata: input.rpc_metadata,
+                     rpc_timeout: input.rpc_timeout
+                   )
+                 end
+          raise Error::AsyncActivityCanceledError if resp.cancel_requested
+
+          nil
+        end
+
+        def complete_async_activity(input)
+          if input.task_token_or_id_reference.is_a?(Temporalio::Client::ActivityIDReference)
+            @client.workflow_service.respond_activity_task_completed_by_id(
+              Api::WorkflowService::V1::RespondActivityTaskCompletedByIdRequest.new(
+                workflow_id: input.task_token_or_id_reference.workflow_id,
+                run_id: input.task_token_or_id_reference.run_id,
+                activity_id: input.task_token_or_id_reference.activity_id,
+                namespace: @client.namespace,
+                identity: @client.connection.identity,
+                result: @client.data_converter.to_payloads([input.result])
+              ),
+              rpc_retry: true,
+              rpc_metadata: input.rpc_metadata,
+              rpc_timeout: input.rpc_timeout
+            )
+          else
+            @client.workflow_service.respond_activity_task_completed(
+              Api::WorkflowService::V1::RespondActivityTaskCompletedRequest.new(
+                task_token: input.task_token_or_id_reference,
+                namespace: @client.namespace,
+                identity: @client.connection.identity,
+                result: @client.data_converter.to_payloads([input.result])
+              ),
+              rpc_retry: true,
+              rpc_metadata: input.rpc_metadata,
+              rpc_timeout: input.rpc_timeout
+            )
+          end
+          nil
+        end
+
+        def fail_async_activity(input)
+          if input.task_token_or_id_reference.is_a?(Temporalio::Client::ActivityIDReference)
+            @client.workflow_service.respond_activity_task_failed_by_id(
+              Api::WorkflowService::V1::RespondActivityTaskFailedByIdRequest.new(
+                workflow_id: input.task_token_or_id_reference.workflow_id,
+                run_id: input.task_token_or_id_reference.run_id,
+                activity_id: input.task_token_or_id_reference.activity_id,
+                namespace: @client.namespace,
+                identity: @client.connection.identity,
+                failure: @client.data_converter.to_failure(input.error),
+                last_heartbeat_details: if input.last_heartbeat_details.empty?
+                                          nil
+                                        else
+                                          @client.data_converter.to_payloads(input.last_heartbeat_details)
+                                        end
+              ),
+              rpc_retry: true,
+              rpc_metadata: input.rpc_metadata,
+              rpc_timeout: input.rpc_timeout
+            )
+          else
+            @client.workflow_service.respond_activity_task_failed(
+              Api::WorkflowService::V1::RespondActivityTaskFailedRequest.new(
+                task_token: input.task_token_or_id_reference,
+                namespace: @client.namespace,
+                identity: @client.connection.identity,
+                failure: @client.data_converter.to_failure(input.error),
+                last_heartbeat_details: if input.last_heartbeat_details.empty?
+                                          nil
+                                        else
+                                          @client.data_converter.to_payloads(input.last_heartbeat_details)
+                                        end
+              ),
+              rpc_retry: true,
+              rpc_metadata: input.rpc_metadata,
+              rpc_timeout: input.rpc_timeout
+            )
+          end
+          nil
+        end
+
+        def report_cancellation_async_activity(input)
+          if input.task_token_or_id_reference.is_a?(Temporalio::Client::ActivityIDReference)
+            @client.workflow_service.respond_activity_task_canceled_by_id(
+              Api::WorkflowService::V1::RespondActivityTaskCanceledByIdRequest.new(
+                workflow_id: input.task_token_or_id_reference.workflow_id,
+                run_id: input.task_token_or_id_reference.run_id,
+                activity_id: input.task_token_or_id_reference.activity_id,
+                namespace: @client.namespace,
+                identity: @client.connection.identity,
+                details: @client.data_converter.to_payloads(input.details)
+              ),
+              rpc_retry: true,
+              rpc_metadata: input.rpc_metadata,
+              rpc_timeout: input.rpc_timeout
+            )
+          else
+            @client.workflow_service.respond_activity_task_canceled(
+              Api::WorkflowService::V1::RespondActivityTaskCanceledRequest.new(
+                task_token: input.task_token_or_id_reference,
+                namespace: @client.namespace,
+                identity: @client.connection.identity,
+                details: @client.data_converter.to_payloads(input.details)
+              ),
+              rpc_retry: true,
+              rpc_metadata: input.rpc_metadata,
+              rpc_timeout: input.rpc_timeout
+            )
+          end
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/temporalio/internal/proto_utils.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'temporalio/api'
+
+module Temporalio
+  module Internal
+    module ProtoUtils
+      def self.seconds_to_duration(seconds_float)
+        return nil if seconds_float.nil?
+
+        seconds = seconds_float.to_i
+        nanos = ((seconds_float - seconds) * 1_000_000_000).round
+        Google::Protobuf::Duration.new(seconds:, nanos:)
+      end
+
+      def self.memo_to_proto(hash, converter)
+        return nil if hash.nil?
+
+        Api::Common::V1::Memo.new(fields: hash.transform_values { |val| converter.to_payload(val) })
+      end
+
+      def self.memo_from_proto(memo, converter)
+        return nil if memo.nil?
+
+        memo.fields.each_with_object({}) { |(key, val), h| h[key] = converter.from_payload(val) } # rubocop:disable Style/HashTransformValues
+      end
+
+      def self.string_or(str, default = nil)
+        str && !str.empty? ? str : default
+      end
+
+      def self.enum_to_int(enum_mod, enum_val, zero_means_nil: false)
+        # Per https://protobuf.dev/reference/ruby/ruby-generated/#enum when
+        # enums are read back, they are symbols if they are known or number
+        # otherwise
+        enum_val = enum_mod.resolve(enum_val) || raise('Unexpected missing symbol') if enum_val.is_a?(Symbol)
+        enum_val = nil if zero_means_nil && enum_val.zero?
+        enum_val
+      end
+
+      def self.convert_from_payload_array(converter, payloads)
+        return [] if payloads.empty?
+
+        converter.from_payloads(Api::Common::V1::Payloads.new(payloads:))
+      end
+
+      def self.convert_to_payload_array(converter, values)
+        return [] if values.empty?
+
+        converter.to_payloads(values).payloads.to_ary
+      end
+    end
+  end
+end