race_block 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e95fdc53873feda243ec14207fd95bbba5bc6fe37b5a45e6d56c6e85d20cf0be
-  data.tar.gz: 34be0b8dc146d5318c476a756c9cf4b525c235b6320475360fde81da6fe8b80b
+  metadata.gz: 489544d7f2e5b00afafa91544b740ffa44cc85b3f99e6dd2bf4e5f031c825a5d
+  data.tar.gz: 5bd94bdbb176fea865ee8353dd91319d4c8e6e455760ba4601c499405fd8e8a2
 SHA512:
-  metadata.gz: 69e136e4906f2e26ed3ebc426558fa3c345959f2505a1ef816326fb7a5275fb5c07e2e7a0e599918527b2cdd3cc7e52d9abc7bef29c0f3d5a6e372041830062b
-  data.tar.gz: e0565376d86a6a005dfea1a88632af7c14537e21223845875720aad49bb10e6a252726b47f9cb1c98753a50e105481167766e38552818494dd777c08b0999933
+  metadata.gz: 4e096f348d8b97b8d4637f5884a51fbcb1b34fd5ba19e6b41af35e6ed9ce0bd22434dbd5b923d70aeb0350b4b8fc5e77692392a7613427a913bd727bb74cc756
+  data.tar.gz: 60b41cebf121c933e7003ef8bdbf06bb9a667583f8bc74672fafa7d1378424c0906e68031a1912f469349565eaf04632fdb4e878c38b3e53d2a082f1d385ba70

data/.github/workflows/main.yml

@@ -23,7 +23,30 @@ jobs:
       with:
         redis-version: 6.2.4
     - name: Run the default task
+      env:
+        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
       run: |
         gem install bundler -v 2.2.6
         bundle install
         bundle exec rake
+    - name: Send coverage to CodeClimate
+      if: ${{ !env.ACT }}
+      uses: paambaati/codeclimate-action@v2.7.5
+      env:
+        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+    - name: Get coverage
+      if: ${{ !env.ACT }} && github.ref == 'refs/heads/master'
+      run: echo "COVERAGE=$(cat ./coverage/.last_run.json | jq -r '.result.line')%" >> $GITHUB_ENV
+    - name: Testing variables
+      if: ${{ !env.ACT }} && github.ref == 'refs/heads/master'
+      run: echo '' # This empty step is required for `COVERAGE` to be available in the next step, unusre why
+    - name: Create coverage badge
+      if: ${{ !env.ACT }} && github.ref == 'refs/heads/master'
+      uses: schneegans/dynamic-badges-action@v1.1.0
+      with:
+        auth: ${{ secrets.GIST_SECRET }}
+        gistID: 22954a8941d89a10237b7839e57267ec
+        filename: coverage.json
+        label: 'Coverage:'
+        message: ${{ env.COVERAGE }}
+        color: green

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-06-23 20:01:32 UTC using RuboCop version 1.17.0.
+# on 2021-06-25 14:28:46 UTC using RuboCop version 1.17.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -9,30 +9,10 @@
 # Offense count: 1
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 43
+  Max: 20
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 # IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 74
-
-# Offense count: 1
-# Configuration parameters: IgnoredMethods.
-Metrics/CyclomaticComplexity:
-  Max: 15
-
-# Offense count: 1
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
-Metrics/MethodLength:
-  Max: 22
-
-# Offense count: 1
-# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
-Metrics/ParameterLists:
-  Max: 6
-
-# Offense count: 1
-# Configuration parameters: IgnoredMethods.
-Metrics/PerceivedComplexity:
-  Max: 17
+  Max: 91

data/README.md

@@ -1,10 +1,14 @@
 # RaceBlock
 
