moleculer 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adca17fdd330fd7afa3d94ffd7768e1b1c732b9a6ff106defd5dcd6b7437f9ab
-  data.tar.gz: '097cb23699252db25857b462712f18279c4fb712ccb6b5873d846c897ae6447f'
+  metadata.gz: b336fe17152d5c0ebff7495c2fc7e5dd6ea4a5aa0a2cd29ee9f2f67f25fbe95f
+  data.tar.gz: 1f99f72bae588fa8544cf9635891ed9bc51408ec656658090eeded5756f45be3
 SHA512:
-  metadata.gz: 476c7b017f50e95d1bbbba1b3ee933dc9b0168265a2386d250ec74cdba1989839753896f4a55e639e8e783ee2731d44e36cfa7e7f35cd1ca9c40971b176742bc
-  data.tar.gz: 6c1ab62da8bb22d066adc09507ee3010112eeefc53f85f26d3d3d4c523ef7d0f2ec6909fe7d40b4831b0b5303e12b073357309fda66b09648ac512975e7080a6
+  metadata.gz: c9b52239d10c8aca09bae010e5193dfc56ebe3d4df72d8d5f70e497788c7274630951e0bfe1c641f82f57f26bc374772f7ff16d75af4ad093bb13f82b6333987
+  data.tar.gz: 90fa10f008f7807bf729e993bd48a2dab8718144477fe5d340373ac74c0151811376f121af63127c543e4f2693b1bc042e3e4641065197b5c40b532b8bf5facd

data/.codeclimate.yml

@@ -0,0 +1,6 @@
+---
+version: "2"
+plugins:
+  rubocop:
+    enabled: true
+    channel: rubocop-0-60 # Minimum version to support ruby 2.6

data/.rubocop.yml

@@ -7,7 +7,7 @@ Layout/IndentHash:
 Layout/IndentationWidth:
   IgnoredPatterns: []
 
-Style/AlignHash:
+Layout/AlignHash:
   EnforcedColonStyle: table
   EnforcedHashRocketStyle: table
 
@@ -23,6 +23,9 @@ Style/TrailingCommaInHashLiteral:
 Style/TrailingCommaInArrayLiteral:
   EnforcedStyleForMultiline: comma
 
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
 Style/StringLiterals:
     EnforcedStyle: "double_quotes"
 

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.3

data/.travis.yml

@@ -8,10 +8,11 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
+  - 2.6
 env:
   global:
     - CC_TEST_REPORTER_ID=270a7dd1c7f3f40fdb0d62c2403dd1f643e4cadbf6b8f5992e74b62ea4e6974b
-before_install: gem install bundler -v 1.17.1
+before_install: gem install bundler -v 1.17.2
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter

data/CHANGELOG.md

@@ -1,5 +1,20 @@
-# CHANGELOG
+# 0.2.0
 
