clara-temporalio 0.4.3-arm64-darwin

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60dc1e6bea61fc8dd219f9e320668b7cb194148e0fd4dbeb50a3fe4d18d52272
+  data.tar.gz: 9b4b5a8556f132ac9826b5b4d2c11331a7e685076fd25fc1da698b7b82dcb597
+SHA512:
+  metadata.gz: e3c28ba08fb0925ca7a120d37345dbc779da6aa5fea5ad0fa1ca76e6b285e39ca72dd70522901aae139470d3f5b58f2347c1e9cb42281043573007b24a233588
+  data.tar.gz: 9bdaa8f7a23248d1f9b54de29352748f79e94cda45be00b711723596ae37af7465bbff9cf23ffa5e083ef9c3fca0e521715dd4a1758691a4b2fbe64d09081d7d

data/.yardopts

@@ -0,0 +1,2 @@
+--readme README.md
+--protected

data/Gemfile

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'activemodel'
+  gem 'activerecord'
+  gem 'async'
+  gem 'base64'
+  gem 'grpc', '~> 1.69'
+  gem 'grpc-tools', '~> 1.69'
+  gem 'minitest'
+  # We are intentionally not pinning OTel versions here so that CI tests the latest. This also means that the OTel
+  # contrib library also does not require specific versions, we are relying on the compatibility rigor of OTel.
+  gem 'opentelemetry-api'
+  gem 'opentelemetry-sdk'
+  gem 'rake'
+  gem 'rake-compiler'
+  gem 'rbs', '~> 3.5.3'
+  gem 'rb_sys', '~> 0.9.63'
+  gem 'rubocop'
+  gem 'sqlite3'
+  gem 'steep', '~> 1.7.1'
+  gem 'yard'
+end

data/Rakefile

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# rubocop:disable Lint/MissingCopEnableDirective, Style/DocumentationMethod
+
+require 'bundler/gem_tasks'
+require 'rb_sys/cargo/metadata'
+require 'rb_sys/extensiontask'
+
+task build: :compile
+
+GEMSPEC = Gem::Specification.load('temporalio.gemspec')
+
+begin
+  RbSys::ExtensionTask.new('temporalio_bridge', GEMSPEC) do |ext|
+    ext.lib_dir = 'lib/temporalio/internal/bridge'
+  end
+rescue RbSys::CargoMetadataError
+  raise 'Source gem cannot be installed directly, must be a supported platform'
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.warning = false
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+def add_protoc_to_path
+  tools_spec = Gem::Specification.find_by_name('grpc-tools')
+  cpu = RbConfig::CONFIG['host_cpu']
+  cpu = 'x86_64' if cpu == 'x64'
+  os = RbConfig::CONFIG['host_os']
+  os = 'windows' if os.start_with?('mingw')
+  protoc_path = "#{tools_spec.gem_dir}/bin/#{cpu}-#{os}"
+  separator = os == 'windows' ? ';' : ':'
+  ENV['PATH'] = "#{ENV.fetch('PATH', nil)}#{separator}#{protoc_path}"
+end
+
+add_protoc_to_path
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+require 'steep/rake_task'
+
+Steep::RakeTask.new
+
+require 'yard'
+
+module CustomizeYardWarnings # rubocop:disable Style/Documentation
+  def process
+    super
+  rescue YARD::Parser::UndocumentableError
+    # We ignore if it's an API warning
+    last_file = statement.last.file
+    raise unless (last_file.start_with?('lib/temporalio/api/') && last_file.count('/') > 3) ||
+                 last_file.start_with?('lib/temporalio/internal/bridge/api/')
+  end
+end
+
+YARD::Handlers::Ruby::ConstantHandler.prepend(CustomizeYardWarnings)
+
+YARD::Rake::YardocTask.new { |t| t.options = ['--fail-on-warning'] }
+
+Rake::Task[:yard].enhance([:copy_parent_files]) do
+  rm ['LICENSE', 'README.md']
+end
+
+namespace :proto do
+  desc 'Generate API and Core protobufs'
+  task :generate do
+    require_relative 'extra/proto_gen'
+    ProtoGen.new.run
+  end
+end
+
+namespace :rbs do
+  desc 'RBS tasks'
+  task :install_collection do
+    sh 'rbs collection install'
+  end
+end
+
+# We have to copy some parent files to this dir for gem
+task :copy_parent_files do
+  cp '../LICENSE', 'LICENSE'
+  cp '../README.md', 'README.md'
+end
+Rake::Task[:build].enhance([:copy_parent_files]) do
+  rm ['LICENSE', 'README.md']
+end
+
+task :rust_lint do
+  sh 'cargo', 'clippy', '-p', 'temporalio_bridge', '--no-deps', '--', '-Dwarnings'
+  sh 'cargo', 'fmt', '--check'
+end
+
+task default: ['rubocop', 'yard', 'rbs:install_collection', 'steep', 'rust_lint', 'compile', 'test']

