dynamoid_lockable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20dc4301053a630ebf779584c76f14020d6c544d923cffa359adc0cc6cc10785
+  data.tar.gz: 7f808f3a937e3ee7fd92b1dc4baceb796c15ae2a805b293dc8c451521f2eaf8a
+SHA512:
+  metadata.gz: 538ce9bf0e7753d337b8625613c9c201c16a4311831fe0f7172335c61bae2fc13c41b90a460e5f0d00d28522edebd3337db89d0f835c37e97433dd3f1fede9dc
+  data.tar.gz: 3c844120ea632d237da9d45becfb90162718fd111cb1917a359cb8f07d2f0bc6bd81db347a5397e2ac050ffa24751e620bcf46303480def41f431a526e024636

data/.circleci/config.yml

@@ -0,0 +1,100 @@
+version: 2.0
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - "ruby-2.5"
+      - "ruby-2.6"
+      - "ruby-2.7"
+
+jobs:
+  "ruby-2.5":
+    docker:
+      - image: ruby:2.5
+      - image: amazon/dynamodb-local
+        environment:
+          MAX_HEAP_SIZE: 1024m
+          HEAP_NEWSIZE: 512m
+
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}-{{ checksum "Appraisals" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            gem update bundler
+            bundle install
+            bundle exec appraisal install
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}-{{ checksum "Appraisals" }}
+      - run:  bundle exec appraisal rspec --format progress
+
+  "ruby-2.6":
+    docker:
+      - image: ruby:2.6
+      - image: amazon/dynamodb-local
+        environment:
+          MAX_HEAP_SIZE: 1024m
+          HEAP_NEWSIZE: 512m
+
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}-{{ checksum "Appraisals" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            gem update bundler
+            bundle install
+            bundle exec appraisal install
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}-{{ checksum "Appraisals" }}
+      - run: bundle exec appraisal rspec --format progress
+
+  "ruby-2.7":
+    docker:
+      - image: ruby:2.7
+      - image: amazon/dynamodb-local
+        environment:
+          MAX_HEAP_SIZE: 1024m
+          HEAP_NEWSIZE: 512m
+
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}-{{ checksum "Appraisals" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            gem update bundler
+            bundle install
+            bundle exec appraisal install
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}-{{ checksum "Appraisals" }}
+      - run: bundle exec appraisal rspec --format progress
+
+
+
+
+
+

data/.gitignore

@@ -0,0 +1,2 @@
+coverage
+.rspec_status

data/Appraisals

@@ -0,0 +1,8 @@
+
+appraise "dynamoid-3.4" do
+  gem "dynamoid", "~> 3.4.0"
+end
+
+appraise "dynamoid-latest" do
+  gem "dynamoid", "~> 3.0"
+end

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dynamoid_lockable.gemspec
+gemspec
+
+gem 'pry'
+

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    dynamoid_lockable (1.0.0)
+      dynamoid_advanced_where (>= 1.0.1, < 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    aws-eventstream (1.0.3)
+    aws-partitions (1.270.0)
+    aws-sdk-core (3.89.1)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-dynamodb (1.41.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    codecov (0.1.16)
+      json
+      simplecov
+      url
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    dynamoid (3.4.1)
+      activemodel (>= 4)
+      aws-sdk-dynamodb (~> 1)
+      concurrent-ruby (>= 1.0)
+      null-logger
+    dynamoid_advanced_where (1.0.1)
+      dynamoid (>= 3.2, < 4)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.4.0)
+    json (2.3.0)
+    method_source (0.9.2)
+    minitest (5.14.0)
+    null-logger (0.1.5)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    simplecov (0.18.1)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11.0)
+    simplecov-html (0.11.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    url (0.3.2)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-18
+
+DEPENDENCIES
+  appraisal
+  codecov
+  dynamoid_lockable!
+  pry
+  rake (~> 12)
+  rspec (~> 3)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,79 @@
+# DynamoidLockable
+`DynamoidLockable` provides a interface for pessimistic locking for Dynamoid models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dynamoid_lockable'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dynamoid_lockable
+
+## Usage
+```
+class MyModel
+  include Dynamoid::Document
+  include DynamoidLockable
+
+  # Models may have more than one lock discriminated by name.
+  # Creates a lock named :importing, which locks by default for 5 minutes and will refresh the lock every 10 seconds.
+  # Default values:
+  #  lock_for: 10 minutes
+  #  relock_every: 1/3 of lock_for
+  locks_with :importing, lock_for: 5 * 60, relock_every: 10
+end
+
+thing = MyModel.find('abcd')
+
+# Most basic usage
+thing.perform_with_lock(:importing) do
+  # do whatever you like in here, record will remain locked as long as this block is executing and the
+  # thread is able to do work
+end
+
+# Manually locking and unlocking
+thing.lock(:importing)
+# WARNING! Lock is not persisted, you have 5 minutes to complete your task
+do_work(thing)
+thing.unlock(:importing)
+
+# You can also search by entities which are lockable (unlocked, locks expired or eleigible for reentry)
+search = MyModel.lockable(:importing).first
+
+# Note that `lockable` returns a dynamoid_advanced_where chain, so additional where clauses may be appended
+
+# Locks support reentry from the same thread
+thing.lock(:importing)
+thing.lock(:importing) # No error
+
+Thread.new do
+  thing.lock(:importing) # Error: Concerns::Lockable::CouldNotAcquireLock
+end
+```
+
+A note on the options:
+* *locks_for* - should be a reasonably high number, setting it too small will result in excessive DynamoDB usage
+* *relock_every* - should be a positive number, nil or 0 will result in the relock process being disabled
+
+## Errors
+* If unable to obtain a lock, `DynamoidLockable::CouldNotAcquireLock` is raised
+* If unable to obtain to release a lock, `DynamoidLockable::CouldNotUnlock` is raised
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/GetTerminus/dynamoid_lockable.
+

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 "dynamoid_lockable"
+
+# 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(__FILE__)

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/dynamoid_lockable.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/dynamoid_lockable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dynamoid_lockable'
+  spec.version       = DynamoidLockable::VERSION
+  spec.authors       = ['Brian Malinconico']
+  spec.email         = ['bmalinconico@terminus.com']
+
+  spec.summary       = 'Lock your Dynamoid records for only your use'
+  spec.description   = 'Uses atomic writes to DynamoDB to ensure you hold an exclusive lock on your records'
+  spec.homepage      = 'https://github.com/GetTerminus/dynamoid_lockable'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['allowed_push_host'] = 'https://www.rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/GetTerminus/dynamoid_lockable'
+  spec.metadata['changelog_uri'] = 'https://github.com/GetTerminus/dynamoid_lockable/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'dynamoid_advanced_where', '>= 1.0.1', '< 2.0'
+
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'rake', '~> 12'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'codecov'
+end

data/lib/dynamoid_lockable.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require 'dynamoid_lockable/version'
+require 'dynamoid_advanced_where'
+
+require 'securerandom'
+
+module DynamoidLockable
+  class Error < StandardError; end
+
+  class LockingError < Error; end
+  class CouldNotAcquireLock < LockingError; end
+  class CouldNotUnlock < LockingError; end
+
+  DEFAULT_LOCK_TIME = 15 * 60
+
+  def lock(name, locker_name: self.class.locking_name)
+    ensure_lockable_field(name)
+
+    locked_until = Time.now + self.class.lock_config(name)[:duration]
+
+    result = self.class
+                 .lockable(name, locker_name: locker_name)
+                 .upsert(
+                   hash_key,
+                   "#{name}_locked_until": locked_until,
+                   "#{name}_locked_by": locker_name
+                 )
+
+    raise CouldNotAcquireLock unless result
+
+    # Prevents having to call reload, which we've seen take 20seconds
+    # but still populates the value in memory, in case the code block
+    # calls save and persists this copy again
+    send("#{name}_locked_until=", locked_until)
+    send("#{name}_locked_by=", locker_name)
+
+    true
+  end
+
+  def unlock(name)
+    ensure_lockable_field(name)
+
+    result = self.class.unlockable(name)
+                 .upsert(hash_key, "#{name}_locked_until": nil)
+
+    raise CouldNotUnlock unless result
+
+    true
+  end
+
+  def create_relock_thread(name)
+    locker_name = self.class.locking_name
+
+    Thread.new do
+      config = self.class.lock_config(name)
+      loop do
+        lock(name, locker_name: locker_name)
+
+        sleep config[:relock_every]
+      end
+    end
+  end
+
+  def perform_with_lock(name)
+    ensure_lockable_field(name)
+    config = self.class.lock_config(name)
+
+    result = lock(name)
+
+    if config[:relock_every]&.positive?
+      relock_thread = create_relock_thread(name)
+    end
+
+    yield
+  ensure
+    relock_thread&.exit
+    unlock(name) if result # Don't try to unlock if you didn't acquire lock
+  end
+
+  def ensure_lockable_field(name)
+    self.class.ensure_lockable_field(name)
+  end
+
+  module ClassMethods
+    def locking_name
+      Thread.current[:dynamo_lock_name] ||= SecureRandom.uuid
+    end
+
+    # TODO: Make this inheritance safe
+    def lockable_fields
+      @lockable_fields ||= {}
+    end
+
+    def lockable_fields=(val)
+      @lockable_fields = val
+    end
+
+    def lock_config(name)
+      lockable_fields[name.to_sym]
+    end
+
+    def locks_with(base_field, lock_for: DEFAULT_LOCK_TIME, relock_every: lock_for / 3)
+      self.lockable_fields = lockable_fields.merge(
+        base_field.to_sym => { duration: lock_for, relock_every: relock_every }
+      )
+
+      field  "#{base_field}_locked_until".to_sym, :datetime
+      field  "#{base_field}_locked_by".to_sym, :string
+    end
+
+    def lockable(lock_name, locker_name: locking_name)
+      ensure_lockable_field(lock_name)
+
+      advanced_where do |r|
+        r.send(hash_key).exists? & (
+          (r.send("#{lock_name}_locked_by") == locker_name) |
+          !r.send("#{lock_name}_locked_until").exists? |
+          (r.send("#{lock_name}_locked_until") < Time.now)
+        )
+      end
+    end
+
+    def ensure_lockable_field(name)
+      raise "Lock #{name} unrecognized" unless lockable_fields.key?(name)
+    end
+
+    def unlockable(lock_name, locker_name: locking_name)
+      ensure_lockable_field(lock_name)
+
+      advanced_where do |r|
+        r.send(self.hash_key).exists? &
+          (r.send("#{lock_name}_locked_by") == locker_name)
+      end
+    end
+  end
+
+  def self.included(other)
+    other.extend(ClassMethods)
+  end
+end

data/lib/dynamoid_lockable/version.rb

@@ -0,0 +1,3 @@
+module DynamoidLockable
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: dynamoid_lockable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Malinconico
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dynamoid_advanced_where
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Uses atomic writes to DynamoDB to ensure you hold an exclusive lock on
+  your records
+email:
+- bmalinconico@terminus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- Appraisals
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dynamoid_lockable.gemspec
+- lib/dynamoid_lockable.rb
+- lib/dynamoid_lockable/version.rb
+homepage: https://github.com/GetTerminus/dynamoid_lockable
+licenses: []
+metadata:
+  allowed_push_host: https://www.rubygems.org
+  homepage_uri: https://github.com/GetTerminus/dynamoid_lockable
+  source_code_uri: https://github.com/GetTerminus/dynamoid_lockable
+  changelog_uri: https://github.com/GetTerminus/dynamoid_lockable/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Lock your Dynamoid records for only your use
+test_files: []