active_publisher 1.2.5-java → 1.3.0.pre0-java

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA256:
3
- metadata.gz: 7a878924c71e32c34435e80052a8f241b357d2f7b70f3582f7b8920b942e63c0
4
- data.tar.gz: 60b4eb97d20e389ce4865ef393d69a7d49bdac2e47a3aa26eb6e7ca32e459335
2
+ SHA1:
3
+ metadata.gz: 8ab5bdf4352d3913b934a0e54a0085effe6fcf69
4
+ data.tar.gz: 4baa705ae3174699cd4d55ecd51b907dd14ce621
5
5
  SHA512:
6
- metadata.gz: 8f6399701888401993164b31ccb4fff4f14eb13414a7586d7baacac0c49f2c876dfe33035ce091ec4b62ee4a5b64ad961a7deab79691098401388153404c724b
7
- data.tar.gz: 2a1d1347293457b9e5b663d7f4815a176e8d9afdc80e472893c4f1f5206bdfc057bfb6d692067924727aac1e3a6f42bc2fff20cd13698bca12be61e1b72d84bc
6
+ metadata.gz: c47d2ae4a05f959983fe022c6aa2face66684a86b8d9bc3e923f55dcdbdcb826b75c21d1c719ad4ace2e9c3cf2ea2b3aa7d4f43a5e9afd2216399fee7359e5b8
7
+ data.tar.gz: 7930ca08472a9370f6a39789a0d845b19553c0d4ebc98d31f28202182e34a5333a0fe2d5c62678e7972d25a5fc06e60ffffa64d4c2fb939362dba72ba430e89c
data/.travis.yml ADDED
@@ -0,0 +1,9 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.3
4
+ - 2.4
5
+ - jruby-9.1.12.0
6
+ services:
7
+ - rabbitmq
8
+ sudo: false
9
+ cache: bundler
data/README.md CHANGED
@@ -55,7 +55,9 @@ Defaults for the configuration are:
55
55
  :network_recovery_interval => 1,
56
56
  :password => "guest",
57
57
  :port => 5672,
58
+ :publisher_threads => 1,
58
59
  :publisher_confirms => false,
60
+ :publisher_confirms_timeout => 5_000,
59
61
  :seconds_to_wait_for_graceful_shutdown => 30,
60
62
  :timeout => 1,
61
63
  :tls => false,
@@ -35,6 +35,6 @@ Gem::Specification.new do |spec|
35
35
  spec.add_development_dependency "connection_pool"
36
36
  spec.add_development_dependency "fakeredis"
37
37
  spec.add_development_dependency "pry"
38
- spec.add_development_dependency "rake"
38
+ spec.add_development_dependency "rake", "~> 10.0"
39
39
  spec.add_development_dependency "rspec", "~> 3.2"
40
40
  end
@@ -4,6 +4,7 @@ else
4
4
  require "bunny"
5
5
  end
6
6
  require "active_support"
7
+ require "securerandom"
7
8
  require "thread"
8
9
 
9
10
  require "active_publisher/logging"
@@ -35,7 +36,7 @@ module ActivePublisher
35
36
  # @param [Hash] options hash to set message parameters (e.g. headers)
36
37
  def self.publish(route, payload, exchange_name, options = {})
37
38
  with_exchange(exchange_name) do |exchange|
38
- ::ActiveSupport::Notifications.instrument "message_published.active_publisher", :route => route do
39
+ ::ActiveSupport::Notifications.instrument "message_published.active_publisher" do
39
40
  exchange.publish(payload, publishing_options(route, options))
40
41
  end
41
42
  end
@@ -51,7 +52,7 @@ module ActivePublisher
51
52
  fail ActivePublisher::ExchangeMismatchError, "bulk publish messages must match publish_all exchange_name" if message.exchange_name != exchange_name
52
53
 
53
54
  begin
54
- ::ActiveSupport::Notifications.instrument "message_published.active_publisher", :route => message.route do
55
+ ::ActiveSupport::Notifications.instrument "message_published.active_publisher" do
55
56
  exchange.publish(message.payload, publishing_options(message.route, message.options || {}))
