rabbit_messaging 1.6.3 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c45c2e39c99e1b98df503e6e3bca993494c23de174c4128fc01d92a52c6c14aa
-  data.tar.gz: 18cbcd032389ba70240633bb06929c5f1c6ea687cdf5b52e311f50d99dca2778
+  metadata.gz: a10737146cf3e6407d500b5cb61af3c6340a435babad47ac7087a5bb966dfd69
+  data.tar.gz: '0589fbc1d041763ee953c7a4763814daa66b1f241c8536a2096f43420d2b00e4'
 SHA512:
-  metadata.gz: 9e59c4b4e78c0839abff9afcd4aaaaf649d0f81ff14a95864ea46091247eb299a22aac0c1b84ab310c026375c7902077abf39bc4a2b767e672dab7032045e6b7
-  data.tar.gz: 0aac8ba6c08010ffae05038aa46ff924672d3ec4ae2d96bf2669ba6be6013224574dfdd7c5f2231a6ff6072bb51634a5b522cca87a29bccfcce39050821cdfad
+  metadata.gz: 8976861c50915a84af982e2f98d35fd982cce74bd52aa59974bfb213a8dcb65fa10b7b45fee8faf4b13b663ed1b12fb97b23c4d635eb272ddfe8982656da661a
+  data.tar.gz: 7db3fad61e5d9caa136a0799d3b96f6785e4b94f68db8fca7d9d1f60862c6e2821f7a0fe2b47ef8b1f650881aae772a17632dcf6635ec728290da8cc27e37670

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [1.8.0] - 2026-03-25
+### Added
+- Ability to compress data on publisher level and decompress on consumer
+
+## [1.7.0] - 2025-08-19
+### Added
+- Ability to specify a custom job class for publishing via `publishing_job_class_callable` config.
+- Ability to specify a default queue for publishing jobs via `default_publishing_job_queue` config.
+- Ability to specify a custom queue per publish call via `custom_queue_name` argument.
+
 ## [1.5.0] - 2025-05-19
 ### Added
 - Added ability to split log message into parts

data/Gemfile.lock

@@ -8,9 +8,11 @@ GIT
 PATH
   remote: .
   specs:
-    rabbit_messaging (1.6.3)
+    rabbit_messaging (1.8.0)
       bunny (~> 2.0)
       kicks
+      msgpack
+      zlib
 
 GEM
   remote: https://rubygems.org/
@@ -66,6 +68,7 @@ GEM
     logger (1.6.5)
     method_source (1.1.0)
     minitest (5.25.4)
+    msgpack (1.8.0)
     parallel (1.26.3)
     parser (3.3.7.1)
       ast (~> 2.4.1)
@@ -158,6 +161,7 @@ GEM
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
+    zlib (3.2.3)
 
 PLATFORMS
   arm64-darwin

data/README.md

@@ -97,6 +97,14 @@ require "rabbit_messaging"
     }
     ```
 
+  - `publishing_job_class_callable` (`Proc`)
+
+    Custom job class (e.g. ActiveJob or Sidekiq::Job) to work with published messages.
+
+  - `default_publishing_job_queue` (`String` or `Symbol`)
+
+    The name of the queue that will be used by default for publishing jobs. `default` by default.
+
   - `before_receiving_hooks, after_receiving_hooks` (`Array of Procs`)
 
     Before and after hooks with message processing in the middle. Where `before_receiving_hooks` and `after_receiving_hooks` are empty arrays by default.
@@ -139,7 +147,7 @@ require "rabbit_messaging"
   - `connection_reset_max_retries` (`Integer`)
 
     Maximum number of reconnection attempts after a connection loss. Default: 10.
-  
+
     ```ruby
       config.connection_reset_max_retries = 20
     ```
@@ -165,13 +173,16 @@ require "rabbit_messaging"
 
 ```ruby
 Rabbit.publish(
-  routing_key: :support,
-  event: :ping,
-  data: { foo: :bar }, # default is {}
-  exchange_name: 'fanout', # default is fine too
-  confirm_select: true, # setting this to false grants you great speed up and absolutelly no guarantees
-  headers: { "foo" => "bar" }, # custom arguments for routing, default is {}
-  message_id: "asdadsadsad", # A unique identifier such as a UUID that your application can use to identify the message.
+  {
+    routing_key: :support,
+    event: :ping,
+    data: { foo: :bar }, # default is {}
+    exchange_name: 'fanout', # default is fine too
+    confirm_select: true, # setting this to false grants you great speed up and absolutelly no guarantees
+    headers: { "foo" => "bar" }, # custom arguments for routing, default is {}
+    message_id: "asdadsadsad", # A unique identifier such as a UUID that your application can use to identify the message.
+  },
+  custom_queue_name: :my_custom_queue, # The name of the queue for publishing jobs. Overrides the default queue.
 )
 ```
 

data/lib/rabbit/compressor.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "msgpack"
+require "zlib"
+require "base64"
+
+module Rabbit::Compressor
+  Error = Class.new(StandardError)
+  UncompressingError = Class.new(Error)
+
+  extend self
+
+  delegate :decode64, :strict_encode64, to: Base64
+
+  def dump(data, msgpack_options: {}, with_base64: false)
+    dumped = Zlib::Deflate.deflate(MessagePack.pack(data, msgpack_options))
+
+    return dumped unless with_base64
+
+    strict_encode64(dumped)
+  end
+
+  def load(data, msgpack_options: {}, with_base64: false)
+    return {} unless data
+
+    data = decode64(data) if with_base64
+
+    MessagePack.unpack(Zlib::Inflate.inflate(data), msgpack_options)
+  rescue Zlib::Error, MessagePack::UnpackError => error
+    raise UncompressingError, "Unable to uncompress data, #{error}"
+  end
+end

data/lib/rabbit/helper.rb

@@ -2,16 +2,22 @@
 
 module Rabbit
   module Helper
-    def self.generate_message(message_part, parts, index)
+    def self.generate_message(message_part, parts, index, compressed: false)
       if parts == 1
-        message_part
+        format(message_part, compressed)
       elsif index.zero?
-        "#{message_part}..."
+        "#{format(message_part, compressed)}..."
       elsif index == parts - 1
-        "...#{message_part}"
+        "...#{format(message_part, compressed)}"
       else
-        "...#{message_part}..."
+        "...#{format(message_part, compressed)}..."
       end
     end
+
+    def self.format(message_part, compressed)
+      return message_part unless compressed
+
+      "message bytes #{message_part.bytesize}"
+    end
   end
 end

data/lib/rabbit/publishing/job.rb

@@ -5,7 +5,7 @@ require "rabbit/publishing"
 module Rabbit::Publishing
   class Job < ActiveJob::Base
     def perform(message)
-      Rabbit::Publishing.publish(Message.new(message))
+      Rabbit::Publishing.publish(Message.new(**message))
     end
   end
 end

data/lib/rabbit/publishing/message.rb

@@ -2,30 +2,41 @@
 
 module Rabbit::Publishing
   class Message
-    attr_accessor :routing_key, :event, :data,
+    attr_accessor :routing_key, :event, :data, :compress,
                   :confirm_select, :realtime, :headers, :message_id
     attr_reader :exchange_name
 
     alias_method :confirm_select?, :confirm_select
     alias_method :realtime?, :realtime
 
-    def initialize(attributes = {})
-      self.routing_key     = attributes[:routing_key]
-      self.event           = attributes[:event]&.to_s
-      self.data            = attributes.fetch(:data, {})
-      self.exchange_name   = Array(attributes.fetch(:exchange_name, []))
-      self.confirm_select  = attributes.fetch(:confirm_select, true)
-      self.realtime        = attributes.fetch(:realtime, false)
-      self.headers         = attributes.fetch(:headers, {})
-      self.message_id      = attributes[:message_id]
+    def initialize(
+      routing_key: nil,
+      event: nil,
+      data: {},
+      exchange_name: [],
+      confirm_select: true,
+      realtime: false,
+      headers: {},
+      message_id: nil
+    )
+      self.routing_key = routing_key
+      self.event = event&.to_s
+      self.data = data
+      self.exchange_name = Array(exchange_name)
+      self.confirm_select = confirm_select
+      self.realtime = realtime
+      self.headers = headers
+      self.message_id = message_id
+      self.compress = headers.with_indifferent_access.fetch(:compress, false)
     end
 
     def to_hash
       instance_variables.each_with_object({}) do |var, hash|
         key = var.to_s.delete("@").to_sym
+        next if key == :compress
         value = instance_variable_get(var)
         hash[key] = value
-      end.merge(data: JSON.parse(data.to_json))
+      end.merge(data: data_for_hash)
     end
 
     def to_s
@@ -46,9 +57,11 @@ module Rabbit::Publishing
         app_id: Rabbit.config.app_name,
         headers: headers,
         message_id: message_id,
-      }
+      }.tap do |ops|
+        ops[:content_encoding] = "gzip" if compress
+      end
 
-      [JSON.dump(data), real_exchange_name, routing_key.to_s, options]
+      [dumped_data, real_exchange_name, routing_key.to_s, options]
     end
 
     def exchange_name=(names)
@@ -58,5 +71,22 @@ module Rabbit::Publishing
     def real_exchange_name
       [Rabbit.config.group_id, Rabbit.config.project_id, *exchange_name].join(".")
     end
+
+    def dumped_data
+      return JSON.dump(data) unless compress
+      # NOTE: when compress true and realtime false it means data from job
+      # already has been compressed and encoded in base64
+      return Rabbit::Compressor.dump(data) if realtime
+
+      Rabbit::Compressor.decode64(data)
+    end
+
+    private
+
+    def data_for_hash
+      return JSON.parse(data.to_json) unless compress
+
+      Rabbit::Compressor.dump(data, with_base64: true)
+    end
   end
 end

data/lib/rabbit/publishing.rb

@@ -66,17 +66,35 @@ module Rabbit
         message.event, message.confirm_select? ? "confirm" : "no-confirm"
       ]
 
-      message_parts = JSON.dump(message.data)
-                          .scan(/.{1,#{Rabbit.config.logger_message_size_limit}}/)
+      return log_compressed(message.dumped_data, metadata: metadata) if message.compress
 
-      message_parts.each_with_index do |message_part, index|
-        message = Rabbit::Helper.generate_message(message_part, message_parts.size, index)
-        @logger.debug "#{metadata.join ' / '}: #{message}"
-      end
+      log_by_parts(message, metadata: metadata)
     end
 
     def reinitialize_channels_pool
       MUTEX.synchronize { @pool = ChannelsPool.new(create_client) }
     end
+
+    def log_compressed(message_for_publish, metadata:)
+      formatted_message = Rabbit::Helper.generate_message(
+        message_for_publish, 1, 0, compressed: true
+      )
+
+      @logger.debug "#{metadata.join ' / '}: #{formatted_message}"
+    end
+
+    def log_by_parts(message_for_publish, metadata:)
+      message_parts =
+        message_for_publish
+          .dumped_data
+          .scan(/.{1,#{Rabbit.config.logger_message_size_limit}}/)
+
+      message_parts.each_with_index do |message_part, index|
+        formatted_message = Rabbit::Helper.generate_message(
+          message_part, message_parts.size, index
+        )
+        @logger.debug "#{metadata.join ' / '}: #{formatted_message}"
+      end
+    end
   end
 end

data/lib/rabbit/receiving/message.rb

@@ -4,7 +4,7 @@ require "rabbit/receiving/malformed_message"
 
 module Rabbit::Receiving
   class Message
-    attr_accessor :group_id, :project_id, :message_id,
+    attr_accessor :group_id, :project_id, :message_id, :compress,
                   :event, :arguments, :original_message
     attr_reader :data
 
@@ -15,6 +15,7 @@ module Rabbit::Receiving
         group_id: group_id,
         project_id: project_id,
         event: arguments.fetch(:type),
+        compress: arguments.dig(:headers, "compress") || false,
         data: message,
         message_id: arguments.fetch(:message_id, nil),
         arguments: arguments,
@@ -28,12 +29,14 @@ module Rabbit::Receiving
       event: nil,
       data: nil,
       arguments: nil,
-      original_message: nil
+      original_message: nil,
+      compress: false
     )
       self.group_id = group_id
       self.project_id = project_id
       self.message_id = message_id
       self.event = event
+      self.compress = compress
       self.data = data unless data.nil?
       self.arguments = arguments
       self.original_message = original_message
@@ -41,7 +44,7 @@ module Rabbit::Receiving
 
     def data=(value)
       self.original_message = value
-      parsed = JSON.parse(value).deep_symbolize_keys
+      parsed = parsed_data(value)
       @data = parsed
     rescue JSON::ParserError => error
       mark_as_malformed!("JSON::ParserError: #{error.message}")
@@ -60,7 +63,16 @@ module Rabbit::Receiving
         data: data,
         arguments: arguments,
         original_message: original_message,
+        compress: compress,
       }
     end
+
+    private
+
+    def parsed_data(value)
+      return JSON.parse(value).deep_symbolize_keys unless compress
+
+      Rabbit::Compressor.load(value, msgpack_options: { symbolize_keys: true }, with_base64: true)
+    end
   end
 end

data/lib/rabbit/receiving/worker.rb

@@ -4,6 +4,7 @@ require "sneakers"
 
 require "rabbit"
 require "rabbit/receiving/receive"
+require "base64"
 
 class Rabbit::Receiving::Worker
   include Sneakers::Worker
@@ -29,8 +30,10 @@ class Rabbit::Receiving::Worker
   end
 
   def receive_message(message, delivery_info, arguments)
+    compress = arguments.dig(:headers, "compress") || false
+
     Rabbit::Receiving::Receive.new(
-      message: message.dup.force_encoding("UTF-8"),
+      message: prepare_message_for_receiving(message.dup, compress),
       delivery_info: delivery_info,
       arguments: arguments,
     ).call
@@ -49,4 +52,12 @@ class Rabbit::Receiving::Worker
     @queue.instance_variable_set(:@banny, nil)
     run
   end
+
+  private
+
+  def prepare_message_for_receiving(message, compress)
+    return Base64.strict_encode64(message.b) if compress
+
+    message.force_encoding("UTF-8")
+  end
 end

data/lib/rabbit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rabbit
-  VERSION = "1.6.3"
+  VERSION = "1.8.0"
 end

data/lib/rabbit.rb

@@ -4,6 +4,7 @@ require "rabbit/version"
 require "rabbit/daemon"
 require "rabbit/publishing"
 require "rabbit/event_handler"
+require "rabbit/compressor"
 
 require "rabbit/extensions/bunny/channel"
 
@@ -18,6 +19,8 @@ module Rabbit
                   :hooks,
                   :queue_name_conversion,
                   :receiving_job_class_callable,
+                  :publishing_job_class_callable,
+                  :default_publishing_job_queue,
                   :handler_resolver_callable,
                   :exception_notifier,
                   :before_receiving_hooks,
@@ -41,6 +44,8 @@ module Rabbit
       environment: :production,
       queue_name_conversion: nil,
       receiving_job_class_callable: nil,
+      publishing_job_class_callable: nil,
+      default_publishing_job_queue: :default,
       handler_resolver_callable: nil,
       exception_notifier: nil,
       before_receiving_hooks: [],
@@ -63,6 +68,8 @@ module Rabbit
       self.environment = environment.to_sym
       self.queue_name_conversion = queue_name_conversion
       self.receiving_job_class_callable = receiving_job_class_callable
+      self.publishing_job_class_callable = publishing_job_class_callable
+      self.default_publishing_job_queue = default_publishing_job_queue
       self.handler_resolver_callable = handler_resolver_callable
       self.exception_notifier = exception_notifier
       self.before_receiving_hooks = before_receiving_hooks
@@ -163,13 +170,35 @@ module Rabbit
     config.validate!
   end
 
-  def publish(message_options)
-    message = Publishing::Message.new(message_options)
+  def publish(
+    routing_key: nil,
+    event: nil,
+    data: {},
+    exchange_name: [],
+    confirm_select: true,
+    realtime: false,
+    headers: {},
+    message_id: nil,
+    custom_queue_name: nil
+  )
+    message = Publishing::Message.new(
+      routing_key: routing_key,
+      event: event,
+      data: data,
+      exchange_name: exchange_name,
+      confirm_select: confirm_select,
+      realtime: realtime,
+      headers: headers,
+      message_id: message_id,
+    )
+    job_class = config.publishing_job_class_callable
+    publish_job_callable = job_class.is_a?(Proc) ? job_class.call : (job_class || Publishing::Job)
+    queue_name = custom_queue_name || default_queue_name
 
     if message.realtime?
       Publishing.publish(message)
     else
-      Publishing::Job.set(queue: default_queue_name).perform_later(message.to_hash)
+      publish_job_callable.set(queue: queue_name).perform_later(message.to_hash)
     end
   end
 
@@ -179,6 +208,6 @@ module Rabbit
   end
 
   def default_queue_name(ignore_conversion: false)
-    queue_name(:default, ignore_conversion: ignore_conversion)
+    queue_name(config.default_publishing_job_queue, ignore_conversion: ignore_conversion)
   end
 end

data/rabbit_messaging.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "bunny", "~> 2.0"
   spec.add_dependency "kicks"
+  spec.add_dependency "msgpack"
+  spec.add_dependency "zlib"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rabbit_messaging
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.8.0
 platform: ruby
 authors:
 - Umbrellio
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -38,6 +37,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zlib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rabbit (Rabbit Messaging)
 email:
 - oss@umbrellio.biz
@@ -60,6 +87,7 @@ files:
 - config/sneakers.yml
 - environments/development.rb
 - lib/rabbit.rb
+- lib/rabbit/compressor.rb
 - lib/rabbit/daemon.rb
 - lib/rabbit/event_handler.rb
 - lib/rabbit/extensions/bunny/channel.rb
@@ -84,7 +112,6 @@ files:
 homepage: https://github.com/umbrellio/rabbit_messaging
 licenses: []
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -99,8 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Rabbit (Rabbit Messaging)
 test_files: []