temporalio 1.5.0 → 1.6.0

data/sig/temporalio/internal/worker/workflow_worker.rbs

@@ -0,0 +1,99 @@
+module Temporalio
+  module Internal
+    module Worker
+      class WorkflowWorker
+        def self.workflow_definitions: (
+          Array[singleton(Workflow::Definition) | Workflow::Definition::Info] workflows,
+          should_enforce_versioning_behavior: bool
+        ) -> Hash[String?, Workflow::Definition::Info]
+
+        def self.bridge_workflow_failure_exception_type_options: (
+          workflow_failure_exception_types: Array[singleton(Exception)],
+          workflow_definitions: Hash[String?, Workflow::Definition::Info]
+        ) -> [bool, Array[String]]
+
+        def initialize: (
+          bridge_worker: Bridge::Worker,
+          namespace: String,
+          task_queue: String,
+          workflow_definitions: Hash[String?, Workflow::Definition::Info],
+          workflow_executor: Temporalio::Worker::WorkflowExecutor,
+          logger: Logger,
+          data_converter: Converters::DataConverter,
+          metric_meter: Temporalio::Metric::Meter,
+          workflow_interceptors: Array[Temporalio::Worker::Interceptor::Workflow],
+          disable_eager_activity_execution: bool,
+          illegal_workflow_calls: Hash[String, :all | Array[Symbol | Temporalio::Worker::IllegalWorkflowCallValidator] | Temporalio::Worker::IllegalWorkflowCallValidator],
+          workflow_failure_exception_types: Array[singleton(Exception)],
+          workflow_payload_codec_thread_pool: Temporalio::Worker::ThreadPool?,
+          unsafe_workflow_io_enabled: bool,
+          patch_activation_callback: Proc?,
+          debug_mode: bool,
+          ?on_eviction: (^(String run_id, untyped cache_remove_job) -> void)?,
+          assert_valid_local_activity: ^(String) -> void
+        ) -> void
+
+        def handle_activation: (
+          runner: MultiRunner,
+          activation: untyped,
+          decoded: bool
+        ) -> void
+
+        def handle_activation_complete: (
+          runner: MultiRunner,
+          activation_completion: untyped,
+          encoded: bool,
+          completion_complete_queue: Queue
+        ) -> bool
+
+        def on_shutdown_complete: -> void
+
+        def decode_activation: (MultiRunner runner, untyped activation) -> void
+        def encode_activation_completion: (MultiRunner runner, untyped activation_completion) -> void
+        def apply_codec_on_payload_visit: (untyped payload_or_payloads) { (untyped) -> Enumerable[untyped] } -> void
+
+        class State
+          attr_reader workflow_definitions: Hash[String?, Workflow::Definition::Info]
+          attr_reader bridge_worker: Bridge::Worker
+          attr_reader logger: Logger
+          attr_reader metric_meter: Temporalio::Metric::Meter
+          attr_reader data_converter: Converters::DataConverter
+          attr_reader deadlock_timeout: Float?
+          attr_reader illegal_calls: Hash[String, :all | Hash[Symbol, TrueClass | Temporalio::Worker::IllegalWorkflowCallValidator] | Temporalio::Worker::IllegalWorkflowCallValidator]
+          attr_reader namespace: String
+          attr_reader task_queue: String
+          attr_reader disable_eager_activity_execution: bool
+          attr_reader workflow_interceptors: Array[Temporalio::Worker::Interceptor::Workflow]
+          attr_reader workflow_failure_exception_types: Array[singleton(Exception)]
+          attr_reader unsafe_workflow_io_enabled: bool
+          attr_reader patch_activation_callback: Proc?
+          attr_reader assert_valid_local_activity: ^(String) -> void
+
+          attr_writer on_eviction: ^(String run_id, untyped cache_remove_job) -> void
+
+          def initialize: (
+            workflow_definitions: Hash[String?, Workflow::Definition::Info],
+            bridge_worker: Bridge::Worker,
+            logger: Logger,
+            metric_meter: Temporalio::Metric::Meter,
+            data_converter: Converters::DataConverter,
+            deadlock_timeout: Float?,
+            illegal_calls: Hash[String, :all | Hash[Symbol, TrueClass | Temporalio::Worker::IllegalWorkflowCallValidator] | Temporalio::Worker::IllegalWorkflowCallValidator],
+            namespace: String,
+            task_queue: String,
+            disable_eager_activity_execution: bool,
+            workflow_interceptors: Array[Temporalio::Worker::Interceptor::Workflow],
+            workflow_failure_exception_types: Array[singleton(Exception)],
+            unsafe_workflow_io_enabled: bool,
+            patch_activation_callback: Proc?,
+            assert_valid_local_activity: ^(String) -> void
+          ) -> void
+
+          def get_or_create_running_workflow: [T] (String run_id) { -> T } -> T
+          def evict_running_workflow: (String run_id, untyped cache_remove_job) -> void
+          def evict_all: -> void
+        end
+      end
+    end
+  end
+end

