Payload Version 2

.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+node_modules/**/*

README.md

@@ -184,6 +184,26 @@ MyModel.multiple_man_publish(:seed)
 
 3. Stop the seeder rake task when all of your messages have been processed. You can check your RabbitMQ server
 
+## Versioning
+
+Because you may have different versions of MultipleMan between publishers and subscribers,
+MultipleMan attaches **versions** to every message sent. This ensures that updates to payloads,
+metadata, etc. will not affect processing of your messages.
+
+In general, a subscriber will not be able to process messages published by a newer version of
+MultipleMan. We use **minor versions** to indicate changes that may contain a breaking change 
+to payload formats.
+
+As a consequence, when upgrading MultipleMan, it's always safe to upgrade patch versions, but
+when upgrading to a new major or minor version, ensure that you upgrade your subscribers
+prior to upgrading your publishers (if two services both subscribe and publish, you'll need to 
+update them synchronously.) 
+
+Currently, the following versions support the following payload versions:
+
+- **Payload v1** - 1.0.x
+- **Payload v2** - 1.1.x
+
 ## Contributing
 
 1. Fork it

lib/multiple_man.rb

@@ -19,12 +19,15 @@ module MultipleMan
   require 'multiple_man/listeners/listener'
   require 'multiple_man/listeners/seeder_listener'
   require 'multiple_man/model_populator'
-  require 'multiple_man/identity'
   require 'multiple_man/publish'
 
   require 'multiple_man/channel_maintenance/gc'
   require 'multiple_man/channel_maintenance/reaper'
 
+  require 'multiple_man/payload/payload'
+  require 'multiple_man/payload/v1'
+  require 'multiple_man/payload/v2'
+
   def self.logger
     configuration.logger
   end

lib/multiple_man/listeners/listener.rb

@@ -32,24 +32,24 @@ def init_connection
     attr_accessor :subscription, :connection
 
     def listen
-
       MultipleMan.logger.info "Listening for #{subscription.klass} with routing key #{routing_key}."
-      queue.bind(connection.topic, routing_key: routing_key).subscribe(ack: true) do |delivery_info, _, payload|
-        process_message(delivery_info, payload)
+      queue.bind(connection.topic, routing_key: routing_key).subscribe(ack: true) do |delivery_info, properties, payload|
+        parsed_payload = MultipleMan::Payload.build(delivery_info, properties, JSON.parse(payload).with_indifferent_access)
+
+        begin
+          process_message(parsed_payload)
+        rescue Exception => ex
+          handle_error(ex, delivery_info)
+        else
+          MultipleMan.logger.debug "   Successfully processed!"
+          queue.channel.acknowledge(delivery_info.delivery_tag, false)
+        end
       end
     end
 
-    def process_message(delivery_info, payload)
-      MultipleMan.logger.info "Processing message for #{delivery_info.routing_key}."
-      begin
-        payload = JSON.parse(payload).with_indifferent_access
-        subscription.send(operation(delivery_info, payload), payload)
-      rescue ex
-        handle_error(ex, delivery_info)
-      else
-        MultipleMan.logger.debug "   Successfully processed!"
-        queue.channel.acknowledge(delivery_info.delivery_tag, false)
-      end
+    def process_message(payload)
+      MultipleMan.logger.info "Processing message for #{payload}."
+      subscription.send(payload.operation, payload)
     end
 
     def handle_error(ex, delivery_info)

lib/multiple_man/model_populator.rb

@@ -7,10 +7,9 @@ def initialize(record, fields)
     end
 
     def populate(payload)
-      data = payload[:id].merge(payload[:data])
-      fields_for(data).each do |field|
+      fields_for(payload).each do |field|
         source, dest = field.is_a?(Array) ? field : [field, field]
-        populate_field(dest, data[source])
+        populate_field(dest, payload[source])
       end
       record
     end
@@ -37,8 +36,8 @@ def populate_field(field, value)
       end
     end
 
-    def fields_for(data)
-      fields || data.keys
+    def fields_for(payload)
+      fields || payload.keys
     end
   end
 end

lib/multiple_man/model_publisher.rb

@@ -33,7 +33,7 @@ def push_record(connection, record, operation)
 
       MultipleMan.logger.debug("  Record Data: #{data} | Routing Key: #{routing_key}")
 
-      connection.topic.publish(data.payload, routing_key: routing_key)
+      connection.topic.publish(data.payload, routing_key: routing_key, headers: data.headers)
     end
 
     def all_records(records, &block)

lib/multiple_man/payload/payload.rb

@@ -0,0 +1,12 @@
+class MultipleMan::Payload
+  def self.build(delivery_info, properties, data)
+    case properties.headers["version"]
+    when "1", nil
+        V1.new(delivery_info, properties, data)
+    when "2"
+        V2.new(delivery_info, properties, data)
+    else
+        raise "This version of MultipleMan does not support the payload version supplied (#{properties.headers["version"]}). Please upgrade to the latest version."
+    end    
+  end
+end

lib/multiple_man/payload/v1.rb

@@ -0,0 +1,34 @@
+
+class MultipleMan::Payload::V1
+  def initialize(delivery_info, properties, payload)
+    self.payload = payload
+    self.delivery_info = delivery_info
+  end
+
+  def keys
+    (payload['data'].keys + payload['id'].keys).uniq
+  end
+
+  def [](value)
+    payload['data'][value.to_s] || payload['id'][value.to_s]
+  end
+
+  def identify_by
+    if payload['id'].is_a?(Hash)
+      payload['id']
+    else
+      {'multiple_man_identifier' => payload['id']}
+    end
+  end
+
+  def operation
+    payload['operation'] || delivery_info.routing_key.split('.').last
+  end
+
+  def to_s
+    delivery_info.routing_key
+  end
+
+private
+  attr_accessor :payload, :delivery_info
+end

lib/multiple_man/payload/v2.rb

@@ -0,0 +1,37 @@
+
+class MultipleMan::Payload::V2
+  def initialize(delivery_info, properties, payload)
+    self.payload = payload
+    self.delivery_info = delivery_info
+    self.properties = properties
+  end
+
+  def keys
+    payload.keys
+  end
+
+  def [](value)
+    payload[value.to_s]
+  end
+
+  def identify_by
+    Hash[identify_by_header.map do |key|
+      [key, payload[key]]
+    end]
+  end
+
+  def operation
+    delivery_info.routing_key.split('.').last
+  end
+
+  def to_s
+    delivery_info.routing_key
+  end
+
+private
+  attr_accessor :payload, :delivery_info, :properties
+
+  def identify_by_header
+    JSON.parse(properties.headers['identify_by'])  
+  end
+end

lib/multiple_man/payload_generator.rb

@@ -7,20 +7,22 @@ def initialize(record, operation = :create, options = {})
     end
 
     def payload
-      {
-        type: type,
-        operation: operation,
-        id: id,
-        data: data
-      }.to_json
+      data.to_json
+    end
+
+    def headers
+      { 
+        'version' => '2',
+        'identify_by' => identify_by.to_json 
+      }
     end
 
     def type
       options[:as] || record.class.name
     end
 
-    def id
-      Identity.build(record, options).value
+    def identify_by
+      [* (options[:identify_by] || :id) ]       
     end
 
     def data

lib/multiple_man/subscribers/base.rb

@@ -7,19 +7,19 @@ def initialize(klass)
 
     attr_reader :klass
 
-    def create(_)
+    def create(payload)
       # noop
     end
 
-    def update(_)
+    def update(payload)
       # noop
     end
 
-    def destroy(_)
+    def destroy(payload)
       # noop
     end
 
-    def seed(_)
+    def seed(payload)
       # noop
     end
 

lib/multiple_man/subscribers/model_subscriber.rb

@@ -10,28 +10,23 @@ def initialize(klass, options)
     attr_accessor :options
 
     def create(payload)
-      id = payload[:id]
-      model = find_model(id)
-      MultipleMan::ModelPopulator.new(model, options[:fields]).populate(id: find_conditions(id), data: payload[:data])
+      model = find_model(payload)
+      MultipleMan::ModelPopulator.new(model, options[:fields]).populate(payload)
       model.save!
     end
 
     alias_method :update, :create
     alias_method :seed, :create
 
     def destroy(payload)
-      model = find_model(payload[:id])
+      model = find_model(payload)
       model.destroy!
     end
 
   private
 
-    def find_model(id)
-      model_class.where(find_conditions(id)).first || model_class.new
-    end
-
-    def find_conditions(id)
-      id.kind_of?(Hash) ? cleanse_id(id) : {multiple_man_identifier: id}
+    def find_model(payload)
+      model_class.where(cleanse_id(payload.identify_by)).first || model_class.new
     end
 
     def cleanse_id(hash)

lib/multiple_man/version.rb

@@ -1,3 +1,3 @@
 module MultipleMan
-  VERSION = "0.8.1"
+  VERSION = "1.1.0"
 end