toystore 0.13.1 → 0.13.2

data/lib/toy/querying.rb

@@ -4,42 +4,70 @@ module Toy
 
     module ClassMethods
       def read(id, options = nil)
-        if (attrs = adapter.read(id, options))
-          load(id, attrs)
-        end
+        default_payload = {
+          :id      => id,
+          :options => options,
+          :model   => self,
+          :hit     => false, # default to not found
+        }
+
+        Toy.instrumenter.instrument('read.toystore', default_payload) { |payload|
+          if (attrs = adapter.read(id, options))
+            payload[:hit] = true
+            load(id, attrs)
+          end
+        }
       end
 
       alias_method :get, :read
       alias_method :find, :read
 
       def read!(id, options = nil)
-        get(id, options) || raise(Toy::NotFound.new(id))
+        read(id, options) || raise(Toy::NotFound.new(id))
       end
 
       alias_method :get!, :read!
       alias_method :find!, :read!
 
       def read_multiple(ids, options = nil)
-        result = adapter.read_multiple(ids, options)
-        result.each do |id, attrs|
-          result[id] = attrs.nil? ? nil : load(id, attrs)
-        end
-        result
+        default_payload = {
+          :ids     => ids,
+          :options => options,
+          :model   => self,
+          :hits    => 0,
+          :misses  => 0,
+        }
+
+        Toy.instrumenter.instrument('read_multiple.toystore', default_payload) { |payload|
+          result = adapter.read_multiple(ids, options)
+          result.each do |id, attrs|
+            result[id] = if attrs.nil?
+              payload[:misses] += 1
+              nil
+            else
+              payload[:hits] += 1
+              load(id, attrs)
+            end
+          end
+          result
+        }
       end
 
       alias_method :get_multiple, :read_multiple
       alias_method :find_multiple, :read_multiple
 
-      def get_or_new(id)
-        get(id) || new(:id => id)
-      end
-
-      def get_or_create(id)
-        get(id) || create(:id => id)
-      end
-
       def key?(id, options = nil)
-        adapter.key?(id, options)
+        default_payload = {
+          :id      => id,
+          :options => options,
+          :model => self,
+        }
+
+        Toy.instrumenter.instrument('key.toystore', default_payload) { |payload|
+          result = adapter.key?(id, options)
+          payload[:hit] = result
+          result
+        }
       end
       alias :has_key? :key?
 

data/lib/toy/version.rb

@@ -1,3 +1,3 @@
 module Toy
-  VERSION = "0.13.1"
+  VERSION = "0.13.2"
 end

data/perf/reads.rb

@@ -1,6 +1,5 @@
 # require 'perftools'
 require 'pp'
-require 'logger'
 require 'benchmark'
 require 'rubygems'
 
@@ -8,8 +7,6 @@ $:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 require 'toystore'
 require 'adapter/memory'
 
-Toy.logger = ::Logger.new(STDOUT).tap { |log| log.level = ::Logger::INFO }
-
 class User
   include Toy::Store
   attribute :name, String
@@ -40,4 +37,4 @@ puts 'Ratio', toystore_result / adapter_result
 # end
 
 # system('pprof.rb --gif --ignore=Collection#find_one prof_reads > prof_reads.gif')
-# system('open prof_reads.gif')
+# system('open prof_reads.gif')

data/perf/writes.rb

@@ -1,6 +1,5 @@
 # require 'perftools'
 require 'pp'
-require 'logger'
 require 'benchmark'
 require 'rubygems'
 
@@ -8,8 +7,6 @@ $:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 require 'toystore'
 require 'adapter/memory'
 
-Toy.logger = ::Logger.new(STDOUT).tap { |log| log.level = ::Logger::INFO }
-
 class User
   include Toy::Store
 end

data/spec/helper.rb

@@ -1,12 +1,9 @@
 $:.unshift(File.expand_path('../../lib', __FILE__))
 
 require 'pathname'
-require 'logger'
 
 root_path = Pathname(__FILE__).dirname.join('..').expand_path
 lib_path  = root_path.join('lib')
-log_path  = root_path.join('log')
-log_path.mkpath
 
 require 'rubygems'
 require 'bundler'
@@ -14,20 +11,14 @@ require 'bundler'
 Bundler.require(:default, :test)
 
 require 'toy'
-require 'support/constants'
-require 'support/objects'
-require 'support/identity_map_matcher'
-require 'support/name_and_number_key_factory'
-require 'support/shared_active_model_lint'
-
-Logger.new(log_path.join('test.log')).tap do |log|
-  Toy.logger = log
-end
+
+Dir[root_path.join("spec/support/**/*.rb")].each { |f| require f }
 
 RSpec.configure do |c|
   c.include(Support::Constants)
   c.include(Support::Objects)
   c.include(IdentityMapMatcher)
