temporalio 1.5.0 → 1.7.0

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

@@ -0,0 +1,156 @@
+# 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/workflow_completion/workflow_completion.proto
+
+module Temporalio
+  module Internal
+    module Bridge
+      module Api
+        module WorkflowCompletion
+          # Result of a single workflow activation, reported from lang to core
+          class WorkflowActivationCompletion < ::Google::Protobuf::AbstractMessage
+
+            # The run id from the workflow activation you are completing
+            attr_reader run_id(): ::String
+            attr_writer run_id(): ::String | ::Symbol
+            def clear_run_id: () -> void
+
+            attr_accessor successful(): ::Temporalio::Internal::Bridge::Api::WorkflowCompletion::Success?
+            def has_successful?: () -> bool
+            def clear_successful: () -> void
+
+            attr_accessor failed(): ::Temporalio::Internal::Bridge::Api::WorkflowCompletion::Failure?
+            def has_failed?: () -> bool
+            def clear_failed: () -> void
+
+            # Metrics for external payload storage downloads (retrievals) performed while processing
+            # this activation. Only set when external storage retrieved payloads.
+            attr_accessor payload_download_metrics(): ::Temporalio::Internal::Bridge::Api::Common::ExternalStorageMetrics?
+            def has_payload_download_metrics?: () -> bool
+            def clear_payload_download_metrics: () -> void
+
+            # Metrics for external payload storage uploads (stores) performed while processing this
+            # activation. Only set when external storage stored payloads.
+            attr_accessor payload_upload_metrics(): ::Temporalio::Internal::Bridge::Api::Common::ExternalStorageMetrics?
+            def has_payload_upload_metrics?: () -> bool
+            def clear_payload_upload_metrics: () -> void
+
+            attr_reader status(): (::Temporalio::Internal::Bridge::Api::WorkflowCompletion::Success | ::Temporalio::Internal::Bridge::Api::WorkflowCompletion::Failure)?
+            def has_status?: () -> bool
+            def clear_status: () -> void
+
+            type init_map = {
+              run_id: (::String | ::Symbol)?,
+              "run_id" => (::String | ::Symbol)?,
+              successful: (::Temporalio::Internal::Bridge::Api::WorkflowCompletion::Success | ::Temporalio::Internal::Bridge::Api::WorkflowCompletion::Success::init_map)?,
+              "successful" => (::Temporalio::Internal::Bridge::Api::WorkflowCompletion::Success | ::Temporalio::Internal::Bridge::Api::WorkflowCompletion::Success::init_map)?,
+              failed: (::Temporalio::Internal::Bridge::Api::WorkflowCompletion::Failure | ::Temporalio::Internal::Bridge::Api::WorkflowCompletion::Failure::init_map)?,
+              "failed" => (::Temporalio::Internal::Bridge::Api::WorkflowCompletion::Failure | ::Temporalio::Internal::Bridge::Api::WorkflowCompletion::Failure::init_map)?,
+              payload_download_metrics: (::Temporalio::Internal::Bridge::Api::Common::ExternalStorageMetrics | ::Temporalio::Internal::Bridge::Api::Common::ExternalStorageMetrics::init_map)?,
+              "payload_download_metrics" => (::Temporalio::Internal::Bridge::Api::Common::ExternalStorageMetrics | ::Temporalio::Internal::Bridge::Api::Common::ExternalStorageMetrics::init_map)?,
+              payload_upload_metrics: (::Temporalio::Internal::Bridge::Api::Common::ExternalStorageMetrics | ::Temporalio::Internal::Bridge::Api::Common::ExternalStorageMetrics::init_map)?,
+              "payload_upload_metrics" => (::Temporalio::Internal::Bridge::Api::Common::ExternalStorageMetrics | ::Temporalio::Internal::Bridge::Api::Common::ExternalStorageMetrics::init_map)?,
+            }
+
+            def initialize: (?init_map initial_value) -> void
+
+            def []:
+                ("run_id" name) -> ::String
+              | ("successful" name) -> ::Temporalio::Internal::Bridge::Api::WorkflowCompletion::Success?
+              | ("failed" name) -> ::Temporalio::Internal::Bridge::Api::WorkflowCompletion::Failure?
+              | ("payload_download_metrics" name) -> ::Temporalio::Internal::Bridge::Api::Common::ExternalStorageMetrics?
+              | ("payload_upload_metrics" name) -> ::Temporalio::Internal::Bridge::Api::Common::ExternalStorageMetrics?
+
+            def []=:
+                ("run_id" name, (::String | ::Symbol) value) -> void
+              | ("successful" name, ::Temporalio::Internal::Bridge::Api::WorkflowCompletion::Success? value) -> void
+              | ("failed" name, ::Temporalio::Internal::Bridge::Api::WorkflowCompletion::Failure? value) -> void
+              | ("payload_download_metrics" name, ::Temporalio::Internal::Bridge::Api::Common::ExternalStorageMetrics? value) -> void
+              | ("payload_upload_metrics" name, ::Temporalio::Internal::Bridge::Api::Common::ExternalStorageMetrics? value) -> void
+          end
+
+          # Successful workflow activation with a list of commands generated by the workflow execution
+          class Success < ::Google::Protobuf::AbstractMessage
+
+            # A list of commands to send back to the temporal server
+            attr_accessor commands(): ::Google::Protobuf::RepeatedField
+            def clear_commands: () -> void
+
+            # Any internal flags which the lang SDK used in the processing of this activation
+            attr_accessor used_internal_flags(): ::Google::Protobuf::RepeatedField
+            def clear_used_internal_flags: () -> void
+
+            # The versioning behavior this workflow is currently using
+            attr_reader versioning_behavior(): ::Temporalio::Api::Enums::V1::VersioningBehavior::names | ::Integer
+            attr_writer versioning_behavior(): ::Temporalio::Api::Enums::V1::VersioningBehavior::names | ::Temporalio::Api::Enums::V1::VersioningBehavior::strings | ::Integer | ::Float
+            attr_reader versioning_behavior_const(): ::Integer
+            def clear_versioning_behavior: () -> void
+
+            type init_map = {
+              commands: ::Array[::Temporalio::Internal::Bridge::Api::WorkflowCommands::WorkflowCommand]?,
+              "commands" => ::Array[::Temporalio::Internal::Bridge::Api::WorkflowCommands::WorkflowCommand]?,
+              used_internal_flags: ::Array[::Integer | ::Float]?,
+              "used_internal_flags" => ::Array[::Integer | ::Float]?,
+              versioning_behavior: (::Temporalio::Api::Enums::V1::VersioningBehavior::names | ::Temporalio::Api::Enums::V1::VersioningBehavior::strings | ::Integer | ::Float)?,
+              "versioning_behavior" => (::Temporalio::Api::Enums::V1::VersioningBehavior::names | ::Temporalio::Api::Enums::V1::VersioningBehavior::strings | ::Integer | ::Float)?,
+            }
+
+            def initialize: (?init_map initial_value) -> void
+
+            def []:
+                ("commands" name) -> ::Google::Protobuf::RepeatedField
+              | ("used_internal_flags" name) -> (::Google::Protobuf::RepeatedField)
+              | ("versioning_behavior" name) -> (::Temporalio::Api::Enums::V1::VersioningBehavior::names | ::Integer)
+
+            def []=:
+                ("commands" name, ::Google::Protobuf::RepeatedField value) -> void
+              | ("used_internal_flags" name, (::Google::Protobuf::RepeatedField) value) -> void
+              | ("versioning_behavior" name, (::Temporalio::Api::Enums::V1::VersioningBehavior::names | ::Temporalio::Api::Enums::V1::VersioningBehavior::strings | ::Integer | ::Float) value) -> void
+          end
+
+          # Failure to activate or execute a workflow
+          class Failure < ::Google::Protobuf::AbstractMessage
+
+            attr_accessor failure(): ::Temporalio::Api::Failure::V1::Failure?
+            def has_failure?: () -> bool
+            def clear_failure: () -> void
+
+            # Forces overriding the WFT failure cause
+            attr_reader force_cause(): ::Temporalio::Api::Enums::V1::WorkflowTaskFailedCause::names | ::Integer
+            attr_writer force_cause(): ::Temporalio::Api::Enums::V1::WorkflowTaskFailedCause::names | ::Temporalio::Api::Enums::V1::WorkflowTaskFailedCause::strings | ::Integer | ::Float
+            attr_reader force_cause_const(): ::Integer
+            def clear_force_cause: () -> 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)?,
+              force_cause: (::Temporalio::Api::Enums::V1::WorkflowTaskFailedCause::names | ::Temporalio::Api::Enums::V1::WorkflowTaskFailedCause::strings | ::Integer | ::Float)?,
+              "force_cause" => (::Temporalio::Api::Enums::V1::WorkflowTaskFailedCause::names | ::Temporalio::Api::Enums::V1::WorkflowTaskFailedCause::strings | ::Integer | ::Float)?,
+            }
+
+            def initialize: (?init_map initial_value) -> void
+
+            def []:
+                ("failure" name) -> ::Temporalio::Api::Failure::V1::Failure?
+              | ("force_cause" name) -> (::Temporalio::Api::Enums::V1::WorkflowTaskFailedCause::names | ::Integer)
+
+            def []=:
+                ("failure" name, ::Temporalio::Api::Failure::V1::Failure? value) -> void
+              | ("force_cause" name, (::Temporalio::Api::Enums::V1::WorkflowTaskFailedCause::names | ::Temporalio::Api::Enums::V1::WorkflowTaskFailedCause::strings | ::Integer | ::Float) value) -> void
+          end
+        end
+      end
+    end
+  end
+end
+
+module Google
+  module Protobuf
+    class DescriptorPool
+      def lookup: (::String name) -> ::Google::Protobuf::Descriptor
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Temporalio
+  module Internal
+    module Bridge
+      module Api
+      end
+    end
+  end
+end