56
57
  end
57
58
  rescue
@@ -14,14 +14,15 @@ module ActivePublisher
14
14
  :max_queue_size,
15
15
  :supervisor_interval
16
16
 
17
- attr_reader :consumer, :queue, :supervisor
17
+ attr_reader :consumers, :queue, :supervisor
18
18
 
19
19
  def initialize(back_pressure_strategy, max_queue_size, supervisor_interval)
20
20
  self.back_pressure_strategy = back_pressure_strategy
21
21
  @max_queue_size = max_queue_size
22
22
  @supervisor_interval = supervisor_interval
23
23
  @queue = ::MultiOpQueue::Queue.new
24
- create_and_supervise_consumer!
24
+ @consumers = {}
25
+ create_and_supervise_consumers!
25
26
  end
26
27
 
27
28
  def back_pressure_strategy=(strategy)
@@ -52,36 +53,43 @@ module ActivePublisher
52
53
  def size
53
54
  # Requests might be in flight (out of the queue, but not yet published), so taking the max should be
54
55
  # good enough to make sure we're honest about the actual queue size.
55
- return queue.size if consumer.nil?
56
- [queue.size, consumer.sampled_queue_size].max
56
+ return queue.size if consumers.empty?
57
+ [queue.size, consumer_sampled_queue_size].max
57
58
  end
58
59
 
59
60
  private
60
61
 
61
- def create_and_supervise_consumer!
62
- @consumer = ::ActivePublisher::Async::InMemoryAdapter::ConsumerThread.new(queue)
62
+ def create_and_supervise_consumers!
63
+ ::ActivePublisher.configuration.publisher_threads.times do
64
+ consumer_id = ::SecureRandom.uuid
65
+ consumers[consumer_id] = ::ActivePublisher::Async::InMemoryAdapter::ConsumerThread.new(queue)
66
+ supervisor_task = ::Concurrent::TimerTask.new(:execution_interval => supervisor_interval) do
67
+ current_time = ::Time.now
68
+ consumer = consumers[consumer_id]
63
69
 
64
- supervisor_task = ::Concurrent::TimerTask.new(:execution_interval => supervisor_interval) do
65
- current_time = ::Time.now
70
+ # Consumer is lagging if it does not "tick" at least once every 10 seconds.
71
+ seconds_since_last_tick = current_time - consumer.last_tick_at
72
+ consumer_is_lagging = seconds_since_last_tick > ::ActivePublisher.configuration.max_async_publisher_lag_time
73
+ logger.error "ActivePublisher consumer is lagging. Last consumer tick was #{seconds_since_last_tick} seconds ago." if consumer_is_lagging
66
74
 
67
- # Consumer is lagging if it does not "tick" at least once every 10 seconds.
68
- seconds_since_last_tick = current_time - consumer.last_tick_at
69
- consumer_is_lagging = seconds_since_last_tick > ::ActivePublisher.configuration.max_async_publisher_lag_time
70
- logger.error "ActivePublisher consumer is lagging. Last consumer tick was #{seconds_since_last_tick} seconds ago." if consumer_is_lagging
75
+ # Check to see if we should restart the consumer.
76
+ if !consumer.alive? || consumer_is_lagging
77
+ consumer.kill rescue nil
78
+ consumers[consumer_id] = ::ActivePublisher::Async::InMemoryAdapter::ConsumerThread.new(queue)
79
+ end
71
80
 
72
- # Check to see if we should restart the consumer.
73
- if !consumer.alive? || consumer_is_lagging
74
- consumer.kill rescue nil
75
- @consumer = ::ActivePublisher::Async::InMemoryAdapter::ConsumerThread.new(queue)
81
+ # Notify the current queue size.
82
+ ::ActiveSupport::Notifications.instrument "async_queue_size.active_publisher", queue.size
76
83
  end
77
-
78
- # Notify the current queue size.
79
- ::ActiveSupport::Notifications.instrument "async_queue_size.active_publisher", queue.size
84
+ supervisor_task.execute
80
85
  end
81
- supervisor_task.execute
82
86
  end
83
- end
84
87
 
88
+ def consumer_sampled_queue_size
89
+ consumers.values.map(&:sampled_queue_size).max
90
+ end
91
+
92
+ end
85
93
  end
86
94
  end
87
95
  end
@@ -2,13 +2,7 @@ module ActivePublisher
2
2
  module Async
3
3
  module InMemoryAdapter
4
4
  class ConsumerThread
5
- attr_reader :channel, :thread, :queue, :sampled_queue_size, :last_tick_at
6
-
7
- if ::RUBY_PLATFORM == "java"
8
- CHANNEL_CLOSED_ERRORS = [::MarchHare::ChannelAlreadyClosed]
9
- else
10
- CHANNEL_CLOSED_ERRORS = [::Bunny::ChannelAlreadyClosed]
11
- end
5
+ attr_reader :thread, :queue, :sampled_queue_size, :last_tick_at
12
6
 
13
7
  if ::RUBY_PLATFORM == "java"
14
8
  NETWORK_ERRORS = [::MarchHare::NetworkException, ::MarchHare::ConnectionRefused,
@@ -51,32 +45,6 @@ module ActivePublisher
51
45
  end
52
46
  end
53
47
 
54
- def cleanup_up_channel
55
- return if channel.nil?
56
- channel.close
57
- rescue => error
58
- ::ActivePublisher.configuration.error_handler.call(error, {:status => "Cleaning up the channel"})
59
- end
60
-
61
- def handle_current_messages_on_unknown_error(current_messages)
62
- current_messages.each do |message|
63
- # Degrade to single message publish ... or at least attempt to
64
- begin
65
- ::ActivePublisher.publish(message.route, message.payload, message.exchange_name, message.options)
66
- current_messages.delete(message)
67
- rescue *CHANNEL_CLOSED_ERRORS
68
- # If the channel is bad, raise!
69
- raise
70
- rescue *PRECONDITION_ERRORS => error
71
- # Delete messages if rabbitmq cannot declare the exchange (or somet other precondition failed).
72
- ::ActivePublisher.configuration.error_handler.call(error, {:reason => "precondition failed", :message => message})
73
- current_messages.delete(message)
74
- rescue => other_error
75
- ::ActivePublisher.configuration.error_handler.call(other_error, {:route => message.route, :payload => message.payload, :exchange_name => message.exchange_name, :options => message.options})
76
- end
77
- end
78
- end
79
-
80
48
  def make_channel
81
49
  channel = ::ActivePublisher::Async::InMemoryAdapter::Channel.new
82
50
  channel.confirm_select if ::ActivePublisher.configuration.publisher_confirms
@@ -89,66 +57,70 @@ module ActivePublisher
89
57
 
90
58
  def start_thread
91
59
  return if alive?
92
- @thread = ::Thread.new { start_consuming_thread }
93
- end
94
-
95
- def start_consuming_thread
96
- loop do
97
- # Sample the queue size so we don't shutdown when messages are in flight.
98
- @sampled_queue_size = queue.size
99
- current_messages = queue.pop_up_to(50, :timeout => 0.1)
100
- update_last_tick_at
101
- # If the queue is empty, we should continue to update to "last_tick_at" time.
102
- next if current_messages.nil?
103
-
104
- @channel ||= make_channel
105
-
106
- # We only look at active publisher messages. Everything else is dropped.
107
- current_messages.select! { |message| message.is_a?(::ActivePublisher::Message) }
108
-
109
- begin
110
- # Only open a single connection for each group of messages to an exchange
111
- current_messages.group_by(&:exchange_name).each do |exchange_name, messages|
112
- publish_all(exchange_name, messages)
113
- current_messages -= messages
60
+ @thread = ::Thread.new do
61
+ loop do
62
+ # Sample the queue size so we don't shutdown when messages are in flight.
63
+ @sampled_queue_size = queue.size
64
+ current_messages = queue.pop_up_to(50, :timeout => 0.1)
65
+ update_last_tick_at
66
+ # If the queue is empty, we should continue to update to "last_tick_at" time.
67
+ next if current_messages.nil?
68
+
69
+ # We only look at active publisher messages. Everything else is dropped.
70
+ current_messages.select! { |message| message.is_a?(::ActivePublisher::Message) }
71
+
72
+ begin
73
+ @channel ||= make_channel
74
+
75
+ # Only open a single connection for each group of messages to an exchange
76
+ current_messages.group_by(&:exchange_name).each do |exchange_name, messages|
77
+ publish_all(@channel, exchange_name, messages)
78
+ current_messages -= messages
79
+ end
80
+ rescue *NETWORK_ERRORS
81
+ # Sleep because connection is down
82
+ await_network_reconnect
83
+ rescue => unknown_error
84
+ ::ActivePublisher.configuration.error_handler.call(unknown_error, {:number_of_messages => current_messages.size})
85
+ current_messages.each do |message|
86
+ # Degrade to single message publish ... or at least attempt to
87
+ begin
88
+ ::ActivePublisher.publish(message.route, message.payload, message.exchange_name, message.options)
89
+ current_messages.delete(message)
90
+ rescue *PRECONDITION_ERRORS => error
91
+ # Delete messages if rabbitmq cannot declare the exchange (or somet other precondition failed).
92
+ ::ActivePublisher.configuration.error_handler.call(error, {:reason => "precondition failed", :message => message})
93
+ current_messages.delete(message)
94
+ rescue => individual_error
95
+ ::ActivePublisher.configuration.error_handler.call(individual_error, {:route => message.route, :payload => message.payload, :exchange_name => message.exchange_name, :options => message.options})
96
+ end
97
+ end
98
+
99
+ # TODO: Find a way to bubble this out of the thread for logging purposes.
100
+ # Reraise the error out of the publisher loop. The Supervisor will restart the consumer.
101
+ raise unknown_error
102
+ ensure
103
+ # Always requeue anything that gets stuck.
104
+ queue.concat(current_messages) if current_messages && !current_messages.empty?
114
105
  end
115
- rescue *CHANNEL_CLOSED_ERRORS
116
- # If the channel is bad, raise without sending one-by-one!
117
- raise
118
- rescue *NETWORK_ERRORS
119
- # Sleep because connection is down
120
- await_network_reconnect
121
- rescue => unknown_error
122
- ::ActivePublisher.configuration.error_handler.call(unknown_error, {:number_of_messages => current_messages.size})
123
-
124
- # Attempt to deliver a message one-by-one. Raise if a closed channel error appears.
125
- handle_current_messages_on_unknown_error(current_messages)
126
-
127
- # TODO: Find a way to bubble this out of the thread for logging purposes.
128
- # Reraise the error out of the publisher loop. The Supervisor will restart the consumer.
129
- raise unknown_error
130
- ensure
131
- # Always requeue anything that gets stuck.
132
- queue.concat(current_messages) if current_messages && !current_messages.empty?
133
106
  end
134
107
  end
135
- ensure
136
- cleanup_up_channel
137
108
  end
138
109
 
139
- def publish_all(exchange_name, messages)
140
- exchange = channel.topic(exchange_name)
141
- messages.each do |message|
142
- fail ::ActivePublisher::ExchangeMismatchError, "bulk publish messages must match publish_all exchange_name" if message.exchange_name != exchange_name
143
- ::ActiveSupport::Notifications.instrument "message_published.active_publisher", :route => message.route, :message_count => 1 do
110
+ def publish_all(channel, exchange_name, messages)
111
+ ::ActiveSupport::Notifications.instrument "message_published.active_publisher", :message_count => messages.size do
112
+ exchange = channel.topic(exchange_name)
113
+ messages.each do |message|
114
+ fail ActivePublisher::ExchangeMismatchError, "bulk publish messages must match publish_all exchange_name" if message.exchange_name != exchange_name
115
+
144
116
  options = ::ActivePublisher.publishing_options(message.route, message.options || {})
145
117
  exchange.publish(message.payload, options)
146
118
  end
119
+ wait_for_confirms(channel)
147
120
  end
148
- wait_for_confirms
149
121
  end
150
122
 
151
- def wait_for_confirms
123
+ def wait_for_confirms(channel)
152
124
  return true unless channel.using_publisher_confirms?
153
125
  channel.wait_for_confirms(::ActivePublisher.configuration.publisher_confirms_timeout)
154
126
  end
@@ -11,6 +11,7 @@ module ActivePublisher
11
11
  :network_recovery_interval,
12
12
  :password,
13
13
  :port,
14
+ :publisher_threads,
14
15
  :publisher_confirms,
15
16
  :publisher_confirms_timeout,
16
17
  :seconds_to_wait_for_graceful_shutdown,
@@ -39,6 +40,7 @@ module ActivePublisher
39
40
  :max_async_publisher_lag_time => 10,
40
41
  :network_recovery_interval => NETWORK_RECOVERY_INTERVAL,
41
42
  :port => 5672,
43
+ :publisher_threads => 1,
42
44
  :publisher_confirms => false,
43
45
  :publisher_confirms_timeout => 5_000, #specified as a number of milliseconds
44
46
  :seconds_to_wait_for_graceful_shutdown => 30,
@@ -63,8 +65,8 @@ module ActivePublisher
63
65
 
64
66
  yaml_config = attempt_to_load_yaml_file(env)
65
67
  DEFAULTS.each_pair do |key, value|
66
- exists, setting = fetch_config_value(key, cli_options, yaml_config)
67
- ::ActivePublisher.configuration.public_send("#{key}=", setting) if exists
68
+ setting = cli_options[key] || cli_options[key.to_s] || yaml_config[key] || yaml_config[key.to_s]
69
+ ::ActivePublisher.configuration.public_send("#{key}=", setting) if setting
68
70
  end
69
71
 
70
72
  true
@@ -88,15 +90,6 @@ module ActivePublisher
88
90
  end
89
91
  private_class_method :attempt_to_load_yaml_file
90
92
 
91
- def self.fetch_config_value(key, cli_options, yaml_config)
92
- return [true, cli_options[key]] if cli_options.key?(key)
93
- return [true, cli_options[key.to_s]] if cli_options.key?(key.to_s)
94
- return [true, yaml_config[key]] if yaml_config.key?(key)
95
- return [true, yaml_config[key.to_s]] if yaml_config.key?(key.to_s)
96
- [false, nil]
97
- end
98
- private_class_method :fetch_config_value
99
-
100
93
  ##
101
94
  # Instance Methods
102
95
  #
@@ -31,22 +31,9 @@ module ActivePublisher
31
31
  def self.create_connection
32
32
  if ::RUBY_PLATFORM == "java"
33
33
  connection = ::MarchHare.connect(connection_options)
34
- connection.on_blocked do |reason|
35
- on_blocked(reason)
36
- end
37
- connection.on_unblocked do
38
- on_unblocked
39
- end
40
- connection
41
34
  else
42
35
  connection = ::Bunny.new(connection_options)
43
36
  connection.start
44
- connection.on_blocked do |blocked_message|
45
- on_blocked(blocked_message.reason)
46
- end
47
- connection.on_unblocked do
48
- on_unblocked
49
- end
50
37
  connection
51
38
  end
52
39
  end
@@ -71,15 +58,5 @@ module ActivePublisher
71
58
  }
72
59
  end
73
60
  private_class_method :connection_options
74
-
75
- def self.on_blocked(reason)
76
- ::ActiveSupport::Notifications.instrument("connection_blocked.active_publisher", :reason => reason)
77
- end
78
- private_class_method :on_blocked
79
-
80
- def self.on_unblocked
81
- ::ActiveSupport::Notifications.instrument("connection_unblocked.active_publisher")
82
- end
83
- private_class_method :on_unblocked
84
61
  end
85
62
  end
@@ -1,3 +1,3 @@
1
1
  module ActivePublisher
2
- VERSION = "1.2.5"
2
+ VERSION = "1.3.0.pre0"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: active_publisher
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.5
4
+ version: 1.3.0.pre0
5
5
  platform: java
6
6
  authors:
7
7
  - Brian Stien
@@ -12,7 +12,7 @@ authors:
12
12
  autorequire:
13
13
  bindir: exe
14
14
  cert_chain: []
15
- date: 2020-11-23 00:00:00.000000000 Z
15
+ date: 2018-03-13 00:00:00.000000000 Z
16
16
  dependencies:
17
17
  - !ruby/object:Gem::Dependency
18
18
  requirement: !ruby/object:Gem::Requirement
@@ -143,17 +143,17 @@ dependencies:
143
143
  - !ruby/object:Gem::Dependency
144
144
  requirement: !ruby/object:Gem::Requirement
145
145
  requirements:
146
- - - ">="
146
+ - - "~>"
147
147
  - !ruby/object:Gem::Version
148
- version: '0'
148
+ version: '10.0'
149
149
  name: rake
150
150
  prerelease: false
151
151
  type: :development
152
152
  version_requirements: !ruby/object:Gem::Requirement
153
153
  requirements:
154
- - - ">="
154
+ - - "~>"
155
155
  - !ruby/object:Gem::Version
156
- version: '0'
156
+ version: '10.0'
157
157
  - !ruby/object:Gem::Dependency
158
158
  requirement: !ruby/object:Gem::Requirement
159
159
  requirements:
@@ -179,9 +179,9 @@ executables: []
179
179
  extensions: []
180
180
  extra_rdoc_files: []
181
181
  files:
182
- - ".circleci/config.yml"
183
182
  - ".gitignore"
184
183
  - ".rspec"
184
+ - ".travis.yml"
185
185
  - CODE_OF_CONDUCT.md
186
186
  - Gemfile
187
187
  - LICENSE.txt
@@ -219,12 +219,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
219
219
  version: '0'
220
220
  required_rubygems_version: !ruby/object:Gem::Requirement
221
221
  requirements:
222
- - - ">="
222
+ - - ">"
223
223
  - !ruby/object:Gem::Version
224
- version: '0'
224
+ version: 1.3.1
225
225
  requirements: []
226
226
  rubyforge_project:
227
- rubygems_version: 2.7.9
227
+ rubygems_version: 2.6.13
228
228
  signing_key:
229
229
  specification_version: 4
230
230
  summary: Aims to make publishing work across MRI and jRuby painless and add some nice
data/.circleci/config.yml DELETED
@@ -1,56 +0,0 @@
1
- # Inspired by: http://mikebian.co/running-tests-against-multiple-ruby-versions-using-circleci/
2
-
3
- version: 2.1
4
-
5
- orbs:
6
- ruby: circleci/ruby@1.1
7
-
8
- jobs:
9
- test:
10
- parallelism: 1
11
- parameters:
12
- ruby-image:
13
- type: string
14
- docker:
15
- - image: << parameters.ruby-image >>
16
- - image: rabbitmq
17
-
18
- steps:
19
- - checkout
20
- - run:
21
- name: install dockerize
22
- command: wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz && sudo tar -C /usr/local/bin -xzvf dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz && rm dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz
23
- environment:
24
- DOCKERIZE_VERSION: v0.3.0
25
- - run:
26
- name: Wait for rabbitmq
27
- command: dockerize -wait tcp://localhost:5672 -timeout 1m
28
- - run:
29
- name: Install bundler
30
- command: gem install bundler
31
- - run:
32
- name: Which bundler?
33
- command: bundle -v
34
- - run:
35
- name: bundle install
36
- command: bundle install
37
- - run:
38
- name: rspec
39
- command: bundle exec rspec
40
-
41
- # strangely, there seems to be very little documentation about exactly how martix builds work.
42
- # By defining a param inside your job definition, Circle CI will automatically spawn a job for
43
- # unique param value passed via `matrix`. Neat!
44
- # https://circleci.com/blog/circleci-matrix-jobs/
45
- workflows:
46
- build_and_test:
47
- jobs:
48
- - test:
49
- matrix:
50
- parameters:
51
- ruby-image:
52
- - circleci/ruby:2.5
53
- - circleci/ruby:2.6
54
- - circleci/ruby:2.7
55
- - circleci/jruby:9.1
56
- - circleci/jruby:9.2