Review comments

Author: Sushisource

temporalio/lib/temporalio/activity.rb

@@ -4,6 +4,7 @@
 require 'temporalio/activity/context'
 require 'temporalio/activity/definition'
 require 'temporalio/activity/info'
+require 'temporalio/priority'
 
 module Temporalio
   # All activity related classes.

temporalio/lib/temporalio/activity/info.rb

@@ -40,7 +40,7 @@ module Activity
     # @!attribute local?
     #   @return [Boolean] Whether the activity is a local activity or not.
     # @!attribute priority
-    #   @return [Priority, nil] The priority of this activity.
+    #   @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

temporalio/lib/temporalio/client/interceptor.rb

@@ -37,8 +37,8 @@ def intercept_client(next_interceptor)
         :start_delay,
         :request_eager_start,
         :headers,
-        :priority,
         :versioning_override,
+        :priority,
         :rpc_options
       )
 

temporalio/lib/temporalio/internal/client/implementation.rb

@@ -70,7 +70,7 @@ def start_workflow(input)
               input.static_summary, input.static_details, @client.data_converter
             ),
             header: ProtoUtils.headers_to_proto(input.headers, @client.data_converter),
-            priority: input.priority&._to_proto,
+            priority: input.priority._to_proto,
             versioning_override: input.versioning_override&._to_proto
           )
 

temporalio/lib/temporalio/internal/worker/workflow_instance/outbound_implementation.rb

@@ -74,7 +74,7 @@ def execute_activity(input)
                     retry_policy: input.retry_policy&._to_proto,
                     cancellation_type: input.cancellation_type,
                     do_not_eagerly_execute: input.disable_eager_execution,
-                    priority: input.priority&._to_proto
+                    priority: input.priority._to_proto
                   ),
                   user_metadata: ProtoUtils.to_user_metadata(input.summary, nil, @instance.payload_converter)
                 )
@@ -339,7 +339,7 @@ def start_child_workflow(input)
                   memo: ProtoUtils.memo_to_proto_hash(input.memo, @instance.payload_converter),
                   search_attributes: input.search_attributes&._to_proto_hash,
                   cancellation_type: input.cancellation_type,
-                  priority: input.priority&._to_proto
+                  priority: input.priority._to_proto
                 ),
                 user_metadata: ProtoUtils.to_user_metadata(
                   input.static_summary, input.static_details, @instance.payload_converter

temporalio/lib/temporalio/priority.rb

@@ -3,6 +3,10 @@
 require 'temporalio/api'
 
 module Temporalio
+  Priority = Data.define(
+    :priority_key
+  )
+
   # Priority contains metadata that controls relative ordering of task processing when tasks are
   # backlogged in a queue. Initially, Priority will be used in activity and workflow task
   # queues, which are typically where backlogs exist. Priority is (for now) attached to
@@ -15,19 +19,17 @@ module Temporalio
   # The overall semantics of Priority are:
   # 1. First, consider "priority_key": lower number goes first.
   # (more will be added here later).
+  #
+  # @!attribute priority_key
+  #   @return [Integer, nil] The priority key, which is a positive integer from 1 to n, where
+  #     smaller integers correspond to higher priorities (tasks run sooner). In general, tasks in a
+  #     queue should be processed in close to priority order, although small deviations are possible.
+  #     The maximum priority value (minimum priority) is determined by server configuration, and
+  #     defaults to 5.
+  #
+  #     The default priority is (min+max)/2. With the default max of 5 and min of 1, that comes
+  #     out to 3.
   class Priority
-    # The priority key, which is a positive integer from 1 to n, where smaller integers
-    # correspond to higher priorities (tasks run sooner). In general, tasks in a queue should
-    # be processed in close to priority order, although small deviations are possible. The
-    # maximum priority value (minimum priority) is determined by server configuration, and
-    # defaults to 5.
-    #
-    # The default priority is (min+max)/2. With the default max of 5 and min of 1, that comes
-    # out to 3.
-    #
-    # @return [Integer, nil] The priority key
-    attr_reader :priority_key
-
     # @!visibility private
     def self._from_proto(priority)
       return default if priority.nil?
@@ -39,14 +41,7 @@ def self._from_proto(priority)
     #
     # @return [Priority] The default priority
     def self.default
-      @default ||= new
-    end
-
-    # Create a new Priority instance
-    #
-    # @param priority_key [Integer, nil] The priority key
-    def initialize(priority_key: nil)
-      @priority_key = priority_key
+      @default ||= new(priority_key: nil)
     end
 
     # @!visibility private

temporalio/lib/temporalio/workflow.rb

@@ -2,6 +2,7 @@
 
 require 'random/formatter'
 require 'temporalio/error'
+require 'temporalio/priority'
 require 'temporalio/workflow/activity_cancellation_type'
 require 'temporalio/workflow/child_workflow_cancellation_type'
 require 'temporalio/workflow/child_workflow_handle'

temporalio/lib/temporalio/workflow/info.rb

@@ -46,7 +46,7 @@ module Workflow
     # @!attribute parent
     #   @return [ParentInfo, nil] Parent information for the workflow if this is a child.
     # @!attribute priority
-    #   @return [Priority, nil] The priority of this workflow.
+    #   @return [Priority] The priority of this workflow.
     # @!attribute retry_policy
     #   @return [RetryPolicy, nil] Retry policy for the workflow.
     # @!attribute root