data/sig/temporalio/internal/bridge/client.rbs

@@ -0,0 +1,148 @@
+module Temporalio
+  module Internal
+    module Bridge
+      class Client
+        class Options
+          attr_accessor target_host: String
+          attr_accessor client_name: String
+          attr_accessor client_version: String
+          attr_accessor rpc_metadata: Hash[String, String]
+          attr_accessor api_key: String?
+          attr_accessor identity: String
+          attr_accessor tls: TLSOptions?
+          attr_accessor rpc_retry: RPCRetryOptions
+          attr_accessor keep_alive: KeepAliveOptions?
+          attr_accessor http_connect_proxy: HTTPConnectProxyOptions?
+          attr_accessor dns_load_balancing: DnsLoadBalancingOptions?
+          attr_accessor grpc_compression: GrpcCompressionOptions?
+          attr_accessor payloads_warn_size: Integer?
+          attr_accessor memo_warn_size: Integer?
+
+          def initialize: (
+            target_host: String,
+            client_name: String,
+            client_version: String,
+            rpc_metadata: Hash[String, String],
+            api_key: String?,
+            identity: String,
+            ?tls: TLSOptions?,
+            rpc_retry: RPCRetryOptions,
+            ?keep_alive: KeepAliveOptions?,
+            ?http_connect_proxy: HTTPConnectProxyOptions?,
+            ?dns_load_balancing: DnsLoadBalancingOptions?,
+            ?grpc_compression: GrpcCompressionOptions?,
+            ?payloads_warn_size: Integer?,
+            ?memo_warn_size: Integer?
+          ) -> void
+        end
+
+        class TLSOptions
+          attr_accessor client_cert: String?
+          attr_accessor client_private_key: String?
+          attr_accessor server_root_ca_cert: String?
+          attr_accessor domain: String?
+  
+          def initialize: (
+            ?client_cert: String?,
+            ?client_private_key: String?,
+            ?server_root_ca_cert: String?,
+            ?domain: String?
+          ) -> void
+        end
+
+        class RPCRetryOptions
+          attr_accessor initial_interval: Float
+          attr_accessor randomization_factor: Float
+          attr_accessor multiplier: Float
+          attr_accessor max_interval: Float
+          attr_accessor max_elapsed_time: Float
+          attr_accessor max_retries: Integer
+  
+          def initialize: (
+            initial_interval: Float,
+            randomization_factor: Float,
+            multiplier: Float,
+            max_interval: Float,
+            max_elapsed_time: Float,
+            max_retries: Integer
+          ) -> void
+        end
+
+        class KeepAliveOptions
+          attr_accessor interval: Float
+          attr_accessor timeout: Float
+  
+          def initialize: (
+            interval: Float,
+            timeout: Float
+          ) -> void
+        end
+  
+        class HTTPConnectProxyOptions
+          attr_accessor target_host: String
+          attr_accessor basic_auth_user: String?
+          attr_accessor basic_auth_pass: String?
+
+          def initialize: (
+            target_host: String,
+            basic_auth_user: String?,
+            basic_auth_pass: String?
+          ) -> void
+        end
+
+        class DnsLoadBalancingOptions
+          attr_accessor resolution_interval: Float
+
+          def initialize: (
+            resolution_interval: Float
+          ) -> void
+        end
+
+        class GrpcCompressionOptions
+          attr_accessor codec: String
+
+          def initialize: (
+            codec: String
+          ) -> void
+        end
+
+        # Defined in Rust
+
+        SERVICE_WORKFLOW: Integer
+        SERVICE_OPERATOR: Integer
+        SERVICE_CLOUD: Integer
+        SERVICE_TEST: Integer
+        SERVICE_HEALTH: Integer
+
+        def self.new: (Runtime runtime, Options options) -> Client
+
+        def self.async_new: (Runtime runtime, Options options, Queue queue) -> void
+
+        def async_invoke_rpc: (
+          service: Integer,
+          rpc: String,
+          request: String,
+          rpc_retry: bool,
+          rpc_metadata: Hash[String, String]?,
+          rpc_timeout: Float?,
+          rpc_cancellation_token: CancellationToken?,
+          queue: Queue
+        ) -> void
+
+        def update_metadata: (Hash[String, String]) -> void
+        def update_api_key: (String?) -> void
+
+        class RPCFailure < Error
+          def code: -> Temporalio::Error::RPCError::Code::enum
+          def message: -> String
+          def details: -> String?
+        end
+
+        class CancellationToken
+          def self.new: -> CancellationToken
+          def cancel: -> void
+        end
+      end
+    end
+  end
+end

