locksy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43b6b34290b0dedbc0793205bb5cbb1d6e5442ebbcc241998529ed5e4d73d913
+  data.tar.gz: b59b6d7e9c999093e30a6119bf96c782d66db865f803ac2c0f2054b76e0e9a27
+SHA512:
+  metadata.gz: 06f41badc92181f8d4d28e66fa59723488f78110aa3fbfcc7d974b89953db30684c529b5d08d6d0705900abdcc3f4959267f41bcb0a0e7acd1c6a3b77c547f41
+  data.tar.gz: ffe4a652c57acbe76680eb1204f647c0fcf8cf378f7839d4778fe3e6f16279cd3189f59f4ee18f275dd496a8363b4a43c715ec93f433e177a997bd912eeb7922

data/lib/locksy/base_lock.rb

@@ -0,0 +1,76 @@
+require_relative './lock_interface'
+require_relative './errors'
+
+require 'securerandom'
+require 'socket'
+
+module Locksy
+  class BaseLock < LockInterface
+    attr_reader :owner, :default_expiry, :default_extension, :lock_name
+    attr_writer :logger
+
+    # allow injection of a clock to assist testing
+    # do not call or set this outside of tests
+    attr_writer :_clock
+
+    # add a class-level flag to allow children to know to stop loops etc.
+    @_shutting_down = false
+
+    def initialize(lock_name: generate_default_lock_name, owner: generate_default_owner,
+      default_expiry: 10, default_extension: 10, logger: nil, **_args)
+      @owner = owner
+      @default_expiry = default_expiry
+      @default_extension = default_extension
+      @lock_name = lock_name
+      @logger = logger
+    end
+
+    # disabling here because we have a no-op implementation... we're expecting this
+    # class to be extended
+    # rubocop:disable Style/EmptyMethod
+    def obtain_lock(expire_after: default_expiry, **_args); end
+
+    def refresh_lock(expire_after: default_extension, **_args); end
+
+    def release_lock(**_args); end
+    # rubocop:enable Style/EmptyMethod
+
+    def with_lock(expire_after: default_expiry, **args)
+      if (lock_obtained = obtain_lock(expire_after: expire_after, **args))
+        yield
+      end
+    ensure
+      release_lock if lock_obtained
+    end
+
+    def self.shutting_down?
+      @_shutting_down
+    end
+
+    at_exit do
+      @_shutting_down = true
+    end
+
+    protected
+
+    def now
+      (@_clock ||= Time).now.to_f
+    end
+
+    def logger
+      @logger ||= Logger.new
+    end
+
+    def expiry(after)
+      now + after
+    end
+
+    def generate_default_owner
+      "#{Thread.current.object_id}-#{Process.pid}@#{Socket.gethostname}"
+    end
+
+    def generate_default_lock_name
+      "#{SecureRandom.base64(12)}.#{generate_default_owner}"
+    end
+  end
+end

data/lib/locksy/dynamodb.rb

@@ -0,0 +1,136 @@
+require_relative './base_lock'
+require 'forwardable'
+
+module Locksy
+  class DynamoDB < BaseLock
+    extend Forwardable
+
+    attr_reader :dynamo_client, :table_name
+
+    def_delegators 'self.class'.to_sym, :default_table, :default_client
+
+    def initialize(dynamo_client: default_client, table_name: default_table, **_args)
+      # lazy-load the gem to avoid forcing a dependency on the implementation
+      require 'aws-sdk-dynamodb'
+      @dynamo_client = dynamo_client
+      @table_name = table_name
+      @_timeout_stopper = ConditionVariable.new
+      @_timeout_mutex = Mutex.new
+      super
+    end
+
+    def obtain_lock(expire_after: default_expiry, wait_for: nil, **_args)
+      stop_waiting_at = wait_for ? now + wait_for : nil
+      expire_at = expiry(expire_after)
+      dynamo_client.put_item \
+        ({ table_name: table_name,
+           item: { id: lock_name, expires: expire_at, lock_owner: owner },
+           condition_expression: '(attribute_not_exists(expires) OR expires < :expires) ' \
+                                 'OR (attribute_not_exists(lock_owner) OR lock_owner = :owner)',
+           expression_attribute_values: { ':expires' => now, ':owner' => owner } })
+      expire_at
+    rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException
+      if stop_waiting_at && stop_waiting_at > now
+        # Retry at a maximum of 1/2 of the remaining time until the
+        # current lock expires or the remaining time from the what the
+        # caller was willing to wait, subject to a minimum of 0.1s to
+        # prevent busy looping.
+        _wait_for_timeout \
+          ( if (current = retrieve_current_lock).nil?
+              0.1
+            else
+              [stop_waiting_at - now, [(current[:expires] - now) / 2, 0.1].max].min
+            end)
+        retry unless self.class.shutting_down?
+      end
+      raise build_not_owned_error_from_remote
+    end
+
+    def release_lock
+      dynamo_client.delete_item \
+        ({ table_name: table_name,
+           key: { id: lock_name },
+           condition_expression: '(attribute_not_exists(lock_owner) OR lock_owner = :owner) ' \
+                                 'OR (attribute_not_exists(expires) OR expires < :expires)',
+           expression_attribute_values: { ':owner' => owner, ':expires' => now } })
+    rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException
+      raise build_not_owned_error_from_remote
+    end
+
+    def refresh_lock(expire_after: default_extension, **_args)
+      expire_at = expiry(expire_after)
+      dynamo_client.update_item \
+        ({ table_name: table_name,
+           key: { id: lock_name },
+           update_expression: 'SET expires = :expires',
+           condition_expression: 'attribute_exists(expires) AND expires > :now ' \
+                                 'AND lock_owner = :owner',
+           expression_attribute_values: { ':expires' => expire_at,
+                                          ':owner' => owner,
+                                          ':now' => now } })
+      expire_at
+    rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException
+      obtain_lock expire_after: expire_after
+    end
+
+    def create_table
+      dynamo_client.create_table(table_name: table_name,
+                                 key_schema: [{ attribute_name: 'id', key_type: 'HASH' }],
+                                 attribute_definitions: [{ attribute_name: 'id',
+                                                           attribute_type: 'S' }],
+                                 provisioned_throughput: { read_capacity_units: 10,
+                                                           write_capacity_units: 10 })
+    rescue Aws::DynamoDB::Errors::ResourceInUseException => ex
+      unless ex.message == 'Cannot create preexisting table' ||
+          ex.message.start_with?('Table already exists')
+        raise ex
+      end
+    end
+
+    def force_unlock!
+      dynamo_client.delete_item(table_name: table_name, key: { id: lock_name })
+    end
+
+    class << self
+      attr_writer :default_client, :default_table
+
+      def default_table
+        @default_table ||= 'default_locks'
+      end
+
+      def default_client
+        @default_client ||= create_client
+      end
+
+      def create_client(**args)
+        # require at runtime to avoid a gem dependency
+        require 'aws-sdk-dynamodb'
+        Aws::DynamoDB::Client.new(**args)
+      end
+    end
+
+    def _wait_for_timeout(timeout)
+      @_timeout_mutex.synchronize { @_timeout_stopper.wait(@_timeout_mutex, timeout) }
+    end
+
+    def _interrupt_waiting
+      @_timeout_mutex.synchronize { @_timeout_stopper.broadcast }
+    end
+
+    private
+
+    def retrieve_current_lock
+      item = dynamo_client.get_item(table_name: table_name, key: { id: lock_name }).item
+      return nil if item.nil?
+      { lock_name: item['id'], owner: item['lock_owner'], expires: item['expires'] }
+    end
+
+    def build_not_owned_error_from_remote
+      current = retrieve_current_lock || {}
+      LockNotOwnedError.new(lock: self, current_owner: current['owner'],
+                            current_expiry: current['expires'])
+    rescue RuntimeError # in the case that there is a different error raised, ignore it
+      LockNotOwnedError.new(lock: self)
+    end
+  end
+end

data/lib/locksy/errors.rb

@@ -0,0 +1,19 @@
+module Locksy
+  class LockNotOwnedError < RuntimeError
+    attr_reader :lock, :current_owner, :current_expiry
+
+    def initialize(msg = nil, lock:, current_owner: nil, current_expiry: nil)
+      @lock = lock
+      @current_owner = current_owner
+      @current_expiry = current_expiry
+
+      if msg.nil?
+        msg = "Unable to manipulate lock #{lock.lock_name} for #{lock.owner}."
+        msg += " Lock currently owned by #{current_owner}." if current_owner
+        msg += " Lock unnavailable until #{current_expiry}." if current_expiry
+      end
+
+      super msg
+    end
+  end
+end

data/lib/locksy/lock_interface.rb

