temporal-ruby 0.0.1.pre.pre1 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42114cc4bbe2bc250e8c8e5dd5cfef7701fc48ea5b18eb1be4581dc8d8aa1a62
-  data.tar.gz: 4824e86f5440afe08de9d15fb7462eef948bef48696d85fca0fd5714cc117d9e
+  metadata.gz: 53787ddd1790dc6c6351b5a7dc28097945f84b254064f28e70f992a55d71c24c
+  data.tar.gz: b29c289da477adf979d9aad49c37304c25be3b837f428f21928c6eb0b722488c
 SHA512:
-  metadata.gz: 2a8a04ab82160833c6d0ebe0dc7cd8601341821aa1ab8124ccfc5cae854c275868d32765ad5c0c8563d70e72b2d36110c8f61addf44e75899826b57f9123a05b
-  data.tar.gz: 30d8479367f29a687b203c5ecef4e6de1c32bb9263c2e91e6e822a93c7db3f418641e6095a8e4ef0e552ba3973caa6b016f864ea92802bc2189c47185a7e6fff
+  metadata.gz: 5cc0666de89e075656f11d02012de544fb996f2ac8f7d684a1907ff83b00015515ab764be6faf1302dff979415bfe8d734d4d6be2e9bc54343923a79a69fcd70
+  data.tar.gz: 6442f0fb3308c6dd99b1b1f879fd34512eb0d0a49d4965682e65c1649cfbbda88311b9719956f365fd4faebfca55367d7623f584cc32140f1d90a991062b9477

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'coveralls', require: false

data/README.md