+  c.include(InstrumenterHelpers)
 
   c.fail_fast = true
   c.filter_run :focused => true
@@ -38,5 +29,6 @@ RSpec.configure do |c|
   c.before(:each) do
     Toy::IdentityMap.enabled = false
     Toy.key_factory = nil
+    clear_instrumenter
   end
 end

data/spec/support/fake_udp_socket.rb

@@ -0,0 +1,27 @@
+class FakeUDPSocket
+  attr_reader :buffer
+
+  def initialize
+    @buffer = []
+  end
+
+  def send(message, *rest)
+    @buffer.push [message]
+  end
+
+  def recv
+    @buffer.shift
+  end
+
+  def clear
+    @buffer = []
+  end
+
+  def to_s
+    inspect
+  end
+
+  def inspect
+    "<FakeUDPSocket: #{@buffer.inspect}>"
+  end
+end

data/spec/support/instrumenter_helpers.rb

@@ -0,0 +1,14 @@
+module InstrumenterHelpers
+  def setup_memory_instrumenter
+    require 'toy/instrumenters/memory'
+    Toy.instrumenter = Toy::Instrumenters::Memory.new
+  end
+
+  def clear_instrumenter
+    Toy.instrumenter = nil
+  end
+
+  def instrumenter
+    Toy.instrumenter
+  end
+end

data/spec/toy/instrumentation/log_subscriber_spec.rb

@@ -0,0 +1,85 @@
+require 'helper'
+require 'toy/instrumentation/log_subscriber'
+
+describe Toy::Instrumentation::LogSubscriber do
+  uses_constants('User')
+
+  before do
+    Toy.instrumenter = ActiveSupport::Notifications
+    @io = StringIO.new
+    Toy::Instrumentation::LogSubscriber.logger = Logger.new(@io)
+  end
+
+  after do
+    Toy::Instrumentation::LogSubscriber.logger = nil
+  end
+
+  let(:log) { @io.string }
+
+  context "creating a new record" do
+    before do
+      clear_logs
+      @user = User.create
+    end
+
+    it "logs" do
+      log.should match(/User create/)
+      log.should match(/\[ #{@user.id.inspect} \]/)
+    end
+  end
+
+  context "updating a record" do
+    before do
+      User.attribute :name, String
+      @user = User.create(:name => 'Old Name')
+      clear_logs
+      @user.update_attributes(:name => 'New Name')
+    end
+
+    it "logs" do
+      log.should match(/User update/)
+      log.should match(/\[ #{@user.id.inspect} \]/)
+    end
+  end
+
+  context "finding a record" do
+    before do
+      clear_logs
+      User.read('blah')
+    end
+
+    it "logs" do
+      log.should match(/User read/)
+      log.should match(/\[ #{'blah'.inspect} \]/)
+    end
+  end
+
+  context "destroying a record" do
+    before do
+      @user = User.create
+      clear_logs
+      @user.destroy
+    end
+
+    it "logs" do
+      log.should match(/User destroy/)
+      log.should match(/\[ #{@user.id.inspect} \]/)
+    end
+  end
+
+  context "checking if a record exists" do
+    before do
+      clear_logs
+      User.key?('blah')
+    end
+
+    it "logs" do
+      log.should match(/User key/)
+      log.should match(/\[ #{'blah'.inspect} \]/)
+    end
+  end
+
+  def clear_logs
+    @io.string = ''
+  end
+end

data/spec/toy/instrumentation/metriks_subscriber_spec.rb

@@ -0,0 +1,37 @@
+require 'helper'
+require 'toy/instrumentation/metriks'
+
+describe Toy::Instrumentation::MetriksSubscriber do
+  uses_constants('User')
+
+  before do
+    Toy.instrumenter = ActiveSupport::Notifications
+  end
+
+  it "updates timers when calls happen" do
+    # Clear the registry so we don't count the operations required to re-create
+    # the keyspace and column family.
+    Metriks::Registry.default.clear
+
+    user = User.create(:name => 'Joe')
+    user.update_attributes(:name => 'John')
+    user.destroy
+    User.read(user.id)
+    User.read_multiple([user.id])
+
+    Metriks.timer('toystore.create').count.should be(1)
+    Metriks.timer('toystore.User.create').count.should be(1)
+
+    Metriks.timer('toystore.update').count.should be(1)
+    Metriks.timer('toystore.User.update').count.should be(1)
+
+    Metriks.timer('toystore.read').count.should be(1)
+    Metriks.timer('toystore.User.read').count.should be(1)
+
+    Metriks.timer('toystore.read_multiple').count.should be(1)
+    Metriks.timer('toystore.User.read_multiple').count.should be(1)
+
+    Metriks.timer('toystore.destroy').count.should be(1)
+    Metriks.timer('toystore.User.destroy').count.should be(1)
+  end
+end

data/spec/toy/instrumentation/statsd_subscriber_spec.rb

@@ -0,0 +1,47 @@
+require 'helper'
+require 'toy/instrumentation/statsd'
+
+describe Toy::Instrumentation::StatsdSubscriber do
+  uses_constants('User')
+
+  let(:statsd_client) { Statsd.new }
+  let(:socket) { FakeUDPSocket.new }
+
+  before do
+    described_class.client = statsd_client
+    Thread.current[:statsd_socket] = socket
+    Toy.instrumenter = ActiveSupport::Notifications
+  end
+
+  after do
+    described_class.client = nil
+    Thread.current[:statsd_socket] = nil
+  end
+
+  def assert_timer(metric)
+    regex = /#{Regexp.escape metric}\:\d+\|ms/
+    socket.buffer.detect { |op| op.first =~ regex }.should_not be_nil
+  end
+
+  it "updates timers when calls happen" do
+    user = User.create(:name => 'Joe')
+    assert_timer('toystore.create')
+    assert_timer('toystore.User.create')
+
+    user.update_attributes(:name => 'John')
+    assert_timer('toystore.update')
+    assert_timer('toystore.User.update')
+
+    user.destroy
+    assert_timer('toystore.destroy')
+    assert_timer('toystore.User.destroy')
+
+    User.read(user.id)
+    assert_timer('toystore.read')
+    assert_timer('toystore.User.read')
+
+    User.read_multiple([user.id])
+    assert_timer('toystore.read_multiple')
+    assert_timer('toystore.User.read_multiple')
+  end
+end

data/spec/toy/instrumenters/memory_spec.rb

@@ -0,0 +1,26 @@
+require 'helper'
+require 'toy/instrumenters/memory'
+
+describe Toy::Instrumenters::Memory do
+  describe "#initialize" do
+    it "sets events to empty array" do
+      instrumentor = described_class.new
+      instrumentor.events.should eq([])
+    end
+  end
+
+  describe "#instrument" do
+    it "adds to events" do
+      instrumentor = described_class.new
+      name         = 'user.signup'
+      payload      = {:email => 'john@doe.com'}
+      block_result = :yielded
+
+      result = instrumentor.instrument(name, payload) { block_result }
+      result.should eq(block_result)
+
+      event = described_class::Event.new(name, payload, block_result)
+      instrumentor.events.should eq([event])
+    end
+  end
+end

data/spec/toy/instrumenters/noop_spec.rb

@@ -0,0 +1,22 @@
+require 'helper'
+require 'toy/instrumenters/noop'
+
+describe Toy::Instrumenters::Noop do
+  describe ".instrument" do
+    context "with name" do
+      it "yields block" do
+        yielded = false
+        described_class.instrument(:foo) { yielded = true }
+        yielded.should be_true
+      end
+    end
+
+    context "with name and payload" do
+      it "yields block" do
+        yielded = false
+        described_class.instrument(:foo, {:pay => :load}) { yielded = true }
+        yielded.should be_true
+      end
+    end
+  end
+end

data/spec/toy/persistence_spec.rb

@@ -251,6 +251,19 @@ describe Toy::Persistence do
         @doc.save.should be_true
       end
 
+      it "is instrumented" do
+        setup_memory_instrumenter
+
+        @doc.save
+
+        event = instrumenter.events.last
+        event.name.should eq('create.toystore')
+        event.payload.should eq({
+          :id => @doc.persisted_id,
+          :model => User,
+        })
+      end
+
       context "with #persist overridden" do
         before do
           @doc.class_eval do
@@ -309,6 +322,19 @@ describe Toy::Persistence do
         @doc.save.should be_true
       end
 
+      it "is instrumented" do
+        setup_memory_instrumenter
+
+        @doc.save
+
+        event = instrumenter.events.last
+        event.name.should eq('update.toystore')
+        event.payload.should eq({
+          :id => @doc.persisted_id,
+          :model => User,
+        })
+      end
+
       context "with #persist overridden" do
         before do
           @doc.class_eval do
@@ -359,10 +385,26 @@ describe Toy::Persistence do
   end
 
   describe "#destroy" do
+    before do
+      @doc = User.create
+    end
+
     it "should remove the instance" do
-      doc = User.create
-      doc.destroy
-      User.key?(doc.id).should be_false
+      @doc.destroy
+      User.key?(@doc.id).should be_false
+    end
+
+    it "is instrumented" do
+      setup_memory_instrumenter
+
+      @doc.destroy
+
+      event = instrumenter.events.last
+      event.name.should eq('destroy.toystore')
+      event.payload.should eq({
+        :id => @doc.id,
+        :model => User,
+      })
     end
   end