redis_getlock 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 036e43b36aedd8b5350a4c6654a9e23bd67578cc
4
+ data.tar.gz: b89cfca59c6fd6f9817741a60fcfdd839aa04d9d
5
+ SHA512:
6
+ metadata.gz: 60e3c90c10505acfceb91f1f67cbcbec663d3ac3c1d967b9db62ce5cb7b3107367bcb3ba9d0e3c8fb74958f63a2042a096f96cdd095e59e89d809bac363f2071
7
+ data.tar.gz: 0a2abe5631ae645f0f6c37612a6885616ba14d0fc4c893e5252dec7e9ffc3351746538558cfe511a816b8e886c3675ca7060facc93843af664ae1d321796bcf5
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.3.0
4
+ before_install: gem install bundler -v 1.11.2
data/CHANGELOG.md ADDED
@@ -0,0 +1,3 @@
1
+ # 0.1.0 (2016-02-28)
2
+
3
+ First version
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at sonots@gmail.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in redis_getlock.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Naotoshi Seo
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,117 @@
1
+ # RedisGetlock
2
+
3
+ Distributed locking using redis. Unlike other implementations avilable, this gem ensures releasing orphaned lock shortly.
4
+
5
+ # How It Works
6
+
7
+ This gem basically works as [http://redis.io/commands/set](http://redis.io/commands/set) describes for redis >= 2.6.12, and [http://redis.io/commands/setnx](http://redis.io/commands/setnx) describes for redis < 2.6.12.
8
+
9
+ Simple ruby codes which [http://redis.io/commands/set](http://redis.io/commands/set) describes are as follows:
10
+
11
+ ```ruby
12
+ loop do
13
+ break if redis.set(key, 'anystring', {nx: true, ex: timeout})
14
+ sleep 1
15
+ end
16
+ puts 'get lock'
17
+ begin
18
+ # do a job
19
+ ensure
20
+ redis.del(key) # unlock
21
+ end
22
+ ```
23
+
24
+ The problem here is the value of `timeout`.
25
+ The expiration time `timeout` is necessary so that a lock will eventually be released even if a process is crashed or killed by SIGKILL before deleting the key.
26
+ However, how long should we set if we are uncertain how long a job takes?
27
+
28
+ This gem takes a following approach to resolve this problem.
29
+
30
+ 1. Expiration time is set to `2` (default) seconds
31
+ 2. Extend the lock in each `1` (default) sencond interval invoking another thread
32
+
33
+ This way ensures to release orphaned lock in 2 seconds.
34
+
35
+ Simple codes are as follows:
36
+
37
+ ```ruby
38
+ loop do
39
+ break if redis.set(key, 'anystring', {nx: true, ex: 2})
40
+ sleep 1
41
+ end
42
+ puts 'get lock'
43
+ thr = Thread.new do
44
+ loop do
45
+ redis.expire(key, 2)
46
+ sleep 1
47
+ end
48
+ end
49
+ begin
50
+ # do a job
51
+ ensure
52
+ thr.terminate
53
+ redis.del(key) # unlock
54
+ end
55
+ ```
56
+
57
+ ## Installation
58
+
59
+ Add this line to your application's Gemfile:
60
+
61
+ ```ruby
62
+ gem 'redis_getlock'
63
+ ```
64
+
65
+ And then execute:
66
+
67
+ $ bundle
68
+
69
+ Or install it yourself as:
70
+
71
+ $ gem install redis_getlock
72
+
73
+ ## Usage
74
+
75
+ Similarly with ruby standard library [mutex](https://ruby-doc.org/core-2.2.0/Mutex.html), following methods are available:
76
+
77
+ * lock
78
+ * Attempts to grab the lock and waits if it isn’t available.
79
+ * locked?
80
+ * Returns true if this lock is currently held by some.
81
+ * synchronize {}
82
+ * Obtains a lock, runs the block, and releases the lock when the block completes.
83
+ * unlock
84
+ * Releases the lock.
85
+
86
+ ### Example
87
+
88
+ ```ruby
89
+ require 'redis'
90
+ require 'redis_getlock'
91
+
92
+ redis = Redis.new # Redis.new(options)
93
+ mutex = RedisGetlock.new(redis: redis, key: 'lock_key')
94
+
95
+ mutex.lock
96
+ begin
97
+ puts 'get lock'
98
+ ensure
99
+ mutex.unlock
100
+ end
101
+
102
+ mutex.synchronize do
103
+ puts 'get lock'
104
+ end
105
+ ```
106
+
107
+ ## Contributing
108
+
109
+ Bug reports and pull requests are welcome on GitHub at https://github.com/sonots/redis_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.
110
+
111
+ ## License
112
+
113
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
114
+
115
+ ## ChangeLog
116
+
117
+ [CHANGELOG.md](./CHANGELOG.md)
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "redis_getlock"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/bin/try ADDED
@@ -0,0 +1,20 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "redis_getlock"
5
+ require 'logger'
6
+
7
+ if ARGV[0] == 'exit!'
8
+ trap('INT') do
9
+ exit!
10
+ end
11
+ end
12
+
13
+ mutex = RedisGetlock.new(redis: Redis.new, key: 'redis_getlock', logger: Logger.new(STDOUT))
14
+ puts 'redis-cli> del redis_getlock'
15
+ mutex.synchronize do
16
+ loop do
17
+ puts mutex.locked?
18
+ sleep 1
19
+ end
20
+ end
@@ -0,0 +1,3 @@
1
+ class RedisGetlock
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,100 @@
1
+ require 'redis'
2
+ require "redis_getlock/version"
3
+ require 'securerandom'
4
+
5
+ class RedisGetlock
6
+ attr_reader :redis, :key, :logger, :timeout, :interval
7
+
8
+ TIMEOUT = 2
9
+ INTERVAL = 1
10
+
11
+ def initialize(redis:, key:, logger: nil, timeout: TIMEOUT, interval: INTERVAL)
12
+ @redis = redis
13
+ @key = key
14
+ @logger = logger
15
+ @timeout = timeout
16
+ @interval = interval
17
+ end
18
+
19
+ def lock
20
+ logger.info { "RedisGetlock: Wait acquiring a lock: #{key}" } if logger
21
+ if set_options_available?
22
+ lock_with_set_options
23
+ @thr = Thread.new(&method(:keeplock_with_set_options))
24
+ else
25
+ lock_without_set_options
26
+ @thr = Thread.new(&method(:keeplock_without_set_options))
27
+ end
28
+ logger.info { "RedisGetlock: Acquired a lock: #{key}" } if logger
29
+ end
30
+
31
+ def unlock
32
+ @thr.terminate
33
+ redis.del(key)
34
+ logger.info { "RedisGetlock: Released a lock: #{key}" } if logger
35
+ end
36
+
37
+ def locked?
38
+ redis.exists(key)
39
+ end
40
+
41
+ def synchronize(&block)
42
+ lock
43
+ begin
44
+ yield
45
+ ensure
46
+ unlock
47
+ end
48
+ end
49
+
50
+ private
51
+
52
+ def set_options_available?
53
+ return @set_options_avialble unless @set_options_avialble.nil?
54
+ major, minor, patch = redis.info['redis_version'].split('.').map(&:to_i)
55
+ @set_options_avialble = major > 2 || (major == 2 && minor > 7) || (major == 2 && minor == 6 && patch >= 12)
56
+ end
57
+
58
+ # redis >= 2.6.12
59
+ # ref. http://redis.io/commands/set
60
+ def lock_with_set_options
61
+ uuid = SecureRandom.uuid
62
+ loop do
63
+ break if redis.set(key, uuid, {nx: true, ex: timeout}) # key does not exist
64
+ sleep interval
65
+ end
66
+ end
67
+
68
+ def keeplock_with_set_options
69
+ loop do
70
+ redis.expire(key, timeout) # extend expiration
71
+ sleep interval
72
+ end
73
+ end
74
+
75
+ # redis < 2.6.12
76
+ # ref. http://redis.io/commands/setnx
77
+ def lock_without_set_options
78
+ loop do
79
+ current = Time.now.to_f
80
+ if redis.setnx(key, (current + timeout).to_s) # key does not exist
81
+ redis.expire(key, timeout)
82
+ break # acquire lock
83
+ end
84
+ expired = redis.get(key)
85
+ if expired.to_f < current # key exists, but expired
86
+ compared = redis.getset(key, (current + timeout).to_s)
87
+ break if expired == compared # acquire lock
88
+ end
89
+ sleep interval
90
+ end
91
+ end
92
+
93
+ def keeplock_without_set_options
94
+ loop do
95
+ current = Time.now.to_f
96
+ redis.setex(key, timeout, (current + timeout).to_s) # extend expiration
97
+ sleep interval
98
+ end
99
+ end
100
+ end
@@ -0,0 +1,27 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'redis_getlock/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "redis_getlock"
8
+ spec.version = RedisGetlock::VERSION
9
+ spec.authors = ["Naotoshi Seo"]
10
+ spec.email = ["sonots@gmail.com"]
11
+
12
+ spec.summary = %q{Distributed locking using redis, which ensures releasing orphaned lock shortly.}
13
+ spec.description = %q{Distributed locking using redis, which ensures releasing orphaned lock shortly.}
14
+ spec.homepage = "https://github.com/sonots/redis_getlock"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_dependency "redis"
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.11"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "rspec", "~> 3.0"
27
+ end
metadata ADDED
@@ -0,0 +1,116 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: redis_getlock
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Naotoshi Seo
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-08-27 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: redis
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.11'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.11'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ description: Distributed locking using redis, which ensures releasing orphaned lock
70
+ shortly.
71
+ email:
72
+ - sonots@gmail.com
73
+ executables: []
74
+ extensions: []
75
+ extra_rdoc_files: []
76
+ files:
77
+ - ".gitignore"
78
+ - ".rspec"
79
+ - ".travis.yml"
80
+ - CHANGELOG.md
81
+ - CODE_OF_CONDUCT.md
82
+ - Gemfile
83
+ - LICENSE.txt
84
+ - README.md
85
+ - Rakefile
86
+ - bin/console
87
+ - bin/setup
88
+ - bin/try
89
+ - lib/redis_getlock.rb
90
+ - lib/redis_getlock/version.rb
91
+ - redis_getlock.gemspec
92
+ homepage: https://github.com/sonots/redis_getlock
93
+ licenses:
94
+ - MIT
95
+ metadata: {}
96
+ post_install_message:
97
+ rdoc_options: []
98
+ require_paths:
99
+ - lib
100
+ required_ruby_version: !ruby/object:Gem::Requirement
101
+ requirements:
102
+ - - ">="
103
+ - !ruby/object:Gem::Version
104
+ version: '0'
105
+ required_rubygems_version: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - ">="
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
110
+ requirements: []
111
+ rubyforge_project:
112
+ rubygems_version: 2.5.1
113
+ signing_key:
114
+ specification_version: 4
115
+ summary: Distributed locking using redis, which ensures releasing orphaned lock shortly.
116
+ test_files: []