@@ -1,4 +1,6 @@
-# Ruby worker for Temporal [Under Development]
+# Ruby worker for Temporal
+
+[![Coverage Status](https://coveralls.io/repos/github/coinbase/temporal-ruby/badge.svg?branch=master)](https://coveralls.io/github/coinbase/temporal-ruby?branch=master)
 
 <img src="./assets/temporal_logo.png" width="250" align="right" alt="Temporal" />
 
@@ -98,7 +100,7 @@ Temporal service handles all the persistence, fault tolerance and coordination o
 activities. To set it up locally, download and boot the Docker Compose file from the official repo:
 
 ```sh
-> curl -O https://raw.githubusercontent.com/temporalio/temporal/master/docker/docker-compose.yml
+> curl -O https://raw.githubusercontent.com/temporalio/docker-compose/main/docker-compose.yml
 
 > docker-compose up
 ```
@@ -166,7 +168,7 @@ Besides calling activities workflows can:
 
 - Use timers
 - Receive signals
-- Execute other (child) workflows [not yet implemented]
+- Execute other (child) workflows
 - Respond to queries [not yet implemented]
 
 
@@ -308,6 +310,24 @@ of precedence):
 3. Globally, when configuring your Temporal library via `Temporal.configure`
 
 
+## Periodic workflow execution
+
+In certain cases you might need a workflow that runs periodically using a cron schedule. This can be
+achieved using the `Temporal.schedule_workflow` API that take a periodic cron schedule as a second
+argument:
+
+```ruby
+Temporal.schedule_workflow(HealthCheckWorkflow, '*/5 * * * *')
+```
+
+This will instruct Temporal to run a HealthCheckWorkflow every 5 minutes. All the rest of the
+arguments are identical to the `Temporal.start_workflow` API.
+
+*NOTE: Your execution timeout will be measured across all the workflow invocations, so make sure to
+set it to allow as many invocations as you need. You can also set it to `nil`, which will use a
+default value of 10 years.*
+
+
 ## Breaking Changes
 
 Since the workflow execution has to be deterministic, breaking changes can not be simply added and

data/lib/gen/temporal/api/command/v1/message_pb.rb

@@ -124,7 +124,7 @@ end
 
 module Temporal
   module Api
-    module Decision
+    module Command
       module V1
         ScheduleActivityTaskCommandAttributes = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.command.v1.ScheduleActivityTaskCommandAttributes").msgclass
         RequestCancelActivityTaskCommandAttributes = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.command.v1.RequestCancelActivityTaskCommandAttributes").msgclass

data/lib/gen/temporal/api/enums/v1/common_pb.rb

@@ -19,6 +19,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :INDEXED_VALUE_TYPE_BOOL, 5
       value :INDEXED_VALUE_TYPE_DATETIME, 6
     end
+    add_enum "temporal.api.enums.v1.Severity" do
+      value :SEVERITY_UNSPECIFIED, 0
+      value :SEVERITY_HIGH, 1
+      value :SEVERITY_MEDIUM, 2
+      value :SEVERITY_LOW, 3
+    end
   end
 end
 
@@ -28,6 +34,7 @@ module Temporal
       module V1
         EncodingType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.enums.v1.EncodingType").enummodule
         IndexedValueType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.enums.v1.IndexedValueType").enummodule
+        Severity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.enums.v1.Severity").enummodule
       end
     end
   end

data/lib/gen/temporal/api/errordetails/v1/message_pb.rb

@@ -20,13 +20,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "temporal.api.errordetails.v1.ClientVersionNotSupportedFailure" do
       optional :client_version, :string, 1
-      optional :client_impl, :string, 2
+      optional :client_name, :string, 2
       optional :supported_versions, :string, 3
     end
-    add_message "temporal.api.errordetails.v1.FeatureVersionNotSupportedFailure" do
-      optional :feature, :string, 1
-      optional :feature_version, :string, 2
-      optional :supported_versions, :string, 3
+    add_message "temporal.api.errordetails.v1.ServerVersionNotSupportedFailure" do
+      optional :server_version, :string, 1
+      optional :client_supported_server_versions, :string, 2
     end
     add_message "temporal.api.errordetails.v1.NamespaceAlreadyExistsFailure" do
     end
@@ -45,7 +44,7 @@ module Temporal
         WorkflowExecutionAlreadyStartedFailure = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.errordetails.v1.WorkflowExecutionAlreadyStartedFailure").msgclass
         NamespaceNotActiveFailure = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.errordetails.v1.NamespaceNotActiveFailure").msgclass
         ClientVersionNotSupportedFailure = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.errordetails.v1.ClientVersionNotSupportedFailure").msgclass
-        FeatureVersionNotSupportedFailure = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.errordetails.v1.FeatureVersionNotSupportedFailure").msgclass
+        ServerVersionNotSupportedFailure = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.errordetails.v1.ServerVersionNotSupportedFailure").msgclass
         NamespaceAlreadyExistsFailure = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.errordetails.v1.NamespaceAlreadyExistsFailure").msgclass
         CancellationAlreadyRequestedFailure = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.errordetails.v1.CancellationAlreadyRequestedFailure").msgclass
         QueryFailedFailure = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.errordetails.v1.QueryFailedFailure").msgclass

data/lib/gen/temporal/api/version/v1/message_pb.rb

@@ -3,15 +3,25 @@
 
 require 'google/protobuf'
 
+require 'google/protobuf/timestamp_pb'
+require 'temporal/api/enums/v1/common_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("temporal/api/version/v1/message.proto", :syntax => :proto3) do
-    add_message "temporal.api.version.v1.SupportedSDKVersions" do
-      optional :go_sdk, :string, 1
-      optional :java_sdk, :string, 2
+    add_message "temporal.api.version.v1.ReleaseInfo" do
+      optional :version, :string, 1
+      optional :release_time, :message, 2, "google.protobuf.Timestamp"
+      optional :notes, :string, 3
     end
-    add_message "temporal.api.version.v1.WorkerVersionInfo" do
-      optional :implementation, :string, 1
-      optional :feature_version, :string, 2
+    add_message "temporal.api.version.v1.Alert" do
+      optional :message, :string, 1
+      optional :severity, :enum, 2, "temporal.api.enums.v1.Severity"
+    end
+    add_message "temporal.api.version.v1.VersionInfo" do
+      optional :current, :message, 1, "temporal.api.version.v1.ReleaseInfo"
+      optional :recommended, :message, 2, "temporal.api.version.v1.ReleaseInfo"
+      optional :instructions, :string, 3
+      repeated :alerts, :message, 4, "temporal.api.version.v1.Alert"
+      optional :last_update_time, :message, 5, "google.protobuf.Timestamp"
     end
   end
 end
@@ -20,8 +30,9 @@ module Temporal
   module Api
     module Version
       module V1
-        SupportedSDKVersions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.version.v1.SupportedSDKVersions").msgclass
-        WorkerVersionInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.version.v1.WorkerVersionInfo").msgclass
+        ReleaseInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.version.v1.ReleaseInfo").msgclass
+        Alert = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.version.v1.Alert").msgclass
+        VersionInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.version.v1.VersionInfo").msgclass
       end
     end
   end

data/lib/gen/temporal/api/workflowservice/v1/request_response_pb.rb

@@ -3,8 +3,6 @@
 
 require 'google/protobuf'
 
-require 'google/protobuf/duration_pb'
-require 'google/protobuf/timestamp_pb'
 require 'temporal/api/enums/v1/workflow_pb'
 require 'temporal/api/enums/v1/namespace_pb'
 require 'temporal/api/enums/v1/failed_cause_pb'
@@ -22,10 +20,12 @@ require 'temporal/api/query/v1/message_pb'
 require 'temporal/api/replication/v1/message_pb'
 require 'temporal/api/taskqueue/v1/message_pb'
 require 'temporal/api/version/v1/message_pb'
+require 'google/protobuf/duration_pb'
+require 'google/protobuf/timestamp_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("temporal/api/workflowservice/v1/request_response.proto", :syntax => :proto3) do
     add_message "temporal.api.workflowservice.v1.RegisterNamespaceRequest" do
-      optional :name, :string, 1
+      optional :namespace, :string, 1
       optional :description, :string, 2
       optional :owner_email, :string, 3
       optional :workflow_execution_retention_period, :message, 4, "google.protobuf.Duration"
@@ -50,7 +50,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :next_page_token, :bytes, 2
     end
     add_message "temporal.api.workflowservice.v1.DescribeNamespaceRequest" do
-      optional :name, :string, 1
+      optional :namespace, :string, 1
       optional :id, :string, 2
     end
     add_message "temporal.api.workflowservice.v1.DescribeNamespaceResponse" do
@@ -61,7 +61,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :is_global_namespace, :bool, 5
     end
     add_message "temporal.api.workflowservice.v1.UpdateNamespaceRequest" do
-      optional :name, :string, 1
+      optional :namespace, :string, 1
       optional :update_info, :message, 2, "temporal.api.namespace.v1.UpdateNamespaceInfo"
       optional :config, :message, 3, "temporal.api.namespace.v1.NamespaceConfig"
       optional :replication_config, :message, 4, "temporal.api.replication.v1.NamespaceReplicationConfig"
@@ -76,7 +76,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :is_global_namespace, :bool, 5
     end
     add_message "temporal.api.workflowservice.v1.DeprecateNamespaceRequest" do
-      optional :name, :string, 1
+      optional :namespace, :string, 1
       optional :security_token, :string, 2
     end
     add_message "temporal.api.workflowservice.v1.DeprecateNamespaceResponse" do
@@ -148,6 +148,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :force_create_new_workflow_task, :bool, 6
       optional :binary_checksum, :string, 7
       map :query_results, :string, :message, 8, "temporal.api.query.v1.WorkflowQueryResult"
+      optional :namespace, :string, 9
     end
     add_message "temporal.api.workflowservice.v1.RespondWorkflowTaskCompletedResponse" do
       optional :workflow_task, :message, 1, "temporal.api.workflowservice.v1.PollWorkflowTaskQueueResponse"
@@ -158,6 +159,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :failure, :message, 3, "temporal.api.failure.v1.Failure"
       optional :identity, :string, 4
       optional :binary_checksum, :string, 5
+      optional :namespace, :string, 6
     end
     add_message "temporal.api.workflowservice.v1.RespondWorkflowTaskFailedResponse" do
     end
@@ -190,6 +192,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :task_token, :bytes, 1
       optional :details, :message, 2, "temporal.api.common.v1.Payloads"
       optional :identity, :string, 3
+      optional :namespace, :string, 4
     end
     add_message "temporal.api.workflowservice.v1.RecordActivityTaskHeartbeatResponse" do
       optional :cancel_requested, :bool, 1
@@ -209,6 +212,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :task_token, :bytes, 1
       optional :result, :message, 2, "temporal.api.common.v1.Payloads"
       optional :identity, :string, 3
+      optional :namespace, :string, 4
     end
     add_message "temporal.api.workflowservice.v1.RespondActivityTaskCompletedResponse" do
     end
@@ -226,6 +230,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :task_token, :bytes, 1
       optional :failure, :message, 2, "temporal.api.failure.v1.Failure"
       optional :identity, :string, 3
+      optional :namespace, :string, 4
     end
     add_message "temporal.api.workflowservice.v1.RespondActivityTaskFailedResponse" do
     end
@@ -243,6 +248,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :task_token, :bytes, 1
       optional :details, :message, 2, "temporal.api.common.v1.Payloads"
       optional :identity, :string, 3
+      optional :namespace, :string, 4
     end
     add_message "temporal.api.workflowservice.v1.RespondActivityTaskCanceledResponse" do
     end
@@ -396,7 +402,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :completed_type, :enum, 2, "temporal.api.enums.v1.QueryResultType"
       optional :query_result, :message, 3, "temporal.api.common.v1.Payloads"
       optional :error_message, :string, 4
-      optional :worker_version_info, :message, 5, "temporal.api.version.v1.WorkerVersionInfo"
+      optional :namespace, :string, 6
     end
     add_message "temporal.api.workflowservice.v1.RespondQueryTaskCompletedResponse" do
     end
@@ -439,7 +445,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "temporal.api.workflowservice.v1.GetClusterInfoRequest" do
     end
     add_message "temporal.api.workflowservice.v1.GetClusterInfoResponse" do
-      optional :supported_sdk_versions, :message, 1, "temporal.api.version.v1.SupportedSDKVersions"
+      map :supported_clients, :string, :string, 1
+      optional :server_version, :string, 2
+      optional :cluster_id, :string, 3
+      optional :version_info, :message, 4, "temporal.api.version.v1.VersionInfo"
+      optional :cluster_name, :string, 5
+      optional :history_shard_count, :int32, 6
     end
     add_message "temporal.api.workflowservice.v1.ListTaskQueuePartitionsRequest" do
       optional :namespace, :string, 1

data/lib/gen/temporal/api/workflowservice/v1/service_services_pb.rb

@@ -199,9 +199,6 @@ module Temporal
             # Things cleared are:
             # 1. StickyTaskQueue
             # 2. StickyScheduleToStartTimeout
-            # 3. ClientLibraryVersion
-            # 4. ClientFeatureVersion
-            # 5. ClientImpl
             rpc :ResetStickyTaskQueue, ::Temporal::Api::WorkflowService::V1::ResetStickyTaskQueueRequest, ::Temporal::Api::WorkflowService::V1::ResetStickyTaskQueueResponse
             # QueryWorkflow returns query result for a specified workflow execution
             rpc :QueryWorkflow, ::Temporal::Api::WorkflowService::V1::QueryWorkflowRequest, ::Temporal::Api::WorkflowService::V1::QueryWorkflowResponse

data/lib/temporal.rb

@@ -11,6 +11,9 @@ require 'temporal/workflow'
 require 'temporal/workflow/history'
 require 'temporal/workflow/execution_info'
 require 'temporal/metrics'
+require 'temporal/json'
+require 'temporal/errors'
+require 'temporal/workflow/errors'
 
 module Temporal
   class << self
@@ -28,6 +31,8 @@ module Temporal
         task_queue: execution_options.task_queue,
         input: input,
         execution_timeout: execution_options.timeouts[:execution],
+        # If unspecified, individual runs should have the full time for the execution (which includes retries).
+        run_timeout: execution_options.timeouts[:run] || execution_options.timeouts[:execution],
         task_timeout: execution_options.timeouts[:task],
         workflow_id_reuse_policy: options[:workflow_id_reuse_policy],
         headers: execution_options.headers
@@ -36,6 +41,33 @@ module Temporal
       response.run_id
     end
 
+    def schedule_workflow(workflow, cron_schedule, *input, **args)
+      options = args.delete(:options) || {}
+      input << args unless args.empty?
+
+      execution_options = ExecutionOptions.new(workflow, options)
+      workflow_id = options[:workflow_id] || SecureRandom.uuid
+
+      response = client.start_workflow_execution(
+        namespace: execution_options.namespace,
+        workflow_id: workflow_id,
+        workflow_name: execution_options.name,
+        task_queue: execution_options.task_queue,
+        input: input,
+        execution_timeout: execution_options.timeouts[:execution],
+        # Execution timeout is across all scheduled jobs, whereas run is for an individual run.
+        # This default is here for backward compatibility.  Certainly, the run timeout shouldn't be higher
+        # than the execution timeout.
+        run_timeout: execution_options.timeouts[:run] || execution_options.timeouts[:execution],
+        task_timeout: execution_options.timeouts[:task],
+        workflow_id_reuse_policy: options[:workflow_id_reuse_policy],
+        headers: execution_options.headers,
+        cron_schedule: cron_schedule
+      )
+
+      response.run_id
+    end
+
     def register_namespace(name, description = nil)
       client.register_namespace(name: name, description: description)
     end
@@ -52,6 +84,61 @@ module Temporal
       )
     end
 
+    # Long polls for a workflow to be completed and returns whatever the execute function
+    # returned.  This function times out after 30 seconds and throws Temporal::TimeoutError,
+    # not to be confused with Temporal::WorkflowTimedOut which reports that the workflow
+    # itself timed out.
+    # run_id of nil: await the entire workflow completion.  This can span multiple runs
+    # in the case where the workflow uses continue-as-new.
+    # timeout: seconds to wait for the result.  This cannot be longer than 30 seconds because
+    # that is the maximum the server supports.
+    # namespace: if nil, choose the one declared on the Workflow, or the global default
+    def await_workflow_result(workflow, workflow_id:, run_id: nil, timeout: nil, namespace: nil)
+      options = namespace ? {namespace: namespace} : {}
+      execution_options = ExecutionOptions.new(workflow, options)
+      max_timeout = Temporal::Client::GRPCClient::SERVER_MAX_GET_WORKFLOW_EXECUTION_HISTORY_POLL
+      history_response = nil
+      begin
+        history_response = client.get_workflow_execution_history(
+          namespace: execution_options.namespace,
+          workflow_id: workflow_id,
+          run_id: run_id,
+          wait_for_new_event: true,
+          event_type: :close,
+          timeout: timeout || max_timeout,
+        )
+      rescue GRPC::DeadlineExceeded => e
+        message = if timeout 
+          "Timed out after your specified limit of timeout: #{timeout} seconds"
+        else
+          "Timed out after #{max_timeout} seconds, which is the maximum supported amount."
+        end
+        raise TimeoutError.new(message)
+      end
+      history = Workflow::History.new(history_response.history.events)
+      closed_event = history.events.first
+      case closed_event.type
+      when 'WORKFLOW_EXECUTION_COMPLETED'
+        payloads = closed_event.attributes.result
+        return ResultConverter.from_result_payloads(payloads)
+      when 'WORKFLOW_EXECUTION_TIMED_OUT'
+        raise Temporal::WorkflowTimedOut
+      when 'WORKFLOW_EXECUTION_TERMINATED'
+        raise Temporal::WorkflowTerminated
+      when 'WORKFLOW_EXECUTION_CANCELED'
+        raise Temporal::WorkflowCanceled
+      when 'WORKFLOW_EXECUTION_FAILED'
+        raise Temporal::Workflow::Errors.generate_error(closed_event.attributes.failure)
+      when 'WORKFLOW_EXECUTION_CONTINUED_AS_NEW'
+        new_run_id = closed_event.attributes.new_execution_run_id
+        # Throw to let the caller know they're not getting the result
+        # they wanted.  They can re-call with the new run_id to poll.
+        raise Temporal::WorkflowRunContinuedAsNew.new(new_run_id: new_run_id)
+      else
+        raise NotImplementedError, "Unexpected event type #{closed_event.type}."
+      end
+    end
+
     def reset_workflow(namespace, workflow_id, run_id, workflow_task_id: nil, reason: 'manual reset')
       workflow_task_id ||= get_last_completed_workflow_task_id(namespace, workflow_id, run_id)
       raise Error, 'Could not find a completed workflow task event' unless workflow_task_id