data/sig/temporalio/internal/bridge/metric.rbs

@@ -0,0 +1,28 @@
+module Temporalio
+  module Internal
+    module Bridge
+      class Metric
+        def initialize: (
+          Meter meter,
+          Symbol metric_type,
+          String name,
+          String? description,
+          String? unit,
+          Symbol value_type
+        ) -> void
+
+        def record_value: (untyped value, Attributes attrs) -> void
+
+        class Meter
+          def initialize: (Runtime runtime) -> void
+
+          def default_attributes: -> Attributes
+        end
+
+        class Attributes
+          def with_additional: (Hash[untyped, untyped] attrs) -> Attributes
+        end
+      end
+    end
+  end
+end

data/sig/temporalio/internal/bridge/runtime.rbs

@@ -0,0 +1,103 @@
+module Temporalio
+  module Internal
+    module Bridge
+      class Runtime
+        class Options
+          attr_accessor telemetry: TelemetryOptions
+          attr_accessor worker_heartbeat_interval: Float?
+          attr_accessor disable_environment_info: bool
+          attr_accessor runtime_version: String?
+
+          def initialize: (
+            telemetry: TelemetryOptions,
+            worker_heartbeat_interval: Float?,
+            disable_environment_info: bool,
+            runtime_version: String?
+          ) -> void
+        end
+
+        class TelemetryOptions
+          attr_accessor logging: LoggingOptions?
+          attr_accessor metrics: MetricsOptions?
+    
+          def initialize: (
+            logging: LoggingOptions?,
+            metrics: MetricsOptions?
+          ) -> void
+        end
+    
+        class LoggingOptions
+          attr_accessor log_filter: String?
+          attr_accessor log_format: String?
+    
+          def initialize: (
+            log_filter: String?,
+            log_format: String?
+          ) -> void
+        end
+    
+        class MetricsOptions
+          attr_accessor opentelemetry: OpenTelemetryMetricsOptions?
+          attr_accessor prometheus: PrometheusMetricsOptions?
+          attr_accessor buffered_with_size: Integer?
+          attr_accessor attach_service_name: bool
+          attr_accessor global_tags: Hash[String, String]?
+          attr_accessor metric_prefix: String?
+    
+          def initialize: (
+            opentelemetry: OpenTelemetryMetricsOptions?,
+            prometheus: PrometheusMetricsOptions?,
+            buffered_with_size: Integer?,
+            attach_service_name: bool,
+            global_tags: Hash[String, String]?,
+            metric_prefix: String?
+          ) -> void
+        end
+    
+        class OpenTelemetryMetricsOptions
+          attr_accessor url: String
+          attr_accessor headers: Hash[String, String]?
+          attr_accessor metric_periodicity: Float?
+          attr_accessor metric_temporality_delta: bool
+          attr_accessor durations_as_seconds: bool
+          attr_accessor http: bool
+          attr_accessor histogram_bucket_overrides: Hash[String, Array[Numeric]]?
+    
+          def initialize: (
+            url: String,
+            headers: Hash[String, String]?,
+            metric_periodicity: Float?,
+            metric_temporality_delta: bool,
+            durations_as_seconds: bool,
+            http: bool,
+            histogram_bucket_overrides: Hash[String, Array[Numeric]]?
+          ) -> void
+        end
+    
+        class PrometheusMetricsOptions
+          attr_accessor bind_address: String
+          attr_accessor counters_total_suffix: bool
+          attr_accessor unit_suffix: bool
+          attr_accessor durations_as_seconds: bool
+          attr_accessor 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
+        end
+
+        # Defined in Rust
+
+        def self.new: (Options options) -> Runtime
+
+        def run_command_loop: -> void
+
+        def retrieve_buffered_metrics: (bool durations_as_seconds) -> Array[Temporalio::Runtime::MetricBuffer::Update]
+      end
+    end
+  end
+end

