bi-frost 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61a3243740e3d642efe0184d5c64d4ad11e72bff
-  data.tar.gz: 3834b3af2f9541dd7222a2ebf3e266f9430db2ea
+  metadata.gz: 363ad309cb14525b8eff19191a79063afbd1dafa
+  data.tar.gz: ca5ff194604f4bfd3748082c40cfb4b5252f20be
 SHA512:
-  metadata.gz: 764a14af9175bf5ffd9f25d8e1d84aa6fd31988db87da0cca2db0bc262715d669b66e591892b6a7e7f017899ad6e870813781ac25dd98860e7c519faee77ecfa
-  data.tar.gz: 1319f4d4eb92d423485943ecdbdd941f68c78b9360b584213c442f1f8f5ea735e22e1f044e0a8e40e02d37c1f160ada2df9b96e89685ffdb2b22354a8a76b0a7
+  metadata.gz: 6e01794fc41e75b97540793609859481ea476d3f0029e30b2451dac5438e7afc73cf4d868678c9e718a109ad83d9b3010cb0d2363cb420fe9f33c20b09ecb230
+  data.tar.gz: bafa72e44054663f88246a33e072b379747e17969c78112cdeb854c193eb4637ebe37d1c53ecfb433f0fec0368ac1bbd132a148f96c5b1b4a004b95c601616bb

data/lib/bifrost.rb

@@ -1,3 +1,4 @@
+require 'bifrost/entity'
 require 'bifrost/message'
 require 'bifrost/topic'
 require 'bifrost/subscriber'
@@ -8,11 +9,15 @@ require 'bifrost/worker'
 module Bifrost
   # Simple utlity that creates a topic and a single subscriber for the given
   # topic. The topic is returned
-  def self.create_topic_with_subscriber(topic_name, sub_name)
-    topic = Bifrost::Topic.new(topic_name)
+  def self.create_topic_with_subscriber(topic, subscriber)
+    topic = Bifrost::Topic.new(topic)
     topic.save
-    subscriber = Bifrost::Subscriber.new(sub_name)
-    topic.add_subscriber(subscriber)
+    topic.add_subscriber(Bifrost::Subscriber.new(subscriber))
     topic
   end
+
+  # Creates a manager instance
+  def self.manager
+    Bifrost::Manager.new
+  end
 end

data/lib/bifrost/manager.rb

@@ -6,44 +6,69 @@ module Bifrost
   # This class is used to handle the setup and execution of multiple listeners
   class Manager
     include Celluloid
+    include Celluloid::Internals::Logger
+    include Celluloid::Notifications
 
     # The supervisor needs to be notified when a worker dies, it also needs to
     # protect itself from harm
     trap_exit :worker_died
 
+    # Initialisation of the Manager sets up a subscriber, which informs the manager
+    # when the worker is ready to begin work
+    def initialize
+      subscribe('worker_ready', :worker_ready)
+    end
+
     # A supervised worker can be added to the current collection of supervised workers
     # this also starts the actor
-    def add(topic_name, subscriber_name, proc)
-      if topic_name.nil? || subscriber_name.nil? || proc.nil?
+    def add(topic, subscriber, proc)
+      if topic.nil? || subscriber.nil? || proc.nil?
         raise InvalidWorkerDefinitionError, 'Invalid worker'
       else
-        @supervisor = Worker.supervise(
-          as:   Worker.supervisor_handle(topic_name, subscriber_name),
-          args: [topic_name, subscriber_name, proc]
-        )
-        # Link the worker to the supervisor so if the worker misbehaves the supervisor is alerted
-        # to this poor behaviour, the supervisor decides how to handle recovery
-        link(@supervisor.actors.last)
+        @supervisor = Worker.supervise(as: Worker.handle(topic, subscriber), args: [topic, subscriber, proc])
       end
     end
 
     # When we run all the workers as actors in their own threads. This run also blocks to make sure
     # the spawned threads remain operational indefinitely
     def run
-      @supervisor.actors.each { |w| w.async.run }
-      # Put the supervisor thread to sleep indefinitely # Better way?
+      # Put the supervisor thread to sleep indefinitely
       loop do
-        # TODO: Better way?
-        sleep(5)
+        # TODO: Perhaps there is a better way?
+        sleep(60)
+      end
+    end
+
+    # This callback is fired when the worker signals it is ready to commence work after initialisation or
+    # recommence after recovering from a failure.
+    # When a worker completes initialisation it can take a while for the worker to be registered as an Actor
+    # in Celluloid, for this reason we need need to put a minor delay in the initialisation procedure
+    def worker_ready(*args)
+      info("Worker bootstrapping with #{args}...")
+      sleep(ENV['ACTOR_BOOTSTRAP_DELAY'] || 2) # TODO: Perhaps there is a better way?
+      worker = get_worker(args[1], args[2])
+      if worker
+        # Link the worker to the supervisor so if the worker misbehaves the supervisor is alerted
+        # to this poor behaviour, the supervisor decides how to handle recovery
+        link(worker)
+        worker.async.run
+      else
+        error("Worker bootstrap failure with #{args}")
       end
     end
 
     private
 
+    # Retrieve a worker through the supervisory structure, this can take a while as the worker might
+    # be going through a restart procedure by the actor framework
+    def get_worker(topic, subscriber)
+      handle = Worker.handle(topic, subscriber)
+      Celluloid::Actor[handle.to_sym]
+    end
+
     # This callback function fires when an worker dies
     def worker_died(worker, reason)
-      # TODO: Log this instead
-      puts "#{worker.inspect} has died: #{reason.class}"
+      error("Worker #{worker.inspect} has died: #{reason.class}")
     end
   end
 end

data/lib/bifrost/version.rb

@@ -1,15 +1,15 @@
 # Major.Minor.Patch version numbering
 module Bifrost
-  # The major version of Sif, updated only for major changes that are
+  # The major version of Bifrost, updated only for major changes that are
   # likely to require modification to Filmpond apps.
   MAJOR_VERSION = 0
 
-  # The minor version of Sif, updated for new feature releases.
+  # The minor version of Bifrost, updated for new feature releases.
   MINOR_VERSION = 1
 
-  # The patch version of Sif, updated only for bug fixes from the last
+  # The patch version of Bifrost, updated only for bug fixes from the last
   # feature release.
-  PATCH_VERSION = 0
+  PATCH_VERSION = 1
 
   # The full version as a string.
   VERSION = "#{MAJOR_VERSION}.#{MINOR_VERSION}.#{PATCH_VERSION}".freeze

data/lib/bifrost/worker.rb

@@ -9,20 +9,26 @@ module Bifrost
   # combination one at a time
   class Worker < Bifrost::Entity
     include Celluloid
+    include Celluloid::Internals::Logger
+    include Celluloid::Notifications
 
-    attr_reader :topic_name, :subscriber_name, :callback
+    attr_reader :topic, :subscriber, :callback
 
-    def initialize(topic_name, subscriber_name, callback)
-      raise Bifrost::Exceptions::UnsupportedLambdaError, 'not a proc' unless callback.respond_to?(:call)
-      @topic_name ||= topic_name
-      @subscriber_name ||= subscriber_name
+    # Initialise the worker/actor. This actually starts the worker by implicitly calling the run method
+    def initialize(topic, subscriber, callback)
+      raise Bifrost::Exceptions::UnsupportedLambdaError, 'callback is not a proc' unless callback.respond_to?(:call)
+      @topic ||= topic
+      @subscriber ||= subscriber
       @callback ||= callback
       super()
+      info("Worker #{to_sym} starting up...")
+      publish('worker_ready', topic, subscriber)
     end
 
     # This method starts the actor, which runs in an infinite loop. This means the worker should
     # not terminate, but if it does, the supervisor will make sure it restarts
     def run
+      info("Worker #{to_sym} running...")
       loop do
         read_message
         sleep(ENV['QUEUE_DELAY'] || 10)
@@ -32,7 +38,7 @@ module Bifrost
     # Workers have a friendly name which is a combination of the topic and subscriber name
     # which in the operational environment should be unique
     def to_s
-      Worker.supervisor_handle(topic_name, subscriber_name)
+      Worker.handle(topic, subscriber)
     end
 
     # Utlity method to get the name of the worker as a symbol
@@ -41,15 +47,15 @@ module Bifrost
     end
 
     # A worker can tell you what it's friendly name will be, this is in order for supervision
-    def self.supervisor_handle(topic_name, subscriber_name)
-      "#{topic_name}-#{subscriber_name}"
+    def self.handle(topic, subscriber)
+      "#{topic.downcase}#{subscriber.downcase}"
     end
 
     private
 
     # Actual processing of the message
     def read_message
-      message = bus.receive_subscription_message(topic_name, subscriber_name, timeout: ENV['TIMEOUT'] || 10)
+      message = bus.receive_subscription_message(topic, subscriber, timeout: ENV['TIMEOUT'] || 10)
       if message
         callback.call(message.properties['message'])
         bus.delete_subscription_message(message)

data/spec/bifrost/manager_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'bifrost'
 
 describe Bifrost::Manager do
-  let(:cb  )    { proc { |m| puts "Principle Received: message #{m}" } }
+  let(:cb)      { proc { |m| puts "Principle Received: message #{m}" } }
   let(:worker)  { Bifrost::Worker.new('topic', 'subscriber', proc) }
   let(:manager) { Bifrost::Manager.new }
 

data/spec/bifrost/topic_spec.rb

@@ -83,7 +83,7 @@ describe Bifrost::Topic do
   end
 
   it 'should not accept names with spaces in them' do
-    invalid_topic_name = Bifrost::Topic.new('topic name')
-    expect { invalid_topic_name.save }.to raise_error(URI::InvalidURIError)
+    invalid_topic = Bifrost::Topic.new('topic name')
+    expect { invalid_topic.save }.to raise_error(URI::InvalidURIError)
   end
 end

data/spec/bifrost/worker_spec.rb

@@ -9,8 +9,8 @@ describe Bifrost::Worker do
   let(:cb) { proc { |m| puts "Received: message #{m}" } }
   subject(:worker) { Bifrost::Worker.new('topic', 'subscriber', cb) }
 
-  it { is_expected.to respond_to(:topic_name) }
-  it { is_expected.to respond_to(:subscriber_name) }
+  it { is_expected.to respond_to(:topic) }
+  it { is_expected.to respond_to(:subscriber) }
 
   it 'should not except non procs in last argument' do
     expect { Bifrost::Worker.new('topic', 'subscriber', 'x') }
@@ -18,7 +18,12 @@ describe Bifrost::Worker do
   end
 
   it 'should have a friendly string name' do
-    expect(worker.to_s).to eq("#{worker.topic_name}-#{worker.subscriber_name}")
+    expect(worker.to_s).to eq("#{worker.topic}#{worker.subscriber}")
+  end
+
+  it 'should downcase the friendly name' do
+    another_worker = Bifrost::Worker.new('toPic', 'subScriber', cb)
+    expect(another_worker.to_s).to eq("#{another_worker.topic.downcase}#{another_worker.subscriber.downcase}")
   end
 
   it 'should have a friendly symbol name' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bi-frost
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Shirren Premaratne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-31 00:00:00.000000000 Z
+date: 2016-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: azure
@@ -42,14 +42,14 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -150,8 +150,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
-description: Topic definitions should occur via the Bifrost. Subscriptions should
-  take place via the Bifrost. Therefore all messages need to transit through the Bifrost
+description: Bifrost is a pub/sub wrapper library which uses Azure message bus and
+  actors.
 email:
 - shirren@filmpond.com
 executables: []
@@ -178,7 +178,8 @@ files:
 - spec/bifrost/worker_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/filmpond/bifrost
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -188,7 +189,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -199,7 +200,8 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Bifrost is a simple pub/sub messaging wrapper component.
+summary: Bifrost is a pub/sub wrapper library which uses the Azure message bus and
+  actors.
 test_files:
 - spec/bifrost/manager_spec.rb
 - spec/bifrost/message_spec.rb