@@ -67,6 +154,18 @@ module Temporal
       response.run_id
     end
 
+    def terminate_workflow(workflow_id, namespace: nil, run_id: nil, reason: nil, details: nil)
+      namespace ||= Temporal.configuration.namespace
+
+      client.terminate_workflow_execution(
+        namespace: namespace,
+        workflow_id: workflow_id,
+        run_id: run_id,
+        reason: reason,
+        details: details
+      )
+    end
+
     def fetch_workflow_execution_info(namespace, workflow_id, run_id)
       response = client.describe_workflow_execution(
         namespace: namespace,
@@ -117,6 +216,11 @@ module Temporal
       @metrics ||= Metrics.new(configuration.metrics_adapter)
     end
 
+    class ResultConverter
+      extend Concerns::Payloads
+    end
+    private_constant :ResultConverter
+
     private
 
     def client

data/lib/temporal/activity/context.rb

@@ -31,10 +31,14 @@ module Temporal
       end
 
       def heartbeat(details = nil)
-        logger.debug('Activity heartbeat')
+        logger.debug("Activity heartbeat", metadata.to_h)
         client.record_activity_task_heartbeat(task_token: task_token, details: details)
       end
 
+      def heartbeat_details
+        metadata.heartbeat_details
+      end
+
       def logger
         Temporal.logger
       end