data/lib/temporalio/activity/cancellation_details.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'temporalio/error'
+
+module Temporalio
+  module Activity
+    # Details that are set when an activity is cancelled. This is only valid at the time the cancel was received, the
+    # state may change on the server after it is received.
+    class CancellationDetails
+      def initialize(
+        gone_from_server: false,
+        cancel_requested: true,
+        timed_out: false,
+        worker_shutdown: false,
+        paused: false,
+        reset: false
+      )
+        @gone_from_server = gone_from_server
+        @cancel_requested = cancel_requested
+        @timed_out = timed_out
+        @worker_shutdown = worker_shutdown
+        @paused = paused
+        @reset = reset
+      end
+
+      # @return [Boolean] Whether the activity no longer exists on the server (may already be completed or its workflow
+      #   may be completed).
+      def gone_from_server?
+        @gone_from_server
+      end
+
+      # @return [Boolean] Whether the activity was explicitly cancelled.
+      def cancel_requested?
+        @cancel_requested
+      end
+
+      # @return [Boolean] Whether the activity timeout caused activity to be marked cancelled.
+      def timed_out?
+        @timed_out
+      end
+
+      # @return [Boolean] Whether the worker the activity is running on is shutting down.
+      def worker_shutdown?
+        @worker_shutdown
+      end
+
+      # @return [Boolean] Whether the activity was explicitly paused.
+      def paused?
+        @paused
+      end
+
+      # @return [Boolean] Whether the activity was explicitly reset.
+      def reset?
+        @reset
+      end
+    end
+  end
+end

data/lib/temporalio/activity/complete_async_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'temporalio/error'
+
+module Temporalio
+  module Activity
+    # Error raised inside an activity to mark that the activity will be completed asynchronously.
+    class CompleteAsyncError < Error
+    end
+  end
+end

data/lib/temporalio/activity/context.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require 'temporalio/error'
+
+module Temporalio
+  module Activity
+    # Context accessible only within an activity. Use {current} to get the current context. Contexts are fiber or thread
+    # local so may not be available in a newly started thread from an activity and may have to be propagated manually.
+    class Context
+      # @return [Context] The current context, or raises an error if not in activity fiber/thread.
+      def self.current
+        context = current_or_nil
+        raise Error, 'Not in activity context' if context.nil?
+
+        context
+      end
+
+      # @return [Context, nil] The current context or nil if not in activity fiber/thread.
+      def self.current_or_nil
+        _current_executor&.activity_context
+      end
+
+      # @return [Boolean] Whether there is a current context available.
+      def self.exist?
+        !current_or_nil.nil?
+      end
+
+      # @!visibility private
+      def self._current_executor
+        if Fiber.current_scheduler
+          Fiber[:temporal_activity_executor]
+        else
+          Thread.current[:temporal_activity_executor]
+        end
+      end
+
+      # @!visibility private
+      def self._current_executor=(executor)
+        if Fiber.current_scheduler
+          Fiber[:temporal_activity_executor] = executor
+        else
+          Thread.current[:temporal_activity_executor] = executor
+        end
+      end
+
+      # @return [Info] Activity info for this activity.
+      def info
+        raise NotImplementedError
+      end
+
+      # @return [Object, nil] Activity class instance. This should always be present except for advanced cases where the
+      #   definition was manually created without any instance getter/creator.
+      def instance
+        raise NotImplementedError
+      end
+
+      # Record a heartbeat on the activity.
+      #
+      # Heartbeats should be used for all non-immediately-returning, non-local activities and they are required to
+      # receive cancellation. Heartbeat calls are throttled internally based on the heartbeat timeout of the activity.
+      # Users do not have to be concerned with burdening the server by calling this too frequently.
+      #
+      # @param details [Array<Object>] Details to record with the heartbeat.
+      def heartbeat(*details)
+        raise NotImplementedError
+      end
+
+      # @return [Cancellation] Cancellation that is canceled when the activity is canceled.
+      def cancellation
+        raise NotImplementedError
+      end
+
+      # @return [CancellationDetails, nil] Cancellation details if canceled. These are set just before cancellation is
+      #   actually canceled. These details only represent when the cancel was first performed. Once set, this object is
+      #   never mutated. Therefore, the situation on the server may have changed (e.g. unpause), but this still
+      #   represents the values when cancellation first occurred for this attempt.
+      def cancellation_details
+        raise NotImplementedError
+      end
+
+      # @return [Cancellation] Cancellation that is canceled when the worker is shutting down. On worker shutdown, this
+      #   is canceled, then the `graceful_shutdown_period` is waited (default 0s), then the activity is canceled.
+      def worker_shutdown_cancellation
+        raise NotImplementedError
+      end
+
+      # @return [Converters::PayloadConverter] Payload converter associated with this activity.
+      def payload_converter
+        raise NotImplementedError
+      end
+
+      # @return [ScopedLogger] Logger for this activity. Note, this is a shared logger not created each activity
+      #   invocation. It just has logic to extract current activity details and so is only able to do so on log calls
+      #   made with a current context available.
+      def logger
+        raise NotImplementedError
+      end
+
+      # @!visibility private
+      def _scoped_logger_info
+        return @scoped_logger_info unless @scoped_logger_info.nil?
+
+        curr_info = info
+        @scoped_logger_info = {
+          temporal_activity: {
+            activity_id: curr_info.activity_id,
+            activity_type: curr_info.activity_type,
+            attempt: curr_info.attempt,
+            task_queue: curr_info.task_queue,
+            workflow_id: curr_info.workflow_id,
+            workflow_namespace: curr_info.workflow_namespace,
+            workflow_run_id: curr_info.workflow_run_id,
+            workflow_type: curr_info.workflow_type
+          }
+        }.freeze
+      end
+
+      # @return [Metric::Meter] Metric meter to create metrics on, with some activity-specific attributes already set.
+      # @raise [RuntimeError] Called within a {Testing::ActivityEnvironment} and it was not set.
+      def metric_meter
+        raise NotImplementedError
+      end
+
+      # @return [Client] Temporal client this activity worker is running in.
+      # @raise [RuntimeError] Called within a {Testing::ActivityEnvironment} and it was not set.
+      def client
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/temporalio/activity/definition.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+require 'temporalio/internal/proto_utils'
+
+module Temporalio
+  module Activity
+    # Base class for all activities.
+    #
+    # Activities can be given to a worker as instances of this class, which will call execute on the same instance for
+    # each execution, or given to the worker as the class itself which instantiates the activity for each execution.
+    #
+    # All activities must implement {execute}. Inside execute, {Activity::Context.current} can be used to access the
+    # current context to get information, issue heartbeats, etc.
+    #
+    # By default, the activity is named as its unqualified class name. This can be customized with {activity_name}.
+    #
+    # By default, the activity uses the `:default` executor which is usually the thread-pool based executor. This can be
+    # customized with {activity_executor}.
+    #
+    # By default, upon cancellation {::Thread.raise} or {::Fiber.raise} is called with a {Error::CanceledError}. This
+    # can be disabled by passing `false` to {activity_cancel_raise}.
+    #
+    # See documentation for more detail on activities.
+    class Definition
+      class << self
+        protected
+
+        # Override the activity name which is defaulted to the unqualified class name.
+        #
+        # @param name [String, Symbol] Name to use.
+        def activity_name(name)
+          if !name.is_a?(Symbol) && !name.is_a?(String)
+            raise ArgumentError,
+                  'Activity name must be a symbol or string'
+          end
+
+          @activity_name = name.to_s
+        end
+
+        # Override the activity executor which is defaulted to `:default`.
+        #
+        # @param executor_name [Symbol] Executor to use.
+        def activity_executor(executor_name)
+          raise ArgumentError, 'Executor name must be a symbol' unless executor_name.is_a?(Symbol)
+
+          @activity_executor = executor_name
+        end
+
+        # Override whether the activity uses Thread/Fiber raise for cancellation which is defaulted to true.
+        #
+        # @param cancel_raise [Boolean] Whether to raise.
+        def activity_cancel_raise(cancel_raise)
+          unless cancel_raise.is_a?(TrueClass) || cancel_raise.is_a?(FalseClass)
+            raise ArgumentError, 'Must be a boolean'
+          end
+
+          @activity_cancel_raise = cancel_raise
+        end
+
+        # Set an activity as dynamic. Dynamic activities do not have names and handle any activity that is not otherwise
+        # registered. A worker can only have one dynamic activity. It is often useful to use {activity_raw_args} with
+        # this.
+        #
+        # @param value [Boolean] Whether the activity is dynamic.
+        def activity_dynamic(value = true) # rubocop:disable Style/OptionalBooleanParameter
+          raise ArgumentError, 'Must be a boolean' unless value.is_a?(TrueClass) || value.is_a?(FalseClass)
+
+          @activity_dynamic = value
+        end
+
+        # Have activity arguments delivered to `execute` as {Converters::RawValue}s. These are wrappers for the raw
+        # payloads that have not been converted to types (but they have been decoded by the codec if present). They can
+        # be converted with {Context#payload_converter}.
+        #
+        # @param value [Boolean] Whether the activity accepts raw arguments.
+        def activity_raw_args(value = true) # rubocop:disable Style/OptionalBooleanParameter
+          raise ArgumentError, 'Must be a boolean' unless value.is_a?(TrueClass) || value.is_a?(FalseClass)
+
+          @activity_raw_args = value
+        end
+      end
+
+      # @!visibility private
+      def self._activity_definition_details
+        activity_name = @activity_name
+        raise 'Cannot have activity name specified for dynamic activity' if activity_name && @activity_dynamic
+
+        # Disallow kwargs in execute parameters
+        if instance_method(:execute).parameters.any? { |t, _| t == :key || t == :keyreq }
+          raise 'Activity execute cannot have keyword arguments'
+        end
+
+        # Default to unqualified class name if not dynamic
+        activity_name ||= name.to_s.split('::').last unless @activity_dynamic
+        {
+          activity_name:,
+          activity_executor: @activity_executor || :default,
+          activity_cancel_raise: @activity_cancel_raise.nil? || @activity_cancel_raise,
+          activity_raw_args: @activity_raw_args.nil? ? false : @activity_raw_args
+        }
+      end
+
+      # Implementation of the activity. The arguments should be positional and this should return the value on success
+      # or raise an error on failure.
+      def execute(*args)
+        raise NotImplementedError, 'Activity did not implement "execute"'
+      end
+
+      # Definition info of an activity. Activities are usually classes/instances that extend {Definition}, but
+      # definitions can also be manually created with a block via {initialize} here.
+      class Info
+        # @return [String, Symbol, nil] Name of the activity, or nil if the activity is dynamic.
+        attr_reader :name
+
+        # @return [Object, Proc, nil] The pre-created instance or the proc to create/return it.
+        attr_reader :instance
+
+        # @return [Proc] Proc for the activity. Should use {Context#instance} to access the instance.
+        attr_reader :proc
+
+        # @return [Symbol] Name of the executor. Default is `:default`.
+        attr_reader :executor
+
+        # @return [Boolean] Whether to raise in thread/fiber on cancellation. Default is `true`.
+        attr_reader :cancel_raise
+
+        # @return [Boolean] Whether to use {Converters::RawValue}s as arguments.
+        attr_reader :raw_args
+
+        # Obtain definition info representing the given activity, which can be a class, instance, or definition info.
+        #
+        # @param activity [Definition, Class<Definition>, Info] Activity to get info for.
+        # @return Info Obtained definition info.
+        def self.from_activity(activity)
+          # Class means create each time, instance means just call, definition
+          # does nothing special
+          case activity
+          when Class
+            unless activity < Definition
+              raise ArgumentError,
+                    "Class '#{activity}' does not extend Temporalio::Activity::Definition"
+            end
+
+            details = activity._activity_definition_details
+            new(
+              name: details[:activity_name],
+              instance: proc { activity.new },
+              executor: details[:activity_executor],
+              cancel_raise: details[:activity_cancel_raise],
+              raw_args: details[:activity_raw_args]
+            ) { |*args| Context.current.instance&.execute(*args) }
+          when Definition
+            details = activity.class._activity_definition_details
+            new(
+              name: details[:activity_name],
+              instance: activity,
+              executor: details[:activity_executor],
+              cancel_raise: details[:activity_cancel_raise],
+              raw_args: details[:activity_raw_args]
+            ) { |*args| Context.current.instance&.execute(*args) }
+          when Info
+            activity
+          else
+            raise ArgumentError, "#{activity} is not an activity class, instance, or definition info"
+          end
+        end
+
+        # Manually create activity definition info. Most users will use an instance/class of {Definition}.
+        #
+        # @param name [String, Symbol, nil] Name of the activity or nil for dynamic activity.
+        # @param instance [Object, Proc, nil] The pre-created instance or the proc to create/return it.
+        # @param executor [Symbol] Name of the executor.
+        # @param cancel_raise [Boolean] Whether to raise in thread/fiber on cancellation.
+        # @param raw_args [Boolean] Whether to use {Converters::RawValue}s as arguments.
+        # @yield Use this block as the activity.
+        def initialize(
+          name:,
+          instance: nil,
+          executor: :default,
+          cancel_raise: true,
+          raw_args: false,
+          &block
+        )
+          @name = name
+          @instance = instance
+          raise ArgumentError, 'Must give block' unless block_given?
+
+          @proc = block
+          @executor = executor
+          @cancel_raise = cancel_raise
+          @raw_args = raw_args
+          Internal::ProtoUtils.assert_non_reserved_name(name)
+        end
+      end
+    end
+  end
+end