@@ -0,0 +1,41 @@
+module Locksy
+  # AbstractLock allows us to declare the interface for locks.
+  # Any locks created should follow this interface
+  #
+  # disabling this cop because we are declaring this as an interface and deliberately not using here
+  # rubocop:disable Lint/UnusedMethodArgument
+  class LockInterface
+    attr_reader :owner, :default_expiry, :default_extension, :lock_name
+    attr_writer :logger
+
+    def initialize(lock_name: generate_default_lock_name, owner: generate_default_owner,
+      default_expiry: nil, default_extension: nil, logger: nil, **_args)
+      raise NotImplementedError.new 'This is an abstract class - instantiation is not supported'
+    end
+
+    # should return a boolean denoting lock obtained (true) or not (false)
+    def obtain_lock(expire_after: default_expiry, **_args)
+      raise NotImplementedError.new 'Obtaining a lock is not supported'
+    end
+
+    # should raise a LockNotOwnedError if the lock is not owned by the requested owner
+    def refresh_lock(expire_after: default_extension, **_args)
+      raise NotImplementedError.new 'Refreshing a lock is not supported'
+    end
+
+    # should raise a LockNotOwnedError if the lock is not owned by the requested owner
+    def release_lock(**_args)
+      raise NotImplementedError.new 'Releasing a lock is not supported'
+    end
+
+    # should raise a LockNotOwnedError if the lock is not owned by the requested owner
+    def with_lock(expire_after: default_expiry, **_args)
+      raise NotImplementedError.new 'Working with a lock is not supported'
+    end
+
+    protected
+
+    attr_reader :logger, :generate_default_owner, :generate_default_lock_name
+  end
+  # rubocop:enable Lint/UnusedMethodArgument
+end

data/lib/locksy/memory.rb

@@ -0,0 +1,88 @@
+require_relative './base_lock'
+
+module Locksy
+  class Memory < BaseLock
+    @_singleton_mutex = Mutex.new
+    @_datastore = {}
+    @_data_change = ConditionVariable.new
+
+    def obtain_lock(expire_after: default_expiry, wait_for: nil, **_args)
+      stop_waiting_at = wait_for ? now + wait_for : nil
+      begin
+        current = nil
+        self.class._synchronize do
+          current = _in_mutex_retrieve_lock
+          self.class._datastore[lock_name] = [owner, expiry(expire_after)]
+          self.class._notify_data_change
+        end
+      rescue LockNotOwnedError => ex
+        if stop_waiting_at && stop_waiting_at > now
+          # Maximum wait time for the condition variable before retrying
+          # Because it is possible that a condition variable will not be
+          # triggered, or may be triggered by something that is not what
+          # was expected.
+          # Retry at a maximum of 1/2 of the remaining time until the
+          # current lock expires or the remaining time from the what the
+          # caller was willing to wait, subject to a minimum of 0.1s to
+          # prevent busy looping.
+          cv_timeout = [stop_waiting_at - now, [(ex.current_expiry - now) / 2, 0.1].max].min
+          self.class._synchronize { self.class._wait_for_data_change(cv_timeout) }
+          retry unless self.class.shutting_down?
+        end
+        raise ex
+      end
+    end
+
+    def release_lock
+      self.class._synchronize do
+        _in_mutex_retrieve_lock
+        self.class._datastore.delete lock_name
+        self.class._notify_data_change
+      end
+    end
+
+    def refresh_lock(expire_after: default_extension, **_args)
+      obtain_lock expire_after: expire_after
+    end
+
+    class << self
+      attr_reader :_datastore
+
+      # This is needed to allow tests to inject and control the condition variable
+      attr_writer :_data_change
+
+      def release_all!
+        _synchronize { @_datastore = {} }
+      end
+
+      def _synchronize(&blk)
+        @_singleton_mutex.synchronize(&blk)
+      end
+
+      # THIS IS DANGEROUS... CALL ONLY WHEN SYNCHRONIZED IN THE MUTEX
+      def _wait_for_data_change(timeout = nil)
+        @_data_change.wait(@_singleton_mutex, timeout)
+      end
+
+      # THIS IS DANGEROUS... CALL ONLY WHEN SYNCHRONIZED IN THE MUTEX
+      def _notify_data_change
+        @_data_change.broadcast
+      end
+    end
+
+    at_exit do
+      _synchronize { _notify_data_change }
+    end
+
+    private
+
+    def _in_mutex_retrieve_lock
+      current = self.class._datastore[lock_name]
+      if current && current[0] != owner && current[1] > now
+        raise LockNotOwnedError.new(lock: self, current_owner: current[0],
+                                    current_expiry: current[1])
+      end
+      current
+    end
+  end
+end

data/lib/locksy/version.rb

@@ -0,0 +1,5 @@
+require_relative '../locksy'
+
+module Locksy
+  VERSION = '0.0.1'.freeze
+end

data/lib/locksy.rb

@@ -0,0 +1,2 @@
+# Forward module declaration
+module Locksy; end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: locksy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- dan@52degreesnorth.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: byebug
+  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: '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'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-dynamodb
+  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: A tool to provide distributed locking
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/locksy.rb
+- lib/locksy/base_lock.rb
+- lib/locksy/dynamodb.rb
+- lib/locksy/errors.rb
+- lib/locksy/lock_interface.rb
+- lib/locksy/memory.rb
+- lib/locksy/version.rb
+homepage: https://github.com/danleyden/locksy
+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.7.10
+signing_key: 
+specification_version: 4
+summary: A tool to provide distributed locking
+test_files: []