flu-rails 8.0.0 → 8.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a35d15acbcbab2206e789f346ef7c97cd92d4cdc9bed53fe6fb0025256fec3b6
-  data.tar.gz: 5114f719bf9565182eada52d5ccd3c3a1e219ad2bc26e41c288ee7ff0ab58573
+  metadata.gz: 721522defefd5f7c30f0cd24dd1773b6191cf93bc8162d791e349883dd91698f
+  data.tar.gz: 3d5e0c52ddbffbdf5c021647a76460acde5726ca1201bda1022d21fdb3095a05
 SHA512:
-  metadata.gz: a26ad7a3c9274ac803f842b509dcd81eebbc735812347c4473432cbbcb016355c6d7bc7440fe95070f4e53e708d8617849fad2a8c72ffb2443c64445682e2e5f
-  data.tar.gz: 9364931b1ee248a8a43b18089149ba1db00bc4e91fcbd9a7325cae5e7f009493ff9a5ae3b3226d52bf794e17c85d05503811421850a9793f948912a2f5e82b5b
+  metadata.gz: 9965aef8635a94a1f2e8843253e3c8817b2b6b0f61f13b1f0137a1d555eb638c6e12d4f620c004e47f3365cec9fc9da57a2076e629f53ea11df045c21a0c0a27
+  data.tar.gz: 5818a4c90e2b819a12483f9683a75119c33e6573b57e0952916a3cbd258dd6d0e536be85105efbb1b1415fafa105c5de9de478ae3976a06f12ab2f28a86203a8

data/CHANGELOG.md

@@ -5,7 +5,33 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-### [8.0.0] - 2026-07-31
+### [Unreleased]
+
+**Fixed**
+
+* Honour `configuration.logger` when rejecting a request on its user agent.
+* Stop defining those helpers on `ActionController::Base` and `ActionController::API` themselves.
+* Apply the model's `emitter:` override when exporting existing entities. `Util::ExportService`
+  passed `nil` instead of the model's lambda, so a replayed event carried the global
+  `application_name` while the live event for the same entity carried the overriden one — putting
+  the two on different routing keys. Unnoticed since `1.0.4`, where the option was introduced.
+* Do not assume that a defined `Rails` constant means railties is loaded.
+
+**Changed**
+
+* Stop publishing `overriden_emitter` as part of the event payload.
+
+**Tests**
+
+* Enable the three controller examples that were disabled with `xit`, and run them through the real
+  `ActionController` dispatch, which is what triggers the callbacks registered by `track_requests`.
+  This is the code path that hid the `ActionController::UnfilteredParameters` bug fixed in `8.0.1`.
+* Cover `Util::ExportService`, which had no test at all — and which is how the `emitter:` bug above
+  surfaced.
+* Make the spec setup idempotent
+* Integration tests with RabbitMQ
+
+### [8.0.1] - 2026-07-31
 
 **Fixed**
 

data/README.md

@@ -40,7 +40,9 @@ Each configuration is detailed below.
 * Ruby >= 3.2 (tested against 3.2, 3.3 and 3.4)
 * Rails 8 only (`activerecord`, `actionpack` and `activesupport` are runtime dependencies,
   constrained to `~> 8.0`). `flu-rails` extends `ActiveRecord::Base` and `ActionController::Base`, so it requires Rails.
-* Tested with RabbitMQ 3.5.8
+* RabbitMQ: no specific version is required by `flu-rails` itself. The broker is reached through
+  `bunny` 3.x and `rabbitmq_http_api_client` 3.x, which target the
+  [currently supported RabbitMQ release series](https://www.rabbitmq.com/release-information).
 
 ## Usage
 
@@ -171,10 +173,32 @@ All options have a default value. However, all of them can be changed in your in
 From the `flu-rails` directory:
 
 ```
-  $ docker build . -t flu:test
-  $ docker run -v `pwd`:/usr/src/app/ flu:test rspec spec
+  $ docker compose run --rm specs
 ```
 
+This starts a RabbitMQ broker, waits for it, and runs the whole suite against it.
+
+Part of the suite publishes to a real broker and drives its HTTP management API: nothing there is
+stubbed, since a stub cannot tell whether the gem actually speaks AMQP. To run the specs directly on
+your machine, start a broker first:
+
+```
+  $ docker compose up -d rabbitmq
+  $ bundle exec rspec
+```
+
+Without one, those examples are reported as skipped and the rest of the suite still runs. Set
+`FLU_REQUIRE_RABBITMQ` to turn that skip into a failure — this is what the CI workflow does, so that
+a build cannot report success without having reached RabbitMQ:
+
+```
+  $ FLU_REQUIRE_RABBITMQ=true bundle exec rspec
+```
+
+A broker of your own can be used instead through `FLU_RABBITMQ_HOST`, `FLU_RABBITMQ_PORT`,
+`FLU_RABBITMQ_MANAGEMENT_PORT`, `FLU_RABBITMQ_USER` and `FLU_RABBITMQ_PASSWORD`. Every example
+declares an exchange and queues of its own, and deletes them afterwards.
+
 ## Example of Events
 
 ### Structure of an Active Record change
@@ -276,12 +300,12 @@ no API key is stored in this repository, the workflow exchanges a short-lived Gi
 scoped RubyGems credential.
 
 1. Update `Flu::VERSION` in `lib/flu-rails/version.rb` and the `CHANGELOG.md`
-2. Commit and push these changes to `master`
+2. Commit and push these changes to `main`
 3. Tag the commit and push the tag:
 
 ```
-  $ git tag -a v8.0.0 -m "Version 8.0.0"
-  $ git push origin v8.0.0
+  $ git tag -a v8.0.1 -m "Version 8.0.1"
+  $ git push origin v8.0.1
 ```
 
 The workflow then checks that the tag matches `Flu::VERSION`, runs the tests, builds the gem

data/flu-rails.gemspec

@@ -0,0 +1,39 @@
+require_relative "lib/flu-rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "flu-rails"
+  spec.version     = Flu::VERSION
+  spec.authors     = ["Loïc Vigneron", "Lorent Lempereur", "Thibault Poncelet", "Logan Clément"]
+  spec.email       = ["support@commuty.net"]
+  spec.summary     = "Track your application events and publish them to RabbitMQ."
+  spec.description = "Seamlessly emit events from an existing Rails application, without changing its " \
+                     "codebase, and publish them to RabbitMQ. Events are generated from CRUD operations " \
+                     "on ActiveRecord models and from requests on Rails controller actions."
+  spec.homepage    = "https://github.com/crepesourcing/flu-rails"
+  spec.license     = "MIT"
+
+  spec.required_ruby_version = ">= 3.2"
+
+  spec.metadata = {
+    "source_code_uri"       => spec.homepage,
+    "changelog_uri"         => "#{spec.homepage}/blob/main/CHANGELOG.md",
+    "bug_tracker_uri"       => "#{spec.homepage}/issues",
+    "rubygems_mfa_required" => "true"
+  }
+
+  spec.files = Dir.glob(["lib/**/*.rb", "CHANGELOG.md", "MIT-LICENSE", "README.md", "flu-rails.gemspec"])
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "actionpack",               "~> 8.0"
+  spec.add_dependency "activerecord",             "~> 8.0"
+  spec.add_dependency "activesupport",            "~> 8.0"
+  spec.add_dependency "bunny",                    "~> 3.1"
+  spec.add_dependency "logger",                   "~> 1.7"
+  spec.add_dependency "rabbitmq_http_api_client", "~> 3.2"
+
+  spec.add_development_dependency "byebug",       "~> 13.0"
+  spec.add_development_dependency "ostruct",      "~> 0.6"
+  spec.add_development_dependency "rake",         ">= 13.0"
+  spec.add_development_dependency "rspec",        "~> 3.13"
+  spec.add_development_dependency "sqlite3",      "~> 2.9"
+end

data/lib/flu-rails/action_controller_extender.rb

@@ -21,49 +21,38 @@ module Flu
             ignored_request_params   = options.fetch(:ignored_request_params, []).map(&:to_sym)
             emitter_lambda           = options[:emitter]
 
-            before_action do
-              define_request_id
-              @request_start_time = Time.zone.now
-            end
-            prepend_before_action do
-              define_request_entity_metadata_lambda(entity_metadata_lambda)
-            end
-            prepend_after_action do
-              track_requests(event_factory, event_publisher, user_metadata_lambda, ignored_request_params, emitter_lambda)
-              remove_request_entity_metadata_lambda
-            end
-            after_action do
-              remove_request_id
-            end
-
-            def define_request_id
+            # 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      = SecureRandom.uuid
               @flu_request_id = request_id
               Flu::CoreExt.flu_tracker_request_id = request_id
             end
 
-            def remove_request_id
+            define_method(:flu_remove_request_id) do
               Flu::CoreExt.flu_tracker_request_id = nil
             end
 
-            def define_request_entity_metadata_lambda(entity_metadata_lambda)
+            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
 
-            def remove_request_entity_metadata_lambda
+            define_method(:flu_remove_request_entity_metadata) do
               Flu::CoreExt.flu_tracker_request_entity_metadata = nil
             end
 
-            def rejected_origin?(request)
-              rejected_user_agents  = Regexp.union(Flu.config.rejected_user_agents)
-              user_agent            = request.user_agent
-              matching_user_agents  = user_agent&.match(rejected_user_agents)
-              !matching_user_agents.nil?
+            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
 
-            def track_requests(event_factory, event_publisher, user_metadata_lambda, ignored_request_params, emitter_lambda)
-              if rejected_origin?(request)
-                logger.warn "Origin user agent rejected: #{request.user_agent}"
+            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,
@@ -77,6 +66,21 @@ module Flu
                 event_publisher.publish(event)
               end
             end
+
+            before_action do
+              flu_define_request_id
+              @request_start_time = Time.zone.now
+            end
+            prepend_before_action do
+              flu_define_request_entity_metadata
+            end
+            prepend_after_action do
+              flu_track_request
+              flu_remove_request_entity_metadata
+            end
+            after_action do
+              flu_remove_request_id
+            end
           end
         end
       end

data/lib/flu-rails/event_factory.rb

@@ -48,7 +48,9 @@ module Flu
       original_emitter  = @emitter
       overriden_emitter = data[:overriden_emitter]&.strip&.delete(".")
       final_emitter     = overriden_emitter.blank? ? original_emitter : overriden_emitter
-      Event.new(SecureRandom.uuid, final_emitter, kind, name, deep_camelize(data))
+      # 'overriden_emitter' selects the emitter of the event, it is not part of what is tracked:
+      # it is dropped from the payload instead of being published as an 'overridenEmitter' key.
+      Event.new(SecureRandom.uuid, final_emitter, kind, name, deep_camelize(data.except(:overriden_emitter)))
     end
 
     def create_data_from_entity_changes(action_name, entity, request_id, request_entity_metadata, changes, user_metadata_lambda, association_columns, ignored_model_changes, flu_overriden_emitter_lambda)

data/lib/flu-rails/util.rb

@@ -16,12 +16,13 @@ module Flu
           association_columns          = entity_type.flu_association_columns
           user_metadata_lambda         = entity_type.flu_user_metadata_lambdas[:create]
           ignored_model_changes        = entity_type.flu_ignored_model_changes
+          overriden_emitter_lambda     = entity_type.flu_overriden_emitter_lambda
 
           entities.each do |entity|
             print "\r"      unless current_entity_index == 0
             current_entity_index += 1
             print "#{entity_type} (#{current_entity_type_index}/#{total_number_of_entity_types}) : #{current_entity_index}/#{total_number_of_entities}"
-            data            = extract_data_from(entity, event_factory, user_metadata_lambda, association_columns, ignored_model_changes)
+            data            = extract_data_from(entity, event_factory, user_metadata_lambda, association_columns, ignored_model_changes, overriden_emitter_lambda)
             event           = event_factory.build_entity_change_event(data)
             event.timestamp = entity.created_at unless entity.created_at.nil?
             event_publisher.publish(event)
@@ -52,9 +53,17 @@ module Flu
         end
       end
 
-      def extract_data_from(entity, event_factory, user_metadata_lambda, association_columns, ignored_model_changes)
+      def extract_data_from(entity, event_factory, user_metadata_lambda, association_columns, ignored_model_changes, overriden_emitter_lambda)
         changes = create_changes_from_existing(entity)
-        event_factory.create_data_from_entity_changes(:create, entity, nil, nil, changes, user_metadata_lambda, association_columns, ignored_model_changes, nil)
+        event_factory.create_data_from_entity_changes(:create,
+                                                      entity,
+                                                      nil,
+                                                      nil,
+                                                      changes,
+                                                      user_metadata_lambda,
+                                                      association_columns,
+                                                      ignored_model_changes,
+                                                      overriden_emitter_lambda)
       end
 
       def create_changes_from_existing(entity)

data/lib/flu-rails/version.rb

@@ -1,3 +1,3 @@
 module Flu
-  VERSION = "8.0.0"
+  VERSION = "8.0.1"
 end

data/lib/flu-rails.rb

@@ -62,7 +62,10 @@ module Flu
   end
 
   def self.is_testing_environment?
-    defined?(Rails) && config.development_environments.include?(Rails.env)
+    # 'defined?(Rails)' alone is not enough: gems such as 'rails-html-sanitizer' define an empty
+    # 'Rails' namespace, so the constant can exist without railties ever defining 'Rails.env'.
+    return false unless defined?(Rails) && Rails.respond_to?(:env)
+    config.development_environments.include?(Rails.env)
   end
 
   def self.extend_models_and_controllers

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: flu-rails
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.0.1
 platform: ruby
 authors:
 - Loïc Vigneron
 - Lorent Lempereur
 - Thibault Poncelet
+- Logan Clément
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
@@ -169,8 +170,7 @@ description: Seamlessly emit events from an existing Rails application, without
   its codebase, and publish them to RabbitMQ. Events are generated from CRUD operations
   on ActiveRecord models and from requests on Rails controller actions.
 email:
-- info@spin42.com
-- info@commuty.net
+- support@commuty.net
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -178,6 +178,7 @@ files:
 - CHANGELOG.md
 - MIT-LICENSE
 - README.md
+- flu-rails.gemspec
 - lib/flu-rails.rb
 - lib/flu-rails/action_controller_extender.rb
 - lib/flu-rails/active_record_extender.rb
@@ -195,9 +196,8 @@ homepage: https://github.com/crepesourcing/flu-rails
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/crepesourcing/flu-rails
   source_code_uri: https://github.com/crepesourcing/flu-rails
-  changelog_uri: https://github.com/crepesourcing/flu-rails/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/crepesourcing/flu-rails/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/crepesourcing/flu-rails/issues
   rubygems_mfa_required: 'true'
 rdoc_options: []