Class: Textus::Hooks::Bus

Inherits:
Object
  • Object
show all
Defined in:
lib/textus/hooks/bus.rb

Defined Under Namespace

Classes: HookTimeout

Constant Summary collapse

HOOK_TIMEOUT_SECONDS = 
2
EVENTS = 
{
  # RPC events — gem-internal, keep :store
  resolve_intake: { mode: :rpc, args: %i[store config args] },
  transform_rows: { mode: :rpc, args: %i[store rows config] },
  validate: { mode: :rpc, args: %i[store] },

  # Pubsub events — ship :ctx (Hooks::Context) instead of raw store
  entry_put: { mode: :pubsub, args: %i[ctx key envelope] },
  entry_deleted: { mode: :pubsub, args: %i[ctx key] },
  entry_refreshed: { mode: :pubsub, args: %i[ctx key envelope change] },
  entry_renamed: { mode: :pubsub, args: %i[ctx key from_key to_key envelope] },
  build_completed: { mode: :pubsub, args: %i[ctx key envelope sources] },
  proposal_accepted: { mode: :pubsub, args: %i[ctx key target_key] },
  proposal_rejected: { mode: :pubsub, args: %i[ctx key target_key] },
  file_published: { mode: :pubsub, args: %i[ctx key envelope source target] },
  store_loaded: { mode: :pubsub, args: %i[ctx] },
  refresh_started: { mode: :pubsub, args: %i[ctx key mode] },
  refresh_failed: { mode: :pubsub, args: %i[ctx key error_class error_message] },
  refresh_backgrounded: { mode: :pubsub, args: %i[ctx key started_at budget_ms] },
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Bus

Returns a new instance of Bus.



31
32
33
34
35
 
# File 'lib/textus/hooks/bus.rb', line 31

def initialize
  @rpc    = Hash.new { |h, k| h[k] = {} }
  @pubsub = Hash.new { |h, k| h[k] = [] }
  @error_handlers = []
end

Instance Method Details

#listeners(event, key:) ⇒ Object 



65
 
# File 'lib/textus/hooks/bus.rb', line 65

def listeners(event, key:)  = @pubsub[event.to_sym].select { |h| h[:keys].nil? || matches_any?(h[:keys], key) }

#on(event, name, keys: nil) ⇒ Object 



37
 
# File 'lib/textus/hooks/bus.rb', line 37

def on(event, name, keys: nil, &) = register(event, name, keys: keys, &)

#on_error(&block) ⇒ Object 



57
 
# File 'lib/textus/hooks/bus.rb', line 57

def on_error(&block) = @error_handlers << block

#publish(event, strict: false, **kwargs) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/textus/hooks/bus.rb', line 67

def publish(event, strict: false, **kwargs)
  key = kwargs[:key] || "-"
  fired = []
  errored = []
  timed_out = []
  raised = nil

  @pubsub[event.to_sym].each do |sub|
    next unless match?(sub[:keys], key)

    outcome, err = invoke(event, sub, key, kwargs)
    case outcome
    when :ok        then fired << sub[:name]
    when :errored   then errored << sub[:name]
    when :timed_out then timed_out << sub[:name]
    end
    raised ||= err if strict && err
  end

  raise raised if strict && raised

  FireReport.new(fired: fired, errored: errored, timed_out: timed_out)
end

#pubsub_handlers(event) ⇒ Object 



64
 
# File 'lib/textus/hooks/bus.rb', line 64

def pubsub_handlers(event)  = @pubsub[event.to_sym]

#register(event, name, keys: nil, &blk) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/textus/hooks/bus.rb', line 39

def register(event, name, keys: nil, &blk)
  event_sym = event.to_sym
  spec = EVENTS[event_sym] or raise UsageError.new("unknown event: #{event}")
  shape_check!(event_sym, spec, blk)
  name = name.to_sym

  case spec[:mode]
  when :rpc
    raise UsageError.new("#{event_sym} '#{name}' already registered") if @rpc[event_sym].key?(name)

    @rpc[event_sym][name] = blk
  when :pubsub
    raise UsageError.new("#{event_sym} hook '#{name}' already registered") if @pubsub[event_sym].any? { |h| h[:name] == name }

    @pubsub[event_sym] << { name: name, callable: blk, keys: keys }
  end
end

#rpc_callable(event, name) ⇒ Object 



59
60
61
 
# File 'lib/textus/hooks/bus.rb', line 59

def rpc_callable(event, name)
  @rpc[event.to_sym][name.to_sym] or raise UsageError.new("unknown #{event}: #{name}")
end

#rpc_names(event) ⇒ Object 



63
 
# File 'lib/textus/hooks/bus.rb', line 63

def rpc_names(event)        = @rpc[event.to_sym].keys