data/lib/temporalio/activity/info.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Temporalio
+  module Activity
+    Info = Data.define(
+      :activity_id,
+      :activity_type,
+      :attempt,
+      :current_attempt_scheduled_time,
+      :heartbeat_details,
+      :heartbeat_timeout,
+      :local?,
+      :priority,
+      :schedule_to_close_timeout,
+      :scheduled_time,
+      :start_to_close_timeout,
+      :started_time,
+      :task_queue,
+      :task_token,
+      :workflow_id,
+      :workflow_namespace,
+      :workflow_run_id,
+      :workflow_type
+    )
+
+    # Information about an activity.
+    #
+    # @!attribute activity_id
+    #   @return [String] ID for the activity.
+    # @!attribute activity_type
+    #   @return [String] Type name for the activity.
+    # @!attribute attempt
+    #   @return [Integer] Attempt the activity is on.
+    # @!attribute current_attempt_scheduled_time
+    #   @return [Time] When the current attempt was scheduled.
+    # @!attribute heartbeat_details
+    #   @return [Array<Object>] Details from the last heartbeat of the last attempt.
+    # @!attribute heartbeat_timeout
+    #   @return [Float, nil] Heartbeat timeout set by the caller.
+    # @!attribute local?
+    #   @return [Boolean] Whether the activity is a local activity or not.
+    # @!attribute priority
+    #   @return [Priority] The priority of this activity.
+    # @!attribute schedule_to_close_timeout
+    #   @return [Float, nil] Schedule to close timeout set by the caller.
+    # @!attribute scheduled_time
+    #   @return [Time] When the activity was scheduled.
+    # @!attribute start_to_close_timeout
+    #   @return [Float, nil] Start to close timeout set by the caller.
+    # @!attribute started_time
+    #   @return [Time] When the activity started.
+    # @!attribute task_queue
+    #   @return [String] Task queue this activity is on.
+    # @!attribute task_token
+    #   @return [String] Task token uniquely identifying this activity. Note, this is a `ASCII-8BIT` encoded string, not
+    #     a `UTF-8` encoded string nor a valid UTF-8 string.
+    # @!attribute workflow_id
+    #   @return [String] Workflow ID that started this activity.
+    # @!attribute workflow_namespace
+    #   @return [String] Namespace this activity is on.
+    # @!attribute workflow_run_id
+    #   @return [String] Workflow run ID that started this activity.
+    # @!attribute workflow_type
+    #   @return [String] Workflow type name that started this activity.
+    #
+    # @note WARNING: This class may have required parameters added to its constructor. Users should not instantiate this
+    #   class or it may break in incompatible ways.
+    class Info; end # rubocop:disable Lint/EmptyClass
+  end
+end

