Class: Flu::ActionControllerExtender

Inherits:
Object
  • Object
show all
Defined in:
lib/flu-rails/action_controller_extender.rb

Class Method Summary collapse

Class Method Details

.all_controller_types ⇒ Object 



93
94
95
96
 
# File 'lib/flu-rails/action_controller_extender.rb', line 93

def self.all_controller_types
  class_names = ["ActionController::Base", "ActionController::API"]
  class_names.select { |class_name| Object.const_defined?(class_name) }.map(&:constantize)
end

.extend_controllers(event_factory, event_publisher, logger) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
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/flu-rails/action_controller_extender.rb', line 10

def self.extend_controllers(event_factory, event_publisher, logger)
  all_controller_types.each do |controller_type|
    controller_type.class_eval do
      def self.flu_is_tracked=(is_tracked)
        @flu_is_tracked = is_tracked
      end

      def self.flu_is_tracked
        @flu_is_tracked || false
      end 

      define_singleton_method(:track_requests) do |options = {}|
        self.flu_is_tracked      = true
        user_metadata_lambda     = options[:user_metadata]
        entity_metadata_lambda   = options[:entity_metadata]
        ignored_request_params   = options.fetch(:ignored_request_params, []).map(&:to_sym)
        emitter_lambda           = options[:emitter]

        # These helpers are defined with 'define_method' rather than 'def' for two reasons. A bare
        # 'def' opens a new scope, so it captures neither 'logger' nor the tracking options: the
        # former silently resolved to ActionController::Base#logger, which ignored 'Flu.config.logger'
        # altogether. And its default definee is the class 'class_eval' was called on, so the helpers
        # landed on ActionController::Base itself, leaking onto every controller of the host
        # application. Here 'self' is the class calling 'track_requests', which is where they belong.
        define_method(:flu_define_request_id) do
          request_id      = Random.respond_to?(:uuid_v7) ? Random.uuid_v7 : SecureRandom.uuid
          @flu_request_id = request_id
          Flu::CoreExt.flu_tracker_request_id = request_id
        end

        define_method(:flu_remove_request_id) do
          Flu::CoreExt.flu_tracker_request_id = nil
        end

        define_method(:flu_define_request_entity_metadata) do
          Flu::CoreExt.flu_tracker_request_entity_metadata = instance_exec(&entity_metadata_lambda) if entity_metadata_lambda
        end

        define_method(:flu_remove_request_entity_metadata) do
          Flu::CoreExt.flu_tracker_request_entity_metadata = nil
        end

        define_method(:flu_rejected_origin?) do
          rejected_user_agents = Regexp.union(Flu.config.rejected_user_agents)
          !request.user_agent&.match(rejected_user_agents).nil?
        end

        define_method(:flu_track_request) do
          if flu_rejected_origin?
            logger.warn("Origin user agent rejected: #{request.user_agent}")
          else
            tracked_request                     = event_factory.create_data_from_request(@flu_request_id,
                                                                                         params,
                                                                                         request,
                                                                                         response,
                                                                                         @request_start_time,
                                                                                         ignored_request_params)
            tracked_request[:user_metadata]     = instance_exec(&user_metadata_lambda) if user_metadata_lambda
            tracked_request[:overriden_emitter] = instance_exec(&emitter_lambda) if emitter_lambda
            event                               = event_factory.build_request_event(tracked_request)
            event_publisher.publish(event)
          end
        end

        prepend_around_action do |_controller, action|
          flu_define_request_id
          flu_define_request_entity_metadata
          @request_start_time = Time.zone.now
          begin
            action.call
            flu_track_request
          ensure
            flu_remove_request_entity_metadata
            flu_remove_request_id
          end
        end
      end
    end
  end
end