einhorn 0.8.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3f9c31b861db9b8b7ab5d2345be06f60223d60e1243bc2618ec5ef1db2b72e5
-  data.tar.gz: 38144bb080c8719b4d164bcbf8d96d498844626a66b9a522c75fb8bab6309c4f
+  metadata.gz: d96567bd331e59f404e30305612c693fd064558128f41dd6ebad15e0f5bf037f
+  data.tar.gz: a022f5e47a3aa1754d7cc8913975dab3269fc8aa8e7d1a7af83ae7d064f2c97a
 SHA512:
-  metadata.gz: 3370ff020a249f5af7be26bfb48392a0b5721d139b895684e37aa92f612bb00d10e48eeb1b95acc15c74448af96c1df039fc841f6ff45ffdf91d6a16bcc614ab
-  data.tar.gz: 3e6b93f1ed82a46a9578dd3dd59cdb0c5c962772d285e59f1e78e531b7577fa4debbc7e3a28a0e4f9cddf053e4481979b37229ce40a6ed9e476dbba6e7985f1e
+  metadata.gz: 83551dfa88c86a66ed8ba3242c193a6ae6f8e43e780642a346fa2ad54840ea0fe7cad8cc215a416cb97128861e7e3ffd88481a40b4fe77309153a5947265d59c
+  data.tar.gz: fede975c4e07752839033e9752bbc22a7b143400f726fd5d330cd8c0d2fadf84c182c00dc43ad0ee105452e1a537157168bf62595e9092d9afb6290d86bebd97

data/Changes.md

@@ -0,0 +1,10 @@
+# 1.0.0
+
+- Use `YAML.safe_load` for compatibility with Ruby 3.1+ [#102]
+- Functionality previously commented or logged as deprecated has been removed.
+- Standardize code formatting with `standard`
+- Add GitHub CI with Ruby version matrix
+- Drop support for Rubies below 2.5.
+
+Einhorn is now owned and actively maintained by Mike Perham of Contributed Systems.
+Thank you to the Stripe developers who wrote Einhorn and maintained it to this point.

data/README.md

@@ -1,21 +1,7 @@
-# Einhorn: the language-independent shared socket manager
-
-![Einhorn](https://stripe.com/img/blog/posts/meet-einhorn/einhorn.png)
-
-Let's say you have a server process which processes one request at a
-time. Your site is becoming increasingly popular, and this one process
-is no longer able to handle all of your inbound connections. However,
-you notice that your box's load number is low.
 
-So you start thinking about how to handle more requests. You could
-rewrite your server to use threads, but threads are a pain to program
-against (and maybe you're writing in Python or Ruby where you don't
-have true threads anyway). You could rewrite your server to be
-event-driven, but that'd require a ton of effort, and it wouldn't help
-you go beyond one core. So instead, you decide to just run multiple
-copies of your server process.
+# Einhorn: the language-independent shared socket manager
 
-Enter Einhorn. Einhorn makes it easy to run (and keep alive) multiple
+Einhorn makes it easy to run (and keep alive) multiple
 copies of a single long-lived process. If that process is a server
 listening on some socket, Einhorn will open the socket in the master
 process so that it's shared among the workers.
@@ -232,23 +218,6 @@ Then you could set `--reexec-as=` to the name of your bash script and it will ru
         --version                    Show version
 
 
-## Contributing
-
-### Development Status
-
-Einhorn is still in active operation at Stripe, but we are not maintaining
-Einhorn actively. PRs are very welcome, and we will review and merge,
-but we are unlikely to triage and fix reported issues without code.
-
-Contributions are definitely welcome. To contribute, just follow the
-usual workflow:
-
-1. Fork Einhorn
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Github pull request
-
 ## History
 
 Einhorn came about when Stripe was investigating seamless code
@@ -267,7 +236,7 @@ EventMachine-LE to support file-descriptor passing. Check out
 
 ## Compatibility
 
-Einhorn runs in Ruby 2.0, 2.1, and 2.2
+Einhorn runs in Ruby 2.5+.
 
 The following libraries ease integration with Einhorn with languages other than
 Ruby:
@@ -290,5 +259,5 @@ Ruby:
 
 ## About
 
-Einhorn is a project of [Stripe](https://stripe.com), led by [Carl Jackson](https://github.com/zenazn). Feel free to get in touch at
-info@stripe.com.
+Einhorn was a project of [Stripe](https://stripe.com).
+It is now maintained by [Contributed Systems](https://contribsys.com).

data/einhorn.gemspec

@@ -1,27 +1,29 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/einhorn/version', __FILE__)
+require File.expand_path("../lib/einhorn/version", __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ['Greg Brockman']
-  gem.email         = ['gdb@stripe.com']
-  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.authors = ["Stripe", "Mike Perham"]
+  gem.email = ["support+github@stripe.com", "mperham@gmail.com"]
+  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/contribsys/einhorn"
+  gem.license = "MIT"
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = 'einhorn'
-  gem.require_paths = ['lib']
+  gem.files = ["einhorn.gemspec", "README.md", "Changes.md", "LICENSE.txt"] + `git ls-files bin lib example`.split("\n")
+  gem.executables = %w[einhorn einhornsh]
+  gem.test_files = []
+  gem.name = "einhorn"
+  gem.require_paths = ["lib"]
+  gem.required_ruby_version = ">= 2.5.0"
+  gem.version = Einhorn::VERSION
 
-  gem.add_development_dependency 'rack', '~> 1.6'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'minitest', '< 5.0'
-  gem.add_development_dependency 'mocha', '~> 0.13'
-  gem.add_development_dependency 'chalk-rake'
-  gem.add_development_dependency 'subprocess'
+  gem.metadata = {
+    "bug_tracker_uri" => "https://github.com/contribsys/einhorn/issues",
+    "documentation_uri" => "https://github.com/contribsys/einhorn/wiki",
+    "changelog_uri" => "https://github.com/contribsys/einhorn/blob/main/Changes.md"
+  }
 
-  gem.version       = Einhorn::VERSION
+  gem.add_development_dependency "rake", "~> 13"
+  gem.add_development_dependency "minitest", "~> 5"
+  gem.add_development_dependency "mocha", "~> 1"
+  gem.add_development_dependency "subprocess", "~> 1"
 end

data/example/pool_worker.rb

@@ -12,8 +12,8 @@
 puts "From PID #{$$}: loading #{__FILE__}"
 
 def einhorn_main
-  while true
+  loop do
     puts "From PID #{$$}: Doing some work"
     sleep 1
   end
-end
+end

data/example/thin_example

@@ -6,12 +6,12 @@
 #   https://github.com/stripe/thin.git, and
 #   https://github.com/stripe/eventmachine.git
 
-require 'rubygems'
-require 'einhorn'
+require "rubygems"
+require "einhorn"
 
-require 'eventmachine-le'
-require 'thin'
-require 'thin/attach_socket'
+require "eventmachine-le"
+require "thin"
+require "thin/attach_socket"
 
 class App
   def initialize(id)
@@ -19,7 +19,7 @@ class App
   end
 
   def call(env)
-    return [200, {}, "[#{$$}] From server instance #{@id}: Got your request!\n"]
+    [200, {}, "[#{$$}] From server instance #{@id}: Got your request!\n"]
   end
 end
 
@@ -41,8 +41,8 @@ def einhorn_main
     (0...fd_count).each do |i|
       sock = Einhorn::Worker.socket!(i)
       srv = Thin::Server.new(App.new(i),
-        :backend => Thin::Backends::AttachSocket,
-        :socket => IO.for_fd(sock))
+        backend: Thin::Backends::AttachSocket,
+        socket: IO.for_fd(sock))
       srv.start
     end
   end

data/example/time_server

@@ -12,15 +12,15 @@
 # or, if you want to try out preloading:
 #
 #     einhorn -b 127.0.0.1:2345,r -p ./time_server ./time_server
-require 'rubygems'
-require 'einhorn/worker'
+require "rubygems"
+require "einhorn/worker"
 
 def log(msg)
   puts "=== [#{$$}] #{msg}"
 end
 
 def einhorn_main
-  log "Called with ENV['EINHORN_FD_0']: #{ENV['EINHORN_FD_0']}"
+  log "Called with ENV['EINHORN_FD_0']: #{ENV["EINHORN_FD_0"]}"
 
   fd_num = Einhorn::Worker.socket!
   socket = Socket.for_fd(fd_num)
@@ -49,12 +49,12 @@ def einhorn_main
 
   # Real work happens here.
   begin
-    while true
+    loop do
       accepted, _ = socket.accept
       accepted.write("[#{$$}] The current time is: #{Time.now}!\n")
       accepted.close
     end
-  rescue Exception
+  rescue Interrupt
   end
 end
 

data/lib/einhorn/client.rb

@@ -1,12 +1,12 @@
-require 'set'
-require 'yaml'
+require "set"
+require "yaml"
+require "einhorn/safe_yaml"
 
 module Einhorn
   class Client
     # Keep this in this file so client can be loaded entirely
     # standalone by user code.
     module Transport
-
       ParseError = defined?(Psych::SyntaxError) ? Psych::SyntaxError : ArgumentError
 
       def self.send_message(socket, message)
@@ -21,24 +21,24 @@ module Einhorn
 
       def self.serialize_message(message)
         serialized = YAML.dump(message)
-        escaped = serialized.gsub(/%|\n/, '%' => '%25', "\n" => '%0A')
+        escaped = serialized.gsub(/%|\n/, "%" => "%25", "\n" => "%0A")
         escaped + "\n"
       end
 
       def self.deserialize_message(line)
-        serialized = line.gsub(/%(25|0A)/, '%25' => '%', '%0A' => "\n")
-        YAML.load(serialized)
+        serialized = line.gsub(/%(25|0A)/, "%25" => "%", "%0A" => "\n")
+        SafeYAML.load(serialized)
       end
     end
 
     def self.for_path(path_to_socket)
       socket = UNIXSocket.open(path_to_socket)
-      self.new(socket)
+      new(socket)
     end
 
     def self.for_fd(fileno)
       socket = UNIXSocket.for_fd(fileno)
-      self.new(socket)
+      new(socket)
     end
 
     def initialize(socket)