master_lock 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 321dbc834c9f475dac38543343c696ae1eafda08
-  data.tar.gz: 5f764d38a83de5434bf318944de4dc4b478202e1
+  metadata.gz: 1ab9ca1ac176e6f632f6c3d71ed4008bec96df23
+  data.tar.gz: 43f2c87012e46141d08990ae8e5ce4badfba36e5
 SHA512:
-  metadata.gz: 67f9681ccef00d1fa3e4956524fc419dbb097b770ebb985cbdf16a4f584ecdaaee7220ff4ab68d9699723ebef24131002ee5cc0ec4b42338e79114618c4c145a
-  data.tar.gz: e6b55e755805fc89ad8c26a942e3d6be4770631285d1ed207ad250c2dc5ad95c7d3b77315ec48035e1cd2a317e8dae4235f87f340af349eebe1ea938a4e9bfe9
+  metadata.gz: 4f5a952ef00b065ef69563acdb808a2921726229be3ea9c78bf15b6070804ae8d8020f3cea5fd2e27f6ce52ae69d7bc13c4ec1d1a7dc6d9072cee626af4c4a19
+  data.tar.gz: 82d2e7768c6d528d211f53870b06296194b328fb0ce4f703cfdd6e31287a1a8514a73c0f9a0db4776b194b9c32b1f0296d73738b9eeb83b20dfaa89e3548917f

data/README.md

@@ -24,7 +24,19 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+def perform_safe_operation
+  MasterLock.synchronize("perform_safe_operation") do
+    # Code executes within locked context
+  end
+end
+
+# Call MasterLock.start when your application boots up.
+# This starts a background thread to prevent locks from expiring.
+MasterLock.start
+```
+
+See [documentation](http://www.rubydoc.info/gems/master_lock) for advanced usage.
 
 ## Development
 

data/lib/master_lock/redis_lock.rb

@@ -44,7 +44,7 @@ module MasterLock
     def acquire(timeout:)
       timeout_time = Time.now + timeout
       loop do
-        locked = redis.set(key, owner, nx: true, px: ttl_ms)
+        locked = redis.set(redis_key, owner, nx: true, px: ttl_ms)
         return true if locked
         return false if Time.now >= timeout_time
         sleep(@sleep_interval)
@@ -60,7 +60,7 @@ module MasterLock
       result = eval_script(
         RedisScripts::EXTEND_SCRIPT,
         RedisScripts::EXTEND_SCRIPT_HASH,
-        keys: [key],
+        keys: [redis_key],
         argv: [owner, ttl_ms]
       )
       result != 0
@@ -74,7 +74,7 @@ module MasterLock
       result = eval_script(
         RedisScripts::RELEASE_SCRIPT,
         RedisScripts::RELEASE_SCRIPT_HASH,
-        keys: [key],
+        keys: [redis_key],
         argv: [owner]
       )
       result != 0
@@ -93,5 +93,9 @@ module MasterLock
         redis.eval(script, keys: keys, argv: argv)
       end
     end
+
+    def redis_key
+      "#{MasterLock.config.key_prefix}:#{key}"
+    end
   end
 end

data/lib/master_lock/registry.rb

@@ -69,15 +69,21 @@ module MasterLock
     def extend_lock(registration)
       registration.mutex.synchronize do
         time = Time.now
+        lock_key = registration.lock.key
         if !registration.thread.alive?
           registration.released = true
+          MasterLock.logger.info(
+            "Releasing lock #{lock_key} after owning thread terminated"
+          )
         elsif !registration.released &&
             registration.acquired_at + registration.extend_interval < time
+          lock_key = registration.lock.key
           if registration.lock.extend
             registration.acquired_at = time
+            MasterLock.logger.debug("Renewed lease on lock #{lock_key}")
           else
             registration.released = true
-            # TODO: Notify of failure somehow
+            MasterLock.logger.warn("Could not renew lease on lock #{lock_key}")
           end
         end
       end

data/lib/master_lock/version.rb

@@ -1,3 +1,3 @@
 module MasterLock
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/lib/master_lock.rb

@@ -1,5 +1,6 @@
 require 'master_lock/version'
 
+require 'logger'
 require 'socket'
 
 # MasterLock is a system for interprocess locking. Resources can be locked by a
@@ -27,6 +28,7 @@ module MasterLock
     :acquire_timeout,
     :extend_interval,
     :hostname,
+    :logger,
     :key_prefix,
     :process_id,
     :redis,
@@ -72,7 +74,7 @@ module MasterLock
 
       lock = RedisLock.new(
         redis: config.redis,
-        key: redis_key(key),
+        key: key,
         ttl: ttl,
         owner: generate_owner
       )
@@ -82,11 +84,16 @@ module MasterLock
 
       registration =
         @registry.register(lock, extend_interval)
+      logger.debug("Acquired lock #{key}")
       begin
         yield
       ensure
         @registry.unregister(registration)
-        lock.release # TODO: Check result of this
+        if lock.release
+          logger.debug("Released lock #{key}")
+        else
+          logger.warn("Failed to release lock #{key}")
+        end
       end
     end
 
@@ -103,6 +110,13 @@ module MasterLock
       end
     end
 
+    # Get the configured logger.
+    #
+    # @return [Logger]
+    def logger
+      config.logger
+    end
+
     # @return [Config] MasterLock configuration settings
     def config
       if !defined?(@config)
@@ -110,6 +124,8 @@ module MasterLock
         @config.acquire_timeout = DEFAULT_ACQUIRE_TIMEOUT
         @config.extend_interval = DEFAULT_EXTEND_INTERVAL
         @config.hostname = Socket.gethostname
+        @config.logger = Logger.new(STDOUT)
+        @config.logger.progname = name
         @config.key_prefix = DEFAULT_KEY_PREFIX
         @config.process_id = Process.pid
         @config.sleep_time = DEFAULT_SLEEP_TIME
@@ -135,10 +151,6 @@ module MasterLock
     def generate_owner
       "#{config.hostname}:#{config.process_id}:#{Thread.current.object_id}"
     end
-
-    def redis_key(key)
-      "#{config.key_prefix}:#{key}"
-    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: master_lock
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Jim Posen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-03 00:00:00.000000000 Z
+date: 2016-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis