blue_green_workers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 763c209e7bb28f7c8e3753cc57d4f3e9d0b1c021
+  data.tar.gz: 1afcd620a1b05e054f56300f0dbdecd0d7509c50
+SHA512:
+  metadata.gz: fc6b12114e9d32012f262e85fc34f87bb073edfad3ac36d7c846348b7c483db0a22300bdfc407b64c88a3ae74293caf106cac54860605f9800be86bb201cf620
+  data.tar.gz: fd9be9b4151d112db6af2eaffb8d4cacf25e1382f86c8c205dc77f0f2c7a1d77639a10ecca8762db659720ea6f72d80198e49b24c3fdfbad04d4ec622747765f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+spec/examples.txt
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+    - '*.gemspec'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in blue_green_workers.gemspec
+gemspec

data/README.md

@@ -0,0 +1,62 @@
+# BlueGreenWorkers
+
+This gem provides helpers to coordiante workers across multiple clusters that for which only one cluster should be active at a time.  Think [blue green deployments](https://martinfowler.com/bliki/BlueGreenDeployment.html)
+
+## Installation
+
+```ruby
+  gem 'blue_green_workers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blue_green_workers
+
+## Usage
+
+This gem doesn't attempt to provide an interface through which you specify which cluster is currently active, that's left as an exercise to the reader.  One could very easily use ActiveRecord and a simple RESTFul interface to set the current active cluster.
+
+### Config
+```ruby
+BlueGreenWorkers.configure do |config|
+  config.cluster_name = 'blue'
+  config.determine_active_cluster { ActiveCluster.first.value }
+  config.activate { QueueClient.listen! }
+  config.deactivate { QueueClient.shutdown! }
+  config.logger = Logger.new STDOUT
+end
+```
+
+* `cluster_name` - Defines the name for this cluster.  Something like `ENV['CLUSTER_NAME']` probably makes sense
+* `determine_active_cluster` - Takes a block that returns the name of the current active cluster
+* `refresh_interval` (optional) - How often to cache the active cluster, `0` (the default) will call the block passed to `determine_active_cluster` every time a worker is executed.
+* `activate` (optiona) - Block to call when this cluster goes active.  Will be called during initialization.  `refresh_interval` must be specified.
+* `deactivate` (optiona) - Block to call when this cluster goes passive.  This block will not be called if the cluster is started in passive mode.  `refresh_interval` must be specified.
+* `logger` (optiona) - Logger to use
+
+### Executing jobs
+
+In addition to attaching event handles to `activate` and `deactivate` you can also do this:
+
+```ruby
+loop do
+  BlueGreenWorkers.execute do
+    # Do some work, poll for stuff, etc
+  end
+  sleep 60
+end
+```
+
+## 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/hawknewton/blue_green_workers.

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'blue_green_workers'
+
+# 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

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

@@ -0,0 +1,37 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blue_green_workers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'blue_green_workers'
+  spec.version       = BlueGreenWorkers::VERSION
+  spec.authors       = ['hawknewton']
+  spec.email         = ['hawk.newton@gmail.com']
+
+  spec.summary       = "Deactivate background workers when we're the standby" \
+  'cluster'
+  spec.description = '
+    Deactive any type of background worker when the cluster is standby.  This is
+    useful when deploying apps that utilize timers or queues with a blue/green
+    deploy strategy.
+  '.strip
+  spec.homepage      = 'https://github.com/hawknewton/blue_green_workers'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'null-logger', '~> 0.1'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-eventually', '~> 0.2'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+end

data/lib/blue_green_workers/config.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'pry'
+
+module BlueGreenWorkers
+  # Config for BlueGreenWorkers
+  class Config
+    attr_reader :active_cluster_block
+    attr_accessor :cluster_name, :refresh_interval, :activate_block,
+                  :deactivate_block
+    attr_writer :logger
+
+    def activate(&block)
+      @activate_block = block
+    end
+
+    def deactivate(&block)
+      @deactivate_block = block
+    end
+
+    def determine_active_cluster(&block)
+      @active_cluster_block = block
+    end
+
+    def logger
+      @logger ||= Logger.new STDOUT
+    end
+
+    def validate
+      cluster_name || raise('No cluster_name defined')
+      active_cluster_block || raise('No determine_active_cluster block defined')
+    end
+  end
+end

data/lib/blue_green_workers/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BlueGreenWorkers
+  VERSION = '0.1.0'
+end

data/lib/blue_green_workers.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'blue_green_workers/version'
+require 'blue_green_workers/config'
+require 'logger'
+
+# Main module for blue_green_workers
+module BlueGreenWorkers
+  def self.active_cluster
+    if config.refresh_interval.positive?
+      @active_cluster
+    else
+      determine_active_cluster
+    end
+  end
+
+  def self.configure
+    yield config
+    determine_active_cluster
+    (config.refresh_interval || 0).positive? && start_refresh_thread
+    config.validate
+  end
+
+  def self.execute
+    if config.active_cluster_block.call == config.cluster_name
+      yield
+    else
+      logger.debug 'Workers not active, skipping BlueGreenWorkers#execute'
+    end
+  end
+
+  def self.shutdown
+    logger.warn 'Shutting down BlueGreenWotkers!'
+    @refresh_thread&.kill
+    @active_cluster = nil
+    @refresh_thread = nil
+    @config = nil
+  end
+
+  # private
+  def self.activate
+    logger.info 'BlueGreenWorkers cluster activating!'
+    config.activate_block&.call
+  end
+
+  def self.deactivate
+    logger.info 'BlueGreenWorkers cluster deactivating!'
+    config.deactivate_block&.call
+  end
+
+  def self.active_cluster=(cluster)
+    if cluster != @active_cluster
+      if cluster == config.cluster_name
+        activate
+      elsif @active_cluster == config.cluster_name
+        deactivate
+      end
+    end
+    @active_cluster = cluster
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.determine_active_cluster
+    self.active_cluster = config.active_cluster_block.call
+  end
+
+  def self.logger
+    config.logger
+  end
+
+  def self.refresh_thread
+    logger.info "BlueGreenWorkers refreshing every #{config.refresh_interval}s"
+    @refresh_thread ||= Thread.new { refresh_loop }
+  end
+
+  def self.refresh_loop
+    loop do
+      begin
+        determine_active_cluster
+        sleep config.refresh_interval
+      rescue StandardError => err
+        Logger.error "Error during refresh: #{err} #{err.backtrace.join "\n"}"
+      end
+    end
+  end
+
+  def self.start_refresh_thread
+    refresh_thread
+  end
+
+  private_class_method :active_cluster=, :config, :determine_active_cluster,
+                       :logger, :refresh_thread, :start_refresh_thread,
+                       :refresh_loop
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: blue_green_workers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hawknewton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: null-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !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-eventually
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+description: |-
+  Deactive any type of background worker when the cluster is standby.  This is
+      useful when deploying apps that utilize timers or queues with a blue/green
+      deploy strategy.
+email:
+- hawk.newton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- blue_green_workers.gemspec
+- lib/blue_green_workers.rb
+- lib/blue_green_workers/config.rb
+- lib/blue_green_workers/version.rb
+homepage: https://github.com/hawknewton/blue_green_workers
+licenses: []
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Deactivate background workers when we're the standbycluster
+test_files: []