-##  0.1.1
+### Features
+
+* **actions:** ability to process errors that occur when executing actions 
+  ([9a3f36d](https://github.com/moleculer-ruby/moleculer/commit/9a3f36d))
+* **events:** add ability to rescue from event errors and  handle 
+  ([0f2cf1a](https://github.com/moleculer-ruby/moleculer/commit/0f2cf1a))
+* **fake transporter:** add fake transporter that can be used without dependencies on an actual connected transporter
+* **broker:** add the ability to check if a borker is started through the `#started` method
+
+### Bugfixes
+* fix `concurrent_ruby` version requirement to ensure at least `1.1` is required
+* fix an issue where heartbeats back up in the queue and cause errors when consumed
+
+#  0.1.1
+
+### Bugfixes
 * fixes bug where event publishing uses the wrong method name to look up local events
 * fixes condition where events may double publish when multiple events are registered

data/Gemfile.lock

@@ -1,22 +1,28 @@
 PATH
   remote: .
   specs:
-    moleculer (0.1.1)
+    moleculer (0.2.0)
       awesome_print (~> 1.8)
-      concurrent-ruby (~> 1.0)
+      concurrent-ruby (~> 1.1)
       ougai (~> 1.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     awesome_print (1.8.0)
     concurrent-ruby (1.1.5)
     diff-lcs (1.3)
     docile (1.3.1)
+    jaro_winkler (1.5.2)
     json (2.1.0)
     oj (3.7.12)
     ougai (1.7.1)
       oj (~> 3.4)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
     rake (10.5.0)
     redis (4.0.1)
     rspec (3.8.0)
@@ -32,12 +38,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rubocop (0.69.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.0)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     timecop (0.9.1)
+    unicode-display_width (1.6.0)
     yard (0.9.18)
 
 PLATFORMS
@@ -49,9 +64,10 @@ DEPENDENCIES
   rake (~> 10.0)
   redis (~> 4.0)
   rspec (~> 3.0)
+  rubocop (~> 0.69)
   simplecov (~> 0.16)
   timecop (~> 0.9.1)
   yard (~> 0.9.11)
 
 BUNDLED WITH
-   1.17.1
+   1.17.2

data/README.md

@@ -10,20 +10,6 @@ build efficient, reliable & scalable services. Moleculer provides many features
 microservices.
 
 
-## Features
-- request-reply concept
-- event-driven architecture with balancing
-- built-in service registry & dynamic service discovery
-- load balanced requests & events (round-robin, random(wip), cpu-usage(wip), latency(wip))
-- supports versioned services
-- built-in caching solution (memory, Redis)
-- pluggable transporters (TCP, NATS, MQTT, Redis, NATS Streaming, Kafka)
-- pluggable serializers (JSON, Avro, MsgPack, Protocol Buffers, Thrift)
-- pluggable validator
-- multiple services on a node/server
-- all nodes are equal, no master/leader node
-
-
 ## Getting Started
 ### Install the Gem
 
@@ -100,3 +86,23 @@ times out and throws an error.
 
 #### transporter (default: redis://localhost)
 The transporter Moleculer should use. For more information on transporters see [Transporters](https://moleculer.services/docs/0.13/networking.html#Transporters)
+
+
+## Roadmap
+
+### 0.1 (COMPLETE)
+Initial release
+
+* Redis transporter
+* Round robin load balancing
+* Service registry & dynamic service discovery
+* JSON serializer
+
+### 0.2 (IN  PROGRESS)
+* Fake transporter (for testing)
+* Error handling, (ability to use Airbrake, etc.)
+* Event grouping
+
+### 0.3 (PENDING)
+* NATS transporter
+* Built in caching solution (Redis, Memory)

data/lib/moleculer/broker.rb

@@ -93,7 +93,7 @@ module Moleculer
 
     def start
       @logger.info "starting"
-      @transporter.connect
+      @transporter.start
       register_local_node
       start_subscribers
       publish_discover
@@ -105,7 +105,7 @@ module Moleculer
     def stop
       @logger.info "stopping"
       publish(:disconnect)
-      @transporter.disconnect
+      @transporter.stop
       exit 0
     end
 
@@ -172,6 +172,18 @@ module Moleculer
       )
     end
 
+    ##
+    # @return [Proc] returns the rescue_action if defined on the configuration
+    def rescue_action
+      config.rescue_action
+    end
+
+    ##
+    # @return [Proc] returns the rescue_event if defined on the configuration
+    def rescue_event
+      config.rescue_event
+    end
+
     private
 
     def handle_signal(sig)

data/lib/moleculer/configuration.rb

@@ -74,6 +74,8 @@ module Moleculer
     config_accessor :serializer, :json
     config_accessor :node_id, "#{Socket.gethostname.downcase}-#{Process.pid}"
     config_accessor :service_prefix
+    config_accessor :rescue_action
+    config_accessor :rescue_event
 
     attr_accessor :broker
 

data/lib/moleculer/service/action.rb

@@ -29,15 +29,20 @@ module Moleculer
       end
 
       ##
-      # @param context [Moleculer::Context] the execution contextd
+      # @param context [Moleculer::Context] the execution context
       #
       # @return [Moleculer::Support::Hash] returns a hash which will be converted into json for the response.
+      # @raise [Errors::InvalidActionResponse] thrown when the result of calling the action does not return a hash
       def execute(context, broker)
         response = @service.new(broker).public_send(@method, context)
-        # rubocop:disable Style/RaiseArgs
-        raise Errors::InvalidActionResponse.new(response) unless response.is_a? Hash
+        # rubocop disabled because in this case we need a specific error handling format
+        raise Errors::InvalidActionResponse.new(response) unless response.is_a? Hash # rubocop:disable Style/RaiseArgs
 
         response
+      rescue StandardError => e
+        raise e unless broker.rescue_action
+
+        broker.rescue_action.call(e)
       end
 
       def node

data/lib/moleculer/service/event.rb

@@ -28,8 +28,13 @@ module Moleculer
       ##
       # Executes the event
       # @param data [Hash] the event data
+      # @param broker [Moleculer::Broker] the moleculer broker
       def execute(data, broker)
         @service.new(broker).public_send(@method, data)
+      rescue StandardError => e
+        raise e unless broker.rescue_event
+
+        broker.rescue_event.call(e)
       end
 
       ##

data/lib/moleculer/transporters/base.rb

@@ -0,0 +1,45 @@
+module Moleculer
+  ##
+  # A transporter is the method by which moleculer transports information from one service to the next. Transporters can
+  # be created using any over-the-wire bus that can be made to support some level of queueing (i.e. Redis, NATS, Kafka)
+  module Transporters
+    ##
+    # All transporters inherit from this class. The Base class simply defines an interface that transporters should
+    # adhere to.
+    class Base
+      ##
+      # @param config [Moleculer::Configuration] the transporter configuration.
+      def initialize(config)
+        @config = config
+      end
+
+      ##
+      # Subscribes to the given channel on the transporter's message bus
+      # @param channel [String] the channel to which to subscribe
+      def subscribe(_channel, &_block)
+        raise NotImplementedError
+      end
+
+      ##
+      # Publishes the provided packet to the transporter's message bus. The publish method is expected to implement the
+      # method of translating the packet data into the channel information on which to publish.
+      # @param packet [Moleculer::Packet::Base] the packet to publish to the network.
+      def publish(_packet)
+        raise NotImplementedError
+      end
+
+      ##
+      # Starts the transporter, and activates all of the subscriptions. The subscriptions should not start consuming
+      # until the start method has been called.
+      def start
+        raise NotImplementedError
+      end
+
+      ##
+      # Stops the transporter, and stops all subscriptions from consuming
+      def stop
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/moleculer/transporters/fake.rb

@@ -0,0 +1,33 @@
+require_relative "base"
+
+module Moleculer
+  module Transporters
+    ##
+    # The fake transporter is designed to be used in testing. It is simply an in memory queue and should not be used
+    # in production.
+    class Fake < Base
+      def initialize(config)
+        super(config)
+        # in this case we want to use a class var as this needs to behave like a singleton to mimic how a global
+        # transporter functions
+        @@subscriptions ||= {} # rubocop:disable Style/ClassVars
+      end
+
+      def subscribe(channel, &block)
+        @@subscriptions[channel] = block
+      end
+
+      def publish(packet)
+        @@subscriptions[packet.topic].call(packet)
+      end
+
+      def start
+        true
+      end
+
+      def stop
+        true
+      end
+    end
+  end
+end

data/lib/moleculer/transporters/redis.rb

@@ -1,4 +1,5 @@
 require "redis"
+require_relative "base"
 
 # frozen_string_literal: true
 
@@ -6,7 +7,7 @@ module Moleculer
   module Transporters
     ##
     # The Moleculer Redis transporter
-    class Redis
+    class Redis < Base
       ##
       # @private
       # Represents the publisher connection
@@ -21,7 +22,7 @@ module Moleculer
         # Publishes the packet to the packet's topic
         def publish(packet)
           topic = packet.topic
-          @logger.trace "publishing packet to '#{topic}'", packet.as_json
+          @logger.debug "publishing packet to '#{topic}'", packet.as_json
           connection.publish(topic, @serializer.serialize(packet))
         end
 
@@ -155,6 +156,7 @@ module Moleculer
           @uri           = config.transporter
           @logger        = config.logger.get_child("[REDIS.TRANSPORTER]")
           @subscriptions = Concurrent::Array.new
+          @started       = false
         end
 
         def subscribe(channel, &block)
@@ -163,13 +165,25 @@ module Moleculer
             channel: channel,
             block:   block,
             config:  @config,
-          ).connect
+          )
+
+          @subscriptions.last.connect if started?
         end
 
         def disconnect
           @logger.debug "disconnecting subscriptions"
           @subscriptions.each(&:disconnect)
         end
+
+        def connect
+          @logger.debug "connecting subscriptions"
+          @subscriptions.each(&:connect)
+          @started = true
+        end
+
+        def started?
+          @started
+        end
       end
 
       def initialize(config)
@@ -184,11 +198,12 @@ module Moleculer
         publisher.publish(packet)
       end
 
-      def connect
+      def start
         publisher.connect
+        subscriber.connect
       end
 
-      def disconnect
+      def stop
         publisher.disconnect
         subscriber.disconnect
       end

data/lib/moleculer/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moleculer
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/moleculer.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "concurrent-ruby",     "~> 1.0"
+  spec.add_dependency "concurrent-ruby",     "~> 1.1"
   spec.add_dependency "ougai",               "~> 1.7"
   spec.add_dependency "awesome_print",       "~> 1.8"
 
@@ -45,6 +45,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake",      "~> 10.0"
   spec.add_development_dependency "redis",     "~> 4.0"
   spec.add_development_dependency "rspec",     "~> 3.0"
+  spec.add_development_dependency "rubocop",   "~> 0.69"
   spec.add_development_dependency "simplecov", "~> 0.16"
   spec.add_development_dependency "timecop",   "~> 0.9.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moleculer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - fugufish
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-13 00:00:00.000000000 Z
+date: 2019-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: ougai
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.69'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.69'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -157,9 +171,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
@@ -207,6 +223,8 @@ files:
 - lib/moleculer/support/open_struct.rb
 - lib/moleculer/support/string_util.rb
 - lib/moleculer/transporters.rb
+- lib/moleculer/transporters/base.rb
+- lib/moleculer/transporters/fake.rb
 - lib/moleculer/transporters/redis.rb
 - lib/moleculer/version.rb
 - moleculer.gemspec
@@ -231,8 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: This is a Ruby implementation of the Moleculer framework.