mysql_getlock 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e4b268a546f480cf35e54bec236f82e2ee74f25
-  data.tar.gz: a11b170c1fd935e9f02b258b23185d1879fc952f
+  metadata.gz: 88dca1f22a91ecae47c4cc919cf9ebbb7469cb7e
+  data.tar.gz: 63f0e9adfdd7c2901f69c45fbd2518569397e461
 SHA512:
-  metadata.gz: 94050442d95798cd3a54571c8662f87b09c8190aa1709ffe64f48f0aaea0f1119724560f93497b9ee78293f1186f2fe2af63a86b9617daf59155e490015883ba
-  data.tar.gz: 44e6fc1dbd8202f89fd87f8cc79f61f81572afbaeadc1dfd8e5ecea17d69c92e21d14dd3c56b9aa62373b986369613e32af827c56dc79a3a79f3843ce95e965f
+  metadata.gz: e6adaa01efcd040b6ae82fe31332ebf28c9558d31ec3be4d690c8858b1f5aab447e130bef82b70dd7621fcbd17913f36645e4d2b2a001be54f72033c11e527d5
+  data.tar.gz: 374c9497d072e02722d2883acfe865cbb7eaf46f15024aba43d3e955f7471e11b5beffa304c63a2c2eb2de12cab5988cf39c9de9a66870f777c1839e6bf5616c

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.2.2 (2016-08-29)
+
+Enhancements:
+
+* Before MySQL 5.5.8, a negative timeout value did not mean infinite timeout on platforms except Windows. Apply large number of timeout (4294967295) if timeout < 0 is given to support infinite timeout spuriously for MySQL < 5.5.8.
+
 # 0.2.1 (2016-08-28)
 
 Enhancements:

data/lib/mysql_getlock.rb

@@ -5,22 +5,25 @@ class MysqlGetlock
   attr_reader :mysql2, :key, :logger, :timeout
 
   TIMEOUT = -1 # inifinity
+  PSEUDO_INFINITE_TIMEOUT = 4294967295 # for < 5.5.8
 
   class Error < ::StandardError; end
   class LockError < ::StandardError; end
 
   def initialize(mysql2:, key:, logger: nil, timeout: TIMEOUT)
     self.mysql2 = mysql2
-    @key = Mysql2::Client.escape(key)
-    @logger = logger
-    @timeout = timeout
+    set_key(key)
+    set_logger(logger)
+    set_timeout(timeout)
   end
 
   # Use this setter if you reconnect mysql2 (which means renew Mysql2::Client instance),
   # but still want to use same MysqlGetlock instance
   def mysql2=(mysql2)
     @mysql2 = mysql2
+    @mysql_version = nil
     @multiple_lockable = nil
+    @infinite_timeoutable = nil
   end
 
   def lock
@@ -28,7 +31,7 @@ class MysqlGetlock
       raise Error, "get_lock() is already issued in the same connection for '#{current_session_key}'"
     end
 
-    logger.info { "#{log_head}Wait #{timeout < 0 ? '' : "#{timeout} sec "}to acquire a mysql lock '#{key}'" } if logger
+    logger.info { "#{log_head}Wait #{timeout < -1 ? '' : "#{timeout} sec "}to acquire a mysql lock '#{key}'" } if logger
     results = mysql2.query(%Q[select get_lock('#{key}', #{timeout})], as: :array)
     case results.to_a.first.first
     when 1
@@ -92,6 +95,23 @@ class MysqlGetlock
 
   private
 
+  def set_timeout(timeout)
+    if infinite_timeoutable?
+      @timeout = timeout
+    else
+      # To support MySQL < 5.5.8, put large number of seconds to express infinite timeout spuriously
+      @timeout = (timeout < 0 ? PSEUDO_INFINITE_TIMEOUT : timeout)
+    end
+  end
+
+  def set_key(key)
+    @key = Mysql2::Client.escape(key)
+  end
+
+  def set_logger(logger)
+    @logger = logger
+  end
+
   def log_head
     "PID-#{::Process.pid} TID-#{::Thread.current.object_id.to_s(36)}: "
   end
@@ -99,10 +119,23 @@ class MysqlGetlock
   # From MySQL 5.7.5, multiple simultaneous locks can be acquired
   def multiple_lockable?
     return @multiple_lockable unless @multiple_lockable.nil?
+    major, minor, patch = mysql_version
+    @multiple_lockable = (major > 5) || (major == 5 && minor > 7) || (major == 5 && minor == 7 && patch >= 5)
+  end
+
+  # Before MySQL 5.5.8, a negative timeout value means infinite timeout on Windows. As of 5.5.8, this behavior applies on all platforms.
+  def infinite_timeoutable?
+    return @infinite_timeoutable unless @infinite_timeoutable.nil?
+    major, minor, patch = mysql_version
+    @infinite_timeoutable = (major > 5) || (major == 5 && minor > 5) || (major == 5 && minor == 5 && patch >= 8)
+  end
+
+  def mysql_version
+    return @mysql_version if @mysql_version
     results = mysql2.query('select version()', as: :array)
     version = results.to_a.first.first
     major, minor, patch = version.split('.').map(&:to_i)
-    @multiple_lockable = (major > 5) || (major == 5 && minor > 7) || (major == 5 && minor == 7 && patch >= 5)
+    @mysql_version = [major, minor, patch]
   end
 
   # Before MySQL 5.7.5, only a single simultaneous lock can be acquired

data/lib/mysql_getlock/version.rb

@@ -1,3 +1,3 @@
 class MysqlGetlock
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysql_getlock
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-28 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2