Class: Temporalio::Activity::Definition::Info

Inherits:
Object
  • Object
show all
Defined in:
lib/temporalio/activity/definition.rb

Overview

Definition info of an activity. Activities are usually classes/instances that extend Temporalio::Activity::Definition, but definitions can also be manually created with a block via #initialize here.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, instance: nil, executor: :default, cancel_raise: true, raw_args: false) { ... } ⇒ Info

Manually create activity definition info. Most users will use an instance/class of Temporalio::Activity::Definition.

Parameters:

  • name (String, Symbol, nil) —

    Name of the activity or nil for dynamic activity.

  • instance (Object, Proc, nil) (defaults to: nil) —

    The pre-created instance or the proc to create/return it.

  • executor (Symbol) (defaults to: :default) —

    Name of the executor.

  • cancel_raise (Boolean) (defaults to: true) —

    Whether to raise in thread/fiber on cancellation.

  • raw_args (Boolean) (defaults to: false) —

    Whether to use Converters::RawValues as arguments.

Yields:

  • Use this block as the activity.

Raises:

  • (ArgumentError) 


176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/temporalio/activity/definition.rb', line 176

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

Instance Attribute Details

#cancel_raise ⇒ Boolean (readonly)

Returns Whether to raise in thread/fiber on cancellation. Default is ‘true`.

Returns:

  • (Boolean) —

    Whether to raise in thread/fiber on cancellation. Default is ‘true`.



125
126
127
 
# File 'lib/temporalio/activity/definition.rb', line 125

def cancel_raise
  @cancel_raise
end

#executor ⇒ Symbol (readonly)

Returns Name of the executor. Default is ‘:default`.

Returns:

  • (Symbol) —

    Name of the executor. Default is ‘:default`.



122
123
124
 
# File 'lib/temporalio/activity/definition.rb', line 122

def executor
  @executor
end

#instance ⇒ Object, ... (readonly)

Returns The pre-created instance or the proc to create/return it.

Returns:

  • (Object, Proc, nil) —

    The pre-created instance or the proc to create/return it.



116
117
118
 
# File 'lib/temporalio/activity/definition.rb', line 116

def instance
  @instance
end

#name ⇒ String, ... (readonly)

Returns Name of the activity, or nil if the activity is dynamic.

Returns:

  • (String, Symbol, nil) —

    Name of the activity, or nil if the activity is dynamic.



113
114
115
 
# File 'lib/temporalio/activity/definition.rb', line 113

def name
  @name
end

#proc ⇒ Proc (readonly)

Returns Proc for the activity. Should use Context#instance to access the instance.

Returns:

  • (Proc) —

    Proc for the activity. Should use Context#instance to access the instance.



119
120
121
 
# File 'lib/temporalio/activity/definition.rb', line 119

def proc
  @proc
end

#raw_args ⇒ Boolean (readonly)

Returns Whether to use Converters::RawValues as arguments.

Returns:



128
129
130
 
# File 'lib/temporalio/activity/definition.rb', line 128

def raw_args
  @raw_args
end

Class Method Details

.from_activity(activity) ⇒ Object

Obtain definition info representing the given activity, which can be a class, instance, or definition info.

Parameters:

Returns:

  • Info Obtained definition info.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/temporalio/activity/definition.rb', line 134

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