data/sig/temporalio/internal/workflow_task_failure_error.rbs

@@ -0,0 +1,6 @@
+module Temporalio
+  module Internal
+    module WorkflowTaskFailureError
+    end
+  end
+end

data/sig/temporalio/internal.rbs

@@ -0,0 +1,4 @@
+module Temporalio
+  module Internal
+  end
+end

data/sig/temporalio/metric.rbs

@@ -0,0 +1,55 @@
+module Temporalio
+  class Metric
+    def record: (
+      Numeric value,
+      ?additional_attributes: Hash[String | Symbol, String | Integer | Float | bool]?
+    ) -> void
+
+    def with_additional_attributes: (
+      Hash[String | Symbol, String | Integer | Float | bool] additional_attributes
+    ) -> Metric
+
+    def metric_type: -> (:counter | :histogram | :gauge)
+
+    def name: -> String
+
+    def description: -> String?
+
+    def unit: -> String?
+
+    def value_type: -> (:integer | :float | :duration)
+
+    class Meter
+      def self.null: -> Meter
+
+      def create_metric:
+        (
+          :counter metric_type,
+          String name,
+          ?description: String?,
+          ?unit: String?,
+          ?value_type: :integer
+        ) -> Metric
+        |
+        (
+          :histogram metric_type,
+          String name,
+          ?description: String?,
+          ?unit: String?,
+          ?value_type: (:integer | :float | :duration)
+        ) -> Metric
+        |
+        (
+          :gauge metric_type,
+          String name,
+          ?description: String?,
+          ?unit: String?,
+          ?value_type: (:integer | :float)
+        ) -> Metric
+
+        def with_additional_attributes: (
+          Hash[String | Symbol, String | Integer | Float | bool] additional_attributes
+        ) -> Meter
+    end
+  end
+end

data/sig/temporalio/priority.rbs

@@ -0,0 +1,17 @@
+module Temporalio
+  class Priority
+    attr_reader priority_key: Integer?
+    attr_reader fairness_key: String?
+    attr_reader fairness_weight: Float?
+
+    def initialize: (?priority_key: Integer?, ?fairness_key: String?, ?fairness_weight: Float?) -> void
+
+    def self._from_proto: (Api::Common::V1::Priority?) -> Priority
+
+    def self.default: -> Priority
+
+    def _to_proto: -> Api::Common::V1::Priority?
+
+    def empty?: -> bool
+  end
+end

data/sig/temporalio/retry_policy.rbs

@@ -0,0 +1,21 @@
+module Temporalio
+  class RetryPolicy
+    attr_reader initial_interval: duration
+    attr_reader backoff_coefficient: duration
+    attr_reader max_interval: duration?
+    attr_reader max_attempts: Integer
+    attr_reader non_retryable_error_types: Array[String]?
+
+    def self._from_proto: (Api::Common::V1::RetryPolicy raw_policy) -> RetryPolicy
+
+    def initialize: (
+      ?initial_interval: duration,
+      ?backoff_coefficient: duration,
+      ?max_interval: duration?,
+      ?max_attempts: Integer,
+      ?non_retryable_error_types: Array[String]?
+    ) -> void
+
+    def _to_proto: -> Api::Common::V1::RetryPolicy
+  end
+end

data/sig/temporalio/runtime/metric_buffer.rbs