+[![Gem Version](https://badge.fury.io/rb/race_block.svg)](https://badge.fury.io/rb/race_block)
 [![Ruby](https://github.com/joeyparis/race_block/actions/workflows/main.yml/badge.svg)](https://github.com/joeyparis/race_block/actions/workflows/main.yml)
+![Master Test Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/joeyparis/22954a8941d89a10237b7839e57267ec/raw/coverage.json)
+[![Develop Test Coverage](https://api.codeclimate.com/v1/badges/dee875117bee3e5a72f7/test_coverage)](https://codeclimate.com/github/joeyparis/race_block/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/dee875117bee3e5a72f7/maintainability)](https://codeclimate.com/github/joeyparis/race_block/maintainability)
 
 A Ruby code block wrapper to help prevent race conditions across multiple threads and even separate servers.
 
-**Disclaimer** This code has been used in production for several years now without incident, but I make no guarantee about the thread-safeness it has. Use at your own risk.
+>**Disclaimer** This code has been used in production for several years now without incident, but I make no guarantee about the thread-safeness it has. Use at your own risk.
 
 ## Concept
 
@@ -29,6 +33,10 @@ And then execute:
 Or install it yourself as:
 
     $ gem install race_block
+    
+## Requirements:
+* Ruby >= 2.5
+* A Redis server
 
 ## Potential Use Cases
 
@@ -39,6 +47,18 @@ The original inspiration behind this gem was running cron jobs across multiple s
 
 ## Usage
 
+Before calling `RaceBlock.start` you'll need to configure your own redis client in `RaceBlock.config`
+
+```ruby
+RaceBlock.config do |config|
+    config.redis = Redis.new
+end
+
+# or...
+
+RaceBlock.config.redis = Redis.new
+```
+
 Any code that you want to be "thread-safe" and ensure is only executing in one location should be placed in a `RaceBlock` with a unique identifying key that will be checked across all instances.
 
 ```ruby
@@ -53,9 +73,19 @@ end
 |------|-------|-----------|
 |sleep_delay|0.5|How many seconds the RaceBlock should wait after generating its unique token before it checks if it can execute the RaceBlock. **Important** This value should be longer than the amount of time it takes your server to write to the Redis database. 0.5 seconds has worked for us, but longer  `sleep_delay` values should technically be safer.|
 |expire|60|How many seconds the key should be stored for while running. This number should be longer than the length of time the RaceBlock will take to execute once it starts. The key will be deleted 3 seconds after the block completes, regardless of the time left from `expire`.|
-|expire_immediately|false|Whether or not the key should expire immediately after block completion, or wait the default 3 seconds.|
-|debug|false|Can help debug why a RaceBlock call is running or not running.|
-|dsync_tokens|false| **TESTING ONLY** This is purely for testing purposes to simulate inconsistent request times. It should never be used in a production environment.|
+|expiration_delay|3|How long after block completion before the key is deleted. Setting to 0 will delete it instanttly upon block completion.|
+|desync_tokens|0| **TESTING ONLY** This is purely for testing purposes to simulate inconsistent request times. It should never be used in a production environment.|
+
+#### Changing default values
+You can change the default values using `RaceBlock.config`, otherwise they can be overridden on a per call basis.
+
+```ruby
+RaceBlock.config do |config|
+    config.sleep_delay = 1.5
+    config.expire = 14
+    config.expiration_delay = 4
+end
+```
 
 ## Development
 

data/lib/race_block.rb

@@ -2,24 +2,40 @@
 
 require "securerandom"
 require "logger"
-require "redis"
+
 require_relative "race_block/version"
 
 # Block for preventing race conditions across multiple threads and instances
 module RaceBlock
   class Error < StandardError; end
 
-  def self.client(reload: false)
-    if @redis.nil? || reload
-      @redis = Redis.new(host: ENV["REDIS_HOST"], port: ENV["REDIS_PORT"])
+  # For managing RaceBlock current configuration settings
+  class Configuration
+    attr_accessor :redis, :expire, :expiration_delay, :sleep_delay
+
+    def initialize
+      reset
+    end
 
-      begin
-        @redis.ping
-      rescue Redis::CannotConnectError => e
-        RaceBlock.logger.error e
-      end
+    def reset
+      @expire = 60
+      @expiration_delay = 3
+      @sleep_delay = 0.5
     end
-    @redis
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.config
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+    configuration
+  end
+
+  def self.client
+    config.redis
   end
 
   def self.logger
@@ -34,8 +50,8 @@ module RaceBlock
     RaceBlock.client.del(RaceBlock.key(key))
   end
 
-  def self.start(key, sleep_delay: 0.5, expire: 60, expire_immediately: false, debug: false, desync_tokens: false)
-    raise("A key must be provided to start a RaceBlock") if key.nil? || key.empty?
+  def self.start(key, expire: config.expire, expiration_delay: config.expiration_delay, **args)
+    raise("A key must be provided to start a RaceBlock") if key.empty?
 
     @key = RaceBlock.key(key)
 
@@ -45,43 +61,45 @@ module RaceBlock
     # not set
     RaceBlock.client.expire(@key, 10) if RaceBlock.client.ttl(@key) == -1
 
-    if !RaceBlock.client.get(@key)
-      sleep rand(0.0..sleep_delay) if desync_tokens && ENV["RACK_ENV"] == "test"
-      token = SecureRandom.hex
-      RaceBlock.client.set(@key, token)
-      RaceBlock.client.expire(@key, [15, sleep_delay].max)
-      sleep sleep_delay
-      # Okay, so I feel like this is pseudo science, but whatever. Our
-      # race condition comes from when the same cron job is called by
-      # several different server instances at the same time
-      # (theoretically) all within the same second (much less really).
-      # By waiting a second we can let all the same cron jobs that were
-      # called at roughly the exact same time finish their write to the
-      # redis cache so that by the time the sleep is over, only one
-      # token is still accurate. I'm hesitant to believe this actually
-      # works, but I can't find any flaws in the logic at the current
-      # moment, and I also believe this is what is keep the EmailQueue
-      # stable which seems to have no duplicate sending problems.
-      if RaceBlock.client.get(@key) == token
-        RaceBlock.client.expire(@key, expire.is_a?(Integer) ? expire : 60)
-        logger.info("Running block") if debug
-
-        r = yield
-
-        # I have lots of internal debates on whether I should full
-        # delete the key here or still let it sit for a few seconds
-        RaceBlock.client.expire(@key, desync_tokens && ENV["RACK_ENV"] == "test" ? 10 : 3)
-
-        RaceBlock.client.del(@key) if expire_immediately
-
-        r
-      elsif debug
-        logger.info("Token out of sync")
-      end
-    # Token out of sync
-    elsif debug
-      logger.info("Token already exists")
-    end
     # Token already exists
+    return logger.debug("Token already exists") if RaceBlock.client.get(@key)
+
+    return unless set_token_and_wait(@key, **args)
+
+    RaceBlock.client.expire(@key, expire)
+    logger.debug("Running block")
+
+    r = yield
+
+    # I have lots of internal debates on whether I should full
+    # delete the key here or still let it sit for a few seconds
+    RaceBlock.client.expire(@key, expiration_delay)
+
+    r
+  end
+
+  def self.set_token_and_wait(key, sleep_delay: config.sleep_delay, desync_tokens: 0)
+    sleep desync_tokens # Used for testing only
+    token = SecureRandom.hex
+    RaceBlock.client.set(key, token)
+    RaceBlock.client.expire(key, (sleep_delay + 15).round)
+    sleep sleep_delay
+    # Okay, so I feel like this is pseudo science, but whatever. Our
+    # race condition comes from when the same cron job is called by
+    # several different server instances at the same time
+    # (theoretically) all within the same second (much less really).
+    # By waiting a second we can let all the same cron jobs that were
+    # called at roughly the exact same time finish their write to the
+    # redis cache so that by the time the sleep is over, only one
+    # token is still accurate. I'm hesitant to believe this actually
+    # works, but I can't find any flaws in the logic at the current
+    # moment, and I also believe this is what is keep the EmailQueue
+    # stable which seems to have no duplicate sending problems.
+
+    return true if RaceBlock.client.get(@key) == token
+
+    # Token out of sync
+    logger.debug("Token out of sync")
+    false
   end
 end

data/lib/race_block/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RaceBlock
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/race_block.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "A Ruby code block wrapper to help prevent race conditions " \
                        "across multiple threads and even separate servers."
   # spec.description   = "TODO: Write a longer description or delete this line."
-  spec.homepage      = "https://github.com/joeyparis/race_block"
+  spec.homepage      = "https://rubygems.org/gems/race_block"
   spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
@@ -30,10 +30,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  spec.add_dependency "redis", "4.0.1"
-
   spec.add_development_dependency "rake", "13.0"
+  spec.add_development_dependency "redis", "4.0.1"
   spec.add_development_dependency "rspec", "3.10"
   spec.add_development_dependency "rubocop", "1.17"
   spec.add_development_dependency "simplecov", "0.21.2"

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: race_block
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joey Paris
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-23 00:00:00.000000000 Z
+date: 2021-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.1
-  type: :runtime
+        version: '13.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 4.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 4.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -117,11 +117,11 @@ files:
 - lib/race_block.rb
 - lib/race_block/version.rb
 - race_block.gemspec
-homepage: https://github.com/joeyparis/race_block
+homepage: https://rubygems.org/gems/race_block
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/joeyparis/race_block
+  homepage_uri: https://rubygems.org/gems/race_block
   source_code_uri: https://github.com/joeyparis/race_block
 post_install_message: 
 rdoc_options: []