mysql_getlock 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8625c1078600c6ca873a1f87f635cab49d2e3f49
+  data.tar.gz: 439b7b5d0d6ba8c4e4adf7920c58cd4a6cd00c33
+SHA512:
+  metadata.gz: 02e54ae4102c4343d01d7442811b58183ba643b6e7f30dea1fc3051c6abc3f946fdba6e2e991f387da8ad6df1235668b94be8fe7544ada7af17d4bcc174ab8fd
+  data.tar.gz: 40846197fdf77717614c5e11d1fb84d361f9e3455b8ee69f6a2b6e29564c174ccf339340d4471c8b4faf45f197c108c09a0f3b8a5d5522fa1c053fd0d0552952

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,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 0.1.1 (2016-08-28)
+
+Fixes:
+
+* trivial but critical fix
+
+# 0.1.0 (2016-08-28)
+
+First version
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at sonots@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'pry'
+gem 'pry-nav'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Naotoshi Seo
+
+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,101 @@
+# MysqlGetlock
+
+Distributed locking using mysql `get_lock()`. Unlike distributed locking using redis, this ensures releasing orphaned lock.
+
+## How It Works
+
+This gem uses MySQL [get_lock()](http://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock).
+
+Simple ruby codes which describes how it works are as follows:
+
+```ruby
+mysql.query(%Q[select get_lock('db_name.key', -1)])
+puts 'get lock'
+begin
+  # do a job
+ensure
+  mysql.query(%Q[select release_lock('db_name.key')])
+end
+```
+
+MySQL `get_lock()` has a characteristic that the lock is implicitly released when your session terminates (either normally or abnormally). Safe!
+
+## NOTICE
+
+Note that
+
+1. Before 5.7.5, only a single simultaneous lock can be acquired in a session, and `GET_LOCK()` releases any existing lock. This gem raises `MysqlGetlock::Error` on such situation.
+2. The key name is global in a mysql instance. It is advised to use database-specific or application-specific lock names such as `db_name.str` or `app_name.environment.str`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mysql_getlock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mysql_getlock
+
+## Usage
+
+Similarly with ruby standard library [mutex](https://ruby-doc.org/core-2.2.0/Mutex.html), following methods are available:
+
+* lock
+  * Attempts to grab the lock and waits if it isn’t available.
+* locked?
+  * Returns true if this lock is currently held by some.
+* synchronize {}
+  * Obtains a lock, runs the block, and releases the lock when the block completes.
+* unlock
+  * Releases the lock.
+
+Options of `MysqlGetlock.new` are:
+
+* mysql2
+  * Provide a mysql2 instance
+* key
+  * Key name for a distributed lock
+* timeout
+  * The timeout of trying to get the lock. A negative value means infinite timeout (default: -1)
+* logger
+  * Provide a logger for MysqlGetlock (for debug)
+
+### Example
+
+```ruby
+require 'mysql2'
+require 'mysql_getlock'
+
+mysql2 = Mysql2::Client.new # Mysql2::Client.new(options)
+mutex = MysqlGetlock.new(mysql2: mysql2, key: 'db_name.lock_key')
+
+mutex.lock
+begin
+  puts 'get lock'
+ensure
+  mutex.unlock
+end
+
+mutex.synchronize do
+  puts 'get lock'
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sonots/mysql_getlock. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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).
+
+## ChangeLog
+
+[CHANGELOG.md](./CHANGELOG.md)

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mysql_getlock"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/try

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mysql_getlock"
+require 'logger'
+
+if ARGV[0] == 'exit!'
+  trap('INT') do
+    exit!
+  end
+end
+
+mysql2 = Mysql2::Client.new
+mutex = MysqlGetlock.new(
+  mysql2: mysql2, key: 'mysql_getlock2', logger: Logger.new(STDOUT)
+)
+mutex.synchronize do
+  loop do
+    puts mutex.locked?
+    sleep 1
+  end
+end

data/lib/mysql_getlock/version.rb

@@ -0,0 +1,3 @@
+class MysqlGetlock
+  VERSION = "0.1.1"
+end

data/lib/mysql_getlock.rb

@@ -0,0 +1,112 @@
+require 'mysql2'
+require "mysql_getlock/version"
+
+class MysqlGetlock
+  attr_reader :mysql2, :key, :logger, :timeout
+
+  TIMEOUT = -1 # inifinity
+
+  class Error < ::StandardError; end
+
+  def initialize(mysql2:, key:, logger: nil, timeout: TIMEOUT)
+    self.mysql2 = mysql2
+    @key = Mysql2::Client.escape(key)
+    @logger = logger
+    @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
+    @multiple_lockable = nil
+  end
+
+  def lock
+    if !multiple_lockable? and (current_session_key and current_session_key != key)
+      raise Error, "get_lock() is already issued in the same connection for '#{current_session_key}'"
+    end
+
+    logger.info { "#{log_head}Wait acquiring 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
+      logger.info { "#{log_head}Acquired a mysql lock '#{key}'" } if logger
+      set_current_session_key(key)
+    when 0
+      logger.info { "#{log_head}Timeout to acquire a mysql lock '#{key}'" } if logger
+      release_current_session_key
+    else # nil
+      logger.info { "#{log_head}Unknown Error to acquire a mysql lock '#{key}'" } if logger
+      release_current_session_key
+    end
+  end
+
+  def unlock
+    if !multiple_lockable? and (current_session_key and current_session_key != key)
+      raise Error, "get_lock() was issued for another key '#{current_session_key}', please unlock it beforehand"
+    end
+
+    results = mysql2.query(%Q[select release_lock('#{key}')], as: :array)
+    release_current_session_key
+    case results.to_a.first.first
+    when 1
+      logger.info { "#{log_head}Released a mysql lock '#{key}'" } if logger
+      true
+    when 0
+      logger.info { "#{log_head}Failed to release a mysql lock since somebody else locked '#{key}'" } if logger
+      false
+    else # nil
+      logger.info { "#{log_head}Mysql lock did not exist '#{key}'" } if logger
+      true
+    end
+  end
+
+  def locked?
+    results = mysql2.query(%Q[select is_free_lock('#{key}')], as: :array)
+    results.to_a.first.first == 0
+  end
+
+  def synchronize(&block)
+    lock
+    begin
+      yield
+    ensure
+      unlock
+    end
+  end
+
+  private
+
+  def log_head
+    "PID-#{::Process.pid} TID-#{::Thread.current.object_id.to_s(36)}: "
+  end
+
+  # From MySQL 5.7.5, multiple simultaneous locks can be acquired
+  def multiple_lockable?
+    return @multiple_lockable unless @multiple_lockable.nil?
+    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)
+  end
+
+  # Before MySQL 5.7.5, only a single simultaneous lock can be acquired
+  @session_keys = {}
+
+  def self.session_keys
+    @session_keys
+  end
+
+  def current_session_key
+    MysqlGetlock.session_keys[mysql2.object_id]
+  end
+
+  def set_current_session_key(key)
+    MysqlGetlock.session_keys[mysql2.object_id] = key
+  end
+
+  def release_current_session_key
+    MysqlGetlock.session_keys.delete(mysql2.object_id)
+  end
+end

data/mysql_getlock.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mysql_getlock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mysql_getlock"
+  spec.version       = MysqlGetlock::VERSION
+  spec.authors       = ["Naotoshi Seo"]
+  spec.email         = ["sonots@gmail.com"]
+
+  spec.summary       = %q{Distributed locking using mysql get_lock().}
+  spec.description   = %q{Distributed locking using mysql get_lock().}
+  spec.homepage      = "https://github.com/sonots/mysql_getlock"
+  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 "mysql2"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: mysql_getlock
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Distributed locking using mysql get_lock().
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/try
+- lib/mysql_getlock.rb
+- lib/mysql_getlock/version.rb
+- mysql_getlock.gemspec
+homepage: https://github.com/sonots/mysql_getlock
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Distributed locking using mysql get_lock().
+test_files: []