phobos 1.9.0.pre.beta1 → 1.9.0.pre.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ac51b2a5d3cdaa995dc2f8dfca3d8597c225c0b311724655712bb1ba7060991
-  data.tar.gz: d58bf202dced7bf24c483b0cd2067e4e13e2a43e8f1cfa756377ccf1cf4861dc
+  metadata.gz: f2b2f9eeb44e40d9cb01add121e7b388c66e99f5482e5f2ec78bb7bc3263bd32
+  data.tar.gz: 796484971553a2b19edc18f0e4192ffaece1de0c27894bfa0344b0af29fc3f23
 SHA512:
-  metadata.gz: 4b41e84f671b6f59d94bced995a491818468b1932fe22309e55bff1236d5f165c624d65647bc24ce054f5ab41e8ed20a53ffdb04ab21d755a3fa46cc52e9ba24
-  data.tar.gz: 69651f14500c3c0126b55429f0c5fd8bc2118845a6eac07147cd4c7cd87aa12d7f101a79f250cd428747c322ad469121af8a10fe94af3bc1f5fa67c70d0666a6
+  metadata.gz: 0f2f422bff9b56354c1378c283090277a1af164b2b8a3f9a038c85a25157131e1e2cd005d37e72ba21d921620521210020859368b42851dc110043395052ab11
+  data.tar.gz: dbd23e7210111e63921854bf279c0f64aa9a4ba426f24af897924a1c6a76cb24a19be4c35db1105013c0d0de3c6a6e2bb73272df6cce9b24e4dce9c9a445becf

data/CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ``
 ## UNRELEASED
 
+## [1.9.0-beta2] - 2020-01-09
+
+- Allow `around_consume` to yield payload and metadata, and deprecate
+  `before_consume` and `around_consume` that does not yield anything.
+
 ## [1.9.0-beta1] - 2019-12-18
 - Update `publish` and `async_publish` to use keyword arguments
   instead of positional ones. Deprecate positional arguments

data/README.md

@@ -169,7 +169,7 @@ class MyHandler
 
   def around_consume(payload, metadata)
     Phobos.logger.info "consuming..."
-    output = yield
+    output = yield payload, metadata
     Phobos.logger.info "done, output: #{output}"
   end
 
@@ -187,7 +187,7 @@ class MyHandler
 
   def self.around_consume(payload, metadata)
     Phobos.logger.info "consuming..."
-    output = yield
+    output = yield payload, metadata
     Phobos.logger.info "done, output: #{output}"
   end
 
@@ -197,18 +197,7 @@ class MyHandler
 end
 ```
 
-Finally, it is also possible to preprocess the message payload before consuming it using the `before_consume` hook which is invoked before `#around_consume` and `#consume`. The result of this operation will be assigned to payload, so it is important to return the modified payload. This can be very useful, for example if you want a single point of decoding Avro messages and want the payload as a hash instead of a binary.
-
-```ruby
-class MyHandler
-  include Phobos::Handler
-
-  def before_consume(payload, metadata)
-    # optionally preprocess payload
-    payload
-  end
-end
-```
+Note: Previous versions used a `before_consume` method to pre-process the payload. This is still supported, but deprecated. Going forward, `around_consume` should yield the payload and metadata back to the calling code, allowing it to act as a pre-processor, e.g. by decoding Avro messages into Ruby hashes.
 
 Take a look at the examples folder for some ideas.
 
@@ -218,7 +207,7 @@ The hander life cycle can be illustrated as:
 
 or optionally,
 
-  `.start` -> `#before_consume` -> `#around_consume` [ `#consume` ] -> `.stop`
+  `.start` -> `#around_consume` [ `#consume` ] -> `.stop`
 
 #### Batch Consumption
 
@@ -242,14 +231,12 @@ instance method `headers` with the headers for that message.
 class MyBatchHandler
   include Phobos::BatchHandler
 
-  def before_consume_batch(payloads, metadata)
+  def around_consume_batch(payloads, metadata)
     payloads.each do |p|
       p.payload[:timestamp] = Time.zone.now
     end
-  end
 
-  def around_consume_batch(payloads, metadata)
-    yield
+    yield payloads, metadata
   end
 
   def consume_batch(payloads, metadata)
@@ -625,7 +612,6 @@ describe MyConsumer do
 
   it 'consumes my message' do
     expect_any_instance_of(described_class).to receive(:around_consume).with(payload, metadata).once.and_call_original
-    expect_any_instance_of(described_class).to receive(:before_consume).with(payload, metadata).once.and_call_original
     expect_any_instance_of(described_class).to receive(:consume).with(payload, metadata).once.and_call_original
 
     process_message(handler: described_class, payload: payload, metadata: metadata)

data/lib/phobos/actions/process_batch_inline.rb

@@ -47,12 +47,30 @@ module Phobos
         )
       end
 
