Class: Temporalio::Internal::Client::Implementation
- Inherits:
-
Client::Interceptor::Outbound
- Object
- Client::Interceptor::Outbound
- Temporalio::Internal::Client::Implementation
- Defined in:
- lib/temporalio/internal/client/implementation.rb
Instance Attribute Summary
Attributes inherited from Client::Interceptor::Outbound
Class Method Summary collapse
Instance Method Summary collapse
- #_start_workflow_request_from_with_start_options(klass, start_options) ⇒ Object
- #backfill_schedule(input) ⇒ Object
- #cancel_workflow(input) ⇒ Object
- #complete_async_activity(input) ⇒ Object
- #count_workflows(input) ⇒ Object
- #create_schedule(input) ⇒ Object
- #delete_schedule(input) ⇒ Object
- #describe_schedule(input) ⇒ Object
- #describe_workflow(input) ⇒ Object
- #fail_async_activity(input) ⇒ Object
- #fetch_workflow_history_events(input) ⇒ Object
- #heartbeat_async_activity(input) ⇒ Object
-
#initialize(client) ⇒ Implementation
constructor
A new instance of Implementation.
- #list_schedules(input) ⇒ Object
- #list_workflows(input) ⇒ Object
- #pause_schedule(input) ⇒ Object
- #poll_workflow_update(input) ⇒ Object
- #query_workflow(input) ⇒ Object
- #report_cancellation_async_activity(input) ⇒ Object
- #signal_with_start_workflow(input) ⇒ Object
- #signal_workflow(input) ⇒ Object
- #start_update_with_start_workflow(input) ⇒ Object
- #start_workflow(input) ⇒ Object
- #start_workflow_update(input) ⇒ Object
- #terminate_workflow(input) ⇒ Object
- #trigger_schedule(input) ⇒ Object
- #unpause_schedule(input) ⇒ Object
- #update_schedule(input) ⇒ Object
Constructor Details
#initialize(client) ⇒ Implementation
Returns a new instance of Implementation.
44 45 46 47 |
# File 'lib/temporalio/internal/client/implementation.rb', line 44 def initialize(client) super(nil) # steep:ignore @client = client end |
Class Method Details
.with_default_rpc_options(user_rpc_options) ⇒ Object
29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
# File 'lib/temporalio/internal/client/implementation.rb', line 29 def self.() # If the user did not provide an override_retry, we need to make sure # we use an option set that has it as "true" if .nil? = @always_retry_options ||= Temporalio::Client::RPCOptions.new(override_retry: true) elsif !.is_a?(Temporalio::Client::RPCOptions) raise ArgumentError, 'rpc_options must be RPCOptions' elsif .override_retry.nil? # Copy and set as true = .dup .override_retry = true end end |
Instance Method Details
#_start_workflow_request_from_with_start_options(klass, start_options) ⇒ Object
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
# File 'lib/temporalio/internal/client/implementation.rb', line 301 def (klass, ) klass.new( request_id: SecureRandom.uuid, namespace: @client.namespace, workflow_type: Api::Common::V1::WorkflowType.new(name: .workflow), workflow_id: .id, task_queue: Api::TaskQueue::V1::TaskQueue.new(name: .task_queue.to_s), input: @client.data_converter.to_payloads(.args), workflow_execution_timeout: ProtoUtils.seconds_to_duration(.execution_timeout), workflow_run_timeout: ProtoUtils.seconds_to_duration(.run_timeout), workflow_task_timeout: ProtoUtils.seconds_to_duration(.task_timeout), identity: @client.connection.identity, workflow_id_reuse_policy: .id_reuse_policy, workflow_id_conflict_policy: .id_conflict_policy, retry_policy: .retry_policy&._to_proto, cron_schedule: .cron_schedule, memo: ProtoUtils.memo_to_proto(.memo, @client.data_converter), search_attributes: .search_attributes&._to_proto, workflow_start_delay: ProtoUtils.seconds_to_duration(.start_delay), user_metadata: ProtoUtils.( .static_summary, .static_details, @client.data_converter ), header: ProtoUtils.headers_to_proto(.headers, @client.data_converter) ) end |
#backfill_schedule(input) ⇒ Object
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 |
# File 'lib/temporalio/internal/client/implementation.rb', line 671 def backfill_schedule(input) @client.workflow_service.patch_schedule( Api::WorkflowService::V1::PatchScheduleRequest.new( namespace: @client.namespace, schedule_id: input.id, patch: Api::Schedule::V1::SchedulePatch.new( backfill_request: input.backfills.map(&:_to_proto) ), identity: @client.connection.identity, request_id: SecureRandom.uuid ), rpc_options: Implementation.(input.) ) nil end |
#cancel_workflow(input) ⇒ Object
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 |
# File 'lib/temporalio/internal/client/implementation.rb', line 571 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_options: Implementation.(input.) ) nil end |
#complete_async_activity(input) ⇒ Object
829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 |
# File 'lib/temporalio/internal/client/implementation.rb', line 829 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_options: Implementation.(input.) ) 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_options: Implementation.(input.) ) end nil end |
#count_workflows(input) ⇒ Object
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 |
# File 'lib/temporalio/internal/client/implementation.rb', line 348 def count_workflows(input) resp = @client.workflow_service.count_workflow_executions( Api::WorkflowService::V1::CountWorkflowExecutionsRequest.new( namespace: @client.namespace, query: input.query || '' ), rpc_options: Implementation.(input.) ) 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 |
#create_schedule(input) ⇒ Object
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'lib/temporalio/internal/client/implementation.rb', line 606 def create_schedule(input) if input.schedule.state.limited_actions && input.schedule.state.remaining_actions.zero? raise 'Must set limited actions to false if there are no remaining actions set' end if !input.schedule.state.limited_actions && !input.schedule.state.remaining_actions.zero? raise 'Must set limited actions to true if there are remaining actions set' end @client.workflow_service.create_schedule( Api::WorkflowService::V1::CreateScheduleRequest.new( namespace: @client.namespace, schedule_id: input.id, schedule: input.schedule._to_proto(@client.data_converter), initial_patch: if input.trigger_immediately || !input.backfills.empty? Api::Schedule::V1::SchedulePatch.new( trigger_immediately: if input.trigger_immediately Api::Schedule::V1::TriggerImmediatelyRequest.new( overlap_policy: input.schedule.policy.overlap ) end, backfill_request: input.backfills.map(&:_to_proto) ) end, identity: @client.connection.identity, request_id: SecureRandom.uuid, memo: ProtoUtils.memo_to_proto(input.memo, @client.data_converter), search_attributes: input.search_attributes&._to_proto ), rpc_options: Implementation.(input.) ) Temporalio::Client::ScheduleHandle.new(client: @client, id: input.id) rescue Error::RPCError => e # Unpack and raise already started if that's the error, otherwise default raise details = if e.code == Error::RPCError::Code::ALREADY_EXISTS && e.grpc_status.details.first e.grpc_status.details.first.unpack(Api::ErrorDetails::V1::WorkflowExecutionAlreadyStartedFailure) end raise Error::ScheduleAlreadyRunningError if details raise end |
#delete_schedule(input) ⇒ Object
687 688 689 690 691 692 693 694 695 696 697 |
# File 'lib/temporalio/internal/client/implementation.rb', line 687 def delete_schedule(input) @client.workflow_service.delete_schedule( Api::WorkflowService::V1::DeleteScheduleRequest.new( namespace: @client.namespace, schedule_id: input.id, identity: @client.connection.identity ), rpc_options: Implementation.(input.) ) nil end |
#describe_schedule(input) ⇒ Object
699 700 701 702 703 704 705 706 707 708 709 710 711 |
# File 'lib/temporalio/internal/client/implementation.rb', line 699 def describe_schedule(input) Temporalio::Client::Schedule::Description.new( id: input.id, raw_description: @client.workflow_service.describe_schedule( Api::WorkflowService::V1::DescribeScheduleRequest.new( namespace: @client.namespace, schedule_id: input.id ), rpc_options: Implementation.(input.) ), data_converter: @client.data_converter ) end |
#describe_workflow(input) ⇒ Object
367 368 369 370 371 372 373 374 375 376 377 378 379 |
# File 'lib/temporalio/internal/client/implementation.rb', line 367 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_options: Implementation.(input.) ) Temporalio::Client::WorkflowExecution::Description.new(resp, @client.data_converter) end |
#fail_async_activity(input) ⇒ Object
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 |
# File 'lib/temporalio/internal/client/implementation.rb', line 856 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_options: Implementation.(input.) ) 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_options: Implementation.(input.) ) end nil end |
#fetch_workflow_history_events(input) ⇒ Object
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 |
# File 'lib/temporalio/internal/client/implementation.rb', line 381 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_options: Implementation.(input.) ) 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 |
#heartbeat_async_activity(input) ⇒ Object
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 |
# File 'lib/temporalio/internal/client/implementation.rb', line 800 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_options: Implementation.(input.) ) 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_options: Implementation.(input.) ) end raise Error::AsyncActivityCanceledError if resp.cancel_requested nil end |
#list_schedules(input) ⇒ Object
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 |
# File 'lib/temporalio/internal/client/implementation.rb', line 647 def list_schedules(input) Enumerator.new do |yielder| req = Api::WorkflowService::V1::ListSchedulesRequest.new( namespace: @client.namespace, query: input.query || '' ) loop do resp = @client.workflow_service.list_schedules( req, rpc_options: Implementation.(input.) ) resp.schedules.each do |raw_entry| yielder << Temporalio::Client::Schedule::List::Description.new( raw_entry:, data_converter: @client.data_converter ) end break if resp.next_page_token.empty? req.next_page_token = resp.next_page_token end end end |
#list_workflows(input) ⇒ Object
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 |
# File 'lib/temporalio/internal/client/implementation.rb', line 327 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_options: Implementation.(input.) ) 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 |
#pause_schedule(input) ⇒ Object
713 714 715 716 717 718 719 720 721 722 723 724 725 |
# File 'lib/temporalio/internal/client/implementation.rb', line 713 def pause_schedule(input) @client.workflow_service.patch_schedule( Api::WorkflowService::V1::PatchScheduleRequest.new( namespace: @client.namespace, schedule_id: input.id, patch: Api::Schedule::V1::SchedulePatch.new(pause: input.note), identity: @client.connection.identity, request_id: SecureRandom.uuid ), rpc_options: Implementation.(input.) ) nil end |
#poll_workflow_update(input) ⇒ Object
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 |
# File 'lib/temporalio/internal/client/implementation.rb', line 538 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_options: Implementation.(input.) ) 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::CANCELED raise Error::WorkflowUpdateRPCTimeoutOrCanceledError end raise end end |
#query_workflow(input) ⇒ Object
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 |
# File 'lib/temporalio/internal/client/implementation.rb', line 425 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: Internal::ProtoUtils.headers_to_proto(input.headers, @client.data_converter) ), query_reject_condition: input.reject_condition || 0 ), rpc_options: Implementation.(input.) ) rescue Error::RPCError => e # If the status is INVALID_ARGUMENT, we can assume it's a query failed # error raise Error::WorkflowQueryFailedError, e. 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 |
#report_cancellation_async_activity(input) ⇒ Object
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 |
# File 'lib/temporalio/internal/client/implementation.rb', line 893 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_options: Implementation.(input.) ) 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_options: Implementation.(input.) ) end nil end |
#signal_with_start_workflow(input) ⇒ Object
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 |
# File 'lib/temporalio/internal/client/implementation.rb', line 250 def signal_with_start_workflow(input) raise ArgumentError, 'Start operation is required' unless input.start_workflow_operation # Try to mark used before using input.start_workflow_operation._mark_used # Build req = input.start_workflow_operation. req = ( Api::WorkflowService::V1::SignalWithStartWorkflowExecutionRequest, ) req.signal_name = input.signal req.signal_input = @client.data_converter.to_payloads(input.args) # Send request begin resp = @client.workflow_service.signal_with_start_workflow_execution( req, rpc_options: Implementation.(input.) ) 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 e = Error::WorkflowAlreadyStartedError.new( workflow_id: req.workflow_id, workflow_type: req.workflow_type.name, run_id: details.run_id ) end end # Before we raise here, we want to the start operation exception input.start_workflow_operation._set_workflow_handle(e) raise e end # Set handle and return handle handle = Temporalio::Client::WorkflowHandle.new( client: @client, id: .id, run_id: nil, result_run_id: resp.run_id, first_execution_run_id: resp.run_id ) input.start_workflow_operation._set_workflow_handle(handle) handle end |
#signal_workflow(input) ⇒ Object
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 |
# File 'lib/temporalio/internal/client/implementation.rb', line 406 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: Internal::ProtoUtils.headers_to_proto(input.headers, @client.data_converter), identity: @client.connection.identity, request_id: SecureRandom.uuid ), rpc_options: Implementation.(input.) ) nil end |
#start_update_with_start_workflow(input) ⇒ Object
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 |
# File 'lib/temporalio/internal/client/implementation.rb', line 108 def start_update_with_start_workflow(input) raise ArgumentError, 'Start operation is required' unless input.start_workflow_operation if input.start_workflow_operation..id_conflict_policy == WorkflowIDConflictPolicy::UNSPECIFIED raise ArgumentError, 'ID conflict policy is required in start operation' end # Try to mark used before using input.start_workflow_operation._mark_used # Build request = input.start_workflow_operation. start_req = ( Api::WorkflowService::V1::StartWorkflowExecutionRequest, ) req = Api::WorkflowService::V1::ExecuteMultiOperationRequest.new( namespace: @client.namespace, operations: [ Api::WorkflowService::V1::ExecuteMultiOperationRequest::Operation.new(start_workflow: start_req), Api::WorkflowService::V1::ExecuteMultiOperationRequest::Operation.new( update_workflow: Api::WorkflowService::V1::UpdateWorkflowExecutionRequest.new( namespace: @client.namespace, workflow_execution: Api::Common::V1::WorkflowExecution.new( workflow_id: .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: Internal::ProtoUtils.headers_to_proto(input.headers, @client.data_converter) ) ), wait_policy: Api::Update::V1::WaitPolicy.new( lifecycle_stage: input.wait_for_stage ) ) ) ] ) # Continually try to start until an exception occurs, the user-asked stage is reached, or the stage is # accepted. But we will set the workflow handle as soon as we can. # @type var update_resp: untyped update_resp = nil run_id = nil begin loop do resp = @client.workflow_service.execute_multi_operation( req, rpc_options: Implementation.(input.) ) run_id = resp.responses.first.start_workflow.run_id # Set workflow handle (no-op if already set) input.start_workflow_operation._set_workflow_handle( Temporalio::Client::WorkflowHandle.new( client: @client, id: .id, run_id: nil, result_run_id: run_id, first_execution_run_id: run_id ) ) update_resp = resp.responses.last.update_workflow # We're only done if the response stage is at least accepted if update_resp && Api::Enums::V1::UpdateWorkflowExecutionLifecycleStage.resolve(update_resp.stage) >= Temporalio::Client::WorkflowUpdateWaitStage::ACCEPTED break end 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 && update_resp.outcome update_resp.outcome = @client._impl.poll_workflow_update( Temporalio::Client::Interceptor::PollWorkflowUpdateInput.new( workflow_id: .id, run_id:, update_id: input.update_id, rpc_options: input. ) ) end rescue Error => e # If this is a multi-operation failure, set exception to the first present, non-OK, non-aborted error if e.is_a?(Error::RPCError) multi_err = e.grpc_status.details&.first&.unpack(Api::ErrorDetails::V1::MultiOperationExecutionFailure) if multi_err non_aborted = multi_err.statuses.find do |s| # Exists, not-ok, not-aborted s && s.code != Error::RPCError::Code::OK && !s.details&.first&.is(Api::Failure::V1::MultiOperationExecutionAborted) end if non_aborted e = Error::RPCError.new( non_aborted., code: non_aborted.code, raw_grpc_status: Api::Common::V1::GrpcStatus.new( code: non_aborted.code, message: non_aborted., details: non_aborted.details.to_a ) ) end end end if e.is_a?(Error::RPCError) # Deadline exceeded or cancel is a special error type if e.code == Error::RPCError::Code::DEADLINE_EXCEEDED || e.code == Error::RPCError::Code::CANCELED e = Error::WorkflowUpdateRPCTimeoutOrCanceledError.new elsif e.code == Error::RPCError::Code::ALREADY_EXISTS && e.grpc_status.details.first # Unpack and set already started if that's the error details = e.grpc_status.details.first.unpack( Api::ErrorDetails::V1::WorkflowExecutionAlreadyStartedFailure ) if details e = Error::WorkflowAlreadyStartedError.new( workflow_id: .id, workflow_type: start_req.workflow_type, run_id: details.run_id ) end end end # Cancel is a special type e = Error::WorkflowUpdateRPCTimeoutOrCanceledError.new if e.is_a?(Error::CanceledError) # Before we raise here, we want to try to set the start operation exception (no-op if already set with a # handle) input.start_workflow_operation._set_workflow_handle(e) raise e end # Return handle Temporalio::Client::WorkflowUpdateHandle.new( client: @client, id: input.update_id, workflow_id: .id, workflow_run_id: run_id, known_outcome: update_resp.outcome ) end |
#start_workflow(input) ⇒ Object
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/temporalio/internal/client/implementation.rb', line 49 def start_workflow(input) req = Api::WorkflowService::V1::StartWorkflowExecutionRequest.new( request_id: SecureRandom.uuid, namespace: @client.namespace, workflow_type: Api::Common::V1::WorkflowType.new(name: input.workflow), 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, user_metadata: ProtoUtils.( input.static_summary, input.static_details, @client.data_converter ), header: ProtoUtils.headers_to_proto(input.headers, @client.data_converter) ) # Send request begin resp = @client.workflow_service.start_workflow_execution( req, rpc_options: Implementation.(input.) ) 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 |
#start_workflow_update(input) ⇒ Object
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 |
# File 'lib/temporalio/internal/client/implementation.rb', line 461 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: Internal::ProtoUtils.headers_to_proto(input.headers, @client.data_converter) ) ), 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_options: Implementation.(input.) ) # 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::CANCELED raise Error::WorkflowUpdateRPCTimeoutOrCanceledError end raise rescue Error::CanceledError raise Error::WorkflowUpdateRPCTimeoutOrCanceledError 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_options: input. ) ) 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 |
#terminate_workflow(input) ⇒ Object
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 |
# File 'lib/temporalio/internal/client/implementation.rb', line 588 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_options: Implementation.(input.) ) nil end |
#trigger_schedule(input) ⇒ Object
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 |
# File 'lib/temporalio/internal/client/implementation.rb', line 727 def trigger_schedule(input) @client.workflow_service.patch_schedule( Api::WorkflowService::V1::PatchScheduleRequest.new( namespace: @client.namespace, schedule_id: input.id, patch: Api::Schedule::V1::SchedulePatch.new( trigger_immediately: Api::Schedule::V1::TriggerImmediatelyRequest.new( overlap_policy: input.overlap || 0 ) ), identity: @client.connection.identity, request_id: SecureRandom.uuid ), rpc_options: Implementation.(input.) ) nil end |
#unpause_schedule(input) ⇒ Object
745 746 747 748 749 750 751 752 753 754 755 756 757 |
# File 'lib/temporalio/internal/client/implementation.rb', line 745 def unpause_schedule(input) @client.workflow_service.patch_schedule( Api::WorkflowService::V1::PatchScheduleRequest.new( namespace: @client.namespace, schedule_id: input.id, patch: Api::Schedule::V1::SchedulePatch.new(unpause: input.note), identity: @client.connection.identity, request_id: SecureRandom.uuid ), rpc_options: Implementation.(input.) ) nil end |
#update_schedule(input) ⇒ Object
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 |
# File 'lib/temporalio/internal/client/implementation.rb', line 759 def update_schedule(input) # TODO(cretz): This is supposed to be a retry-conflict loop, but we do # not yet have a way to know update failure is due to conflict token # mismatch update = input.updater.call( Temporalio::Client::Schedule::Update::Input.new( description: Temporalio::Client::Schedule::Description.new( id: input.id, raw_description: @client.workflow_service.describe_schedule( Api::WorkflowService::V1::DescribeScheduleRequest.new( namespace: @client.namespace, schedule_id: input.id ), rpc_options: Implementation.(input.) ), data_converter: @client.data_converter ) ) ) # Do nothing if update is nil, fail if not an expected update return nil if update.nil? unless update.is_a?(Temporalio::Client::Schedule::Update) raise TypeError, 'Expected result of update block to be a Schedule::Update' end @client.workflow_service.update_schedule( Api::WorkflowService::V1::UpdateScheduleRequest.new( namespace: @client.namespace, schedule_id: input.id, schedule: update.schedule._to_proto(@client.data_converter), search_attributes: update.search_attributes&._to_proto, identity: @client.connection.identity, request_id: SecureRandom.uuid ), rpc_options: Implementation.(input.) ) nil end |