the_lone_dyno 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57ba91bea8834c6e34ddbb1c1538ba646e9d82a0
-  data.tar.gz: afe9c78b57d5a1d032f36f28a9e450e4a6cff5f0
+  metadata.gz: adca286b5e4342cdb298d996c5b0c3c4d0b3ed28
+  data.tar.gz: fd8ca87a0ea95f950d302adea2a98c9c7e73fd7a
 SHA512:
-  metadata.gz: 48adc6fdab84f9347f174352227ae8e3ee9504f9a88f3774a22d0a556b9d97cd4278a8ca5d0f23ccfe1d34f5a194b8cb13ae0f1a44f95c5f19e2b5b5950a1693
-  data.tar.gz: dada3ca815f8a0643103f834a62a29e5078f5aa84b2b3a824bb8e88188683c2983034a0775bfd7daec014b0d565f84120a13653b21ae83b8166a96e3bbdd8e88
+  metadata.gz: 6f5765b377228c781d175eeaac583f698956fdc98cadb65aa3696b122811eb16043f0c7e181ca3e6db7f1a83435587553d1e65fdcba95fcfe274e87b9c8399ac
+  data.tar.gz: cdd2373747aa9e34b8325769495d8eab1fd22dc15251c9eeb58ce658b80d93b91886b9e12bf7ef5e4c8263326348e24f5148d51239b1aef6afbd5b6c3b748923

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # A Log of Changes!
 
+## [1.0.0] - 2015-11-06
+
+- Exclusivity is no longer provided by advisory locks instead uses a naming convention
+  provided by ENV['DYNO']. Prior implementation had the problem that on Puma or unicorn
+  the lock would be aquired by the master process but not the puma workers . Most likely we want
+  the workers to be doing tasks.
+
 ## [0.1.1] - 2015-10-12
 
 - Restrict locking behavior by process type. Default is "web".

data/README.md

@@ -2,7 +2,7 @@
 
 # TheLoneDyno
 
-Isolate code to only run on a certain number of Heroku dynos. Uses Postgres [advisory locks](http://www.postgresql.org/docs/9.1/static/explicit-locking.html) to isolate behavior and Postgres [LISTEN/NOTIFY](http://www.postgresql.org/docs/9.1/static/sql-notify.html) to trigger custom events.
+Isolate code to only run on a certain number of Heroku dynos. Then use [LISTEN/NOTIFY](http://www.postgresql.org/docs/9.1/static/sql-notify.html) to trigger custom events on those dynos.
 
 [![Build Status](https://travis-ci.org/schneems/the_lone_dyno.svg?branch=master)](https://travis-ci.org/schneems/the_lone_dyno)
 
@@ -14,6 +14,10 @@ Why is this needed? All Heroku dynos operate independently of one another. Once
 
 > 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.
 
+## How
+
+A big change happened between version 0.1 and 1.0. We are no longer using Postgres advisory locks. Instead we're depending on the `DYNO=web.1` environment variables. This makes behavior more predictable and easier to reason about.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -115,7 +119,7 @@ TheLoneDyno.exclusive(process_type: "worker") do
 end
 ```
 
-This will attempt to lock any DYNO environment variable containing "worker" string. You can use a string or a regex. if the `$DYNO` environment variable isn't present or if `process_type` is set to `false` then the check will be skipped and the first process to boot will aquire the lock regardless of dyno type. This behavior is purposful so you can aquire and lock on your local develoment machine.
+This will attempt to lock any DYNO environment variable containing "worker" string.
 
 ## Running on more than 1 Dyno
 
@@ -129,7 +133,7 @@ end
 
 ## Using multiple locks on the same app
 
-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:
+If you need to customize the default listen 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
@@ -145,7 +149,6 @@ end
 
 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
@@ -175,7 +178,7 @@ Keep in mind that your lock is only held for the duration of your block, so if t
 
 ## 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
+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 [hey_you](https://github.com/heroku/hey_you#database-connection). So that's how you can configure the connection
 
 ```
 connection = Module do
@@ -192,7 +195,7 @@ end
 You can alternatively set the `DEFAULT_CONNECTION`
 
 ```
-Pg::Lock = Module do
+HeyYou::DEFAULT_CONNECTION = Module do
   def self.exec(sql, bind)
     DB.fetch(sql, bind)
   end

data/lib/the_lone_dyno.rb

@@ -1,76 +1,51 @@
 require "the_lone_dyno/version"
-require "pg_lock"
+require "hey_you"
 
 module TheLoneDyno
   DEFAULT_KEY = "the_lone_dyno_hi_ho_silver"
-  WEB_PROCESS_TYPE_REGEX = /\Aweb/
+  DEFAULT_PROCESS_TYPE = "web"
 
   # Use to ensure only `dynos` count of dynos are exclusively running
   # the given block
-  def self.exclusive(background: true, dynos: 1, process_type: WEB_PROCESS_TYPE_REGEX, key_base: DEFAULT_KEY, connection: ::PgLock::DEFAULT_CONNECTION_CONNECTOR.call, &block)
+  def self.exclusive(dynos: 1, process_type: DEFAULT_PROCESS_TYPE, background: true, sleep: 60, ttl: 0.1, connection: ::HeyYou::DEFAULT_CONNECTION_CONNECTOR.call, key_base: DEFAULT_KEY, **args, &block)
+    dynos = dyno_names(dynos, process_type)
 
-    return if process_type && ENV["DYNO"] && !ENV["DYNO"].match(process_type)
+    return unless dynos.include?(ENV['DYNO'])
+
+    watcher = ListenWatch.new(ENV['DYNO'] + key_base, connection)
 
     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)
+        forever_block = Proc.new { |*a| block.call(*a); while true do; sleep 180 ; end; }
+        forever_block.call(watcher)
       end
     else
-      Lock.new(key_base, dynos).lock(connection, &block)
+      block.call(watcher)
     end
   end
 
+  def self.dyno_names(dynos, process_type)
+    1.upto(dynos.to_i).map { |i| "#{process_type}.#{i}" }
+  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)
+  def self.signal(payload = "", dynos: 1, process_type: DEFAULT_PROCESS_TYPE, key_base: DEFAULT_KEY, connection: ::HeyYou::DEFAULT_CONNECTION_CONNECTOR.call, **args, &block)
+    dynos = dyno_names(dynos, process_type)
+
+    dynos.each do |dyno|
+      HeyYou.new(channel: (dyno + key_base).gsub(".".freeze, "_".freeze), connection: connection).notify(payload)
     end
   end
 
   # Used for running a block when a pg NOTIFY is sent
   class ListenWatch
     def initialize(key, raw_connection)
-      @key = key
+      @key = key.gsub(".".freeze, "_".freeze)
       @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
+      HeyYou.new(sleep: sleep, ttl: ttl, channel: @key, connection: @raw_connection).listen(&block)
     end
   end
 end

data/lib/the_lone_dyno/version.rb

@@ -1,3 +1,3 @@
 module TheLoneDyno
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/the_lone_dyno.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   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_dependency             "hey_you", "~> 0.1.1"
 
   spec.add_development_dependency "pg", ">= 0.15"
   spec.add_development_dependency "activerecord", ">= 2.3"

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: the_lone_dyno
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - schneems
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-12 00:00:00.000000000 Z
+date: 2015-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pg_lock
+  name: hey_you
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement