railway-ipc 4.0.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fa6ce7e4b6f8667fa4939cc334dd66845c39e5f357bd4887eb030b7f4edcf3a
-  data.tar.gz: ea8f959e0cf43ed38b71276baac73c4c4e417ee8d4323d47605390a95d573c53
+  metadata.gz: 5d520b8d56b0ef067e1a02228e1982541de4abce283d83ccdf7d168ee3cbb52f
+  data.tar.gz: b4b3eb85928de3ee6dd2a86f3e93e89567b37996af3e2476baa074de3cf5dc47
 SHA512:
-  metadata.gz: e76cd2483ea799dd04f7acc27cd5f7799a6f7bd6d6e9bc6e64c08e0a621f55ad6e9ba37fb53c685fea4dd8847b78bde3b73bb97091d9f3764d15c3ce5237c84b
-  data.tar.gz: 62955dfb46eb250156ff8d9c1c9c1570169bc1c45742ca231dbbceadeb091f71439793645620cad63ba5e0c21e393894aa13d96444ac0da4f440c0b7179076a7
+  metadata.gz: 1190af3d7a5e4bb953007b9c2f31668ba0e6048b9958af0927c9be59d01ce4f3f8139c205354e2b931bc08c831c8f9a6e40e94bc40410b9329dc709bc212c5a4
+  data.tar.gz: 24f7eba242e5879ec229b80e2d4b24af920bcfa4bfef2a5b0b12b1c8c9e408011b2bd7f0954fcfd27de64d4c7429b185dc9945073a78e1192868ea414a2cfc02

data/CHANGELOG.md

@@ -1,8 +1,7 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 ### Added
@@ -10,6 +9,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 ### Fixed
 
+## [5.0.0] - 2021-02-17
+### Added
+* Message encoders. Messages can now be encoded using either binary protobufs (the default) or JSON protobufs.
+* `RailwayIpc::OutgoingMessage` abstraction that encapsulates everything about a message to be published.
+
+### Changed
+* `Publisher#publish` now takes an optional `format` parameter that specifies how the message should be encoded. It is added to the message header when the message is published. The default format is `binary_protobuf`.
+* (Breaking change) `Publisher#publish` now returns an `OutgoingMessage` instead of a `Bunny::Exchange`.
+* Refactor `PublishedMessage#store_message` to take an `OutgoingMessage`.
+
+### Removed
+* (Breaking change) Remove deprecated `SingletonPublisher`
+
 ## [4.0.1] - 2021-01-12
 ### Fixed
 * Fixed `undefined method fetch for Bunny::MessageProperties` error. `Bunny::MessageProperties` isn't really a Hash, it wraps one (and doesn't provide a `#fetch` method).
@@ -100,7 +112,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Correlation ID and message UUID are auto generated for messages for IDs are not passed in [#23](https://github.com/learn-co/railway_ipc_gem/pull/23)
 
-[Unreleased]: https://github.com/learn-co/railway_ipc_gem/compare/v4.0.1...HEAD
+[Unreleased]: https://github.com/learn-co/railway_ipc_gem/compare/v5.0.0...HEAD
+[5.0.0]: https://github.com/learn-co/railway_ipc_gem/compare/v4.0.1...v5.0.0
 [4.0.1]: https://github.com/learn-co/railway_ipc_gem/compare/v4.0.0...v4.0.1
 [4.0.0]: https://github.com/learn-co/railway_ipc_gem/compare/v3.0.0...v4.0.0
 [3.0.0]: https://github.com/learn-co/railway_ipc_gem/compare/v2.2.2...v3.0.0

data/lib/railway_ipc.rb

@@ -14,8 +14,10 @@ require 'railway_ipc/unknown_message.pb'
 require 'railway_ipc/rabbitmq/adapter'
 require 'railway_ipc/handler'
 require 'railway_ipc/handler_store'
+require 'railway_ipc/message_encoders'
 require 'railway_ipc/message_decoders'
 require 'railway_ipc/incoming_message'
+require 'railway_ipc/outgoing_message'
 require 'railway_ipc/connection_manager'
 require 'railway_ipc/publisher'
 require 'railway_ipc/responder'

data/lib/railway_ipc/consumer/consumer.rb

@@ -61,7 +61,7 @@ module RailwayIpc
     # override them. -BN
     def work_with_params(payload, _delivery_info, metadata)
       headers = metadata.headers || {}
-      message_format = headers.fetch('message_format', 'protobuf_binary')
+      message_format = headers.fetch('message_format', 'binary_protobuf')
 
       message = RailwayIpc::IncomingMessage.new(payload, message_format: message_format)
       RailwayIpc::ProcessIncomingMessage.call(self, message)

data/lib/railway_ipc/incoming_message.rb

@@ -47,8 +47,8 @@ module RailwayIpc
 
     def get_decoder(name)
       {
-        'protobuf_binary' => RailwayIpc::MessageDecoders::ProtobufBinaryDecoder,
-        'protobuf_json' => RailwayIpc::MessageDecoders::ProtobufJsonDecoder
+        'binary_protobuf' => RailwayIpc::MessageDecoders::ProtobufBinaryDecoder,
+        'json_protobuf' => RailwayIpc::MessageDecoders::ProtobufJsonDecoder
       }.fetch(name, DEFAULT_DECODER)
     end
   end

data/lib/railway_ipc/message_encoders.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RailwayIpc
+  module MessageEncoders
+    ProtobufBinaryEncoder = lambda do |message|
+      {
+        type: message.type,
+        encoded_message: Base64.encode64(message.proto.class.encode(message.proto))
+      }.to_json
+    rescue NoMethodError
+      raise RailwayIpc::InvalidProtobuf.new("Message #{message} is not a valid protobuf")
+    end
+
+    ProtobufJsonEncoder = lambda do |message|
+      {
+        type: message.type,
+        encoded_message: message.proto.to_h
+      }.to_json
+    rescue NoMethodError
+      raise RailwayIpc::InvalidProtobuf.new("Message #{message} is not a valid protobuf")
+    end
+  end
+end

data/lib/railway_ipc/models/published_message.rb

@@ -7,16 +7,15 @@ module RailwayIpc
 
     validates :uuid, :status, presence: true
 
-    def self.store_message(exchange_name, message)
-      encoded_message = RailwayIpc::Rabbitmq::Payload.encode(message)
+    def self.store_message(outgoing_message)
       create!(
-        uuid: message.uuid,
-        message_type: message.class.to_s,
-        user_uuid: message.user_uuid,
-        correlation_id: message.correlation_id,
-        encoded_message: encoded_message,
+        uuid: outgoing_message.uuid,
+        message_type: outgoing_message.type,
+        user_uuid: outgoing_message.user_uuid,
+        correlation_id: outgoing_message.correlation_id,
+        encoded_message: outgoing_message.encoded,
         status: 'sent',
-        exchange: exchange_name
+        exchange: outgoing_message.exchange
       )
     end
 

data/lib/railway_ipc/outgoing_message.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RailwayIpc
+  class OutgoingMessage
+    extend Forwardable
+
+    attr_reader :proto, :exchange, :format
+
+    def_delegators :@proto, :uuid, :user_uuid, :correlation_id
+
+    def initialize(proto, exchange, format=nil)
+      proto.uuid = SecureRandom.uuid if proto.uuid.blank?
+      proto.correlation_id = SecureRandom.uuid if proto.correlation_id.blank?
+      @proto = proto
+      @exchange = exchange
+      @format = format
+    end
+
+    def type
+      proto.class.to_s
+    end
+
+    def encoded
+      @encoded ||= encoder.call(self)
+    end
+
+    private
+
+    DEFAULT_ENCODER = RailwayIpc::MessageEncoders::ProtobufBinaryEncoder
+
+    def encoder
+      {
+        'binary_protobuf' => RailwayIpc::MessageEncoders::ProtobufBinaryEncoder,
+        'json_protobuf' => RailwayIpc::MessageEncoders::ProtobufJsonEncoder
+      }.fetch(format, DEFAULT_ENCODER)
+    end
+  end
+end

data/lib/railway_ipc/publisher.rb

@@ -1,55 +1,5 @@
 # frozen_string_literal: true
 
-module RailwayIpc
-  class SingletonPublisher < Sneakers::Publisher
-    include ::Singleton
-
-    def self.exchange(exchange)
-      @exchange_name = exchange
-    end
-
-    def self.exchange_name
-      raise 'Subclass must set the exchange' unless @exchange_name
-
-      @exchange_name
-    end
-
-    def initialize
-      super(exchange: self.class.exchange_name, exchange_type: :fanout)
-    end
-
-    def publish(message, published_message_store=RailwayIpc::PublishedMessage)
-      RailwayIpc.logger.warn('DEPRECATED: Use new PublisherInstance class', log_message_options)
-      ensure_message_uuid(message)
-      ensure_correlation_id(message)
-      RailwayIpc.logger.info('Publishing message', log_message_options(message))
-      result = super(RailwayIpc::Rabbitmq::Payload.encode(message))
-      published_message_store.store_message(self.class.exchange_name, message)
-      result
-    rescue RailwayIpc::InvalidProtobuf => e
-      RailwayIpc.logger.error('Invalid protobuf', log_message_options(message))
-      raise e
-    end
-
-    private
-
-    def ensure_message_uuid(message)
-      message.uuid = SecureRandom.uuid if message.uuid.blank?
-      message
-    end
-
-    def ensure_correlation_id(message)
-      message.correlation_id = SecureRandom.uuid if message.correlation_id.blank?
-      message
-    end
-
-    def log_message_options(message=nil)
-      options = { feature: 'railway_ipc_publisher', exchange: self.class.exchange_name }
-      message.nil? ? options : options.merge(protobuf: { type: message.class, data: message })
-    end
-  end
-end
-
 module RailwayIpc
   class Publisher
     attr_reader :exchange_name, :message_store
@@ -60,13 +10,12 @@ module RailwayIpc
     end
 
     # rubocop:disable Metrics/AbcSize
-    def publish(message)
-      message.uuid = SecureRandom.uuid if message.uuid.blank?
-      message.correlation_id = SecureRandom.uuid if message.correlation_id.blank?
+    def publish(message, format='binary_protobuf')
+      outgoing_message = OutgoingMessage.new(message, exchange_name, format)
+      stored_message = message_store.store_message(outgoing_message)
       RailwayIpc.logger.info('Publishing message', log_message_options(message))
-
-      stored_message = message_store.store_message(exchange_name, message)
-      exchange.publish(RailwayIpc::Rabbitmq::Payload.encode(message))
+      exchange.publish(outgoing_message.encoded, headers: { message_format: format })
+      outgoing_message
     rescue RailwayIpc::InvalidProtobuf => e
       RailwayIpc.logger.error('Invalid protobuf', log_message_options(message))
       raise e

data/lib/railway_ipc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailwayIpc
-  VERSION = '4.0.1'
+  VERSION = '5.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: railway-ipc
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 5.0.0
 platform: ruby
 authors:
 - ''
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-12 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -249,8 +249,10 @@ files:
 - lib/railway_ipc/incoming_message.rb
 - lib/railway_ipc/logger.rb
 - lib/railway_ipc/message_decoders.rb
+- lib/railway_ipc/message_encoders.rb
 - lib/railway_ipc/models/consumed_message.rb
 - lib/railway_ipc/models/published_message.rb
+- lib/railway_ipc/outgoing_message.rb
 - lib/railway_ipc/publisher.rb
 - lib/railway_ipc/rabbitmq/adapter.rb
 - lib/railway_ipc/rabbitmq/payload.rb