+      def preprocess(batch, handler)
+        if handler.respond_to?(:before_consume_batch)
+          Phobos.deprecate('before_consume_batch is deprecated and will be removed in 2.0. \
+                            Use around_consume_batch and yield payloads and metadata objects.')
+          handler.before_consume_batch(batch, @metadata)
+        else
+          batch
+        end
+      end
+
       def process_batch(batch)
         instrument('listener.process_batch_inline', @metadata) do |_metadata|
           handler = @listener.handler_class.new
 
-          preprocessed_batch = handler.before_consume_batch(batch, @metadata)
-          consume_block = proc { handler.consume_batch(preprocessed_batch, @metadata) }
+          preprocessed_batch = preprocess(batch, handler)
+          consume_block = proc { |around_batch, around_metadata|
+            if around_batch
+              handler.consume_batch(around_batch, around_metadata)
+            else
+              Phobos.deprecate('Calling around_consume_batch without yielding payloads \
+                                and metadata is deprecated and will be removed in 2.0.')
+              handler.consume_batch(preprocessed_batch, @metadata)
+            end
+          }
 
           handler.around_consume_batch(preprocessed_batch, @metadata, &consume_block)
         end

data/lib/phobos/actions/process_message.rb

@@ -35,33 +35,50 @@ module Phobos
 
       private
 
+      def preprocess(payload, handler)
+        if handler.respond_to?(:before_consume)
+          Phobos.deprecate('before_consume is deprecated and will be removed in 2.0. \
+                            Use around_consume and yield payload and metadata objects.')
+          begin
+            handler.before_consume(payload, @metadata)
+          rescue ArgumentError
+            handler.before_consume(payload)
+          end
+        else
+          payload
+        end
+      end
+
+      def consume_block(payload, handler)
+        proc { |around_payload, around_metadata|
+          if around_payload
+            handler.consume(around_payload, around_metadata)
+          else
+            Phobos.deprecate('Calling around_consume without yielding payload and metadata \
+                              is deprecated and will be removed in 2.0.')
+            handler.consume(payload, @metadata)
+          end
+        }
+      end
+
       def process_message(payload)
         instrument('listener.process_message', @metadata) do
           handler = @listener.handler_class.new
 
-          preprocessed_payload = before_consume(handler, payload)
-          consume_block = proc { handler.consume(preprocessed_payload, @metadata) }
+          preprocessed_payload = preprocess(payload, handler)
+          block = consume_block(preprocessed_payload, handler)
 
           if @listener.handler_class.respond_to?(:around_consume)
             # around_consume class method implementation
             Phobos.deprecate('around_consume has been moved to instance method, please update '\
                              'your consumer. This will not be backwards compatible in the future.')
-            @listener.handler_class.around_consume(preprocessed_payload, @metadata, &consume_block)
+            @listener.handler_class.around_consume(preprocessed_payload, @metadata, &block)
           else
             # around_consume instance method implementation
-            handler.around_consume(preprocessed_payload, @metadata, &consume_block)
+            handler.around_consume(preprocessed_payload, @metadata, &block)
           end
         end
       end
-
-      def before_consume(handler, payload)
-        handler.before_consume(payload, @metadata)
-      rescue ArgumentError
-        Phobos.deprecate('before_consume now expects metadata as second argument, please update '\
-                         'your consumer. This will not be backwards compatible in the future.')
-
-        handler.before_consume(payload)
-      end
     end
   end
 end

data/lib/phobos/batch_handler.rb

@@ -6,16 +6,12 @@ module Phobos
       base.extend(ClassMethods)
     end
 
-    def before_consume_batch(payloads, _metadata)
-      payloads
-    end
-
     def consume_batch(_payloads, _metadata)
       raise NotImplementedError
     end
 
-    def around_consume_batch(_payloads, _metadata)
-      yield
+    def around_consume_batch(payloads, metadata)
+      yield payloads, metadata
     end
 
     module ClassMethods

data/lib/phobos/handler.rb

@@ -6,16 +6,12 @@ module Phobos
       base.extend(ClassMethods)
     end
 
-    def before_consume(payload, _metadata)
-      payload
-    end
-
     def consume(_payload, _metadata)
       raise NotImplementedError
     end
 
-    def around_consume(_payload, _metadata)
-      yield
+    def around_consume(payload, metadata)
+      yield payload, metadata
     end
 
     module ClassMethods

data/lib/phobos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Phobos
-  VERSION = '1.9.0-beta1'
+  VERSION = '1.9.0-beta2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phobos
 version: !ruby/object:Gem::Version
-  version: 1.9.0.pre.beta1
+  version: 1.9.0.pre.beta2
 platform: ruby
 authors:
 - Túlio Ornelas
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-18 00:00:00.000000000 Z
+date: 2020-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler