dynamodb-mutex 0.0.1 → 0.0.2

data/README.rst

@@ -15,14 +15,16 @@ Usage
        # Access to shared resource.
     end
 
-You can pass following options to ``with_lock``
-
-.. code-block:: ruby
-
-    :block  => 1    # Specify in seconds how long you want to wait for the lock to be released. (default: 1)
-                    # It will raise DynamoDBMutex::LockError after block timeout
-    :sleep  => 0.1  # Specify in seconds how long the polling interval should be when :block is given.
-                    # It is NOT recommended to go below 0.01. (default: 0.1)
-    :ttl => 10      # Specify in seconds when the lock should be considered stale when something went wrong
-                    # with the one who held the lock and failed to unlock. (default: 10)
-
+If no lock name (``:your_lock`` above) is given, ``#with_lock`` uses
+``'default.lock'``.
+
+You can pass ``with_lock`` the following options:
+
+* ``:wait_for_other`` (default ``1``):
+  Seconds to to wait for another process to release the lock.
+* ``:polling_interval`` (default ``0.1``):
+  Seconds between retrials to acquire lock. Should be at least
+  "``(:wait_for_other / 5) * (no_of_instances - 1)``".
+* ``:stale_after`` (default ``10``):
+  Seconds after which the lock is considered stale and will be automatically
+  deleted; set to "falsey" (``nil`` or ``false``) to disable.

data/lib/dynamodb-mutex.rb

@@ -1,2 +1 @@
-
-require_relative 'dynamodb_mutex'
+require_relative 'dynamodb_mutex'

data/lib/dynamodb_mutex.rb

@@ -1,8 +1,7 @@
-
 require 'dynamodb_mutex/lock'
 
 module DynamoDBMutex
-  
+
   def self.with_lock *args, &block
     Lock.with_lock(*args, &block)
   end

data/lib/dynamodb_mutex/lock.rb

@@ -4,61 +4,66 @@ require_relative 'logging'
 module DynamoDBMutex
 
   LockError = Class.new(StandardError)
-  
+
   module Lock
     include Logging
     extend self
 
     TABLE_NAME = 'dynamodb-mutex'
 
-    def with_lock name, opts = {}
-      opts[:ttl]      ||= 10     
-      opts[:block]    ||= 1
-      opts[:sleep]    ||= 0.1        
+    def with_lock name = 'default.lock', opts = {}
+      opts[:stale_after]      ||= 10  # seconds
+      opts[:wait_for_other]   ||= 1   # seconds
+      opts[:polling_interval] ||= 0.1 # seconds
 
       if create(name, opts)
-        begin Timeout::timeout(opts[:ttl]) { return(yield) }
+        begin Timeout::timeout(opts[:stale_after]) { return(yield) }
         ensure delete(name)
         end
       else
-        raise LockError, "Unable to hold #{name} after #{opts[:block]} ms"
+        raise LockError, "Unable to acquire #{name} after #{opts[:wait_for_other]} seconds"
       end
     end
 
     private
 
       def create name, opts
-        acquire_timeout = Time.now.to_i + opts[:block]
+        acquire_timeout = Time.now.to_i + opts[:wait_for_other]
 
         while Time.now.to_i < acquire_timeout
-          delete(name) if expired?(name, opts[:ttl])
+          delete(name) if stale?(name, opts[:stale_after])
           begin
             table.items.put({:id => name, :created => Time.now.to_i},
               :unless_exists => :id)
-            logger.info "ACQUIRED LOCK #{name} by #{pid}"
+            logger.info "#{pid} acquired #{name}"
             return true
           rescue AWS::DynamoDB::Errors::ConditionalCheckFailedException
-            logger.info "Waiting for the #{name} (pid=#{pid})..."
-            sleep opts[:sleep]
+            logger.info "#{pid} is waiting for #{name}"
+            sleep opts[:polling_interval]
           end
         end
 
+        logger.warn "#{pid} failed to acquire #{name}"
         false
       end
 
       def delete(name)
         table.items.at(name).delete
-        logger.info "RELEASED LOCK #{name} by #{pid}"
+        logger.info "#{pid} released lock #{name}"
       end
 
       def pid
-        Process.pid
+        @hostname ||= Socket.gethostname
+
+        "#{@hostname}-#{Process.pid}"
       end
 
-      def expired?(name, ttl)
-        if l = table.items.at(name).attributes.to_h(:consistent_read => true)
-          if t = l["created"]
-            t < (Time.now.to_i - ttl)
+      def stale?(name, ttl)
+        return false unless ttl
+
+        if lock_attributes = table.items.at(name).attributes.to_h(:consistent_read => true)
+          if time_locked = lock_attributes["created"]
+            time_locked < (Time.now.to_i - ttl)
           end
         end
       end
@@ -68,16 +73,22 @@ module DynamoDBMutex
         dynamo_db = AWS::DynamoDB.new
 
         begin
+          tries ||= 10
           @table = dynamo_db.tables[TABLE_NAME].load_schema
         rescue AWS::DynamoDB::Errors::ResourceInUseException
-          logger.info "table named: #{TABLE_NAME} already exists"
+          raise LockError, "Cannot load schema for table #{TABLE_NAME}" if (tries -= 1).zero?
+
+          logger.info "Could not load schema for table #{TABLE_NAME}; retrying"
+          sleep 1
           retry
         rescue AWS::DynamoDB::Errors::ResourceNotFoundException
-          @table = dynamo_db.tables.create(TABLE_NAME, 5, 5, {})
-          sleep 1 unless @table.status == :active
+          logger.info "Creating table #{TABLE_NAME}"
+          @table = dynamo_db.tables.create(TABLE_NAME, 5, 5)
+          sleep 1 while @table.status != :active
+          logger.info "Table #{TABLE_NAME} created"
         end
 
         @table
       end
     end
