thread_safe_uniqueness_record 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 1b85529102224768963da56f2ea724300bbc8147f02a49416ce2bb5aa1c45712
4
+ data.tar.gz: c78dc2a0c96b48ddc2afb9b2be7d425a3cfc66b947d6e0884b9a89c8919597ae
5
+ SHA512:
6
+ metadata.gz: 3a55e10f508fc10ecc21a4408f5255e8544dd82f1c1898afd37f38536f78f1f26671d653ee734014ab051c0d065e02e3e9581001a798c5d986c11ce490e501a4
7
+ data.tar.gz: 73ca619fad954a77fd2872deb3f6901407e7696345def0e49550bc32f84e73bc8df4c335aa469c4407642c30a4cb7c108b20550e4de5ba507607cee55a6e25da
@@ -0,0 +1,23 @@
1
+ version: 2.1
2
+
3
+ # Define the jobs we want to run for this project
4
+ jobs:
5
+ build:
6
+ docker:
7
+ - image: circleci/ruby:2.6.5
8
+ steps:
9
+ - checkout
10
+ test:
11
+ docker:
12
+ - image: circleci/ruby:2.6.5
13
+ steps:
14
+ - checkout
15
+ - run: bundle install
16
+ - run: bundle exec rspec
17
+
18
+ # Orchestrate our job run sequence
19
+ workflows:
20
+ build_and_test:
21
+ jobs:
22
+ - build
23
+ - test
@@ -0,0 +1,14 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
12
+ .byebug_history
13
+ Gemfile.*
14
+ .ruby-version
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
@@ -0,0 +1,11 @@
1
+ Documentation:
2
+ Enabled: false
3
+ Layout/LineLength:
4
+ Max: 120
5
+ Metrics/BlockLength:
6
+ Max: 120
7
+ Lint/AmbiguousBlockAssociation:
8
+ Exclude:
9
+ - "spec/**/*"
10
+ Style/FrozenStringLiteralComment:
11
+ Enabled: false
File without changes
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at alexei.mifrill.strizhak@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [https://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: https://contributor-covenant.org
74
+ [version]: https://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in thread_safe_uniqueness_record.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2020 Aleksey Strizhak
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.
@@ -0,0 +1,61 @@
1
+ [![CircleCI](https://circleci.com/gh/Mifrill/thread_safe_uniqueness_record.svg?style=svg)](https://app.circleci.com/pipelines/github/Mifrill/thread_safe_uniqueness_record)
2
+
3
+ # ThreadSafeUniquenessRecord
4
+
5
+ Usage is raised by thread race when the first thread tries to create
6
+ the record at the same time the second thread is trying to create exactly
7
+ the same record because both threads are seen no such record in DB
8
+ on find_by action by the passed attributes.
9
+
10
+ [Rails implementation of `create_or_find_by`](https://github.com/rails/rails/blob/24c1429a9e553196eb72312ec831afb6268222b1/activerecord/lib/active_record/relation.rb#L179-L222)
11
+
12
+ In thread race when both of threads proceed after the passed
13
+ uniqueness validation in model without raise of RecordInvalid error
14
+ and one of the thread has committed the change in DB then the second thread
15
+ fires the RecordNotUnique error with retry on the rescue.
16
+
17
+ The attempts limiter is required to prevent the infinite loop when tries
18
+ to create the record which can't be found by the passed attributes but
19
+ becomes a duplicate by any other attributes.
20
+
21
+ ## Installation
22
+
23
+ Add this line to your application's Gemfile:
24
+
25
+ ```ruby
26
+ gem 'thread_safe_uniqueness_record'
27
+ ```
28
+
29
+ And then execute:
30
+
31
+ $ bundle install
32
+
33
+ Or install it yourself as:
34
+
35
+ $ gem install thread_safe_uniqueness_record
36
+
37
+ ## Usage
38
+
39
+ model_klass: ActiveRecordModel
40
+ attributes: Hash of model instance attributes
41
+
42
+ ThreadSafeUniquenessRecord::FindOrCreateBy.call(model_klass: model_klass, attributes: attributes)
43
+
44
+ ## Development
45
+
46
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
47
+
48
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
49
+
50
+ ## Contributing
51
+
52
+ Bug reports and pull requests are welcome on GitHub at https://github.com/Mifrill/thread_safe_uniqueness_record. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Mifrill/thread_safe_uniqueness_record/blob/master/CODE_OF_CONDUCT.md).
53
+
54
+
55
+ ## License
56
+
57
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
58
+
59
+ ## Code of Conduct
60
+
61
+ Everyone interacting in the ThreadSafeUniquenessRecord project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Mifrill/thread_safe_uniqueness_record/blob/master/CODE_OF_CONDUCT.md).
@@ -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
@@ -0,0 +1,13 @@
1
+ #!/usr/bin/env ruby
2
+ require 'bundler/setup'
3
+ require 'thread_safe_uniqueness_record'
4
+
5
+ # You can add fixtures and/or initialization code here to make experimenting
6
+ # with your gem easier. You can also use a different console, if you like.
7
+
8
+ # (If you use this, don't forget to add pry to your Gemfile!)
9
+ # require "pry"
10
+ # Pry.start
11
+
12
+ require 'irb'
13
+ IRB.start(__FILE__)
@@ -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
@@ -0,0 +1,2 @@
1
+ #!/usr/bin/env ruby
2
+ require 'thread_safe_uniqueness_record'
@@ -0,0 +1,31 @@
1
+ require 'thread_safe_uniqueness_record/version'
2
+ require 'thread_safe_uniqueness_record/find_or_create_by'
3
+ require 'active_record'
4
+ require 'concurrent'
5
+
6
+ module ThreadSafeUniquenessRecord
7
+ class Error < StandardError; end
8
+
9
+ class UniquenessValidationError
10
+ def self.===(exception)
11
+ exception.is_a?(ActiveRecord::RecordInvalid) &&
12
+ /Validation failed:.+\btaken\b/.match?(exception.message)
13
+ end
14
+ end
15
+
16
+ MAX_TRIES = 3
17
+ ERRORS = [
18
+ UniquenessValidationError,
19
+ ActiveRecord::RecordNotUnique
20
+ ].freeze
21
+
22
+ def self.with_retry
23
+ attempts ||= Concurrent::ThreadLocalVar.new(0)
24
+ yield
25
+ rescue *ERRORS => e
26
+ attempts.value += 1
27
+ raise e if attempts.value >= MAX_TRIES
28
+
29
+ retry
30
+ end
31
+ end
@@ -0,0 +1,11 @@
1
+ module ThreadSafeUniquenessRecord
2
+ class FindOrCreateBy
3
+ def self.call(model_klass:, attributes:)
4
+ ThreadSafeUniquenessRecord.with_retry do
5
+ ActiveRecord::Base.transaction(requires_new: true) do
6
+ model_klass.find_or_create_by!(attributes)
7
+ end
8
+ end
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,3 @@
1
+ module ThreadSafeUniquenessRecord
2
+ VERSION = '0.1.0'
3
+ end
@@ -0,0 +1,33 @@
1
+ require_relative 'lib/thread_safe_uniqueness_record/version'
2
+
3
+ Gem::Specification.new do |spec|
4
+ spec.name = 'thread_safe_uniqueness_record'
5
+ spec.version = ThreadSafeUniquenessRecord::VERSION
6
+ spec.authors = ['Aleksey Strizhak']
7
+ spec.email = ['alexei.mifrill.strizhak@gmail.com']
8
+
9
+ spec.summary = 'Thread safe creation of unique ActiveRecord'
10
+ spec.description = 'The preventer of thread race conditions for ActiveRecord unique model creations'
11
+ spec.homepage = 'https://github.com/Mifrill/thread_safe_uniqueness_record.git'
12
+ spec.license = 'MIT'
13
+ spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
14
+
15
+ spec.metadata['homepage_uri'] = spec.homepage
16
+ spec.metadata['changelog_uri'] = 'https://github.com/Mifrill/thread_safe_uniqueness_record/blob/master/CHANGELOG.md'
17
+
18
+ # Specify which files should be added to the gem when it is released.
19
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
20
+ spec.files = Dir.chdir(File.expand_path(__dir__)) do
21
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
22
+ end
23
+ spec.bindir = 'exe'
24
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
25
+ spec.require_paths = ['lib']
26
+
27
+ spec.add_runtime_dependency 'activerecord'
28
+ spec.add_runtime_dependency 'concurrent-ruby'
29
+
30
+ spec.add_development_dependency 'byebug'
31
+ spec.add_development_dependency 'rspec', '~> 3.8'
32
+ spec.add_development_dependency 'sqlite3'
33
+ end
metadata ADDED
@@ -0,0 +1,134 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: thread_safe_uniqueness_record
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Aleksey Strizhak
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2020-10-30 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: activerecord
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: concurrent-ruby
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: byebug
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '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.8'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.8'
69
+ - !ruby/object:Gem::Dependency
70
+ name: sqlite3
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ description: The preventer of thread race conditions for ActiveRecord unique model
84
+ creations
85
+ email:
86
+ - alexei.mifrill.strizhak@gmail.com
87
+ executables:
88
+ - thread_safe_uniqueness_record
89
+ extensions: []
90
+ extra_rdoc_files: []
91
+ files:
92
+ - ".circleci/config.yml"
93
+ - ".gitignore"
94
+ - ".rspec"
95
+ - ".rubocop.yml"
96
+ - CHANGELOG.md
97
+ - CODE_OF_CONDUCT.md
98
+ - Gemfile
99
+ - LICENSE.txt
100
+ - README.md
101
+ - Rakefile
102
+ - bin/console
103
+ - bin/setup
104
+ - exe/thread_safe_uniqueness_record
105
+ - lib/thread_safe_uniqueness_record.rb
106
+ - lib/thread_safe_uniqueness_record/find_or_create_by.rb
107
+ - lib/thread_safe_uniqueness_record/version.rb
108
+ - thread_safe_uniqueness_record.gemspec
109
+ homepage: https://github.com/Mifrill/thread_safe_uniqueness_record.git
110
+ licenses:
111
+ - MIT
112
+ metadata:
113
+ homepage_uri: https://github.com/Mifrill/thread_safe_uniqueness_record.git
114
+ changelog_uri: https://github.com/Mifrill/thread_safe_uniqueness_record/blob/master/CHANGELOG.md
115
+ post_install_message:
116
+ rdoc_options: []
117
+ require_paths:
118
+ - lib
119
+ required_ruby_version: !ruby/object:Gem::Requirement
120
+ requirements:
121
+ - - ">="
122
+ - !ruby/object:Gem::Version
123
+ version: 2.3.0
124
+ required_rubygems_version: !ruby/object:Gem::Requirement
125
+ requirements:
126
+ - - ">="
127
+ - !ruby/object:Gem::Version
128
+ version: '0'
129
+ requirements: []
130
+ rubygems_version: 3.0.3
131
+ signing_key:
132
+ specification_version: 4
133
+ summary: Thread safe creation of unique ActiveRecord
134
+ test_files: []