temporalio 0.1.1 → 0.2.0

data/Rakefile

@@ -0,0 +1,387 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/BlockLength, 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
+    raise unless statement.last.file.start_with?('lib/temporalio/api/') ||
+                 statement.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'] }
+
+require 'fileutils'
+require 'google/protobuf'
+
+namespace :proto do
+  desc 'Generate API and Core protobufs'
+  task :generate do
+    # Remove all existing
+    FileUtils.rm_rf('lib/temporalio/api')
+
+    def generate_protos(api_protos)
+      # Generate API to temp dir and move
+      FileUtils.rm_rf('tmp-proto')
+      FileUtils.mkdir_p('tmp-proto')
+      sh 'bundle exec grpc_tools_ruby_protoc ' \
+         '--proto_path=ext/sdk-core/sdk-core-protos/protos/api_upstream ' \
+         '--proto_path=ext/sdk-core/sdk-core-protos/protos/api_cloud_upstream ' \
+         '--proto_path=ext/additional_protos ' \
+         '--ruby_out=tmp-proto ' \
+         "#{api_protos.join(' ')}"
+
+      # Walk all generated Ruby files and cleanup content and filename
+      Dir.glob('tmp-proto/temporal/api/**/*.rb') do |path|
+        # Fix up the import
+        content = File.read(path)
+        content.gsub!(%r{^require 'temporal/(.*)_pb'$}, "require 'temporalio/\\1'")
+        File.write(path, content)
+
+        # Remove _pb from the filename
+        FileUtils.mv(path, path.sub('_pb', ''))
+      end
+
+      # Move from temp dir and remove temp dir
+      FileUtils.cp_r('tmp-proto/temporal/api', 'lib/temporalio')
+      FileUtils.rm_rf('tmp-proto')
+    end
+
+    # Generate from API with Google ones removed
+    generate_protos(Dir.glob('ext/sdk-core/sdk-core-protos/protos/api_upstream/**/*.proto').reject do |proto|
+      proto.include?('google')
+    end)
+
+    # Generate from Cloud API
+    generate_protos(Dir.glob('ext/sdk-core/sdk-core-protos/protos/api_cloud_upstream/**/*.proto'))
+
+    # Generate additional protos
+    generate_protos(Dir.glob('ext/additional_protos/**/*.proto'))
+
+    # Write files that will help with imports. We are requiring the
+    # request_response and not the service because the service depends on Google
+    # API annotations we don't want to have to depend on.
+    File.write(
+      'lib/temporalio/api/cloud/cloudservice.rb',
+      <<~TEXT
+        # frozen_string_literal: true
+
+        require 'temporalio/api/cloud/cloudservice/v1/request_response'
+      TEXT
+    )
+    File.write(
+      'lib/temporalio/api/workflowservice.rb',
+      <<~TEXT
+        # frozen_string_literal: true
+
+        require 'temporalio/api/workflowservice/v1/request_response'
+      TEXT
+    )
+    File.write(
+      'lib/temporalio/api/operatorservice.rb',
+      <<~TEXT
+        # frozen_string_literal: true
+
+        require 'temporalio/api/operatorservice/v1/request_response'
+      TEXT
+    )
+    File.write(
+      'lib/temporalio/api.rb',
+      <<~TEXT
+        # frozen_string_literal: true
+
+        require 'temporalio/api/cloud/cloudservice'
+        require 'temporalio/api/common/v1/grpc_status'
+        require 'temporalio/api/errordetails/v1/message'
+        require 'temporalio/api/operatorservice'
+        require 'temporalio/api/workflowservice'
+
+        module Temporalio
+          # Raw protocol buffer models.
+          module Api
+          end
+        end
+      TEXT
+    )
+
+    # Write the service classes that have the RPC calls
+    def write_service_file(qualified_service_name:, file_name:, class_name:, service_enum:)
+      # Do service lookup
+      desc = Google::Protobuf::DescriptorPool.generated_pool.lookup(qualified_service_name)
+      raise 'Failed finding service descriptor' unless desc
+
+      # Open file to generate Ruby code
+      File.open("lib/temporalio/client/connection/#{file_name}.rb", 'w') do |file|
+        file.puts <<~TEXT
+          # frozen_string_literal: true
+
+          # Generated code.  DO NOT EDIT!
+
+          require 'temporalio/api'
+          require 'temporalio/client/connection/service'
+          require 'temporalio/internal/bridge/client'
+
+          module Temporalio
+            class Client
+              class Connection
+                # #{class_name} API.
+                class #{class_name} < Service
+                  # @!visibility private
+                  def initialize(connection)
+                    super(connection, Internal::Bridge::Client::#{service_enum})
+                  end
+        TEXT
+
+        desc.each do |method|
+          # Camel case to snake case
+          rpc = method.name.gsub(/([A-Z])/, '_\1').downcase.delete_prefix('_')
+          file.puts <<-TEXT
+
+        # Calls #{class_name}.#{method.name} API call.
+        #
+        # @param request [#{method.input_type.msgclass}] API request.
+        # @param rpc_retry [Boolean] Whether to implicitly retry known retryable errors.
+        # @param rpc_metadata [Hash<String, String>, nil] Headers to include on the RPC call.
+        # @param rpc_timeout [Float, nil] Number of seconds before timeout.
+        # @return [#{method.output_type.msgclass}] API response.
+        def #{rpc}(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil)
+          invoke_rpc(
+            rpc: '#{rpc}',
+            request_class: #{method.input_type.msgclass},
+            response_class: #{method.output_type.msgclass},
+            request:,
+            rpc_retry:,
+            rpc_metadata:,
+            rpc_timeout:
+          )
+        end
+          TEXT
+        end
+
+        file.puts <<~TEXT
+                end
+              end
+            end
+          end
+        TEXT
+      end
+
+      # Open file to generate RBS code
+      # TODO(cretz): Improve this when RBS proto is supported
+      File.open("sig/temporalio/client/connection/#{file_name}.rbs", 'w') do |file|
+        file.puts <<~TEXT
+          # Generated code.  DO NOT EDIT!
+
+          module Temporalio
+            class Client
+              class Connection
+                class #{class_name} < Service
+                  def initialize: (Connection) -> void
+        TEXT
+
+        desc.each do |method|
+          # Camel case to snake case
+          rpc = method.name.gsub(/([A-Z])/, '_\1').downcase.delete_prefix('_')
+          file.puts <<-TEXT
+        def #{rpc}: (untyped request, ?rpc_retry: bool, ?rpc_metadata: Hash[String, String]?, ?rpc_timeout: Float?) -> untyped
+          TEXT
+        end
+
+        file.puts <<~TEXT
+                end
+              end
+            end
+          end
+        TEXT
+      end
+    end
+
+    require './lib/temporalio/api/workflowservice/v1/service'
+    write_service_file(
+      qualified_service_name: 'temporal.api.workflowservice.v1.WorkflowService',
+      file_name: 'workflow_service',
+      class_name: 'WorkflowService',
+      service_enum: 'SERVICE_WORKFLOW'
+    )
+    require './lib/temporalio/api/operatorservice/v1/service'
+    write_service_file(
+      qualified_service_name: 'temporal.api.operatorservice.v1.OperatorService',
+      file_name: 'operator_service',
+      class_name: 'OperatorService',
+      service_enum: 'SERVICE_OPERATOR'
+    )
+    require './lib/temporalio/api/cloud/cloudservice/v1/service'
+    write_service_file(
+      qualified_service_name: 'temporal.api.cloud.cloudservice.v1.CloudService',
+      file_name: 'cloud_service',
+      class_name: 'CloudService',
+      service_enum: 'SERVICE_CLOUD'
+    )
+
+    # Generate Rust code
+    def generate_rust_match_arm(file:, qualified_service_name:, service_enum:, trait:)
+      # Do service lookup
+      desc = Google::Protobuf::DescriptorPool.generated_pool.lookup(qualified_service_name)
+      file.puts <<~TEXT
+        #{service_enum} => match call.rpc.as_str() {
+      TEXT
+
+      desc.to_a.sort_by(&:name).each do |method|
+        # Camel case to snake case
+        rpc = method.name.gsub(/([A-Z])/, '_\1').downcase.delete_prefix('_')
+        file.puts <<~TEXT
+          "#{rpc}" => rpc_call!(self, callback, call, #{trait}, #{rpc}),
+        TEXT
+      end
+      file.puts <<~TEXT
+          _ => Err(error!("Unknown RPC call {}", call.rpc)),
+        },
+      TEXT
+    end
+    File.open('ext/src/client_rpc_generated.rs', 'w') do |file|
+      file.puts <<~TEXT
+        // Generated code.  DO NOT EDIT!
+
+        use magnus::{Error, Ruby};
+        use temporal_client::{CloudService, OperatorService, WorkflowService};
+
+        use super::{error, rpc_call};
+        use crate::{
+            client::{Client, RpcCall, SERVICE_CLOUD, SERVICE_OPERATOR, SERVICE_WORKFLOW},
+            util::AsyncCallback,
+        };
+
+        impl Client {
+            pub fn invoke_rpc(&self, service: u8, callback: AsyncCallback, call: RpcCall) -> Result<(), Error> {
+                match service {
+      TEXT
+      generate_rust_match_arm(
+        file:,
+        qualified_service_name: 'temporal.api.workflowservice.v1.WorkflowService',
+        service_enum: 'SERVICE_WORKFLOW',
+        trait: 'WorkflowService'
+      )
+      generate_rust_match_arm(
+        file:,
+        qualified_service_name: 'temporal.api.operatorservice.v1.OperatorService',
+        service_enum: 'SERVICE_OPERATOR',
+        trait: 'OperatorService'
+      )
+      generate_rust_match_arm(
+        file:,
+        qualified_service_name: 'temporal.api.cloud.cloudservice.v1.CloudService',
+        service_enum: 'SERVICE_CLOUD',
+        trait: 'CloudService'
+      )
+      file.puts <<~TEXT
+                    _ => Err(error!("Unknown service")),
+                }
+            }
+        }
+      TEXT
+    end
+    sh 'cargo', 'fmt', '--', 'ext/src/client_rpc_generated.rs'
+
+    # Generate core protos
+    FileUtils.rm_rf('lib/temporalio/internal/bridge/api')
+    # Generate API to temp dir
+    FileUtils.rm_rf('tmp-proto')
+    FileUtils.mkdir_p('tmp-proto')
+    sh 'bundle exec grpc_tools_ruby_protoc ' \
+       '--proto_path=ext/sdk-core/sdk-core-protos/protos/api_upstream ' \
+       '--proto_path=ext/sdk-core/sdk-core-protos/protos/local ' \
+       '--ruby_out=tmp-proto ' \
+       "#{Dir.glob('ext/sdk-core/sdk-core-protos/protos/local/**/*.proto').join(' ')}"
+    # Walk all generated Ruby files and cleanup content and filename
+    Dir.glob('tmp-proto/temporal/sdk/**/*.rb') do |path|
+      # Fix up the imports
+      content = File.read(path)
+      content.gsub!(%r{^require 'temporal/(.*)_pb'$}, "require 'temporalio/\\1'")
+      content.gsub!(%r{^require 'temporalio/sdk/core/(.*)'$}, "require 'temporalio/internal/bridge/api/\\1'")
+      File.write(path, content)
+
+      # Remove _pb from the filename
+      FileUtils.mv(path, path.sub('_pb', ''))
+    end
+    # Move from temp dir and remove temp dir
+    FileUtils.mkdir_p('lib/temporalio/internal/bridge/api')
+    FileUtils.cp_r(Dir.glob('tmp-proto/temporal/sdk/core/*'), 'lib/temporalio/internal/bridge/api')
+    FileUtils.rm_rf('tmp-proto')
+  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'
+  sh 'cargo', 'fmt', '--check'
+end
+
+task default: ['rubocop', 'yard', 'rbs:install_collection', 'steep', 'rust_lint', 'compile', 'test']

data/ext/Cargo.toml

@@ -0,0 +1,25 @@
+[package]
+name = "temporalio_bridge"
+version = "0.1.0"
+edition = "2021"
+authors = ["Chad Retz <chad@temporal.io>"]
+license = "MIT"
+publish = false
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+futures = "0.3"
+magnus = "0.7"
+parking_lot = "0.12"
+prost = "0.13"
+rb-sys = "0.9"
+temporal-client = { version = "0.1.0", path = "./sdk-core/client" }
+temporal-sdk-core = { version = "0.1.0", path = "./sdk-core/core", features = ["ephemeral-server"] }
+temporal-sdk-core-api = { version = "0.1.0", path = "./sdk-core/core-api" }
+temporal-sdk-core-protos = { version = "0.1.0", path = "./sdk-core/sdk-core-protos" }
+tokio = "1.26"
+tonic = "0.12"
+tracing = "0.1"
+url = "2.2"

data/lib/temporalio/activity/complete_async_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'temporalio/error'
+
+module Temporalio
+  class 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

@@ -1,102 +1,107 @@
-require 'temporalio/error/failure'
-require 'temporalio/errors'
+# frozen_string_literal: true
+
+require 'temporalio/error'
 
 module Temporalio
   class Activity
-    # This class provides methods that can be called from activity classes.
+    # 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
-      # @api private
-      def initialize(info, heartbeat_proc, interceptors, shielded: false)
-        @thread = Thread.current
-        @info = info
-        @heartbeat_proc = heartbeat_proc
-        @interceptors = interceptors
-        @pending_cancellation = nil
-        @shielded = shielded
-        @mutex = Mutex.new
+      # @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
 
-      # Information about the running activity.
-      #
-      # @return [Temporalio::Activity::Info]
-      def info
-        interceptors.invoke(:activity_info) { @info }
+      # @return [Context, nil] The current context or nil if not in activity fiber/thread.
+      def self.current_or_nil
+        _current_executor&.activity_context
       end
 
-      # Send a heartbeat for the current activity.
-      #
-      # @param details [Array<any>] Data to store with the heartbeat.
-      def heartbeat(*details)
-        interceptors.invoke(:heartbeat, *details) do |*d|
-          @heartbeat_proc.call(*d)
-        end
+      # @return [Boolean] Whether there is a current context available.
+      def self.exist?
+        !current_or_nil.nil?
       end
 
-      # Protect a part of activity's implementation from cancellations.
-      #
-      # Activity cancellations are implemented using the `Thread#raise`, which can unsafely
-      # terminate your implementation. To disable this behaviour make sure to wrap critical parts of
-      # your business logic in this method.
-      #
-      # For shielding a whole activity consider using {Temporalio::Activity.shielded!}.
-      #
-      # A cancellation that got requested while in a shielded block will not interrupt the execution
-      # and will raise a {Temporalio::Error::CancelledError} right after the block has finished.
-      #
-      # @yield Block to be protected from cancellations.
-      def shield(&block)
-        # The whole activity is shielded, called from a nested shield
-        #   or while handling a CancelledError (in a rescue or ensure blocks)
-        return block.call if @shielded || cancelled?
-
-        if Thread.current != thread
-          # TODO: Use logger instead when implemented
-          warn "Activity shielding is not intended to be used outside of activity's thread."
-          return block.call
+      # @!visibility private
+      def self._current_executor
+        if Fiber.current_scheduler
+          Fiber[:temporal_activity_executor]
+        else
+          Thread.current[:temporal_activity_executor]
         end
+      end
 
-        mutex.synchronize do
-          @shielded = true
-          result = block.call
-          # RBS: StandardError fallback is only needed to satisfy steep - https://github.com/soutaro/steep/issues/477
-          raise @pending_cancellation || StandardError if cancelled?
-
-          result
-        ensure # runs while still holding the lock
-          @shielded = false
+      # @!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
 
-      # Whether a cancellation was ever requested on this activity.
-      #
-      # @return [Boolean] true if the activity has had a cancellation request, false otherwise.
-      def cancelled?
-        !!@pending_cancellation
+      # @return [Info] Activity info for this activity.
+      def info
+        raise NotImplementedError
       end
 
-      # Cancel the running activity by raising a provided error.
+      # Record a heartbeat on the activity.
       #
-      # @param reason [String] Reason for cancellation.
-      # @param by_request [Boolean] Cancellation requested by the server or not.
+      # 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.
       #
-      # @api private
-      def cancel(reason, by_request: false)
-        error = Temporalio::Error::ActivityCancelled.new(reason, by_request)
-        @pending_cancellation = error
-
-        locked = mutex.try_lock
-        # @shielded inside the lock means the whole activity is shielded
-        if locked && !@shielded
-          thread.raise(error)
-        end
-      ensure
-        # only release the lock if we locked it
-        mutex.unlock if locked
+      # @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 [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
 
-      private
+      # @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
 
-      attr_reader :thread, :interceptors, :mutex
+      # TODO(cretz): metric meter
     end
   end
 end

data/lib/temporalio/activity/definition.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Temporalio
+  class Activity
+    # Definition of an activity. Activities are usually classes/instances that extend {Activity}, but definitions can
+    # also be manually created with a proc/block.
+    class Definition
+      # @return [String, Symbol] Name of the activity.
+      attr_reader :name
+
+      # @return [Proc] Proc for the activity.
+      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
+
+      # Obtain a definition representing the given activity, which can be a class, instance, or definition.
+      #
+      # @param activity [Activity, Class<Activity>, Definition] Activity to get definition for.
+      # @return Definition Obtained definition.
+      def self.from_activity(activity)
+        # Class means create each time, instance means just call, definition
+        # does nothing special
+        case activity
+        when Class
+          raise ArgumentError, "Class '#{activity}' does not extend Activity" unless activity < Activity
+
+          details = activity._activity_definition_details
+          new(
+            name: details[:activity_name],
+            executor: details[:activity_executor],
+            cancel_raise: details[:activity_cancel_raise],
+            # Instantiate and call
+            proc: proc { |*args| activity.new.execute(*args) }
+          )
+        when Activity
+          details = activity.class._activity_definition_details
+          new(
+            name: details[:activity_name],
+            executor: details[:activity_executor],
+            cancel_raise: details[:activity_cancel_raise],
+            # Just call
+            proc: proc { |*args| activity.execute(*args) }
+          )
+        when Activity::Definition
+          activity
+        else
+          raise ArgumentError, "#{activity} is not an activity class, instance, or definition"
+        end
+      end
+
+      # Manually create activity definition. Most users will use an instance/class of {Activity}.
+      #
+      # @param name [String, Symbol] Name of the activity.
+      # @param proc [Proc, nil] Proc for the activity, or can give block.
+      # @param executor [Symbol] Name of the executor.
+      # @param cancel_raise [Boolean] Whether to raise in thread/fiber on cancellation.
+      # @yield Use this block as the activity. Cannot be present with `proc`.
+      def initialize(name:, proc: nil, executor: :default, cancel_raise: true, &block)
+        @name = name
+        if proc.nil?
+          raise ArgumentError, 'Must give proc or block' unless block_given?
+
+          proc = block
+        elsif block_given?
+          raise ArgumentError, 'Cannot give proc and block'
+        end
+        @proc = proc
+        @executor = executor
+        @cancel_raise = cancel_raise
+      end
+    end
+  end
+end