@@ -0,0 +1,49 @@
+module Temporalio
+  class Runtime
+    class MetricBuffer
+      module DurationFormat
+        type enum = Symbol
+    
+        MILLISECONDS: enum
+        SECONDS: enum
+      end
+
+      class Update
+        attr_reader metric: Metric
+        attr_reader value: Integer | Float
+        attr_reader attributes: Hash[String, String | Integer | Float | bool]
+
+        def initialize: (
+          metric: Metric,
+          value: Integer | Float,
+          attributes: Hash[String, String | Integer | Float | bool]
+        ) -> void
+      end
+
+      class Metric
+        attr_reader name: String
+        attr_reader description: String?
+        attr_reader unit: String?
+        attr_reader kind: (:counter | :histogram | :gauge)
+
+        def initialize: (
+          name: String,
+          description: String?,
+          unit: String?,
+          kind: (:counter | :histogram | :gauge)
+        ) -> void
+      end
+
+      def initialize: (
+        Integer buffer_size,
+        ?duration_format: DurationFormat::enum
+      ) -> void
+
+      def retrieve_updates: -> Array[Update]
+
+      def _buffer_size: -> Integer
+
+      def _set_runtime: (Runtime runtime) -> void
+    end
+  end
+end

data/sig/temporalio/runtime.rbs

@@ -0,0 +1,118 @@
+module Temporalio
+  class Runtime
+    class TelemetryOptions
+      attr_reader logging: LoggingOptions?
+      attr_reader metrics: MetricsOptions?
+
+      def initialize: (
+        ?logging: LoggingOptions?,
+        ?metrics: MetricsOptions?
+      ) -> void
+
+      def _to_bridge: -> Internal::Bridge::Runtime::TelemetryOptions
+    end
+
+    class LoggingOptions
+      attr_reader log_filter: LoggingFilterOptions | String
+
+      def initialize: (
+        ?log_filter: LoggingFilterOptions | String
+      ) -> void
+
+      def _to_bridge: -> Internal::Bridge::Runtime::LoggingOptions
+    end
+
+    type logging_filter_level = 'TRACE' | 'DEBUG' | 'INFO' | 'WARN' | 'ERROR'
+
+    class LoggingFilterOptions
+      attr_reader core_level: logging_filter_level
+      attr_reader other_level: logging_filter_level
+
+      def initialize: (
+        ?core_level: logging_filter_level,
+        ?other_level: logging_filter_level
+      ) -> void
+
+      def _to_bridge: -> String
+    end
+
+    class MetricsOptions
+      attr_reader opentelemetry: OpenTelemetryMetricsOptions?
+      attr_reader prometheus: PrometheusMetricsOptions?
+      attr_reader buffer: MetricBuffer?
+      attr_reader attach_service_name: bool
+      attr_reader global_tags: Hash[String, String]?
+      attr_reader metric_prefix: String?
+
+      def initialize: (
+        ?opentelemetry: OpenTelemetryMetricsOptions?,
+        ?prometheus: PrometheusMetricsOptions?,
+        ?buffer: MetricBuffer?,
+        ?attach_service_name: bool,
+        ?global_tags: Hash[String, String]?,
+        ?metric_prefix: String?
+      ) -> void
+
+      def _to_bridge: -> Internal::Bridge::Runtime::MetricsOptions
+    end
+
+    class OpenTelemetryMetricsOptions
+      module MetricTemporality
+        CUMULATIVE: 1
+        DELTA: 2
+
+        type enum = 1 | 2
+      end
+
+      attr_reader url: String
+      attr_reader headers: Hash[String, String]?
+      attr_reader metric_periodicity: Float?
+      attr_reader metric_temporality: MetricTemporality
+      attr_reader durations_as_seconds: bool
+      attr_reader http: bool
+      attr_reader histogram_bucket_overrides: Hash[String, Array[Numeric]]?
+
+      def initialize: (
+        url: String,
+        ?headers: Hash[String, String]?,
+        ?metric_periodicity: Float?,
+        ?metric_temporality: MetricTemporality,
+        ?durations_as_seconds: bool,
+        ?http: bool,
+        ?histogram_bucket_overrides: Hash[String, Array[Numeric]]?
+      ) -> void
+
+      def _to_bridge: -> Internal::Bridge::Runtime::OpenTelemetryMetricsOptions
+    end
+
+    class PrometheusMetricsOptions
+      attr_reader bind_address: String
+      attr_reader counters_total_suffix: bool
+      attr_reader unit_suffix: bool
+      attr_reader durations_as_seconds: bool
+      attr_reader histogram_bucket_overrides: Hash[String, Array[Numeric]]?
+
+      def initialize: (
+        bind_address: String,
+        ?counters_total_suffix: bool,
+        ?unit_suffix: bool,
+        ?durations_as_seconds: bool,
+        ?histogram_bucket_overrides: Hash[String, Array[Numeric]]?
+      ) -> void
+
+      def _to_bridge: -> Internal::Bridge::Runtime::PrometheusMetricsOptions
+    end
+
+    def self.default: -> Runtime
+    def self.default=: (Runtime runtime) -> void
+
+    attr_reader metric_meter: Metric::Meter
+
+    def initialize: (
+      ?telemetry: TelemetryOptions,
+      ?worker_heartbeat_interval: Float?
+    ) -> void
+
+    def _core_runtime: -> Internal::Bridge::Runtime
+  end
+end

