the_lone_dyno 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8cc00080214d127a40dd7ffde3cd0ae7e7298bda
+  data.tar.gz: 8948b5958cae2c5cf67e17cdf4c82ab8949a376e
+SHA512:
+  metadata.gz: 56a23c590fdcce8d35b9891e99482feafb9a932d7623a398e085fec5d8f1fbc2510415f6353c94b62afdb9da0bf27dabe6afd0241e65ea7c8a88ed271aeb0dda
+  data.tar.gz: 35e29cfe0431f04c0b5e2c01a41c5d2dd04e0b65561086dbb461c83a96047a6f6e91e081eccf6a391e8a85c494d2e20c1072378338dd0295fa80e9c01f80830f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6
+
+before_script:
+  - psql -c 'create database the_lone_dyno_test;' -U postgres

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in the_lone_dyno.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 schneems
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,206 @@
+![The Lone Dyno logo](https://www.dropbox.com/s/m7v8yndgcgt8sf3/Screenshot%202015-10-08%2014.42.32.png?dl=1)
+
+# TheLoneDyno
+
+Isolate code to only run on a certain number of Heroku dynos. Using and Postgres [advisory locks](http://www.postgresql.org/docs/9.1/static/explicit-locking.html). You can later trigger events using Postgres listen/notify.
+
+[![Build Status](https://travis-ci.org/schneems/the_lone_dyno.svg?branch=master)](https://travis-ci.org/schneems/the_lone_dyno)
+
+## Why?
+
+Why would you want to run code on only one dyno? Maybe you want to add some performance monitoring code to a critical path in production, you don't want to slow down all your dynos, so you can retain throughput by isolating to only run on one dyno. Maybe you want to test out a refactoring or change, instead of rolling it out to all of your service, you could run it on a select number. Whatever the reason, if you want to run some code on only a few dynos, this is the gem for you!
+
+Why is this needed? All Heroku dynos operate independently of one another. Once one is running you can't change it. You can `$ heroku run bash` but this gives you a new dyno that doesn't receieve any web traffic. If you want to run code on only a certain number of dynos it's been difficult to do so until now.
+
+> Be warned, only changing behavior on 1 dyno in your app, could cause difficult to reproduce problems. "I'm getting an error but only once fore every 20 requests". Using this library is an advanced technique and should be implemented with care. Make sure to tell the rest of your team what you're doing, and remove the code from your codebase as soon as you're done.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'the_lone_dyno'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install the_lone_dyno
+
+## Usage
+
+In an initializer like `config/initializers/the_lone_dyno.rb` configure your code:
+
+```ruby
+TheLoneDyno.exclusive do
+  while true do
+    # Code that only runs in 1 dyno in the background
+    puts "bump-ba-da-bump-ba-da-bump"
+    sleep 1
+  end
+end
+
+puts "Does not block future code execution"
+```
+
+This code will only run on one dyno. By default code passed into the block will run in the background and the lock will be held for as long as your process is alive. For example if we run the above code we should get:
+
+```
+Does not block future code execution
+bump-ba-da-bump-ba-da-bump
+bump-ba-da-bump-ba-da-bump
+bump-ba-da-bump-ba-da-bump
+bump-ba-da-bump-ba-da-bump
+bump-ba-da-bump-ba-da-bump
+# ...
+```
+
+So your app will continue to load and run as usual.
+
+Note: The Lone Dyno restricts code at the process/machine level. While it will prevent this code from being executed on multiple machines it is not restricted from running multiple times in the same process. If you are calling this code in multiple threads it will execute in every thread. If that's not what you want, you'll need to add your own mutex.
+
+## Triggering Events
+
+Sometimes you'll need to interact with your Lone Dyno externally. You can trigger events with listen/notify.
+
+```ruby
+TheLoneDyno.exclusive do |signal|
+  # Code you only want to run on 1 dyno
+
+  signal.watch do |payload|
+    puts "I only get called when I receive the signal: #{payload}"
+  end
+end
+```
+
+The code you are running inside of the `watch` block will run in a background thread waiting for a notification. How do you send a signal? You can do so with `$ heroku run bash`
+
+```
+$ heroku run bash
+$ rails console
+>
+> TheLoneDyno.signal("hi ho silver!")
+```
+
+When you do this 1 and only one dyno will emit
+
+```
+"I only get called when I receive the signal: hi ho silver"
+```
+
+Whatever configuration you pass into `TheLoneDyno#exclusive` need to be passed into `TheLoneDyno#signal` such as `key_base` and `dynos`. See configuration options below. This is needed since each dyno maintains a unique lock, we re-use the same name to signal the same dyno using postgres' [Listen/Notify](http://www.postgresql.org/docs/9.1/static/sql-notify.html).
+
+ By default the background thread wakes up every 60 seconds and waits 0.1 seconds to see if there is a message. You can customize this behavior using `sleep` and `ttl`. So to have it check every 10 seconds, and not wait at all you could run
+
+```ruby
+TheLoneDyno.exclusive do |signal|
+  # Code you only want to run on 1 dyno
+
+  signal.watch(sleep: 10, ttl: 0) do |payload|
+    puts "I only get called when I receive the signal: #{payload}"
+  end
+end
+```
+
+## Config
+
+You can control the number of dynos you run code on by passing in an integer:
+
+```ruby
+TheLoneDyno.exclusive(dynos: 5) do
+  # Code you only want to run on 5 dyno
+end
+```
+
+Under the hood this uses PG advisory locks. If you need to customize the default advisory key, for instance if you want to have multiple processes you want to isolate to a set of dynos you can use the `key_base:` key, for example:
+
+```ruby
+TheLoneDyno.exclusive(key_base: "reticulate splines") do
+  # Code for reticulating splines
+end
+
+TheLoneDyno.exclusive(dynos: 42, key_base: "extrapolate conclusions") do
+  # Code for extrapolating conclusions
+end
+```
+
+## Run Syncronously in the Foreground
+
+If you don't want to run your exclusive process in the background you can force it to run syncronously using `background: false`. For example:
+
+
+```ruby
+TheLoneDyno.exclusive(background: false) do |signal|
+  while true do
+    puts "bump-ba-da-bump-ba-da-bump"
+    sleep 1
+  end
+end
+
+puts "Does block execution"
+```
+
+produces
+
+```
+bump-ba-da-bump-ba-da-bump
+bump-ba-da-bump-ba-da-bump
+bump-ba-da-bump-ba-da-bump
+bump-ba-da-bump-ba-da-bump
+bump-ba-da-bump-ba-da-bump
+# ...
+```
+
+Notice the `puts "Does block execution"` never gets called because our Lone Dyno block never exits.
+
+Keep in mind that your lock is only held for the duration of your block, so if the code in your block exits, another machine may be able to pick up the lock. For this reason it is recommended to not run short tasks syncronously in the foreground.
+
+
+## Connection
+
+By default The Lone Dyno assumes you're using Active Record and already have a connection configured. If you want to use a different ORM, you'll need to provide TheLoneDyno with an object that responds to `exec` that executes arbitrary SQL. Under the hood this library uses [pg_lock](https://github.com/heroku/pg_lock#database-connection). So that's how you can configure the connection
+
+```
+connection = Module do
+  def self.exec(sql, bind)
+    DB.fetch(sql, bind)
+  end
+end
+
+TheLoneDyno.exclusive(connection: connection)  do
+
+end
+```
+
+You can alternatively set the `DEFAULT_CONNECTION`
+
+```
+Pg::Lock = Module do
+  def self.exec(sql, bind)
+    DB.fetch(sql, bind)
+  end
+end
+
+TheLoneDyno.exclusive  do
+
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/the_lone_dyno. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "the_lone_dyno"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/the_lone_dyno.rb

@@ -0,0 +1,72 @@
+require "the_lone_dyno/version"
+require "pg_lock"
+
+module TheLoneDyno
+  DEFAULT_KEY = "the_lone_dyno_hi_ho_silver"
+
+  # Use to ensure only `dynos` count of dynos are exclusively running
+  # the given block
+  def self.exclusive(background: true, dynos: 1, key_base: DEFAULT_KEY, connection: ::PgLock::DEFAULT_CONNECTION_CONNECTOR.call, &block)
+    if background
+      Thread.new do
+        forever_block = Proc.new { |*args| block.call(*args); while true do; sleep 180 ; end; }
+        Lock.new(key_base, dynos).lock(connection, &forever_block)
+      end
+    else
+      Lock.new(key_base, dynos).lock(connection, &block)
+    end
+  end
+
+  # Use to send a custom signal to any exclusive running dynos
+  def self.signal(payload = "", dynos: 1, key_base: DEFAULT_KEY, connection: ::PgLock::DEFAULT_CONNECTION_CONNECTOR.call, &block)
+    Lock.new(key_base, dynos).keys.each do |key|
+      message = "NOTIFY #{key}, '#{payload}'"
+      puts message
+      connection.exec(message)
+    end
+  end
+
+  # Used for running a block when a pg NOTIFY is sent
+  class ListenWatch
+    def initialize(key, raw_connection)
+      @key = key
+      @raw_connection = raw_connection
+    end
+
+    def watch(sleep: 60, ttl: 0.01, &block)
+      @raw_connection.exec "LISTEN #{@key}"
+
+      @thread = Thread.new do
+        while true do
+          sleep sleep
+
+          @raw_connection.wait_for_notify(ttl) do |channel, pid, payload|
+            block.call(payload)
+          end
+        end
+      end
+    end
+  end
+
+  # Used for generating lock and listen keys. Isolates
+  # advisory locking behavior.
+  class Lock
+    def initialize(key_base, dynos, &block)
+      @key_base = key_base.to_s
+      @dynos    = Integer(dynos)
+      @block    = block
+    end
+
+    def keys
+      @dynos.times.map {|i| "#{@key_base}_#{i}" }
+    end
+
+    def lock(connection, &block)
+      keys.each do |key|
+        PgLock.new(name: key, ttl: false, connection: connection).lock do
+          block.call(ListenWatch.new(key, connection))
+        end
+      end
+    end
+  end
+end

data/lib/the_lone_dyno/version.rb

@@ -0,0 +1,3 @@
+module TheLoneDyno
+  VERSION = "0.1.0"
+end

data/the_lone_dyno.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'the_lone_dyno/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "the_lone_dyno"
+  spec.version       = TheLoneDyno::VERSION
+  spec.authors       = ["schneems"]
+  spec.email         = ["richard.schneeman@gmail.com"]
+
+  spec.summary       = %q{Isolate code to only run on a certain number of Heroku dynos.}
+  spec.description   = %q{Run code on only a certain number of Heroku dynos, isolated}
+  spec.homepage      = "https://github.com/schneems/the_lone_dyno"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency             "pg_lock", "~> 0.1.0"
+
+  spec.add_development_dependency "pg", ">= 0.15"
+  spec.add_development_dependency "activerecord", ">= 2.3"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: the_lone_dyno
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- schneems
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg_lock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: Run code on only a certain number of Heroku dynos, isolated
+email:
+- richard.schneeman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/the_lone_dyno.rb
+- lib/the_lone_dyno/version.rb
+- the_lone_dyno.gemspec
+homepage: https://github.com/schneems/the_lone_dyno
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Isolate code to only run on a certain number of Heroku dynos.
+test_files: []