-end
+end

data/lib/dynamodb_mutex/version.rb

@@ -1,4 +1,4 @@
 
 module DynamoDBMutex
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/dynamodb_mutex_spec.rb

@@ -1,47 +1,75 @@
 require 'spec_helper'
+require 'ostruct'
 
 describe DynamoDBMutex::Lock do
-  
+
   let(:locker) { DynamoDBMutex::Lock }
+  let(:lockname) { 'test.lock' }
 
   describe '#with_lock' do
-
-    def run(id, ms)
-      print "invoked worker #{id}...\n"
-      locker.with_lock 'test.lock' do
-        sleep(ms)
-      end
-    end
-
-    it 'should execute block by default' do
+    it 'executes block' do
       locked = false
-      locker.with_lock 'test.lock' do
+      locker.with_lock(lockname) do
         locked = true
       end
       expect(locked).to eq(true)
     end
+  end
+
+  describe '#with_lock', pipe: true do
+    before(:example) do
+      @notify = Class.new do
+        def initialize
+          @reader, @writer = IO.pipe
+        end
+
+        def poke
+          @reader.close
+          @writer.write "\n"
+        end
+
+        def wait
+          @writer.close
+          @reader.gets
+        end
+      end.new
+    end
+
+    def run_infinitely(notify)
+      locker.with_lock(lockname) do
+        notify.poke
+        sleep
+      end
+    end
+
+    it 'raises error after :wait_for_other timeout' do
+      begin
+        child = fork { run_infinitely(@notify) }
+
+        @notify.wait
 
-    it 'should raise error after block timeout' do
-      if pid1 = fork
-        sleep(1)
         expect {
-          locker.with_lock('test.lock'){ sleep 1 }
+          locker.with_lock(lockname, wait_for_other: 0, stale_after: 100) { return }
         }.to raise_error(DynamoDBMutex::LockError)
-        Process.waitall
-      else
-        run(1, 5)
+
+      ensure
+        Process.kill('QUIT', child)
       end
     end
 
-    it 'should expire lock if stale' do
-      if pid1 = fork
-        sleep(2)
-        locker.with_lock 'test.lock', block: 10 do
-          expect(locker).to receive(:delete).with('test.lock')
-        end 
-        Process.waitall
-      else
-        run(1, 5)
+
+    it 'deletes lock if stale' do
+      begin
+        child = fork { run_infinitely(@notify) }
+
+        @notify.wait
+
+        locker.with_lock(lockname, stale_after: 0, wait_for_other: 100) do
+          expect(locker).to receive(:delete).with(lockname)
+        end
+
+      ensure
+        Process.kill('QUIT', child)
       end
     end
 

data/spec/spec_helper.rb

@@ -6,11 +6,15 @@ require 'aws-sdk'
 
 AWS.config(:use_ssl => false,
            :dynamo_db_endpoint => 'localhost',
-           :dynamo_db_port => 4567)
+           :dynamo_db_port => 4567,
+           :access_key_id => 'foo',
+           :secret_access_key => 'bar',
+          )
 
 require 'dynamodb-mutex'
 
 RSpec.configure do |config|
+  DynamoDBMutex::Lock.logger = Logger.new(StringIO.new, 1024*1024, 10)
 
   dynamo_thread = nil
 
@@ -19,6 +23,7 @@ RSpec.configure do |config|
     FakeDynamo::Storage.instance.load_aof
 
     dynamo_thread = Thread.new do
+      $stdout = StringIO.new
       FakeDynamo::Server.run!(port: 4567, bind: 'localhost') do |server|
         if server.respond_to?('config') && server.config.respond_to?('[]=')
           server.config[:AccessLog] = []
@@ -34,4 +39,4 @@ RSpec.configure do |config|
     FileUtils.rm('test.fdb', force: true)
   end
 
-end
+end

metadata

@@ -1,74 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: dynamodb-mutex
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
+  prerelease: 
 platform: ruby
 authors:
 - Dinesh Yadav
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-08 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fake_dynamo
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -76,47 +86,50 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.1.3
-description: dynamodb-mutex implements a simple mutex that can be used to coordinate
+description: dynamodb-mutex implements a simple mutex that can be used to coordinateaccess
+  to shared data from multiple concurrent hosts
 email: dy@clearhaus.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.rst
 - Rakefile
-- lib/dynamodb-mutex.rb
-- lib/dynamodb_mutex.rb
-- lib/dynamodb_mutex/lock.rb
 - lib/dynamodb_mutex/logging.rb
+- lib/dynamodb_mutex/lock.rb
 - lib/dynamodb_mutex/version.rb
-- spec/dynamodb_mutex_spec.rb
+- lib/dynamodb-mutex.rb
+- lib/dynamodb_mutex.rb
 - spec/spec_helper.rb
+- spec/dynamodb_mutex_spec.rb
+- README.rst
 homepage: http://github.com/clearhaus/dynamodb-mutex
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Distributed mutex based on AWS DynamoDB
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 2c51332da52855eb26f2f6dcf190ca6c46da6f75
-  data.tar.gz: 795579cb3f014ac3974cc30d90658f917ff5cef8
-SHA512:
-  metadata.gz: ca601a979c69633c6d21ff8e40c614b482936134fe5aab758cb1107aa24ccb934a106bb015715533fb255e4de13836743ff7f0fd62b7aef42036e94ed6219b8b
-  data.tar.gz: b7ba8b59b985ff8b067e88b621f81859bb963475c0c92ca0031cc246f5abc9839083704298d9154d24054ce980c9993eb20fbe47b709afdbe3fc53533a103bc0