pwwka 0.7.0.RC1 → 0.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +12 -9
- data/README.md +2 -28
- data/lib/pwwka/channel_connector.rb +1 -13
- data/lib/pwwka/configuration.rb +0 -2
- data/lib/pwwka/receiver.rb +6 -10
- data/lib/pwwka/test_handler.rb +2 -2
- data/lib/pwwka/version.rb +1 -1
- data/spec/receiver_spec.rb +0 -42
- data/spec/spec_helper.rb +1 -1
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5d748e0097f28d4bac944b11074a16298e986063
|
4
|
+
data.tar.gz: e8bbbf37f1e6d71c95b3ce448dfb09f6e8eaa78b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b1074d5e3420223ca2d3ea219119f288adce4b464d15dd6312ac7ae8880ad757b335b2f8d78762649d532f42a022eda478fc9980be7e30508f9df7cdf25a9d5e
|
7
|
+
data.tar.gz: 87a47d11cf6e95683393162cc60ca3986a802394a4cf6ff583883ee7d7794f68ef15cf6e63e6d97408a035b55cb44fdb7a92629a05c352f3e9bb5602f00d8812
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
pwwka (0.7.0
|
4
|
+
pwwka (0.7.0)
|
5
5
|
activemodel
|
6
6
|
activesupport
|
7
7
|
bunny
|
@@ -10,20 +10,23 @@ PATH
|
|
10
10
|
GEM
|
11
11
|
remote: https://www.rubygems.org/
|
12
12
|
specs:
|
13
|
-
activemodel (
|
14
|
-
activesupport (=
|
15
|
-
|
16
|
-
|
13
|
+
activemodel (4.2.6)
|
14
|
+
activesupport (= 4.2.6)
|
15
|
+
builder (~> 3.1)
|
16
|
+
activesupport (4.2.6)
|
17
17
|
i18n (~> 0.7)
|
18
|
+
json (~> 1.7, >= 1.7.7)
|
18
19
|
minitest (~> 5.1)
|
20
|
+
thread_safe (~> 0.3, >= 0.3.4)
|
19
21
|
tzinfo (~> 1.1)
|
20
22
|
amq-protocol (2.0.1)
|
21
|
-
|
23
|
+
builder (3.2.2)
|
24
|
+
bunny (2.3.1)
|
22
25
|
amq-protocol (>= 2.0.1)
|
23
|
-
concurrent-ruby (1.0.2)
|
24
26
|
diff-lcs (1.2.5)
|
25
27
|
i18n (0.7.0)
|
26
|
-
|
28
|
+
json (1.8.3)
|
29
|
+
minitest (5.8.4)
|
27
30
|
mono_logger (1.1.0)
|
28
31
|
multi_json (1.11.2)
|
29
32
|
rack (1.6.4)
|
@@ -73,4 +76,4 @@ DEPENDENCIES
|
|
73
76
|
rspec
|
74
77
|
|
75
78
|
BUNDLED WITH
|
76
|
-
1.
|
79
|
+
1.12.5
|
data/README.md
CHANGED
@@ -98,12 +98,12 @@ send_message!(payload, routing_key)
|
|
98
98
|
```
|
99
99
|
|
100
100
|
### Error Handling
|
101
|
-
|
102
101
|
This method accepts several strategies for handling errors, pass in using the `on_error` parameter:
|
103
102
|
|
104
103
|
* `:raise`: Log the error and raise the exception received from Bunny. (default strategy)
|
105
104
|
* `:ignore`: Log the error and return false.
|
106
|
-
* `:resque`: Log the error and return false. Also, enqueue a job with Resque
|
105
|
+
* `:resque`: Log the error and return false. Also, enqueue a job with Resque
|
106
|
+
to send the message. See `send_message_async` below.
|
107
107
|
|
108
108
|
### Delayed Messages
|
109
109
|
You might want to delay sending a message (for example, if you have just created a database
|
@@ -217,32 +217,6 @@ class ClientIndexMessageHandler
|
|
217
217
|
|
218
218
|
end
|
219
219
|
```
|
220
|
-
#### Handling Errors
|
221
|
-
|
222
|
-
By default, if your handler raises an uncaught exception, the message will be Nacked, **but not requeued**. This means
|
223
|
-
it's dropped on the floor and likely won't have been completely processed.
|
224
|
-
|
225
|
-
You can configure `requeue_on_error` in the configuration to change this behavior:
|
226
|
-
|
227
|
-
```ruby
|
228
|
-
require 'pwwka'
|
229
|
-
Pwwka.configure do |config|
|
230
|
-
|
231
|
-
# ...
|
232
|
-
|
233
|
-
config.requeue_on_error = true
|
234
|
-
end
|
235
|
-
```
|
236
|
-
|
237
|
-
This will requeue the message **exactly once**. It uses the headers to check if the message has been retried. If it
|
238
|
-
hasn't, and your handler raises an exception, it will be placed back on the queue. The second time your handler
|
239
|
-
processes it, there is a header indicating it's been retried, so if a failure happens again, the message **is not
|
240
|
-
requeued**.
|
241
|
-
|
242
|
-
Because requeuing puts the message at the head of the queue, a hard failure will result in an infinite loop, which will
|
243
|
-
lead to filling up your queue. Nevertheless, this should address intermittent failures.
|
244
|
-
|
245
|
-
**It is recommended that you set this option**. It's off for backwards compatibility.
|
246
220
|
|
247
221
|
#### Handling Messages with Resque
|
248
222
|
|
@@ -27,18 +27,6 @@ module Pwwka
|
|
27
27
|
end
|
28
28
|
|
29
29
|
def delayed_queue
|
30
|
-
# This works by hacking the dead letter exchange concept with a timeout.
|
31
|
-
# We set up a delayed exchange that has a delayed queue. This queue, configured below,
|
32
|
-
# sets its dead letter exchange to be the main exchange (topic_exchange above).
|
33
|
-
#
|
34
|
-
# This means that when a message send to the delayed queue is either nack'ed with no retry OR
|
35
|
-
# it's TTL expires, it will be sent to the configured dead letter exchange, which is the main topic_exchange.
|
36
|
-
#
|
37
|
-
# Since nothing is actually consuming messages on the delayed queue, the only way messages can be removed and
|
38
|
-
# sent back to the main exchange is if their TTL expires. As you can see in Pwwka::Transmitter#send_delayed_message!
|
39
|
-
# we set an expiration on the message and send it to the delayed exchange. This means that the delay time is the TTL,
|
40
|
-
# so the messages sits in the delayed queue until its TTL/delay expires, and then it's sent onto the
|
41
|
-
# main exchange for everyone to consume. Thus creating a delay.
|
42
30
|
raise_if_delayed_not_allowed
|
43
31
|
@delayed_queue ||= begin
|
44
32
|
queue = channel.queue("pwwka_delayed_#{Pwwka.environment}", durable: true,
|
@@ -47,7 +35,7 @@ module Pwwka
|
|
47
35
|
})
|
48
36
|
queue.bind(delayed_exchange)
|
49
37
|
queue
|
50
|
-
end
|
38
|
+
end
|
51
39
|
end
|
52
40
|
alias :create_delayed_queue :delayed_queue
|
53
41
|
|
data/lib/pwwka/configuration.rb
CHANGED
@@ -10,7 +10,6 @@ module Pwwka
|
|
10
10
|
attr_accessor :logger
|
11
11
|
attr_accessor :options
|
12
12
|
attr_accessor :send_message_resque_backoff_strategy
|
13
|
-
attr_accessor :requeue_on_error
|
14
13
|
|
15
14
|
def initialize
|
16
15
|
@rabbit_mq_host = nil
|
@@ -21,7 +20,6 @@ module Pwwka
|
|
21
20
|
@send_message_resque_backoff_strategy = [5, #intermittent glitch?
|
22
21
|
60, # quick interruption
|
23
22
|
600, 600, 600] # longer-term outage?
|
24
|
-
@requeue_on_error = false
|
25
23
|
end
|
26
24
|
|
27
25
|
def payload_logging
|
data/lib/pwwka/receiver.rb
CHANGED
@@ -29,13 +29,9 @@ module Pwwka
|
|
29
29
|
receiver.ack(delivery_info.delivery_tag)
|
30
30
|
logf "Processed Message on %{queue_name} -> %{payload}, %{routing_key}", queue_name: queue_name, payload: payload, routing_key: delivery_info.routing_key
|
31
31
|
rescue => e
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
else
|
36
|
-
logf "Error Processing Message on %{queue_name} -> %{payload}, %{routing_key}: %{exception}: %{backtrace}", queue_name: queue_name, payload: payload, routing_key: delivery_info.routing_key, exception: e, backtrace: e.backtrace.join(';'), at: :error
|
37
|
-
receiver.nack(delivery_info.delivery_tag)
|
38
|
-
end
|
32
|
+
logf "Error Processing Message on %{queue_name} -> %{payload}, %{routing_key}: %{exception}: %{backtrace}", queue_name: queue_name, payload: payload, routing_key: delivery_info.routing_key, exception: e, backtrace: e.backtrace.join(';'), at: :error
|
33
|
+
# no requeue
|
34
|
+
receiver.nack(delivery_info.delivery_tag)
|
39
35
|
end
|
40
36
|
end
|
41
37
|
rescue Interrupt => _
|
@@ -48,7 +44,7 @@ module Pwwka
|
|
48
44
|
|
49
45
|
def topic_queue
|
50
46
|
@topic_queue ||= begin
|
51
|
-
queue = channel.queue(queue_name, durable: true
|
47
|
+
queue = channel.queue(queue_name, durable: true)
|
52
48
|
queue.bind(topic_exchange, routing_key: routing_key)
|
53
49
|
queue
|
54
50
|
end
|
@@ -67,14 +63,14 @@ module Pwwka
|
|
67
63
|
end
|
68
64
|
|
69
65
|
def drop_queue
|
70
|
-
topic_queue.purge
|
66
|
+
topic_queue.purge
|
71
67
|
topic_queue.delete
|
72
68
|
end
|
73
69
|
|
74
70
|
def test_teardown
|
75
71
|
drop_queue
|
76
72
|
topic_exchange.delete
|
77
|
-
channel_connector.connection_close
|
73
|
+
channel_connector.connection_close
|
78
74
|
end
|
79
75
|
|
80
76
|
end
|
data/lib/pwwka/test_handler.rb
CHANGED
@@ -30,7 +30,7 @@ module Pwwka
|
|
30
30
|
end
|
31
31
|
end
|
32
32
|
|
33
|
-
# Get the message on the queue as TestHandler::Message
|
33
|
+
# Get the message on the queue as TestHandler::Message.
|
34
34
|
def pop_message
|
35
35
|
delivery_info, properties, payload = test_queue.pop
|
36
36
|
Message.new(delivery_info,
|
@@ -70,7 +70,7 @@ module Pwwka
|
|
70
70
|
channel_connector.delayed_exchange.delete
|
71
71
|
end
|
72
72
|
|
73
|
-
channel_connector.connection_close
|
73
|
+
channel_connector.connection_close
|
74
74
|
end
|
75
75
|
|
76
76
|
# Simple class to hold a popped message.
|
data/lib/pwwka/version.rb
CHANGED
data/spec/receiver_spec.rb
CHANGED
@@ -25,7 +25,6 @@ describe Pwwka::Receiver do
|
|
25
25
|
|
26
26
|
after(:each) do
|
27
27
|
Pwwka.configuration.logger = @original_logger
|
28
|
-
Pwwka.configuration.requeue_on_error = false
|
29
28
|
@receiver.test_teardown rescue nil
|
30
29
|
end
|
31
30
|
|
@@ -54,47 +53,6 @@ describe Pwwka::Receiver do
|
|
54
53
|
expect(logger).to have_received(:error).with(/Error Processing Message.*#{Regexp.escape(payload.to_s)}.*#{Regexp.escape(exception.backtrace.join(';'))}/)
|
55
54
|
end
|
56
55
|
|
57
|
-
context "when we're configured to requeue on error" do
|
58
|
-
before do
|
59
|
-
Pwwka.configuration.requeue_on_error = true
|
60
|
-
end
|
61
|
-
it "should nack_requeue the sent message if it hasn't been retried before" do
|
62
|
-
exception = begin
|
63
|
-
raise "blow up"
|
64
|
-
rescue => ex
|
65
|
-
ex
|
66
|
-
end
|
67
|
-
expect(HandyHandler).to receive(:handle!).and_raise(ex)
|
68
|
-
expect(@receiver).not_to receive(:ack)
|
69
|
-
expect(@receiver).to receive(:nack_requeue).with(instance_of(Fixnum))
|
70
|
-
Pwwka::Transmitter.send_message!(payload, routing_key)
|
71
|
-
@receiver.test_teardown # force the message to be processed and exception handled
|
72
|
-
expect(logger).to have_received(:info).with(/START Transmitting.*#{Regexp.escape(payload.to_s)}/)
|
73
|
-
expect(logger).to have_received(:info).with(/END Transmitting.*#{Regexp.escape(payload.to_s)}/)
|
74
|
-
expect(logger).to have_received(:info).with(/AFTER Transmitting.*#{Regexp.escape(payload.to_s)}/)
|
75
|
-
expect(logger).to have_received(:error).with(/Error Processing Message.*#{Regexp.escape(payload.to_s)}.*#{Regexp.escape(exception.backtrace.join(';'))}/)
|
76
|
-
end
|
77
|
-
|
78
|
-
it "should nack the sent message if it HAS been retried before" do
|
79
|
-
# Super cheesy, but I don't see another way to access this
|
80
|
-
allow_any_instance_of(Bunny::DeliveryInfo).to receive(:redelivered).and_return(true)
|
81
|
-
exception = begin
|
82
|
-
raise "blow up"
|
83
|
-
rescue => ex
|
84
|
-
ex
|
85
|
-
end
|
86
|
-
expect(HandyHandler).to receive(:handle!).and_raise(ex)
|
87
|
-
expect(@receiver).not_to receive(:ack)
|
88
|
-
expect(@receiver).to receive(:nack).with(instance_of(Fixnum))
|
89
|
-
Pwwka::Transmitter.send_message!(payload, routing_key)
|
90
|
-
@receiver.test_teardown # force the message to be processed and exception handled
|
91
|
-
expect(logger).to have_received(:info).with(/START Transmitting.*#{Regexp.escape(payload.to_s)}/)
|
92
|
-
expect(logger).to have_received(:info).with(/END Transmitting.*#{Regexp.escape(payload.to_s)}/)
|
93
|
-
expect(logger).to have_received(:info).with(/AFTER Transmitting.*#{Regexp.escape(payload.to_s)}/)
|
94
|
-
expect(logger).to have_received(:error).with(/Error Processing Message.*#{Regexp.escape(payload.to_s)}.*#{Regexp.escape(exception.backtrace.join(';'))}/)
|
95
|
-
end
|
96
|
-
end
|
97
|
-
|
98
56
|
end
|
99
57
|
|
100
58
|
describe "instance methods and ::new" do
|
data/spec/spec_helper.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: pwwka
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.7.0
|
4
|
+
version: 0.7.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Stitch Fix Engineering
|
@@ -15,7 +15,7 @@ authors:
|
|
15
15
|
autorequire:
|
16
16
|
bindir: bin
|
17
17
|
cert_chain: []
|
18
|
-
date: 2016-
|
18
|
+
date: 2016-09-20 00:00:00.000000000 Z
|
19
19
|
dependencies:
|
20
20
|
- !ruby/object:Gem::Dependency
|
21
21
|
name: bunny
|
@@ -183,12 +183,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
183
183
|
version: '0'
|
184
184
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
185
185
|
requirements:
|
186
|
-
- - "
|
186
|
+
- - ">="
|
187
187
|
- !ruby/object:Gem::Version
|
188
|
-
version:
|
188
|
+
version: '0'
|
189
189
|
requirements: []
|
190
190
|
rubyforge_project:
|
191
|
-
rubygems_version: 2.
|
191
|
+
rubygems_version: 2.6.6
|
192
192
|
signing_key:
|
193
193
|
specification_version: 4
|
194
194
|
summary: Send and receive messages via RabbitMQ
|