temporalio 1.5.0 → 1.6.0

data/sig/temporalio/error/failure.rbs

@@ -0,0 +1,170 @@
+module Temporalio
+  class Error
+    class Failure < Error
+    end
+
+    class WorkflowAlreadyStartedError < Failure
+      attr_reader workflow_id: String
+      attr_reader workflow_type: String
+      attr_reader run_id: String?
+
+      def initialize: (workflow_id: String, workflow_type: String, run_id: String?) -> void
+    end
+
+    class ActivityAlreadyStartedError < Failure
+      attr_reader activity_id: String
+      attr_reader activity_type: String
+      attr_reader activity_run_id: String?
+
+      def initialize: (activity_id: String, activity_type: String, activity_run_id: String?) -> void
+    end
+
+    class ApplicationError < Failure
+      attr_reader details: Array[Object?]
+      attr_reader type: String?
+      attr_reader non_retryable: bool
+      attr_reader next_retry_delay: duration?
+      attr_reader category: Category::enum
+
+      def initialize: (
+        String message,
+        *Object? details,
+        ?type: String?,
+        ?non_retryable: bool,
+        ?next_retry_delay: duration?,
+        ?category: Category::enum
+      ) -> void
+
+      def retryable?: -> bool
+
+      module Category
+        type enum = Integer
+
+        UNSPECIFIED: enum
+        BENIGN: enum
+      end
+    end
+
+    class CanceledError < Failure
+      attr_reader details: Array[Object?]
+
+      def initialize: (String message, ?details: Array[Object?]) -> void
+    end
+
+    class TerminatedError < Failure
+      attr_reader details: Array[Object?]
+
+      def initialize: (String message, details: Array[Object?]) -> void
+    end
+
+    class TimeoutError < Failure
+      attr_reader type: TimeoutType::enum
+      attr_reader last_heartbeat_details: Array[Object?]
+
+      def initialize: (String message, type: TimeoutType::enum, last_heartbeat_details: Array[Object?]) -> void
+
+      module TimeoutType
+        type enum = Integer
+  
+        START_TO_CLOSE: enum
+        SCHEDULE_TO_START: enum
+        SCHEDULE_TO_CLOSE: enum
+        HEARTBEAT: enum
+      end
+    end
+
+    class ServerError < Failure
+      attr_reader non_retryable: bool
+
+      def initialize: (String message, non_retryable: bool) -> void
+
+      def retryable?: -> bool
+    end
+
+    module RetryState
+      type enum = Integer
+
+      IN_PROGRESS: enum
+      NON_RETRYABLE_FAILURE: enum
+      TIMEOUT: enum
+      MAXIMUM_ATTEMPTS_REACHED: enum
+      RETRY_POLICY_NOT_SET: enum
+      INTERNAL_SERVER_ERROR: enum
+      CANCEL_REQUESTED: enum
+    end
+
+    class ActivityError < Failure
+      attr_reader scheduled_event_id: Integer
+      attr_reader started_event_id: Integer
+      attr_reader identity: String
+      attr_reader activity_type: String
+      attr_reader activity_id: String
+      attr_reader retry_state: RetryState::enum?
+
+      def initialize: (
+        String message,
+        scheduled_event_id: Integer,
+        started_event_id: Integer,
+        identity: String,
+        activity_type: String,
+        activity_id: String,
+        retry_state: RetryState::enum?
+      ) -> void
+    end
+
+    class ChildWorkflowError < Failure
+      attr_reader namespace: String
+      attr_reader workflow_id: String
+      attr_reader run_id: String
+      attr_reader workflow_type: String
+      attr_reader initiated_event_id: Integer
+      attr_reader started_event_id: Integer
+      attr_reader retry_state: RetryState::enum?
+
+      def initialize: (
+        String message,
+        namespace: String,
+        workflow_id: String,
+        run_id: String,
+        workflow_type: String,
+        initiated_event_id: Integer,
+        started_event_id: Integer,
+        retry_state: RetryState::enum?
+      ) -> void
+    end
+
+    class NexusOperationError < Failure
+      attr_reader endpoint: String
+      attr_reader service: String
+      attr_reader operation: String
+      attr_reader operation_token: String?
+
+      def initialize: (
+        String message,
+        endpoint: String,
+        service: String,
+        operation: String,
+        operation_token: String?
+      ) -> void
+    end
+
+    class NexusHandlerError < Failure
+      attr_reader error_type: Symbol
+      attr_reader retry_behavior: RetryBehavior::enum
+
+      def initialize: (
+        String message,
+        error_type: Symbol | String,
+        retry_behavior: RetryBehavior::enum
+      ) -> void
+
+      module RetryBehavior
+        type enum = Integer
+
+        UNSPECIFIED: enum
+        RETRYABLE: enum
+        NON_RETRYABLE: enum
+      end
+    end
+  end
+end

data/sig/temporalio/error.rbs

@@ -0,0 +1,88 @@
+module Temporalio
+  class Error < StandardError
+    def self.canceled?: (Exception error) -> bool
+
+    def self._with_backtrace_and_cause: (
+      Exception err,
+      backtrace: Array[String]?,
+      cause: Exception?
+    ) -> Exception
+
+    class WorkflowFailedError < Error
+      def initialize: -> void
+    end
+
+    class ActivityFailedError < Error
+      def initialize: -> void
+    end
+
+    class WorkflowContinuedAsNewError < Error
+      attr_reader new_run_id: String
+
+      def initialize: (new_run_id: String) -> void
+    end
+
+    class WorkflowQueryFailedError < Error
+    end
+
+    class WorkflowQueryRejectedError < Error
+      attr_reader status: Client::WorkflowExecutionStatus::enum
+
+      def initialize: (status: Client::WorkflowExecutionStatus::enum) -> void
+    end
+
+    class WorkflowUpdateFailedError < Error
+      def initialize: -> void
+    end
+
+    class WorkflowUpdateRPCTimeoutOrCanceledError < Error
+      def initialize: -> void
+    end
+
+    class ScheduleAlreadyRunningError < Error
+      def initialize: -> void
+    end
+
+    class AsyncActivityCanceledError < Error
+      attr_reader details: Activity::CancellationDetails
+
+      def initialize: (Activity::CancellationDetails details) -> void
+    end
+
+    class RPCError < Error
+      attr_reader code: Code::enum
+
+      def initialize: (
+        String message,
+        code: Code::enum,
+        raw_grpc_status: String? | Api::Common::V1::GrpcStatus
+      ) -> void
+
+      def grpc_status: -> Api::Common::V1::GrpcStatus
+
+      private def create_grpc_status: -> Api::Common::V1::GrpcStatus
+
+      module Code
+        OK: 0
+        CANCELED: 1
+        UNKNOWN: 2
+        INVALID_ARGUMENT: 3
+        DEADLINE_EXCEEDED: 4
+        NOT_FOUND: 5
+        ALREADY_EXISTS: 6
+        PERMISSION_DENIED: 7
+        RESOURCE_EXHAUSTED: 8
+        FAILED_PRECONDITION: 9
+        ABORTED: 10
+        OUT_OF_RANGE: 11
+        UNIMPLEMENTED: 12
+        INTERNAL: 13
+        UNAVAILABLE: 14
+        DATA_LOSS: 15
+        UNAUTHENTICATED: 16
+
+        type enum = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16
+      end
+    end
+  end
+end

data/sig/temporalio/internal/bridge/api/activity_result/activity_result.rbs