data/lib/temporalio/activity.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'temporalio/activity/cancellation_details'
+require 'temporalio/activity/complete_async_error'
+require 'temporalio/activity/context'
+require 'temporalio/activity/definition'
+require 'temporalio/activity/info'
+require 'temporalio/priority'
+
+module Temporalio
+  # All activity related classes.
+  module Activity
+  end
+end

data/lib/temporalio/api/activity/v1/message.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: temporal/api/activity/v1/message.proto
+
+require 'google/protobuf'
+
+require 'temporalio/api/common/v1/message'
+require 'temporalio/api/taskqueue/v1/message'
+require 'google/protobuf/duration_pb'
+
+
+descriptor_data = "\n&temporal/api/activity/v1/message.proto\x12\x18temporal.api.activity.v1\x1a$temporal/api/common/v1/message.proto\x1a\'temporal/api/taskqueue/v1/message.proto\x1a\x1egoogle/protobuf/duration.proto\"\xf3\x02\n\x0f\x41\x63tivityOptions\x12\x38\n\ntask_queue\x18\x01 \x01(\x0b\x32$.temporal.api.taskqueue.v1.TaskQueue\x12<\n\x19schedule_to_close_timeout\x18\x02 \x01(\x0b\x32\x19.google.protobuf.Duration\x12<\n\x19schedule_to_start_timeout\x18\x03 \x01(\x0b\x32\x19.google.protobuf.Duration\x12\x39\n\x16start_to_close_timeout\x18\x04 \x01(\x0b\x32\x19.google.protobuf.Duration\x12\x34\n\x11heartbeat_timeout\x18\x05 \x01(\x0b\x32\x19.google.protobuf.Duration\x12\x39\n\x0cretry_policy\x18\x06 \x01(\x0b\x32#.temporal.api.common.v1.RetryPolicyB\x93\x01\n\x1bio.temporal.api.activity.v1B\x0cMessageProtoP\x01Z\'go.temporal.io/api/activity/v1;activity\xaa\x02\x1aTemporalio.Api.Activity.V1\xea\x02\x1dTemporalio::Api::Activity::V1b\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Temporalio
+  module Api
+    module Activity
+      module V1
+        ActivityOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.activity.v1.ActivityOptions").msgclass
+      end
+    end
+  end
+end