data/sig/temporalio/scoped_logger.rbs

@@ -0,0 +1,15 @@
+module Temporalio
+  class ScopedLogger < Logger
+    attr_accessor scoped_values_getter: Proc?
+    attr_accessor disable_scoped_values: bool
+
+    def initialize: (Logger) -> void
+
+    class LogMessage
+      attr_reader message: Object
+      attr_reader scoped_values: Object
+
+      def initialize: (Object message, Object scoped_values) -> void
+    end
+  end
+end

data/sig/temporalio/search_attributes.rbs

@@ -0,0 +1,82 @@
+module Temporalio
+  class SearchAttributes
+    class Key
+      attr_reader name: String
+      attr_reader type: Integer
+
+      def initialize: (String name, Integer type) -> void
+
+      def validate_value: (Object value) -> void
+
+      def value_set: (Object value) -> Update
+      def value_unset: -> Update
+    end
+
+    class Update
+      attr_reader key: Key
+      attr_reader value: Object?
+
+      def initialize: (Key key, Object? value) -> void
+
+      def _to_proto_pair: -> [String, Api::Common::V1::Payload]
+    end
+
+    def self._from_proto: (
+      Api::Common::V1::SearchAttributes? proto,
+      ?disable_mutations: bool,
+      ?never_nil: bool
+    ) -> SearchAttributes?
+
+    def self._value_from_payload: (Api::Common::V1::Payload payload) -> Object?
+
+    def self._to_proto_pair: (Key key, Object? value) -> [String, Api::Common::V1::Payload]
+
+    def initialize: (SearchAttributes existing) -> void
+                  | (Hash[Key, Object] existing) -> void
+                  | -> void
+
+    def []=: (Key | String | Symbol key, Object? value) -> void
+    def []: (Key key) -> Object?
+
+    def delete: (Key | String | Symbol key) -> void
+
+    def each: { (Key key, Object value) -> void } -> self
+
+    def to_h: -> Hash[Key, Object]
+
+    def dup: -> SearchAttributes
+
+    def empty?: -> bool
+
+    def length: -> Integer
+
+    alias size length
+
+    def update: (*Update updates) -> SearchAttributes
+
+    def update!: (*Update updates) -> void
+
+    def _raw_hash: -> Hash[Key, Object]
+
+    def _to_proto: -> Api::Common::V1::SearchAttributes
+
+    def _to_proto_hash: -> Hash[String, Api::Common::V1::Payload]
+
+    def _assert_mutations_enabled: -> void
+
+    def _disable_mutations=: (bool value) -> void
+
+    module IndexedValueType
+      TEXT: Integer
+      KEYWORD: Integer
+      INTEGER: Integer
+      FLOAT: Integer
+      BOOLEAN: Integer
+      TIME: Integer
+      KEYWORD_LIST: Integer
+
+      PROTO_NAMES: Hash[Integer, String]
+      PROTO_VALUES: Hash[String, Integer]
+    end
+  end
+end

data/sig/temporalio/simple_plugin.rbs

