railway-ipc 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5002df116daa50da3bfcefc3a966901a49c04671e869f23a645482ef9cf4c619
-  data.tar.gz: de49b0064f5b57f77893f46701007928a3e1c0fa4644a34041de50c6c4113f18
+  metadata.gz: 7f349dc76232b1cef6492bb2dc09cdbd58bf2ad22be64bfd1771e4e6d7192b16
+  data.tar.gz: 3e04b076735ca1bcc8d1cc376925311b1547b8b13a554691726f348a62625cfc
 SHA512:
-  metadata.gz: 9ed5098e317e039d3e4ed0305aca7f571be35f1ace0d88a513ef702ec381f10fe8291378b00ca181a6d23cfcbc7882c367dacedfb68d458ff71f9c8f808128d3
-  data.tar.gz: a30c8d4795fcd839588a8e9fc375c027b4a36e48b64eee9800a659fa4380f2d89d66f89c838c80fb70bf2072917146bcb6bd4ad4917141fa4dcfc0cfdf89db14
+  metadata.gz: d0dd3263f9ca6c57da0fd98c25b720f1f7bad7ec87bb4c34cd110d51824b350ca255d9a467170d420aeb323faff081f03ea62c18c080f3a52fd72f0c687be49a
+  data.tar.gz: 74d6f196446603d93d42050e2c672ccac22ec49cedbc2d026cf8f8f61eb0bc4d6537b179ad2d60cd37426ad6b60ab9e428d40b21f69ce21426cc86cbeefaacaf

data/.gitignore

@@ -4,6 +4,7 @@
 /coverage/
 /doc/
 /pkg/
+/rake
 /spec/reports/
 /tmp/
 Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/CHANGELOG.md

@@ -10,6 +10,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 ### Fixed
 
+## [4.0.0] - 2021-01-11
+### Added
+* JSON decoder for consumers that can handle JSON encoded Protobufs. Note that the publishers do not (yet) have the option of encoding the messages as JSON.
+
+### Changed
+* (Breaking Change) Rename `Consumer#work` to `Consumer#work_with_params`. This was necessary so that we can support specifying different message encodings via metadata in the future. If the message encoding cannot be determined from the message metadata fall back to a default decoder (binary protobufs).
+
+### Fixed
+* `./bin/console` script was broken because Pry wasn't a dependency; added Pry as a development dependency only.
+
 ## [3.0.0] - 2020-12-07
 ### Changed
 * Consumers _will no longer crash_ when an exception is raised. Instead, consumers will move the message that caused the exception to a single dead-letter exchange called 'ipc:errors'. Railway will configure the dead-letter exchange automatically.
@@ -86,7 +96,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/v30.0.0...HEAD
+[Unreleased]: https://github.com/learn-co/railway_ipc_gem/compare/v4.0.0...HEAD
+[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
 [2.2.2]: https://github.com/learn-co/railway_ipc_gem/compare/v2.2.1...v2.2.2
 [2.2.1]: https://github.com/learn-co/railway_ipc_gem/compare/v2.2.0...v2.2.1

data/lib/railway_ipc.rb

@@ -14,6 +14,7 @@ require 'railway_ipc/unknown_message.pb'
 require 'railway_ipc/rabbitmq/adapter'
 require 'railway_ipc/handler'
 require 'railway_ipc/handler_store'
+require 'railway_ipc/message_decoders'
 require 'railway_ipc/incoming_message'
 require 'railway_ipc/connection_manager'
 require 'railway_ipc/publisher'

data/lib/railway_ipc/consumer/consumer.rb

@@ -56,8 +56,14 @@ module RailwayIpc
       queue.opts[:exchange]
     end
 
-    def work(payload)
-      message = RailwayIpc::IncomingMessage.new(payload)
+    # REFACTOR: Long term we should think about not leaking Sneakers
+    # methods as part of Railway's public API since clients can (and do)
+    # override them. -BN
+    def work_with_params(payload, _delivery_info, metadata)
+      message_format = metadata.fetch('headers', {})
+                               .fetch('message_format', 'protobuf_binary')
+
+      message = RailwayIpc::IncomingMessage.new(payload, message_format: message_format)
       RailwayIpc::ProcessIncomingMessage.call(self, message)
       ack!
     rescue StandardError => e

data/lib/railway_ipc/incoming_message.rb

@@ -2,9 +2,10 @@
 
 module RailwayIpc
   class IncomingMessage
-    attr_reader :type, :payload, :parsed_payload, :errors
+    attr_reader :type, :message_format, :payload, :parsed_payload, :errors
 
-    def initialize(payload)
+    def initialize(payload, message_format: nil)
+      @message_format = message_format
       @parsed_payload = JSON.parse(payload)
       @type = parsed_payload['type']
       @payload = payload
@@ -32,20 +33,23 @@ module RailwayIpc
     end
 
     def decoded
-      @decoded ||=
-        begin
-          protobuf_msg = Base64.decode64(parsed_payload['encoded_message'])
-          decoder = Kernel.const_get(type)
-          decoder.decode(protobuf_msg)
-        rescue Google::Protobuf::ParseError => e
-          raise RailwayIpc::IncomingMessage::ParserError.new(e)
-        rescue NameError
-          RailwayIpc::Messages::Unknown.decode(protobuf_msg)
-        end
+      @decoded ||= \
+        get_decoder(message_format).call(type, parsed_payload['encoded_message'])
     end
 
     def stringify_errors
       errors.values.join(', ')
     end
+
+    private
+
+    DEFAULT_DECODER = RailwayIpc::MessageDecoders::ProtobufBinaryDecoder
+
+    def get_decoder(name)
+      {
+        'protobuf_binary' => RailwayIpc::MessageDecoders::ProtobufBinaryDecoder,
+        'protobuf_json' => RailwayIpc::MessageDecoders::ProtobufJsonDecoder
+      }.fetch(name, DEFAULT_DECODER)
+    end
   end
 end

data/lib/railway_ipc/message_decoders.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RailwayIpc
+  module MessageDecoders
+    ProtobufBinaryDecoder = lambda do |type, encoded_message|
+      protobuf_msg = Base64.decode64(encoded_message)
+      protobuf_klass = Kernel.const_get(type)
+      protobuf_klass.decode(protobuf_msg)
+    rescue Google::Protobuf::ParseError => e
+      raise RailwayIpc::IncomingMessage::ParserError.new(e)
+    rescue NameError
+      RailwayIpc::Messages::Unknown.decode(protobuf_msg)
+    end
+
+    ProtobufJsonDecoder = lambda do |type, message_hash|
+      protobuf_klass = Kernel.const_get(type)
+      protobuf_klass.new(message_hash)
+    rescue ArgumentError => e
+      raise RailwayIpc::IncomingMessage::ParserError.new(e)
+    rescue NameError
+      # NOTE: I didn't realize this until I made this ProtobufJsonDecoder, but
+      # the ProtobufBinaryDecoder will ignore any unknown keys -- which is
+      # probably not what we want. I'm coding this the same way as the binary
+      # protobuf version for consistency, but we should re-think how we want to
+      # handle this situation. -BN
+      RailwayIpc::Messages::Unknown.new(
+        user_uuid: message_hash.fetch(:user_uuid, ''),
+        correlation_id: message_hash.fetch(:correlation_id, ''),
+        uuid: message_hash.fetch(:uuid, ''),
+        context: message_hash.fetch(:context, {})
+      )
+    end
+  end
+end

data/lib/railway_ipc/version.rb

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

data/railway_ipc.gemspec

@@ -48,6 +48,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'database_cleaner', '~> 1.7'
   spec.add_development_dependency 'listen', '~> 3.0.5'
   spec.add_development_dependency 'pg', '~> 0.18'
+  spec.add_development_dependency 'pry', '~> 0.13'
   spec.add_development_dependency 'rails', '~> 5.0.7'
   spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'shoulda-matchers', '~> 4.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: railway-ipc
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - ''
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-07 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -213,6 +227,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -233,6 +248,7 @@ files:
 - lib/railway_ipc/handler_store.rb
 - lib/railway_ipc/incoming_message.rb
 - lib/railway_ipc/logger.rb
+- lib/railway_ipc/message_decoders.rb
 - lib/railway_ipc/models/consumed_message.rb
 - lib/railway_ipc/models/published_message.rb
 - lib/railway_ipc/publisher.rb