hutch 0.19.0-java

data/lib/hutch.rb

@@ -0,0 +1,62 @@
+require 'hutch/adapter'
+require 'hutch/consumer'
+require 'hutch/worker'
+require 'hutch/broker'
+require 'hutch/logging'
+require 'hutch/serializers/identity'
+require 'hutch/serializers/json'
+require 'hutch/config'
+require 'hutch/message'
+require 'hutch/cli'
+require 'hutch/version'
+require 'hutch/error_handlers'
+require 'hutch/exceptions'
+require 'hutch/tracers'
+
+module Hutch
+
+  def self.register_consumer(consumer)
+    self.consumers << consumer
+  end
+
+  def self.consumers
+    @consumers ||= []
+  end
+
+  def self.logger
+    Hutch::Logging.logger
+  end
+
+  def self.global_properties=(properties)
+    @global_properties = properties
+  end
+
+  def self.global_properties
+    @global_properties ||= {}
+  end
+
+  def self.connect(options = {}, config = Hutch::Config)
+    unless connected?
+      @broker = Hutch::Broker.new(config)
+      @broker.connect(options)
+    end
+  end
+
+  def self.disconnect
+    @broker.disconnect if @broker
+  end
+
+  def self.broker
+    @broker
+  end
+
+  def self.connected?
+    return false unless broker
+    return false unless broker.connection
+    broker.connection.open?
+  end
+
+  def self.publish(*args)
+    broker.publish(*args)
+  end
+end

data/lib/hutch/adapter.rb

@@ -0,0 +1,11 @@
+if defined?(JRUBY_VERSION)
+  require 'hutch/adapters/march_hare'
+  module Hutch
+    Adapter = Adapters::MarchHareAdapter
+  end
+else
+  require 'hutch/adapters/bunny'
+  module Hutch
+    Adapter = Adapters::BunnyAdapter
+  end
+end

data/lib/hutch/adapters/bunny.rb

@@ -0,0 +1,33 @@
+require 'bunny'
+require 'forwardable'
+
+module Hutch
+  module Adapters
+    class BunnyAdapter
+      extend Forwardable
+
+      DEFAULT_VHOST = Bunny::Session::DEFAULT_VHOST
+
+      ConnectionRefused = Bunny::TCPConnectionFailed
+      PreconditionFailed = Bunny::PreconditionFailed
+
+      def_delegators :@connection, :start, :disconnect, :close, :create_channel, :open?
+
+      def initialize(opts={})
+        @connection = Bunny.new(opts)
+      end
+
+      def self.decode_message(delivery_info, properties, payload)
+        [delivery_info, properties, payload]
+      end
+
+      def prefetch_channel(ch, prefetch)
+        ch.prefetch(prefetch) if prefetch
+      end
+
+      def current_timestamp
+        Time.now.to_i
+      end
+    end
+  end
+end

data/lib/hutch/adapters/march_hare.rb

@@ -0,0 +1,37 @@
+require 'march_hare'
+require 'forwardable'
+
+module Hutch
+  module Adapters
+    class MarchHareAdapter
+      extend Forwardable
+
+      DEFAULT_VHOST = "/"
+
+      ConnectionRefused = MarchHare::ConnectionRefused
+      PreconditionFailed = MarchHare::PreconditionFailed
+
+      def_delegators :@connection, :start, :disconnect, :close, :open?
+
+      def initialize(opts = {})
+        @connection = MarchHare.connect(opts)
+      end
+
+      def self.decode_message(delivery_info, payload)
+        [delivery_info, delivery_info.properties, payload]
+      end
+
+      def prefetch_channel(ch, prefetch)
+        ch.prefetch = prefetch if prefetch
+      end
+
+      def create_channel(n = nil, consumer_pool_size = 1)
+        @connection.create_channel(n)
+      end
+
+      def current_timestamp
+        Time.now
+      end
+    end
+  end
+end

data/lib/hutch/broker.rb

@@ -0,0 +1,374 @@
+require 'carrot-top'
+require 'securerandom'
+require 'hutch/logging'
+require 'hutch/exceptions'
+
+module Hutch
+  class Broker
+    include Logging
+
+    attr_accessor :connection, :channel, :exchange, :api_client
+
+    def initialize(config = nil)
+      @config = config || Hutch::Config
+    end
+
+    def connect(options = {})
+      @options = options
+      set_up_amqp_connection
+      if http_api_use_enabled?
+        logger.info "HTTP API use is enabled"
+        set_up_api_connection
+      else
+        logger.info "HTTP API use is disabled"
+      end
+
+      if tracing_enabled?
+        logger.info "tracing is enabled using #{@config[:tracer]}"
+      else
+        logger.info "tracing is disabled"
+      end
+
+      if block_given?
+        begin
+          yield
+        ensure
+          disconnect
+        end
+      end
+    end
+
+    def disconnect
+      @channel.close    if @channel
+      @connection.close if @connection
+      @channel, @connection, @exchange, @api_client = nil, nil, nil, nil
+    end
+
+    # Connect to RabbitMQ via AMQP. This sets up the main connection and
+    # channel we use for talking to RabbitMQ. It also ensures the existance of
+    # the exchange we'll be using.
+    def set_up_amqp_connection
+      open_connection!
+      open_channel!
+
+      exchange_name = @config[:mq_exchange]
+      logger.info "using topic exchange '#{exchange_name}'"
+
+      with_bunny_precondition_handler('exchange') do
+        @exchange = @channel.topic(exchange_name, durable: true)
+      end
+    end
+
+    def open_connection!
+      logger.info "connecting to rabbitmq (#{sanitized_uri})"
+
+      @connection = Hutch::Adapter.new(connection_params)
+
+      with_bunny_connection_handler(sanitized_uri) do
+        @connection.start
+      end
+
+      logger.info "connected to RabbitMQ at #{connection_params[:host]} as #{connection_params[:username]}"
+      @connection
+    end
+
+    def open_channel!
+      logger.info "opening rabbitmq channel with pool size #{consumer_pool_size}"
+      @channel = @connection.create_channel(nil, consumer_pool_size).tap do |ch|
+        @connection.prefetch_channel(ch, @config[:channel_prefetch])
+        if @config[:publisher_confirms] || @config[:force_publisher_confirms]
+          logger.info 'enabling publisher confirms'
+          ch.confirm_select
+        end
+      end
+    end
+
+    # Set up the connection to the RabbitMQ management API. Unfortunately, this
+    # is necessary to do a few things that are impossible over AMQP. E.g.
+    # listing queues and bindings.
+    def set_up_api_connection
+      logger.info "connecting to rabbitmq HTTP API (#{api_config.sanitized_uri})"
+
+      with_authentication_error_handler do
+        with_connection_error_handler do
+          @api_client = CarrotTop.new(host: api_config.host, port: api_config.port,
+                                      user: api_config.username, password: api_config.password,
+                                      ssl: api_config.ssl)
+          @api_client.exchanges
+        end
+      end
+    end
+
+    def http_api_use_enabled?
+      op = @options.fetch(:enable_http_api_use, true)
+      cf = if @config[:enable_http_api_use].nil?
+             true
+           else
+             @config[:enable_http_api_use]
+           end
+
+      op && cf
+    end
+
+    def tracing_enabled?
+      @config[:tracer] && @config[:tracer] != Hutch::Tracers::NullTracer
+    end
+
+    # Create / get a durable queue and apply namespace if it exists.
+    def queue(name, arguments = {})
+      with_bunny_precondition_handler('queue') do
+        namespace = @config[:namespace].to_s.downcase.gsub(/[^-_:\.\w]/, "")
+        name = name.prepend(namespace + ":") unless namespace.empty?
+        channel.queue(name, durable: true, arguments: arguments)
+      end
+    end
+
+    # Return a mapping of queue names to the routing keys they're bound to.
+    def bindings
+      results = Hash.new { |hash, key| hash[key] = [] }
+      @api_client.bindings.each do |binding|
+        next if binding['destination'] == binding['routing_key']
+        next unless binding['source'] == @config[:mq_exchange]
+        next unless binding['vhost'] == @config[:mq_vhost]
+        results[binding['destination']] << binding['routing_key']
+      end
+      results
+    end
+
+    # Bind a queue to the broker's exchange on the routing keys provided. Any
+    # existing bindings on the queue that aren't present in the array of
+    # routing keys will be unbound.
+    def bind_queue(queue, routing_keys)
+      if http_api_use_enabled?
+        # Find the existing bindings, and unbind any redundant bindings
+        queue_bindings = bindings.select { |dest, keys| dest == queue.name }
+        queue_bindings.each do |dest, keys|
+          keys.reject { |key| routing_keys.include?(key) }.each do |key|
+            logger.debug "removing redundant binding #{queue.name} <--> #{key}"
+            queue.unbind(@exchange, routing_key: key)
+          end
+        end
+      end
+
+      # Ensure all the desired bindings are present
+      routing_keys.each do |routing_key|
+        logger.debug "creating binding #{queue.name} <--> #{routing_key}"
+        queue.bind(@exchange, routing_key: routing_key)
+      end
+    end
+
+    # Each subscriber is run in a thread. This calls Thread#join on each of the
+    # subscriber threads.
+    def wait_on_threads(timeout)
+      # Thread#join returns nil when the timeout is hit. If any return nil,
+      # the threads didn't all join so we return false.
+      per_thread_timeout = timeout.to_f / work_pool_threads.length
+      work_pool_threads.none? { |thread| thread.join(per_thread_timeout).nil? }
+    end
+
+    def stop
+      if defined?(JRUBY_VERSION)
+        channel.close
+      else
+        # Enqueue a failing job that kills the consumer loop
+        channel_work_pool.shutdown
+        # Give `timeout` seconds to jobs that are still being processed
+        channel_work_pool.join(@config[:graceful_exit_timeout])
+        # If after `timeout` they are still running, they are killed
+        channel_work_pool.kill
+      end
+    end
+
+    def requeue(delivery_tag)
+      @channel.reject(delivery_tag, true)
+    end
+
+    def reject(delivery_tag, requeue=false)
+      @channel.reject(delivery_tag, requeue)
+    end
+
+    def ack(delivery_tag)
+      @channel.ack(delivery_tag, false)
+    end
+
+    def nack(delivery_tag)
+      @channel.nack(delivery_tag, false, false)
+    end
+
+    def publish(routing_key, message, properties = {}, options = {})
+      ensure_connection!(routing_key, message)
+
+      serializer = options[:serializer] || @config[:serializer]
+
+      non_overridable_properties = {
+        routing_key:  routing_key,
+        timestamp:    @connection.current_timestamp,
+        content_type: serializer.content_type,
+      }
+      properties[:message_id]   ||= generate_id
+
+      payload = serializer.encode(message)
+      logger.info {
+        spec =
+          if serializer.binary?
+            "#{payload.bytesize} bytes message"
+          else
+            "message '#{payload}'"
+          end
+        "publishing #{spec} to #{routing_key}"
+      }
+
+      response = @exchange.publish(payload, {persistent: true}.
+        merge(properties).
+        merge(global_properties).
+        merge(non_overridable_properties))
+
+      channel.wait_for_confirms if @config[:force_publisher_confirms]
+      response
+    end
+
+    def confirm_select(*args)
+      @channel.confirm_select(*args)
+    end
+
+    def wait_for_confirms
+      @channel.wait_for_confirms
+    end
+
+    def using_publisher_confirmations?
+      @channel.using_publisher_confirmations?
+    end
+
+    private
+
+    def raise_publish_error(reason, routing_key, message)
+      msg = "unable to publish - #{reason}. Message: #{JSON.dump(message)}, Routing key: #{routing_key}."
+      logger.error(msg)
+      raise PublishError, msg
+    end
+
+    def ensure_connection!(routing_key, message)
+      raise_publish_error('no connection to broker', routing_key, message) unless @connection
+      raise_publish_error('connection is closed', routing_key, message) unless @connection.open?
+    end
+
+    def api_config
+      @api_config ||= OpenStruct.new.tap do |config|
+        config.host = @config[:mq_api_host]
+        config.port = @config[:mq_api_port]
+        config.username = @config[:mq_username]
+        config.password = @config[:mq_password]
+        config.ssl = @config[:mq_api_ssl]
+        config.protocol = config.ssl ? "https://" : "http://"
+        config.sanitized_uri = "#{config.protocol}#{config.username}@#{config.host}:#{config.port}/"
+      end
+    end
+
+    def connection_params
+      parse_uri
+
+      {}.tap do |params|
+        params[:host]               = @config[:mq_host]
+        params[:port]               = @config[:mq_port]
+        params[:vhost]              = if @config[:mq_vhost] && "" != @config[:mq_vhost]
+                                        @config[:mq_vhost]
+                                      else
+                                        Hutch::Adapter::DEFAULT_VHOST
+                                      end
+        params[:username]           = @config[:mq_username]
+        params[:password]           = @config[:mq_password]
+        params[:tls]                = @config[:mq_tls]
+        params[:tls_key]            = @config[:mq_tls_key]
+        params[:tls_cert]           = @config[:mq_tls_cert]
+        params[:verify_peer]        = @config[:mq_verify_peer]
+        if @config[:mq_tls_ca_certificates]
+          params[:tls_ca_certificates] = @config[:mq_tls_ca_certificates]
+        end
+        params[:heartbeat]          = @config[:heartbeat]
+        params[:connection_timeout] = @config[:connection_timeout]
+        params[:read_timeout]       = @config[:read_timeout]
+        params[:write_timeout]      = @config[:write_timeout]
+
+
+        params[:automatically_recover] = true
+        params[:network_recovery_interval] = 1
+
+        params[:client_logger] = @config[:client_logger] if @config[:client_logger]
+      end
+    end
+
+    def parse_uri
+      return unless @config[:uri] && !@config[:uri].empty?
+
+      u = URI.parse(@config[:uri])
+
+      @config[:mq_host]     = u.host
+      @config[:mq_port]     = u.port
+      @config[:mq_vhost]    = u.path.sub(/^\//, "")
+      @config[:mq_username] = u.user
+      @config[:mq_password] = u.password
+    end
+
+    def sanitized_uri
+      p = connection_params
+      scheme = p[:tls] ? "amqps" : "amqp"
+
+      "#{scheme}://#{p[:username]}@#{p[:host]}:#{p[:port]}/#{p[:vhost].sub(/^\//, '')}"
+    end
+
+    def with_authentication_error_handler
+      yield
+    rescue Net::HTTPServerException => ex
+      logger.error "HTTP API connection error: #{ex.message.downcase}"
+      if ex.response.code == '401'
+        raise AuthenticationError.new('invalid HTTP API credentials')
+      else
+        raise
+      end
+    end
+
+    def with_connection_error_handler
+      yield
+    rescue Errno::ECONNREFUSED => ex
+      logger.error "HTTP API connection error: #{ex.message.downcase}"
+      raise ConnectionError.new("couldn't connect to HTTP API at #{api_config.sanitized_uri}")
+    end
+
+    def with_bunny_precondition_handler(item)
+      yield
+    rescue Hutch::Adapter::PreconditionFailed => ex
+      logger.error ex.message
+      s = "RabbitMQ responded with 406 Precondition Failed when creating this #{item}. " +
+          "Perhaps it is being redeclared with non-matching attributes"
+      raise WorkerSetupError.new(s)
+    end
+
+    def with_bunny_connection_handler(uri)
+      yield
+    rescue Hutch::Adapter::ConnectionRefused => ex
+      logger.error "amqp connection error: #{ex.message.downcase}"
+      raise ConnectionError.new("couldn't connect to rabbitmq at #{uri}. Check your configuration, network connectivity and RabbitMQ logs.")
+    end
+
+    def work_pool_threads
+      channel_work_pool.threads || []
+    end
+
+    def channel_work_pool
+      @channel.work_pool
+    end
+
+    def consumer_pool_size
+      @config[:consumer_pool_size]
+    end
+
+    def generate_id
+      SecureRandom.uuid
+    end
+
+    def global_properties
+      Hutch.global_properties.respond_to?(:call) ? Hutch.global_properties.call : Hutch.global_properties
+    end
+
+  end
+end