@@ -0,0 +1,65 @@
+module Temporalio
+  class SimplePlugin
+    include Client::Plugin
+    include Worker::Plugin
+
+    type option[T] = nil | T | ^(T) -> T
+
+    class Options
+      attr_reader name: String
+      attr_reader data_converter: option[Converters::DataConverter]
+      attr_reader client_interceptors: option[Array[Client::Interceptor]]
+      attr_reader activities: option[Array[Activity::Definition | singleton(Activity::Definition) | Activity::Definition::Info]]
+      attr_reader workflows: option[Array[singleton(Workflow::Definition) | Workflow::Definition::Info]]
+      attr_reader worker_interceptors: option[Array[Worker::Interceptor::Activity | Worker::Interceptor::Workflow]]
+      attr_reader workflow_failure_exception_types: option[Array[String]]
+      attr_reader run_context: nil | ^(
+        Worker::Plugin::RunWorkerOptions | Worker::Plugin::WithWorkflowReplayWorkerOptions options,
+        ^(Worker::Plugin::RunWorkerOptions | Worker::Plugin::WithWorkflowReplayWorkerOptions) -> untyped next_call
+      ) -> untyped
+
+      def initialize: (
+        name: String,
+        data_converter: option[Converters::DataConverter],
+        client_interceptors: option[Array[Client::Interceptor]],
+        activities: option[Array[Activity::Definition | singleton(Activity::Definition) | Activity::Definition::Info]],
+        workflows: option[Array[singleton(Workflow::Definition) | Workflow::Definition::Info]],
+        worker_interceptors: option[Array[Worker::Interceptor::Activity | Worker::Interceptor::Workflow]],
+        workflow_failure_exception_types: option[Array[String]],
+        run_context: nil | ^(
+          Worker::Plugin::RunWorkerOptions | Worker::Plugin::WithWorkflowReplayWorkerOptions options,
+          ^(Worker::Plugin::RunWorkerOptions | Worker::Plugin::WithWorkflowReplayWorkerOptions) -> untyped next_call
+        ) -> untyped
+      ) -> void
+    end
+
+    attr_reader options: Options
+
+    def initialize: (
+      name: String,
+      ?data_converter: option[Converters::DataConverter],
+      ?client_interceptors: option[Array[Client::Interceptor]],
+      ?activities: option[Array[Activity::Definition | singleton(Activity::Definition) | Activity::Definition::Info]],
+      ?workflows: option[Array[singleton(Workflow::Definition) | Workflow::Definition::Info]],
+      ?worker_interceptors: option[Array[Worker::Interceptor::Activity | Worker::Interceptor::Workflow]],
+      ?workflow_failure_exception_types: option[Array[String]],
+      ?run_context: nil | ^(
+        Worker::Plugin::RunWorkerOptions | Worker::Plugin::WithWorkflowReplayWorkerOptions options,
+        ^(Worker::Plugin::RunWorkerOptions | Worker::Plugin::WithWorkflowReplayWorkerOptions) -> untyped next_call
+      ) -> untyped
+    ) -> void
+
+    def _single_option: [T < ::Object] (
+      new: option[T],
+      existing: T,
+      type: Class,
+      name: String
+    ) -> T?
+
+    def _array_option: [T < ::Object] (
+      new: option[T],
+      existing: T,
+      name: String
+    ) -> T?
+  end
+end

data/sig/temporalio/testing/activity_environment.rbs

@@ -0,0 +1,52 @@
+module Temporalio
+  module Testing
+    class ActivityEnvironment
+      def self.default_info: -> Activity::Info
+
+      def initialize: (
+        ?info: Activity::Info,
+        ?on_heartbeat: Proc?,
+        ?cancellation: Cancellation,
+        ?on_cancellation_details: Proc?,
+        ?worker_shutdown_cancellation: Cancellation,
+        ?payload_converter: Converters::PayloadConverter,
+        ?logger: Logger,
+        ?activity_executors: Hash[Symbol, Worker::ActivityExecutor],
+        ?metric_meter: Metric::Meter?,
+        ?client: Client?
+      ) -> void
+
+      def run: (
+        Activity::Definition | singleton(Activity::Definition) | Activity::Definition::Info activity,
+        *Object? args
+      ) -> untyped
+
+      class Context < Activity::Context
+        attr_reader info: Activity::Info
+        attr_reader instance: untyped
+        attr_reader cancellation: Cancellation
+        attr_reader worker_shutdown_cancellation: Cancellation
+        attr_reader payload_converter: Converters::PayloadConverter
+        attr_reader logger: Logger
+
+        def initialize: (
+          info: Activity::Info,
+          instance: untyped,
+          on_heartbeat: Proc?,
+          cancellation: Cancellation,
+          on_cancellation_details: Proc,
+          worker_shutdown_cancellation: Cancellation,
+          payload_converter: Converters::PayloadConverter,
+          logger: Logger,
+          metric_meter: Metric::Meter?,
+          client: Client?
+        ) -> void
+
+        def heartbeat: (*untyped details) -> untyped
+        def metric_meter: -> Metric::Meter
+        def client: -> Client
+        def cancellation_details: -> Activity::CancellationDetails?
+      end
+    end
+  end
+end