@@ -0,0 +1,247 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# This RBS interface is provided for convenience, on a best-effort basis.
+# The library is the definitive source for the API contract; if the RBS file
+# and the library's behavior differ, the library behavior is authoritative.
+# We welcome fixes to change the RBS file to match.
+# source: temporal/sdk/core/activity_result/activity_result.proto
+
+module Temporalio
+  module Internal
+    module Bridge
+      module Api
+        module ActivityResult
+          # Used to report activity completions to core
+          class ActivityExecutionResult < ::Google::Protobuf::AbstractMessage
+
+            attr_accessor completed(): ::Temporalio::Internal::Bridge::Api::ActivityResult::Success?
+            def has_completed?: () -> bool
+            def clear_completed: () -> void
+
+            attr_accessor failed(): ::Temporalio::Internal::Bridge::Api::ActivityResult::Failure?
+            def has_failed?: () -> bool
+            def clear_failed: () -> void
+
+            attr_accessor cancelled(): ::Temporalio::Internal::Bridge::Api::ActivityResult::Cancellation?
+            def has_cancelled?: () -> bool
+            def clear_cancelled: () -> void
+
+            attr_accessor will_complete_async(): ::Temporalio::Internal::Bridge::Api::ActivityResult::WillCompleteAsync?
+            def has_will_complete_async?: () -> bool
+            def clear_will_complete_async: () -> void
+
+            attr_reader status(): (::Temporalio::Internal::Bridge::Api::ActivityResult::Success | ::Temporalio::Internal::Bridge::Api::ActivityResult::Failure | ::Temporalio::Internal::Bridge::Api::ActivityResult::Cancellation | ::Temporalio::Internal::Bridge::Api::ActivityResult::WillCompleteAsync)?
+            def has_status?: () -> bool
+            def clear_status: () -> void
+
+            type init_map = {
+              completed: (::Temporalio::Internal::Bridge::Api::ActivityResult::Success | ::Temporalio::Internal::Bridge::Api::ActivityResult::Success::init_map)?,
+              "completed" => (::Temporalio::Internal::Bridge::Api::ActivityResult::Success | ::Temporalio::Internal::Bridge::Api::ActivityResult::Success::init_map)?,
+              failed: (::Temporalio::Internal::Bridge::Api::ActivityResult::Failure | ::Temporalio::Internal::Bridge::Api::ActivityResult::Failure::init_map)?,
+              "failed" => (::Temporalio::Internal::Bridge::Api::ActivityResult::Failure | ::Temporalio::Internal::Bridge::Api::ActivityResult::Failure::init_map)?,
+              cancelled: (::Temporalio::Internal::Bridge::Api::ActivityResult::Cancellation | ::Temporalio::Internal::Bridge::Api::ActivityResult::Cancellation::init_map)?,
+              "cancelled" => (::Temporalio::Internal::Bridge::Api::ActivityResult::Cancellation | ::Temporalio::Internal::Bridge::Api::ActivityResult::Cancellation::init_map)?,
+              will_complete_async: (::Temporalio::Internal::Bridge::Api::ActivityResult::WillCompleteAsync | ::Temporalio::Internal::Bridge::Api::ActivityResult::WillCompleteAsync::init_map)?,
+              "will_complete_async" => (::Temporalio::Internal::Bridge::Api::ActivityResult::WillCompleteAsync | ::Temporalio::Internal::Bridge::Api::ActivityResult::WillCompleteAsync::init_map)?,
+            }
+
+            def initialize: (?init_map initial_value) -> void
+
+            def []:
+                ("completed" name) -> ::Temporalio::Internal::Bridge::Api::ActivityResult::Success?
+              | ("failed" name) -> ::Temporalio::Internal::Bridge::Api::ActivityResult::Failure?
+              | ("cancelled" name) -> ::Temporalio::Internal::Bridge::Api::ActivityResult::Cancellation?
+              | ("will_complete_async" name) -> ::Temporalio::Internal::Bridge::Api::ActivityResult::WillCompleteAsync?
+
+            def []=:
+                ("completed" name, ::Temporalio::Internal::Bridge::Api::ActivityResult::Success? value) -> void
+              | ("failed" name, ::Temporalio::Internal::Bridge::Api::ActivityResult::Failure? value) -> void
+              | ("cancelled" name, ::Temporalio::Internal::Bridge::Api::ActivityResult::Cancellation? value) -> void
+              | ("will_complete_async" name, ::Temporalio::Internal::Bridge::Api::ActivityResult::WillCompleteAsync? value) -> void
+          end
+
+          # Used to report activity resolutions to lang. IE: This is what the activities are resolved with
+          # in the workflow.
+          class ActivityResolution < ::Google::Protobuf::AbstractMessage
+
+            attr_accessor completed(): ::Temporalio::Internal::Bridge::Api::ActivityResult::Success?
+            def has_completed?: () -> bool
+            def clear_completed: () -> void
+
+            attr_accessor failed(): ::Temporalio::Internal::Bridge::Api::ActivityResult::Failure?
+            def has_failed?: () -> bool
+            def clear_failed: () -> void
+
+            attr_accessor cancelled(): ::Temporalio::Internal::Bridge::Api::ActivityResult::Cancellation?
+            def has_cancelled?: () -> bool
+            def clear_cancelled: () -> void
+
+            attr_accessor backoff(): ::Temporalio::Internal::Bridge::Api::ActivityResult::DoBackoff?
+            def has_backoff?: () -> bool
+            def clear_backoff: () -> void
+
+            attr_reader status(): (::Temporalio::Internal::Bridge::Api::ActivityResult::Success | ::Temporalio::Internal::Bridge::Api::ActivityResult::Failure | ::Temporalio::Internal::Bridge::Api::ActivityResult::Cancellation | ::Temporalio::Internal::Bridge::Api::ActivityResult::DoBackoff)?
+            def has_status?: () -> bool
+            def clear_status: () -> void
+
+            type init_map = {
+              completed: (::Temporalio::Internal::Bridge::Api::ActivityResult::Success | ::Temporalio::Internal::Bridge::Api::ActivityResult::Success::init_map)?,
+              "completed" => (::Temporalio::Internal::Bridge::Api::ActivityResult::Success | ::Temporalio::Internal::Bridge::Api::ActivityResult::Success::init_map)?,
+              failed: (::Temporalio::Internal::Bridge::Api::ActivityResult::Failure | ::Temporalio::Internal::Bridge::Api::ActivityResult::Failure::init_map)?,
+              "failed" => (::Temporalio::Internal::Bridge::Api::ActivityResult::Failure | ::Temporalio::Internal::Bridge::Api::ActivityResult::Failure::init_map)?,
+              cancelled: (::Temporalio::Internal::Bridge::Api::ActivityResult::Cancellation | ::Temporalio::Internal::Bridge::Api::ActivityResult::Cancellation::init_map)?,
+              "cancelled" => (::Temporalio::Internal::Bridge::Api::ActivityResult::Cancellation | ::Temporalio::Internal::Bridge::Api::ActivityResult::Cancellation::init_map)?,
+              backoff: (::Temporalio::Internal::Bridge::Api::ActivityResult::DoBackoff | ::Temporalio::Internal::Bridge::Api::ActivityResult::DoBackoff::init_map)?,
+              "backoff" => (::Temporalio::Internal::Bridge::Api::ActivityResult::DoBackoff | ::Temporalio::Internal::Bridge::Api::ActivityResult::DoBackoff::init_map)?,
+            }
+
+            def initialize: (?init_map initial_value) -> void
+
+            def []:
+                ("completed" name) -> ::Temporalio::Internal::Bridge::Api::ActivityResult::Success?
+              | ("failed" name) -> ::Temporalio::Internal::Bridge::Api::ActivityResult::Failure?
+              | ("cancelled" name) -> ::Temporalio::Internal::Bridge::Api::ActivityResult::Cancellation?
+              | ("backoff" name) -> ::Temporalio::Internal::Bridge::Api::ActivityResult::DoBackoff?
+
+            def []=:
+                ("completed" name, ::Temporalio::Internal::Bridge::Api::ActivityResult::Success? value) -> void
+              | ("failed" name, ::Temporalio::Internal::Bridge::Api::ActivityResult::Failure? value) -> void
+              | ("cancelled" name, ::Temporalio::Internal::Bridge::Api::ActivityResult::Cancellation? value) -> void
+              | ("backoff" name, ::Temporalio::Internal::Bridge::Api::ActivityResult::DoBackoff? value) -> void
+          end
+
+          # Used to report successful completion either when executing or resolving
+          class Success < ::Google::Protobuf::AbstractMessage
+
+            attr_accessor result(): ::Temporalio::Api::Common::V1::Payload?
+            def has_result?: () -> bool
+            def clear_result: () -> void
+
+            type init_map = {
+              result: (::Temporalio::Api::Common::V1::Payload | ::Temporalio::Api::Common::V1::Payload::init_map)?,
+              "result" => (::Temporalio::Api::Common::V1::Payload | ::Temporalio::Api::Common::V1::Payload::init_map)?,
+            }
+
+            def initialize: (?init_map initial_value) -> void
+
+            def []:
+                ("result" name) -> ::Temporalio::Api::Common::V1::Payload?
+
+            def []=:
+                ("result" name, ::Temporalio::Api::Common::V1::Payload? value) -> void
+          end
+
+          # Used to report activity failure either when executing or resolving
+          class Failure < ::Google::Protobuf::AbstractMessage
+
+            attr_accessor failure(): ::Temporalio::Api::Failure::V1::Failure?
+            def has_failure?: () -> bool
+            def clear_failure: () -> void
+
+            type init_map = {
+              failure: (::Temporalio::Api::Failure::V1::Failure | ::Temporalio::Api::Failure::V1::Failure::init_map)?,
+              "failure" => (::Temporalio::Api::Failure::V1::Failure | ::Temporalio::Api::Failure::V1::Failure::init_map)?,
+            }
+
+            def initialize: (?init_map initial_value) -> void
+
+            def []:
+                ("failure" name) -> ::Temporalio::Api::Failure::V1::Failure?
+
+            def []=:
+                ("failure" name, ::Temporalio::Api::Failure::V1::Failure? value) -> void
+          end
+
+          # Used to report cancellation from both Core and Lang.
+          # When Lang reports a cancelled activity, it must put a CancelledFailure in the failure field.
+          # When Core reports a cancelled activity, it must put an ActivityFailure with CancelledFailure
+          # as the cause in the failure field.
+          class Cancellation < ::Google::Protobuf::AbstractMessage
+
+            attr_accessor failure(): ::Temporalio::Api::Failure::V1::Failure?
+            def has_failure?: () -> bool
+            def clear_failure: () -> void
+
+            type init_map = {
+              failure: (::Temporalio::Api::Failure::V1::Failure | ::Temporalio::Api::Failure::V1::Failure::init_map)?,
+              "failure" => (::Temporalio::Api::Failure::V1::Failure | ::Temporalio::Api::Failure::V1::Failure::init_map)?,
+            }
+
+            def initialize: (?init_map initial_value) -> void
+
+            def []:
+                ("failure" name) -> ::Temporalio::Api::Failure::V1::Failure?
+
+            def []=:
+                ("failure" name, ::Temporalio::Api::Failure::V1::Failure? value) -> void
+          end
+
+          # Used in ActivityExecutionResult to notify Core that this Activity will complete asynchronously.
+          # Core will forget about this Activity and free up resources used to track this Activity.
+          class WillCompleteAsync < ::Google::Protobuf::AbstractMessage
+
+            type init_map = {
+            }
+
+            def initialize: (?init_map initial_value) -> void
+          end
+
+          # Issued when a local activity needs to retry but also wants to back off more than would be
+          # reasonable to WFT heartbeat for. Lang is expected to schedule a timer for the duration
+          # and then start a local activity of the same type & same inputs with the provided attempt number
+          # after the timer has elapsed.
+          # This exists because Core does not have a concept of starting commands by itself, they originate
+          # from lang. So expecting lang to start the timer / next pass of the activity fits more smoothly.
+          class DoBackoff < ::Google::Protobuf::AbstractMessage
+
+            # The attempt number that lang should provide when scheduling the retry. If the LA failed
+            # on attempt 4 and we told lang to back off with a timer, this number will be 5.
+            attr_reader attempt(): ::Integer
+            attr_writer attempt(): ::Integer | ::Float
+            def clear_attempt: () -> void
+
+            attr_reader backoff_duration(): ::Google::Protobuf::Duration?
+            attr_writer backoff_duration(): (::Google::Protobuf::Duration | ::int)?
+            def has_backoff_duration?: () -> bool
+            def clear_backoff_duration: () -> void
+
+            # The time the first attempt of this local activity was scheduled. Must be passed with attempt
+            # to the retry LA.
+            attr_reader original_schedule_time(): ::Google::Protobuf::Timestamp?
+            attr_writer original_schedule_time(): (::Google::Protobuf::Timestamp | ::Time)?
+            def has_original_schedule_time?: () -> bool
+            def clear_original_schedule_time: () -> void
+
+            type init_map = {
+              attempt: (::Integer | ::Float)?,
+              "attempt" => (::Integer | ::Float)?,
+              backoff_duration: (::Google::Protobuf::Duration | ::Google::Protobuf::Duration)?,
+              "backoff_duration" => (::Google::Protobuf::Duration | ::Google::Protobuf::Duration)?,
+              original_schedule_time: (::Google::Protobuf::Timestamp | ::Google::Protobuf::Timestamp)?,
+              "original_schedule_time" => (::Google::Protobuf::Timestamp | ::Google::Protobuf::Timestamp)?,
+            }
+
+            def initialize: (?init_map initial_value) -> void
+
+            def []:
+                ("attempt" name) -> ::Integer
+              | ("backoff_duration" name) -> ::Google::Protobuf::Duration?
+              | ("original_schedule_time" name) -> ::Google::Protobuf::Timestamp?
+
+            def []=:
+                ("attempt" name, (::Integer | ::Float) value) -> void
+              | ("backoff_duration" name, ((::Google::Protobuf::Duration | ::int)?) value) -> void
+              | ("original_schedule_time" name, ((::Google::Protobuf::Timestamp | ::Time)?) value) -> void
+          end
+        end
+      end
+    end
+  end
+end
+
+module Google
+  module Protobuf
+    class DescriptorPool
+      def lookup: (::String name) -> ::Google::Protobuf::Descriptor
+    end
+  end
+end