temporalio 0.1.1 → 0.3.0

data/lib/temporalio/client/schedule_handle.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'temporalio/client/interceptor'
+require 'temporalio/client/schedule'
+
+module Temporalio
+  class Client
+    # Handle for interacting with a schedule. This is usually created via {Client.create_schedule} or
+    # {Client.schedule_handle}.
+    class ScheduleHandle
+      # @return [String] ID of the schedule.
+      attr_reader :id
+
+      # @!visibility private
+      def initialize(client:, id:)
+        @client = client
+        @id = id
+      end
+
+      # Backfill the schedule by going through the specified time periods as if they passed right now.
+      #
+      # @param backfills [Array<Schedule::Backfill>] Backfill periods.
+      # @param rpc_options [RPCOptions, nil] Advanced RPC options.
+      #
+      # @raise [Error::RPCError] RPC error from call.
+      def backfill(
+        *backfills,
+        rpc_options: nil
+      )
+        raise ArgumentError, 'At least one backfill required' if backfills.empty?
+
+        @client._impl.backfill_schedule(Interceptor::BackfillScheduleInput.new(
+                                          id:,
+                                          backfills:,
+                                          rpc_options:
+                                        ))
+      end
+
+      # Delete this schedule.
+      #
+      # @param rpc_options [RPCOptions, nil] Advanced RPC options.
+      #
+      # @raise [Error::RPCError] RPC error from call.
+      def delete(rpc_options: nil)
+        @client._impl.delete_schedule(Interceptor::DeleteScheduleInput.new(
+                                        id:,
+                                        rpc_options:
+                                      ))
+      end
+
+      # Fetch this schedule's description.
+      #
+      # @param rpc_options [RPCOptions, nil] Advanced RPC options.
+      #
+      # @return [Schedule::Description] Schedule description.
+      # @raise [Error::RPCError] RPC error from call.
+      def describe(rpc_options: nil)
+        @client._impl.describe_schedule(Interceptor::DescribeScheduleInput.new(
+                                          id:,
+                                          rpc_options:
+                                        ))
+      end
+
+      # Pause the schedule and set a note.
+      #
+      # @param note [String] Note to set on the schedule.
+      # @param rpc_options [RPCOptions, nil] Advanced RPC options.
+      #
+      # @raise [Error::RPCError] RPC error from call.
+      def pause(note: 'Paused via Ruby SDK', rpc_options: nil)
+        @client._impl.pause_schedule(Interceptor::PauseScheduleInput.new(
+                                       id:,
+                                       note:,
+                                       rpc_options:
+                                     ))
+      end
+
+      # Trigger an action on this schedule to happen immediately.
+      #
+      # @param overlap [Schedule::OverlapPolicy, nil] If set, overrides the schedule's overlap policy.
+      # @param rpc_options [RPCOptions, nil] Advanced RPC options.
+      #
+      # @raise [Error::RPCError] RPC error from call.
+      def trigger(overlap: nil, rpc_options: nil)
+        @client._impl.trigger_schedule(Interceptor::TriggerScheduleInput.new(
+                                         id:,
+                                         overlap:,
+                                         rpc_options:
+                                       ))
+      end
+
+      # Unpause the schedule and set a note.
+      #
+      # @param note [String] Note to set on the schedule.
+      # @param rpc_options [RPCOptions, nil] Advanced RPC options.
+      #
+      # @raise [Error::RPCError] RPC error from call.
+      def unpause(note: 'Unpaused via Ruby SDK', rpc_options: nil)
+        @client._impl.unpause_schedule(Interceptor::UnpauseScheduleInput.new(
+                                         id:,
+                                         note:,
+                                         rpc_options:
+                                       ))
+      end
+
+      # Update a schedule using a callback to build the update from the description.
+      #
+      # NOTE: In future versions, the callback may be invoked multiple times in a conflict-resolution loop.
+      #
+      # @param rpc_options [RPCOptions, nil] Advanced RPC options.
+      # @yield Block called to obtain the update.
+      # @yieldparam [Schedule::Update::Input] Parameter to the block that contains a description with the schedule to be
+      #   updated.
+      # @yieldreturn [Schedule::Update, nil] The update to apply, or `nil` to not perform an update.
+      #
+      # @raise [Error::RPCError] RPC error from call.
+      def update(rpc_options: nil, &updater)
+        @client._impl.update_schedule(Interceptor::UpdateScheduleInput.new(
+                                        id:,
+                                        updater:,
+                                        rpc_options:
+                                      ))
+      end
+    end
+  end
+end

data/lib/temporalio/client/workflow_execution.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'temporalio/api'
+require 'temporalio/client/workflow_execution_status'
+require 'temporalio/internal/proto_utils'
+require 'temporalio/search_attributes'
+
+module Temporalio
+  class Client
+    # Info for a single workflow execution run.
+    class WorkflowExecution
+      # @return [Api::Workflow::V1::WorkflowExecutionInfo] Underlying protobuf info.
+      attr_reader :raw_info
+
+      # @!visibility private
+      def initialize(raw_info, data_converter)
+        @raw_info = raw_info
+        @memo = Internal::ProtoUtils::LazyMemo.new(raw_info.memo, data_converter)
+        @search_attributes = Internal::ProtoUtils::LazySearchAttributes.new(raw_info.search_attributes)
+      end
+
+      # @return [Time, nil] When the workflow was closed if closed.
+      def close_time
+        Internal::ProtoUtils.timestamp_to_time(@raw_info.close_time)
+      end
+
+      # @return [Time, nil] When this workflow run started or should start.
+      def execution_time
+        Internal::ProtoUtils.timestamp_to_time(@raw_info.execution_time)
+      end
+
+      # @return [Integer] Number of events in the history.
+      def history_length
+        @raw_info.history_length
+      end
+
+      # @return [String] ID for the workflow.
+      def id
+        @raw_info.execution.workflow_id
+      end
+
+      # @return [Hash<String, Object>, nil] Memo for the workflow.
+      def memo
+        @memo.get
+      end
+
+      # @return [String, nil] ID for the parent workflow if this was started as a child.
+      def parent_id
+        @raw_info.parent_execution&.workflow_id
+      end
+
+      # @return [String, nil] Run ID for the parent workflow if this was started as a child.
+      def parent_run_id
+        @raw_info.parent_execution&.run_id
+      end
+
+      # @return [String] Run ID for this workflow run.
+      def run_id
+        @raw_info.execution.run_id
+      end
+
+      # @return [SearchAttributes, nil] Current set of search attributes if any.
+      def search_attributes
+        @search_attributes.get
+      end
+
+      # @return [Time] When the workflow was created.
+      def start_time
+        Internal::ProtoUtils.timestamp_to_time(@raw_info.start_time) || raise # Never nil
+      end
+
+      # @return [WorkflowExecutionStatus] Status for the workflow.
+      def status
+        Internal::ProtoUtils.enum_to_int(Api::Enums::V1::WorkflowExecutionStatus, @raw_info.status)
+      end
+
+      # @return [String] Task queue for the workflow.
+      def task_queue
+        @raw_info.task_queue
+      end
+
+      # @return [String] Type name for the workflow.
+      def workflow_type
+        @raw_info.type.name
+      end
+
+      # Description for a single workflow execution run.
+      class Description < WorkflowExecution
+        # @return [Api::WorkflowService::V1::DescribeWorkflowExecutionResponse] Underlying protobuf description.
+        attr_reader :raw_description
+
+        # @!visibility private
+        def initialize(raw_description, data_converter)
+          super(raw_description.workflow_execution_info, data_converter)
+          @raw_description = raw_description
+        end
+      end
+    end
+  end
+end

data/lib/temporalio/client/workflow_execution_count.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Temporalio
+  class Client
+    # Representation of a count from a count workflows call.
+    class WorkflowExecutionCount
+      # @return [Integer] Approximate number of workflows matching the original query. If the query had a group-by
+      # clause, this is simply the sum of all the counts in {groups}.
+      attr_reader :count
+
+      # @return [Array<AggregationGroup>] Groups if the query had a group-by clause, or empty if not.
+      attr_reader :groups
+
+      # @!visibility private
+      def initialize(count, groups)
+        @count = count
+        @groups = groups
+      end
+
+      # Aggregation group if the workflow count query had a group-by clause.
+      class AggregationGroup
+        # @return [Integer] Approximate number of workflows matching the original query for this group.
+        attr_reader :count
+
+        # @return [Array<Object>] Search attribute values for this group.
+        attr_reader :group_values
+
+        # @!visibility private
+        def initialize(count, group_values)
+          @count = count
+          @group_values = group_values
+        end
+      end
+    end
+  end
+end

data/lib/temporalio/client/workflow_execution_status.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'temporalio/api'
+
+module Temporalio
+  class Client
+    # Status of a workflow execution.
+    module WorkflowExecutionStatus
+      RUNNING = Api::Enums::V1::WorkflowExecutionStatus::WORKFLOW_EXECUTION_STATUS_RUNNING
+      COMPLETED = Api::Enums::V1::WorkflowExecutionStatus::WORKFLOW_EXECUTION_STATUS_COMPLETED
+      FAILED = Api::Enums::V1::WorkflowExecutionStatus::WORKFLOW_EXECUTION_STATUS_FAILED
+      CANCELED = Api::Enums::V1::WorkflowExecutionStatus::WORKFLOW_EXECUTION_STATUS_CANCELED
+      TERMINATED = Api::Enums::V1::WorkflowExecutionStatus::WORKFLOW_EXECUTION_STATUS_TERMINATED
+      CONTINUED_AS_NEW = Api::Enums::V1::WorkflowExecutionStatus::WORKFLOW_EXECUTION_STATUS_CONTINUED_AS_NEW
+      TIMED_OUT = Api::Enums::V1::WorkflowExecutionStatus::WORKFLOW_EXECUTION_STATUS_TIMED_OUT
+    end
+  end
+end