data/sig/temporalio/internal/bridge/testing.rbs

@@ -0,0 +1,91 @@
+module Temporalio
+  module Internal
+    module Bridge
+      module Testing
+        class EphemeralServer
+          class StartDevServerOptions
+            attr_accessor existing_path: String?
+            attr_accessor sdk_name: String
+            attr_accessor sdk_version: String
+            attr_accessor download_version: String
+            attr_accessor download_dest_dir: String?
+            attr_accessor namespace: String
+            attr_accessor ip: String
+            attr_accessor port: Integer?
+            attr_accessor database_filename: String?
+            attr_accessor ui: bool
+            attr_accessor ui_port: Integer?
+            attr_accessor log_format: String
+            attr_accessor log_level: String
+            attr_accessor extra_args: Array[String]
+            attr_accessor download_ttl: Float?
+
+            def initialize: (
+              existing_path: String?,
+              sdk_name: String,
+              sdk_version: String,
+              download_version: String,
+              download_dest_dir: String?,
+              namespace: String,
+              ip: String,
+              port: Integer?,
+              database_filename: String?,
+              ui: bool,
+              ui_port: Integer?,
+              log_format: String,
+              log_level: String,
+              extra_args: Array[String],
+              download_ttl: Float?
+            ) -> void
+          end
+
+          class StartTestServerOptions
+            attr_accessor existing_path: String?
+            attr_accessor sdk_name: String
+            attr_accessor sdk_version: String
+            attr_accessor download_version: String
+            attr_accessor download_dest_dir: String?
+            attr_accessor port: Integer?
+            attr_accessor extra_args: Array[String]
+            attr_accessor download_ttl: Float?
+
+            def initialize: (
+              existing_path: String?,
+              sdk_name: String,
+              sdk_version: String,
+              download_version: String,
+              download_dest_dir: String?,
+              port: Integer?,
+              extra_args: Array[String],
+              download_ttl: Float?
+            ) -> void
+          end
+
+          def self.start_dev_server: (Runtime runtime, StartDevServerOptions options) -> EphemeralServer
+
+          def self.start_test_server: (Runtime runtime, StartTestServerOptions options) -> EphemeralServer
+
+          def shutdown: -> void
+
+          # Defined in Rust
+
+          def self.async_start_dev_server: (
+            Runtime runtime,
+            StartDevServerOptions options,
+            Queue queue
+          ) -> void
+
+          def self.async_start_test_server: (
+            Runtime runtime,
+            StartTestServerOptions options,
+            Queue queue
+          ) -> void
+
+          def target: -> String
+
+          def async_shutdown: (Queue queue) -> void
+        end
+      end
+    end
+  end
+end