CHANGELOG.md

next

• TODO: Replace this bullet point with an actual description of a change.

3.3.0 (16 April 2026)

• Added a new configuration (avro_deserializer_parse_datetimes) which allows to configure the default Apache Avro deserializer to automatically parse date/time/datetime's from deeply nested strings (disabled by default for compatibility) (#76)

3.2.0 (7 April 2026)

• Restored non-buffered ($stdout.sync = true) logging to stdout (#75)
• Added a section for topic auto-creation on the upgrading guide (#75)

3.1.0 (1 April 2026)

• Updated the kafka-playground (#74)

3.0.0 (1 April 2026)

Breaking changes: (#73)

• Upgraded karafka from ~> 1.4 to ~> 2.5 — now powered by librdkafka instead of ruby-kafka. Consumer groups are now shared (one for all topics instead of one per topic). Batch fetching is always on; tune max_wait_time/max_messages for latency vs throughput. See UPGRADING.md for details.

• Upgraded waterdrop from ~> 1.4 to ~> 2.8 — all time-related config values are now in milliseconds. The Rimless producer helpers (Rimless.message etc.) remain unchanged.

• Upgraded avro_turf from ~> 0.11.0 to ~> 1.20

• Switched from Sidekiq to ActiveJob for consumer job processing. The karafka-sidekiq-backend gem is no longer used.

• Renamed constants (old → new):

  • Rimless::BaseConsumer → Rimless::Consumer::Base
  • Rimless::ConsumerApp → Rimless::Consumer::App
  • Rimless::ConsumerJob → Rimless::Consumer::Job
  • Rimless::Karafka::AvroDeserializer → Rimless::Consumer::AvroDeserializer

• Removed constants:

  • Rimless::Karafka::Base64Interchanger (no longer needed)
  • Rimless::Karafka::PassthroughMapper (mappers removed in Karafka 2)

• Anonymous consumer classes are no longer supported. Because Karafka is no longer loaded within the ActiveJob worker process, consumer class names must be serializable (via constantize). Rewrite anonymous consumers as named classes. See UPGRADING.md for details.

• Each Kafka message in a batch is now individually marked as consumed after being enqueued to ActiveJob (mark_as_consumed). This may differ from previous karafka-sidekiq-backend behavior depending on your Karafka offset management configuration. See UPGRADING.md for details.

• KAFKA_BROKERS format changed — protocol prefix (kafka://) is no longer required. Use plain host:port CSV (e.g. your.domain:9092,host:port). The old kafka:// format is still accepted for backwards compatibility.

• Consumer boot flow changed:

  • Remove .boot! from the end of Rimless.consumer.topics(...) in karafka.rb
  • Remove WaterDrop.setup and WaterDrop::Instrumentation::LoggerListener subscriptions from karafka.rb

New configuration options:

• config.job_bridge_class — custom job bridge for Kafka → ActiveJob
• config.consumer_job_class — custom consumer job class
• config.consumer_logger_listener — customize Karafka logging listener
• config.avro_deserializer_class — custom Apache Avro deserializer
• config.avro_configure — fully customize the AvroTurf::Messaging instance
• config.producer_configure — fully customize the WaterDrop::Producer instance
• config.consumer_configure — fully customize the Karafka::App instance

Testing changes:

• Replace #karafka_consumer_for with #kafka_consumer_for in specs
• Replace #publish_for_karafka with karafka.produce in specs

See UPGRADING.md for a complete migration guide.

2.9.0 (18 February 2026)

• Dropped 3rd-level gem dependencies which are not directly used by this gem (#72)

2.8.0 (12 February 2026)

• Corrected some RuboCop glitches (#71)

2.7.0 (28 January 2026)

• Dropped Rails 7.1 support (#70)
• Updated the doc/kafka-playground to latest Rimless/Ruby 3.4 (#69)

2.6.0 (19 January 2026)

• Added the ostruct gem (#68)

2.5.0 (8 January 2026)

• Added support Rails 8.0+ code statistics (#67)

2.4.0 (7 January 2026)

• Upgraded to Ubuntu 24.04 on Github Actions (#66)
• Migrated to hausgold/actions@v2 (#65)

2.3.0 (26 December 2025)

• Added Ruby 4.0 support (#64)
• Dropped Ruby 3.2 and Rails 7.1 support (#63)

2.2.0 (19 December 2025)

• Migrated to a shared Rubocop configuration for HAUSGOLD gems (#62)

2.1.0 (23 October 2025)

• Added support for Rails 8.1 (#60)
• Switched from ActiveSupport::Configurable to a custom implementation based on ActiveSupport::OrderedOptions (#61)

2.0.0 (28 June 2025)

• Corrected some RuboCop glitches (#58)
• Drop Ruby 2 and end of life Rails (<7.1) (#59)

1.13.3 (21 May 2025)

• Corrected some RuboCop glitches (#56)
• Added a workaround for broken specs when Sidekiq >=8.0.3 is installed (#57)

1.13.2 (11 March 2025)

• Corrected a typo of #54, its rimless/railtie not rimless/rails (#55)

1.13.1 (11 March 2025)

• Upgraded the rubocop dependencies (#53)
• Make sure to load 'rimless/railtie' when we initialize Rails on the consumer application (#54)

1.13.0 (27 February 2025)

• Added support for Sidekiq 7 in conjunction with Rails (#52)

1.12.0 (27 February 2025)

• Corrected some RuboCop glitches (#50)
• Relaxed the sinatra gem dependency to >= 2.0 (#51)

1.11.0 (30 January 2025)

• Added all versions up to Ruby 3.4 to the CI matrix (#49)

1.10.2 (17 January 2025)

• Added the logger dependency (#48)

1.10.1 (13 January 2025)

• Do not eager load the configuration (#47)

1.10.0 (11 January 2025)

• Switched to Zeitwerk as autoloader (#46)

1.9.0 (3 January 2025)

• Raised minimum supported Ruby/Rails version to 2.7/6.1 (#45)

1.8.0 (14 November 2024)

• Added support for custom topic names via the full_name: keyword argument on the consumer routing table (#44)
• Added support to pass a block to the routing table (Rimless.consumer.topics) to add custom topic configurations (#44)

1.7.7 (19 September 2024)

• Corrected the Sidekiq interchanger decoding, which is caused by an upstream update of the karafka-sidekiq-backend gem (#43)

1.7.6 (19 September 2024)

• Added a monkey-patch for the constellation Karafka 1.4 and Thor 1.3, on Ruby >=2.7 (#42)

1.7.5 (15 August 2024)

• Just a retag of 1.7.1

1.7.4 (15 August 2024)

• Just a retag of 1.7.1

1.7.3 (15 August 2024)

• Just a retag of 1.7.1

1.7.2 (9 August 2024)

• Just a retag of 1.7.1

1.7.1 (9 August 2024)

• Added API docs building to continuous integration (#41)

1.7.0 (8 July 2024)

• Added CI tests for Rails 6.1 and 7.1 (#39)

1.6.0 (3 July 2024)

• Dropped support for Ruby <2.7 (#38)
• Moved the schema file validation into the retry block for parallel execution (#37)
• Updated the Kafka Playground to the latest Apache Kafka (3.7) and Schema Registry (7.6) versions (#35)

1.5.1 (26 April 2024)

• Added a retry to write compiled schema files as this may fail on parallel execution (#33)

1.5.0 (4 December 2023)

• Do not extend the Rimless.logger to write to stdout by default when running in the development environment - this generates duplicated messages when the configured logger already writes to stdout. A new configuration was added Rimless.configuration.extend_dev_logger = false was added (#32)

1.4.2 (12 July 2023)

• Reverted to use yield_self instead of then in order to support Ruby 2.5 as advertised (broken since #19, 1.3.0) (#31)

1.4.1 (5 July 2023)

• Moved the development dependencies from the gemspec to the Gemfile (#29)
• Pinned Karafka gem <1.4.15 in order to suppress the I_ACCEPT_CRITICAL_ERRORS_IN_KARAFKA_1_4=true agony (#30)

1.4.0 (24 February 2023)

• Added support for Gem release automation

1.3.0 (18 January 2023)

• Bundler >= 2.3 is from now on required as minimal version (#19)
• Dropped support for Ruby < 2.5 (#19)
• Dropped support for Rails < 5.2 (#19)
• Updated all development/runtime gems to their latest Ruby 2.5 compatible version (#19)

1.2.0 (4 October 2021)

• Added a capture_kafka_messages helper for RSpec (#12)

1.1.1 (12 May 2021)

• Corrected the GNU Make release target

1.1.0 (23 October 2020)

• Added support for Karafka ~> 1.4.0 and set is as minimum dependency version (#10)

1.0.4 (14 August 2020)

• Mocked WaterDrop producers in the rimless rspec helper so that tests won't actually talk to Kafka (#9)

1.0.3 (14 May 2020)

• Corrected broken stats when no consumer is yet defined (#8)

1.0.2 (11 March 2020)

• Only load the statistics rake task when Rails is available and the environment is development (instead of not production, this may cause issues for +canary+ or +stage+ Rails environments)

1.0.1 (11 March 2020)

• Added the missing +Karafka::Testing::RSpec::Helpers+ include to the RSpec configuration

1.0.0 (11 March 2020)

• Dropped support for Ruby 2.3/2.4 and added support for Rails 6.0 (#6)
• Implemented a simple opinionated Kafka consumer setup (#7)

0.3.0 (8 November 2019)

• Upgraded the avro_turf gem (~> 0.11.0) (#5)

0.2.1 (13 August 2019)

• Added support for the parallel_tests gem and reconfigure the compiled schema directory to be unique per running test thread. This fixes all race conditions which slow down or break user test suites.

0.2.0 (5 June 2019)

• Added the Rimless.encode (.avro_encode) and Rimless.decode (.avro_decode) helpers/shortcuts to simplify the interaction with the Apache Avro library
  • The .encode method automatically performs input data sanitation and supports deep relative (to the local namespace) schema resolution. This allows you to access deeply located schemes relative by just providing a leading period (eg. .deep.a.b.c becomes development.your_app.deep.a.b.c)
• The .message, '.sync_message', '.async_message' helpers now make use of the new .encode functionality which adds transparent data sanitation and schema name features
• At the test environment the compiled Avro schemas output path is not deleted anymore, instead the compiled schemas are overwritten. This may keep dead schemas, but it allows parallel test execution without flaws. The removal of the compiled schema directory caused previously file read errors when a parallel process started a recompilation.

0.1.4 (17 April 2019)

• Reconfigure (reset) the AvroTurf instance on tests to avoid caching issues (on failed tests the message decoding was not working which results in unrelated errors, instead of showing the actual test failure)

0.1.3 (16 April 2019)

• Check for unset and empty values while configuring dependencies

0.1.2 (16 April 2019)

• Skip the configuration of the AvroTurf gem in case no schema registry URL is configured, this allows the smooth run of Rails asset precompilations without full environment configurations (eg. on CI)

0.1.1 (16 April 2019)

• Skip the configuration of the WaterDrop gem in case no brokers are configured, this allows the smooth run of Rails asset precompilations without full environment configurations (eg. on CI)

0.1.0 (16 April 2019)

• The first release with support for simple Apache Avro message producing on Apache Kafka/Confluent Schema Registry
• Improved the automatic Avro Schema ERB template compiling and included a JSON validation for each file
• Added a powerful RSpec helper/matcher to ease message producer logic tests
• Added an extensive documentation