cache-object 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8ed3e3acf8e4c9fe23e4a3d0f73b067e1570318
-  data.tar.gz: d7f3afcb8be6c0d3065c97e7a1e7f027c25621bf
+  metadata.gz: c2a98fe0b987a204106bb9e8f273ae36b7af394e
+  data.tar.gz: 32890adb0048d8f08c61bad3e3041c58841b2fdd
 SHA512:
-  metadata.gz: b77a6a97aa5e46e6d9d01e16f97fd1e9f724c7029fc21c230ffc622f7bb9b67545cb81407b7010063329f5a3f9b881d949aafc3f1aebdcb3b00ef867097fbdb1
-  data.tar.gz: a0418a92720e49b01648b7bc6730f6d56070d8919c5845e8e32292de0d51197405521053952382d5ccde59e7925382f1a75ef45decde9e96fc4736ba14a58fa0
+  metadata.gz: 84721447edb9c798e46b9b8e094153c8472dfef2ad52803027cdafdefc698d2a7978c437650406f331450767dcc1dbbd1786e78e9f2dda062440ebaf3a49ed84
+  data.tar.gz: 4d492ccb088d4620d9167bf18a15598b10f9b4d1ab988779a0747aef8f44f9a43d27df0db195f2e7c6261a2f51c76327ec6bc3f0f00bff724f5715efc17ab5b3

data/cache-object.gemspec

@@ -19,12 +19,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activerecord", ">= 3.0"
+  spec.add_dependency "ruby-usdt"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
 
   spec.add_development_dependency "rspec", ">= 3.0"
   spec.add_development_dependency "rspec-collection_matchers", ">= 1.0"
+  spec.add_development_dependency "rspec-its", ">= 1.0"
+
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "sqlite3"

data/lib/cache/object.rb

@@ -4,6 +4,7 @@ require 'cache/object/active_record'
 require 'cache/object/adapter'
 require 'cache/object/key_generator'
 require 'cache/object/multi_get'
+require 'cache/object/dtrace_provider'
 
 module Cache
   module Object

data/lib/cache/object/adapter.rb

@@ -9,31 +9,46 @@ module Cache
       end
 
       def write(decorator)
+        DTraceProvider.fire!(:write, decorator.instance.class.name, decorator.instance.id.to_s, ttl.to_s)
+
         decorator.keys.each do |key|
           store.write(key, decorator.instance, expires_in: ttl)
         end
       end
 
       def delete(decorator)
+        DTraceProvider.fire!(:delete, decorator.instance.class.name, decorator.instance.id.to_s)
+
         decorator.keys.each do |key|
           store.delete(key)
         end
       end
 
-      def fetch(klass, id, &block)
-        store.fetch(KeyGenerator.key_for_object(klass.name, id),
-                    expires_in: ttl,
-                    &block)
+      def fetch(klass, id)
+        DTraceProvider.fire!(:fetch, klass.name, id.to_s, ttl.to_s)
+
+        store.fetch(KeyGenerator.key_for_object(klass.name, id), expires_in: ttl) do
+          DTraceProvider.fire!(:fetch_miss, klass.name, id.to_s, ttl.to_s)
+          yield
+        end
       end
 
       def fetch_mapping(klass, attributes, &block)
-        store.fetch(KeyGenerator.key_for_mapping(klass.name, attributes),
-                    expires_in: ttl,
-                    &block)
+        DTraceProvider.fire!(:fetch_mapping, klass.name, attributes.inspect, ttl.to_s)
+
+        store.fetch(KeyGenerator.key_for_mapping(klass.name, attributes), expires_in: ttl) do
+          DTraceProvider.fire!(:fetch_mapping_miss, klass.name, attributes.inspect, ttl.to_s)
+          yield
+        end
       end
 
       def read_multi(args)
-        store.read_multi(*args)
+        total = args.size
+        result = store.read_multi(*args)
+        found = result.size
+
+        DTraceProvider.fire!(:read_multi, args.inspect, found, total - found)
+        result
       end
 
       private

data/lib/cache/object/dtrace_provider.rb

@@ -0,0 +1,43 @@
+require 'usdt'
+
+module Cache
+  module Object
+    class DTraceProvider
+      attr_reader :provider, :probes
+
+      def initialize
+        @provider = USDT::Provider.create(:ruby, :cache_object)
+
+        @probes = {
+          # args: Class name, id, ttl
+          fetch: provider.probe(:adapter, :fetch, :string, :string, :string),
+          # args: Class name, id, ttl
+          fetch_miss: provider.probe(:adapter, :fetch_miss, :string, :string, :string),
+          # args: Class name, attributes.inspect, ttl
+          fetch_mapping: provider.probe(:adapter, :fetch_mapping, :string, :string, :string),
+          # args: Class name, attributes.inspect, ttl
+          fetch_mapping_miss: provider.probe(:adapter, :fetch_mapping_miss, :string, :string, :string),
+          # args: args.inspect, hits, misses
+          read_multi: provider.probe(:adapter, :read_multi, :string, :integer, :integer),
+          # args: class_name, id, ttl
+          write: provider.probe(:adapter, :write, :string, :string, :string),
+          # args: class_name, id
+          delete: provider.probe(:adapter, :delete, :string, :string, :string)
+        }
+      end
+
+      def self.provider
+        @provider ||= new.tap do |p|
+          p.provider.enable
+        end
+      end
+
+      def self.fire!(probe_name, *args)
+        raise "Unknown probe: #{probe_name}" unless self.provider.probes[probe_name]
+        probe = self.provider.probes[probe_name]
+        probe.fire(*args) if probe.enabled?
+      end
+    end
+  end
+end
+

data/lib/cache/object/version.rb

@@ -1,5 +1,5 @@
 module Cache
   module Object
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/spec/cache/object/adapter_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe Cache::Object::Adapter do
 
   let(:cache_store) { double("CacheStore", write: true) }
   let(:adapter) { Cache::Object::Adapter.new(cache_store) }
-  let(:instance) { double(class: double(name: "User")) }
+  let(:instance) { double(class: double(name: "User"), id: "1") }
 
   describe "#delete" do
     it "dispatches to delete" do
@@ -17,6 +17,17 @@ RSpec.describe Cache::Object::Adapter do
 
       adapter.delete(double(instance: instance, keys: ["User-1", "User-1-blah"]))
     end
+
+    describe "probes" do
+      before do
+        allow(cache_store).to receive(:delete)
+      end
+
+      it "fires the write probe" do
+        expect(Cache::Object::DTraceProvider).to receive(:fire!).with(:delete, "User", "1")
+        adapter.delete(double(instance: instance, keys: ["User-1", "User-1-blah"]))
+      end
+    end
   end
 
   describe "#write" do
@@ -26,6 +37,17 @@ RSpec.describe Cache::Object::Adapter do
 
       adapter.write(double(instance: instance, keys: ["User-1", "User-1-blah"]))
     end
+
+    describe "probes" do
+      before do
+        allow(cache_store).to receive(:write)
+      end
+
+      it "fires the write probe" do
+        expect(Cache::Object::DTraceProvider).to receive(:fire!).with(:write, "User", "1", "118")
+        adapter.write(double(instance: instance, keys: ["User-1", "User-1-blah"]))
+      end
+    end
   end
 
   describe "#fetch" do
@@ -35,6 +57,23 @@ RSpec.describe Cache::Object::Adapter do
         adapter.fetch(instance.class, 1, &b)
       }.to yield_control
     end
+
+    describe "probes" do
+      it "fires the fetch probe" do
+        allow(cache_store).to receive(:fetch)
+        expect(Cache::Object::DTraceProvider).to receive(:fire!).with(:fetch, "User", "1", "118")
+        adapter.fetch(instance.class, 1) {}
+      end
+
+      describe "when fetch is a miss" do
+        it "fires the fetch and fetch_miss probes" do
+          allow(cache_store).to receive(:fetch).and_yield
+          expect(Cache::Object::DTraceProvider).to receive(:fire!).with(:fetch, "User", "1", "118")
+          expect(Cache::Object::DTraceProvider).to receive(:fire!).with(:fetch_miss, "User", "1", "118")
+          adapter.fetch(instance.class, 1) {}
+        end
+      end
+    end
   end
 
   describe "#fetch_mapping" do
@@ -44,5 +83,37 @@ RSpec.describe Cache::Object::Adapter do
         adapter.fetch_mapping(instance.class, { user_id: 1, name: "bob" }, &b)
       }.to yield_control
     end
+
+    describe "probes" do
+      it "fires the fetch probe" do
+        allow(cache_store).to receive(:fetch)
+        expect(Cache::Object::DTraceProvider).to receive(:fire!).with(:fetch_mapping, "User", { user_id: 1, name: "bob" }.inspect, "118")
+        adapter.fetch_mapping(instance.class, { user_id: 1, name: "bob" }) {}
+      end
+
+      describe "when fetch is a miss" do
+        it "fires the fetch and fetch_miss probes" do
+          allow(cache_store).to receive(:fetch).and_yield
+          expect(Cache::Object::DTraceProvider).to receive(:fire!).with(:fetch_mapping, "User", { user_id: 1, name: "bob" }.inspect, "118")
+          expect(Cache::Object::DTraceProvider).to receive(:fire!).with(:fetch_mapping_miss, "User", { user_id: 1, name: "bob" }.inspect, "118")
+          adapter.fetch_mapping(instance.class, { user_id: 1, name: "bob" }) {}
+        end
+      end
+    end
+  end
+
+  describe "#read_multi" do
+    it "calls read_multi on the cache_store" do
+      expect(cache_store).to receive(:read_multi).with("blah").and_return({})
+      adapter.read_multi(["blah"])
+    end
+
+    describe "probes" do
+      it "fires the read_multi probe" do
+        expect(Cache::Object::DTraceProvider).to receive(:fire!).with(:read_multi, ["blah", "blah2"].inspect, 1, 1)
+        allow(cache_store).to receive(:read_multi).and_return({"blah2" => 1})
+        adapter.read_multi(["blah", "blah2"])
+      end
+    end
   end
 end

data/spec/cache/object/dtrace_provider_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+RSpec.describe Cache::Object::DTraceProvider do
+  describe 'initialize' do
+    it 'creates a new provider' do
+      expect(USDT::Provider).to receive(:create).with(:ruby, :cache_object).and_return(double(probe: true))
+      Cache::Object::DTraceProvider.new
+    end
+  end
+
+  describe 'probes' do
+    let(:provider) { Cache::Object::DTraceProvider.new }
+
+    describe '#fetch' do
+      subject(:probe) { provider.probes[:fetch] }
+      its(:function) { should eq :adapter }
+      its(:name) { should eq :fetch }
+      its(:arguments) { should eq [:string, :string, :string] }
+    end
+
+    describe '#fetch_miss' do
+      subject(:probe) { provider.probes[:fetch_miss] }
+      its(:function) { should eq :adapter }
+      its(:name) { should eq :fetch_miss }
+      its(:arguments) { should eq [:string, :string, :string] }
+    end
+
+
+    describe '#fetch_mapping' do
+      subject(:probe) { provider.probes[:fetch_mapping] }
+      its(:function) { should eq :adapter }
+      its(:name) { should eq :fetch_mapping }
+      its(:arguments) { should eq [:string, :string, :string] }
+    end
+
+    describe '#fetch_mapping_miss' do
+      subject(:probe) { provider.probes[:fetch_mapping_miss] }
+      its(:function) { should eq :adapter }
+      its(:name) { should eq :fetch_mapping_miss }
+      its(:arguments) { should eq [:string, :string, :string] }
+    end
+
+
+    describe '#read_multi' do
+      subject(:probe) { provider.probes[:read_multi] }
+      its(:function) { should eq :adapter }
+      its(:name) { should eq :read_multi }
+      its(:arguments) { should eq [:string, :integer, :integer] }
+    end
+
+    describe '#write' do
+      subject(:probe) { provider.probes[:write] }
+      its(:function) { should eq :adapter }
+      its(:name) { should eq :write }
+      its(:arguments) { should eq [:string, :string, :string] }
+    end
+
+    describe '#delete' do
+      subject(:probe) { provider.probes[:delete] }
+      its(:function) { should eq :adapter }
+      its(:name) { should eq :delete }
+      its(:arguments) { should eq [:string, :string, :string] }
+    end
+  end
+
+  describe ".fire!" do
+    it "raises if no provider" do
+      expect { Cache::Object::DTraceProvider.fire!(:fake) }.to raise_error
+    end
+
+    describe "when probe is enabled" do
+      it "receives event" do
+        probe = double(enabled?: true)
+        provider = double(probes: { boom: probe})
+        allow(Cache::Object::DTraceProvider).to receive(:provider).and_return(provider)
+        expect(probe).to receive(:fire).with("hai")
+        Cache::Object::DTraceProvider.fire!(:boom, "hai")
+      end
+    end
+
+    describe "when probe is disabled" do
+      it "does not receives event" do
+        probe = double(enabled?: false)
+        provider = double(probes: { boom: probe})
+        allow(Cache::Object::DTraceProvider).to receive(:provider).and_return(provider)
+        expect(probe).to receive(:fire).never
+        Cache::Object::DTraceProvider.fire!(:boom, "hai")
+      end
+    end
+  end
+
+  describe '::provider' do
+    it 'returns a DTraceProvider' do
+      provider = Cache::Object::DTraceProvider.provider
+      expect(provider).to be_a(Cache::Object::DTraceProvider)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'cache/object'
 require 'rspec/collection_matchers'
+require 'rspec/its'
 RSpec.configure do |config|
 
   config.before(:each) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cache-object
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Matt Camuto
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-usdt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -151,6 +179,7 @@ files:
 - lib/cache/object/active_record.rb
 - lib/cache/object/adapter.rb
 - lib/cache/object/config.rb
+- lib/cache/object/dtrace_provider.rb
 - lib/cache/object/instance_decorator.rb
 - lib/cache/object/key_generator.rb
 - lib/cache/object/multi_get.rb
@@ -158,6 +187,7 @@ files:
 - spec/cache/object/active_record_spec.rb
 - spec/cache/object/adapter_spec.rb
 - spec/cache/object/config_spec.rb
+- spec/cache/object/dtrace_provider_spec.rb
 - spec/cache/object/instance_decorator_spec.rb
 - spec/cache/object/multi_get_spec.rb
 - spec/features/cache_object_spec.rb
@@ -191,8 +221,10 @@ test_files:
 - spec/cache/object/active_record_spec.rb
 - spec/cache/object/adapter_spec.rb
 - spec/cache/object/config_spec.rb
+- spec/cache/object/dtrace_provider_spec.rb
 - spec/cache/object/instance_decorator_spec.rb
 - spec/cache/object/multi_get_spec.rb
 - spec/features/cache_object_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
+has_rdoc: