zk_recipes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d7e707bc2f43f78a94c97736934209f049c19fb
+  data.tar.gz: 8b93f73571a1464ee7c231d95e85b5373f0c9312
+SHA512:
+  metadata.gz: af9c84ae0d6797865d787353221429ec7031559b1b948133511127fdf54868e0852d087ffcaf7ec1fa8c67354e2c4077ff6468338788822ad38d8a882f6afd5b
+  data.tar.gz: 8ffdb1eb278394d79bf93ff84ce0a82e5b5ab270f640aa872c32e1561fd846a1aafe626eacc62bd68ff6ca240a4e5865712296ae3ef19523dc7aedc8515162b6

data/.gitignore

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

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--order rand
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  DisplayCopNames: true
+
+Lint/RescueException:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Style:
+  Enabled: false

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nerdrew@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in zk_recipes.gemspec
+gemspec
+
+gem "bundler", "~> 1.14"
+gem "descriptive_statistics", "~> 2.5"
+gem "pry"
+gem "rake", "~> 10.0"
+gem "rspec", "~> 3.6"
+gem "rubocop", "0.49.1"
+gem "zk-server", "~> 1.1"
+
+platform :mri do
+  gem "pry-byebug"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Andrew Lazarus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# ZkRecipes
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "zk_recipes"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zk_recipes
+
+## Usage
+
+A cache that creates its own ZK client:
+
+```ruby
+logger = Logger.new(STDERR)
+cache = ZkRecipes::Cache.new(host: "my-host:1234", logger: logger, timeout: 10, zk_opts: { timeout: 5 }) do |z|
+  z.register("/test/boom", "goat")
+  z.register("/test/foo", 1) { |raw_value| raw_value.to_i * 2 }
+end
+
+puts cache["/test/boom"]
+cache.close!
+```
+
+A cache that uses an existing ZK client:
+
+```ruby
+logger = Logger.new(STDERR)
+zk = ZK.new("my-host:1234", connect: false, timeout: 5) # ZK timeout = 5s
+cache = ZkRecipes::Cache.new(logger: logger)
+cache.register("/test/boom", "goat")
+cache.register("/test/foo", 1) { |raw_value| raw_value.to_i * 2 }
+cache.setup_callbacks(zk) # no more paths can be registered after this
+
+puts cache["/test/boom"] # => "goat"
+
+zk.connect
+cache.wait_for_warm_cache(10) # wait 10s for the cache to warm
+
+zk.create("/test/boom")
+zk.set("/test/boom", "cat")
+
+sleep 1
+
+puts cache["/test/boom"] # => "cat"
+cache.close!
+zk.close!
+```
+
+## 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/nerdrew/ruby-zk_recipes. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
+conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+task :default => %i(spec rubocop)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zk_recipes"
+
+# 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/lib/zk_recipes/cache.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+module ZkRecipes
+  class Cache
+    class Error < StandardError; end
+
+    extend Forwardable
+
+    AS_NOTIFICATION_UPDATE = "zk_recipes.cache.update"
+    AS_NOTIFICATION_ERROR = "zk_recipes.cache.error"
+
+    def initialize(host: nil, logger: nil, timeout: nil, zk_opts: {})
+      @cache = Concurrent::Map.new
+      @latch = Concurrent::CountDownLatch.new
+      @logger = logger
+      @pending_updates = Concurrent::Hash.new
+      @registerable = true
+      @registered_values = Concurrent::Map.new
+      @session_id = nil
+      @watches = Concurrent::Map.new
+      @zk = nil
+
+      if block_given?
+        @owned_zk = true
+        yield(self)
+
+        expiration = Time.now + (timeout || 30)
+        connect(host, zk_opts)
+
+        wait_for_warm_cache(expiration - Time.now)
+      elsif host || timeout || !zk_opts.empty?
+        raise ArgumentError, "host, zk_opts, and timeout are only allowed with a block"
+      else
+        @owned_zk = false
+      end
+    end
+
+    def register(path, default_value, &block)
+      raise Error, "register only allowed before setup_callbacks called" unless @registerable
+
+      debug("added path=#{path} default_value=#{default_value.inspect}")
+      @cache[path] = CachedPath.new(default_value)
+      @registered_values[path] = RegisteredPath.new(default_value, block)
+      ActiveSupport::Notifications.instrument(AS_NOTIFICATION_UPDATE, path: path, value: default_value)
+    end
+
+    def setup_callbacks(zk)
+      @zk = zk
+      @registerable = false
+
+      if @zk.connected? || @zk.connecting?
+        raise Error, "the ZK::Client is already connected, the cached values must be set before connecting"
+      end
+
+      @zk.on_connected do |e|
+        info("on_connected session_id old=#{@session_id} new=#{@zk.session_id} #{e.event_name} #{e.state_name}")
+        if @session_id == @zk.session_id
+          process_pending_updates
+          next
+        end
+
+        @pending_updates.clear
+        @registered_values.each do |path, _value|
+          @watches[path] ||= @zk.register(path) do |event|
+            if event.node_event?
+              debug("node event=#{event.inspect} #{event.event_name} #{event.state_name}")
+              unless update_cache(event.path)
+                @pending_updates[path] = nil
+                @zk.defer { process_pending_updates }
+              end
+            else
+              warn("session event=#{event.inspect}")
+            end
+          end
+          @pending_updates[path] = nil unless update_cache(path)
+        end
+        @session_id = @zk.session_id
+        @latch.count_down
+      end
+
+      @zk.on_expired_session do |e|
+        info("on_expired_session #{e.event_name} #{e.state_name}")
+      end
+
+      @zk.on_exception do |e|
+        error("on_exception exception=#{e.inspect} backtrace=#{e.backtrace.inspect}")
+        ActiveSupport::Notifications.instrument(AS_NOTIFICATION_ERROR, error: e)
+      end
+    end
+
+    def wait_for_warm_cache(timeout = 30)
+      if @latch.wait(timeout)
+        true
+      else
+        warn("didn't connect before timeout connected=#{@zk.connected?} timeout=#{timeout}")
+        false
+      end
+    end
+
+    def close!
+      @watches.each_value(&:unsubscribe)
+      @watches.clear
+      @zk.close! if @owned_zk
+    end
+
+    def fetch(path)
+      @cache.fetch(path).value
+    end
+    alias_method :[], :fetch
+
+    def fetch_existing(path)
+      cached = @cache.fetch(path)
+      cached.value if cached.stat&.exists?
+    end
+
+    private
+
+    def connect(host, zk_opts)
+      raise Error, "already connected" if @zk
+
+      debug("connecting host=#{host.inspect}")
+      ZK.new(host, **zk_opts) do |zk|
+        setup_callbacks(zk)
+      end
+    end
+
+    # only called from ZK thread
+    def update_cache(path)
+      debug("update_cache path=#{path}")
+
+      stat = @zk.stat(path, watch: true)
+
+      instrument_name = AS_NOTIFICATION_UPDATE
+      instrument_params = { path: path }
+
+      unless stat.exists?
+        value = @registered_values.fetch(path).default_value
+        @cache[path] = CachedPath.new(value, stat)
+        debug("no node, setting watch path=#{path}")
+        instrument_params[:value] = value
+        ActiveSupport::Notifications.instrument(instrument_name, instrument_params)
+        return true
+      end
+
+      raw_value, stat = @zk.get(path, watch: true)
+
+      instrument_params.merge!(
+        latency_seconds: Time.now - stat.mtime_t,
+        version: stat.version,
+        data_length: stat.data_length,
+      )
+
+      value = begin
+        registered_value = @registered_values.fetch(path)
+        instrument_params[:value] = registered_value.deserialize(raw_value)
+      rescue => e
+        error(
+          "deserialization error raw_zookeeper_value=#{raw_value.inspect} zookeeper_stat=#{stat.inspect} "\
+          "exception=#{e.inspect} #{e.backtrace.inspect}"
+        )
+        instrument_name = AS_NOTIFICATION_ERROR
+        instrument_params[:error] = e
+        instrument_params[:raw_value] = raw_value
+        registered_value.default_value
+      end
+
+      @cache[path] = CachedPath.new(value, stat)
+
+      debug(
+        "updated cache path=#{path} raw_value=#{raw_value.inspect} "\
+        "value=#{value.inspect} stat=#{stat.inspect}"
+      )
+      ActiveSupport::Notifications.instrument(instrument_name, instrument_params)
+      true
+    rescue ::ZK::Exceptions::ZKError => e
+      warn("update_cache path=#{path} exception=#{e.inspect}, retrying")
+      retry
+    rescue ::ZK::Exceptions::KeeperException, ::Zookeeper::Exceptions::ZookeeperException => e
+      error("update_cache path=#{path} exception=#{e.inspect}")
+      false
+    end
+
+    def process_pending_updates
+      info("processing pending updates=#{@pending_updates.size}")
+      @pending_updates.reject! do |missed_path, _|
+        debug("update_cache with previously missed update path=#{missed_path}")
+        update_cache(missed_path)
+      end
+      info("pending updates not processed=#{@pending_updates.size}")
+    end
+
+    %w(debug info warn error).each do |m|
+      module_eval <<~EOM, __FILE__, __LINE__
+        def #{m}(msg)
+          return unless @logger
+          @logger.#{m}("ZkRecipes::Cache") { msg }
+        end
+      EOM
+    end
+
+    CachedPath = Struct.new(:value, :stat)
+
+    class RegisteredPath < Struct.new(:default_value, :deserializer)
+      def deserialize(raw)
+        deserializer ? deserializer.call(raw) : raw
+      end
+    end
+  end
+end

data/lib/zk_recipes/version.rb

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

data/lib/zk_recipes.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "active_support/notifications"
+require "concurrent"
+require "forwardable"
+require "zk"
+
+require "zk_recipes/version"
+require "zk_recipes/cache"
+
+module ZkRecipes
+end

data/zk_recipes.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zk_recipes/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "zk_recipes"
+  spec.version = ZkRecipes::VERSION
+  spec.authors = ["Andrew Lazarus"]
+  spec.email = ["nerdrew@gmail.com"]
+
+  spec.summary = %q{Common Recipes for Zookeeper}
+  spec.homepage = "https://github.com/nerdrew/ruby-zk_recipes"
+  spec.license = "MIT"
+
+  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_runtime_dependency "activesupport", ">= 4.0"
+  spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
+  spec.add_runtime_dependency "zk", "~> 1.9"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: zk_recipes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Lazarus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: zk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: 
+email:
+- nerdrew@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zk_recipes.rb
+- lib/zk_recipes/cache.rb
+- lib/zk_recipes/version.rb
+- zk_recipes.gemspec
+homepage: https://github.com/nerdrew/ruby-zk_recipes
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Common Recipes for Zookeeper
+test_files: []