einhorn 0.4.8 → 0.4.9

data/einhorn.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |gem|
   gem.summary       = "Einhorn: the language-independent shared socket manager"
   gem.description   = "Einhorn makes it easy to run multiple instances of an application server, all listening on the same port. You can also seamlessly restart your workers without dropping any requests. Einhorn requires minimal application-level support, making it easy to use with an existing project."
   gem.homepage      = "https://github.com/stripe/einhorn"
+  gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/example/plugin.rb

@@ -8,6 +8,17 @@
 
 module Einhorn::Plugins
   module ExamplePlugin
+    # If a State module is defined, its contents will be passed to new
+    # einhorn processes when einhorn is reloaded
+    module State
+      extend Einhorn::AbstractState
+      def self.default_state
+        {
+          :yay => nil
+        }
+      end
+    end
+
     def self.initialize_example_plugin
       # The initializer method must be named `initialize_##[plugin_name]',
       # where [plugin_name] is the name of the plugin module or class in
@@ -16,16 +27,15 @@ module Einhorn::Plugins
     end
 
     def self.optparse(opts)
-      @options = {}
       opts.on("--my-option X", "Patch einhorn with additional options!") do |x|
-        @options[:yay] = x
+        State.yay = x
       end
     end
 
     def self.post_optparse
       # Called after all options native to einhorn or patched by any plugins
-      # are parsed.
-      @required_x = @options.fetch(:yay)
+      # are parsed. Good place to do argument validation
+      raise "Argument --my-option is required" unless State.yay
     end
 
     def self.event_loop

data/lib/einhorn.rb

@@ -93,19 +93,21 @@ module Einhorn
 
   def self.restore_state(state)
     parsed = YAML.load(state)
-    updated_state, message = update_state(parsed[:state])
+    updated_state, message = update_state(Einhorn::State, "einhorn", parsed[:state])
     Einhorn::State.state = updated_state
     Einhorn::Event.restore_persistent_descriptors(parsed[:persistent_descriptors])
+    plugin_messages = update_plugin_states(parsed[:plugins])
     # Do this after setting state so verbosity is right
     Einhorn.log_info("Using loaded state: #{parsed.inspect}")
     Einhorn.log_info(message) if message
+    plugin_messages.each {|msg| Einhorn.log_info(msg)}
   end
 
-  def self.update_state(old_state)
+  def self.update_state(store, store_name, old_state)
     # TODO: handle format updates somehow? (probably need to write
     # special-case code for each)
     updated_state = old_state.dup
-    default = Einhorn::State.default_state
+    default = store.default_state
     added_keys = default.keys - old_state.keys
     deleted_keys = old_state.keys - default.keys
     return [updated_state, nil] if added_keys.length == 0 && deleted_keys.length == 0
@@ -116,12 +118,29 @@ module Einhorn
     message = []
     message << "adding default values for #{added_keys.inspect}"
     message << "deleting values for #{deleted_keys.inspect}"
-    message = "State format has changed: #{message.join(', ')}"
+    message = "State format for #{store_name} has changed: #{message.join(', ')}"
 
     # Can't print yet, since state hasn't been set, so we pass along the message.
     [updated_state, message]
   end
 
+  def self.update_plugin_states(states)
+    plugin_messages = []
+    (states || {}).each do |name, plugin_state|
+      plugin = Einhorn.plugins[name]
+      unless plugin && plugin.const_defined?(:State)
+        plugin_messages << "No state defined in this version of the #{name} " +
+          "plugin; dropping values for keys #{plugin_state.keys.inspect}"
+        next
+      end
+
+      updated_state, plugin_message = update_state(plugin::State, "plugin #{name}", plugin_state)
+      plugin_messages << plugin_message if plugin_message
+      plugin::State.state = updated_state
+    end
+    plugin_messages
+  end
+
   def self.print_state
     log_info(Einhorn::State.state.pretty_inspect)
   end

data/lib/einhorn/command.rb

@@ -157,10 +157,15 @@ module Einhorn
       descriptor_state = Einhorn::Event.persistent_descriptors.map do |descriptor|
         descriptor.to_state
       end
+      plugin_state = {}
+      Einhorn.plugins.each do |name, plugin|
+        plugin_state[name] = plugin::State.state if plugin.const_defined?(:State)
+      end
 
       {
         :state => global_state,
-        :persistent_descriptors => descriptor_state
+        :persistent_descriptors => descriptor_state,
+        :plugins => plugin_state
       }
     end
 

data/lib/einhorn/version.rb

@@ -1,3 +1,3 @@
 module Einhorn
-  VERSION = '0.4.8'
+  VERSION = '0.4.9'
 end

data/test/unit/einhorn.rb

@@ -41,16 +41,16 @@ class EinhornTest < EinhornTestCase
       Einhorn::State.stubs(:default_state).returns(:baz => 23, :foo => 1)
       old_state = {:foo => 2, :bar => 2}
 
-      updated_state, message = Einhorn.update_state(old_state)
+      updated_state, message = Einhorn.update_state(Einhorn::State, 'einhorn', old_state)
       assert_equal({:baz => 23, :foo => 2}, updated_state)
-      assert_match(/State format has changed/, message)
+      assert_match(/State format for einhorn has changed/, message)
     end
 
     it 'does not change the state if the format has not changed' do
       Einhorn::State.stubs(:default_state).returns(:baz => 23, :foo => 1)
       old_state = {:baz => 14, :foo => 1234}
 
-      updated_state, message = Einhorn.update_state(old_state)
+      updated_state, message = Einhorn.update_state(Einhorn::State, 'einhorn', old_state)
       assert_equal({:baz => 14, :foo => 1234}, updated_state)
       assert(message.nil?)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: einhorn
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.4.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-23 00:00:00.000000000 Z
+date: 2013-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -117,7 +117,8 @@ files:
 - test/unit/einhorn/event.rb
 - test/unit/einhorn/worker_pool.rb
 homepage: https://github.com/stripe/einhorn
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -148,3 +149,4 @@ test_files:
 - test/unit/einhorn/command/interface.rb
 - test/unit/einhorn/event.rb
 - test/unit/einhorn/worker_pool.rb
+has_rdoc: