Module: Trailblazer::Operation::PublicCall

Included in:
Trailblazer::Operation
Defined in:
lib/trailblazer/operation/public_call.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.options_for_public_call(options, flow_options = {}) ⇒ Object

Compile a Context object to be passed into the Activity::call.



68
69
70
 
# File 'lib/trailblazer/operation/public_call.rb', line 68

def self.options_for_public_call(options, flow_options = {})
  Trailblazer::Context(options, {}, flow_options[:context_options])
end

Instance Method Details

#call(options = {}, flow_options = {}, **circuit_options) ⇒ Object

Note:

Do not override this method as it will be removed in future versions. Also, you will break tracing.

This is the outer-most public ‘call` method that gets invoked when calling `Create.()`. The signature of this is `params, options, *containers`. This was a mistake, as the first argument could’ve been part of ‘options` hash in the first place.

Create.(params, runtime_data, *containers)

#=> Result<Context...>

In workflows/Nested compositions, this method is not used anymore and it might probably get removed in future versions of TRB. Currently, we use Operation::__call__ as an alternative.

Returns:

  • Operation::Railway::Result binary result object



16
17
18
19
20
 
# File 'lib/trailblazer/operation/public_call.rb', line 16

def call(options = {}, flow_options = {}, **circuit_options)
  return call_with_circuit_interface(options, **circuit_options) if options.is_a?(Array) # This is kind of a hack that could be well hidden if Ruby had method overloading. Goal is to simplify the call/__call__ thing as we're fading out Operation::call anyway.

  call_with_public_interface(options, flow_options, **circuit_options)
end

#call_with_circuit_interface(args, **circuit_options) ⇒ signal, [ctx, flow_options]

This interface is used for all nested OPs (and the outer-most, too).

Parameters:

  • args (Array) —

    • Contains [ctx, flow_options]

  • circuit_options (Hash) —

    • Options to configure activity circuit

Returns:

  • (signal, [ctx, flow_options]) 


58
59
60
 
# File 'lib/trailblazer/operation/public_call.rb', line 58

def call_with_circuit_interface(args, **circuit_options)
  strategy_call(args, **circuit_options) # FastTrack#call
end

#call_with_flow_options(options, flow_options) ⇒ Object

TODO: remove when we stop supporting < 3.0.



78
79
80
81
 
# File 'lib/trailblazer/operation/public_call.rb', line 78

def call_with_flow_options(options, flow_options)
  raise "[Trailblazer] `Operation.call_with_flow_options is deprecated in Ruby 3.0. Use `Operation.(options, flow_options)`" if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.0.0")
  call_with_public_interface(options, flow_options, {invoke_class: Activity::TaskWrap})
end

#call_with_public_interface(options, flow_options, invoke_class: Activity::TaskWrap, **circuit_options) ⇒ Operation::Railway::Result

Default @activity call interface which doesn’t accept circuit_options

Parameters:

  • args (Array) —

    > [ctx, flow_options]

Returns:



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/trailblazer/operation/public_call.rb', line 29

def call_with_public_interface(options, flow_options, invoke_class: Activity::TaskWrap, **circuit_options)
  flow_options  = flow_options_for_public_call(flow_options)

  # In Ruby < 3, calling Op.(params: {}, "current_user" => user) results in both {circuit_options} and {options} containing variables.
  # In Ruby 3.0, **circuit_options is always empty.
  options       = circuit_options.any? ? circuit_options.merge(options) : options

  ctx           = options_for_public_call(options, flow_options)

  # call the activity.
  # This will result in invoking {::call_with_circuit_interface}.
  signal, (ctx, flow_options) = invoke_class.invoke(
    self,
    [ctx, flow_options],
    exec_context: new
  )

  # Result is successful if the activity ended with an End event derived from Railway::End::Success.
  Operation::Railway::Result(signal, ctx, flow_options)
end

#flow_options_for_public_call(options = {}) ⇒ Object

@semi=public



73
74
75
 
# File 'lib/trailblazer/operation/public_call.rb', line 73

def flow_options_for_public_call(options = {})
  options
end

#options_for_public_call(*args) ⇒ Object 



62
63
64
 
# File 'lib/trailblazer/operation/public_call.rb', line 62

def options_for_public_call(*args)
  Operation::PublicCall.options_for_public_call(*args)
end