rails-dtrace 0.0.3 → 0.0.4

data/Gemfile

@@ -1,4 +1,11 @@
 source 'https://rubygems.org'
 
+gem 'ruby-usdt', :git => 'https://github.com/chrisa/ruby-usdt.git',
+          :submodules => true, :branch => 'disable_provider'
+
 # Specify your gem's dependencies in rails-dtrace.gemspec
 gemspec
+
+group :test do
+  gem "guard-rspec"
+end

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -89,7 +89,7 @@ In newer Rails, notifications become more dtrace-like. Rather than a notificatio
 
 In *rails-dtrace*, the notification name becomes the probe function, and we map `start -> entry` and `finish -> exit`.
 
-If a notification subscriber responds to #call, ActiveSupport::Notifications will send methods in the Rails 3 way. For this reason the rails-dtrace code is incompatible at this time. It could conceivably be done with some metaprogramming to trick the Rails framework, but I'd prefer to keep the rails-dtrace code small and readable.
+If a subscriber responds to `#start` and `#finish` it will work in the new way. If it does not, Rails will try to fall back to the older way with `#call`. Because of this, rails-dtrace can be used with either codebase.
 
 Arguments to probes are:
 

data/lib/rails-dtrace.rb

@@ -1,4 +1,5 @@
 require "rails-dtrace/version"
+require "rails-dtrace/provider"
 require "rails-dtrace/subscriber"
 
 require 'rails-dtrace/railtie' if defined?(Rails)

data/lib/rails-dtrace/provider.rb

@@ -0,0 +1,11 @@
+require 'usdt'
+
+module DTrace
+  module Provider
+    class << self
+      def new
+        USDT::Provider.create :ruby, :rails
+      end
+    end
+  end
+end

data/lib/rails-dtrace/subscriber.rb

@@ -1,12 +1,13 @@
 require 'usdt'
+require 'active_support/core_ext/class/attribute_accessors'
+require 'rails-dtrace/provider'
 
 module DTrace
   class Subscriber
     MAX_INT = 2147483647
 
-    cattr_reader :probes, :provider
+    cattr_reader :probes
 
-    @@provider = USDT::Provider.create :ruby, :rails
     @@probes = {}
     @@enabled = false
 
@@ -15,7 +16,9 @@ module DTrace
         @logger ||= Rails.logger if defined?(Rails)
       end
 
-      attr_writer :logger
+      def provider
+        @provider ||= DTrace::Provider.new
+      end
 
       # Rails 3.x define instruments as blocks that wrap code. When the code
       # finishes executing, subscribers are called with the start and end time.
@@ -35,8 +38,6 @@ module DTrace
         fire_probe(notification, id, payload, 'exit')
       end
 
-      protected
-
       def find_or_create_probe(probe_func, probe_name)
         probe_id = "#{probe_func}::#{probe_name}"
 

data/lib/rails-dtrace/version.rb

@@ -1,3 +1,3 @@
 module Dtrace
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/rails-dtrace.gemspec

@@ -16,5 +16,6 @@ Gem::Specification.new do |gem|
   gem.version       = Dtrace::VERSION
 
   gem.add_dependency 'ruby-usdt'
+  gem.add_dependency 'rails', '>= 3.0'
   gem.add_development_dependency 'rspec'
 end

data/spec/rails-dtrace/provider_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'rails-dtrace/provider'
+
+describe DTrace::Provider, '#new' do
+  it "should create a new USDT::Provider" do
+    provider = double("provider")
+    USDT::Provider.should_receive(:create).with(:ruby, :rails).and_return(provider)
+    DTrace::Provider.new.should == provider
+  end
+end

data/spec/rails-dtrace/subscriber_spec.rb

@@ -0,0 +1,163 @@
+require 'spec_helper'
+require 'rails-dtrace/subscriber'
+require 'support/test_provider'
+require 'support/test_logger'
+
+describe DTrace::Subscriber, 'provider' do
+  it "should return a new DTrace::Provider" do
+    provider = double('provider')
+    DTrace::Provider.should_receive(:new).and_return(provider)
+    DTrace::Subscriber.provider.should == provider
+  end
+end
+
+describe DTrace::Subscriber do
+  subject { DTrace::Subscriber }
+
+  let(:provider) {TestProvider.new}
+  let(:logger) { TestLogger.new }
+
+  before do
+    subject.stub(:provider).and_return(provider)
+    subject.stub(:logger).and_return(logger)
+    subject.probes.clear
+  end
+
+  describe '.find_or_create_probe' do
+    context "with a new notification" do
+      let(:probe) { provider.probes.last }
+
+      it "creates a DTrace probe" do
+        expect {
+          subject.find_or_create_probe("test.notification", "event")
+        }.to change {
+          provider.probes.size
+        }.by 1
+      end
+
+      it "registers the notification name as the probe function" do
+        subject.find_or_create_probe("test.notification", "event")
+        probe.probe_func.should == "test.notification"
+      end
+
+      it "registers 'event' as the probe name" do
+        subject.find_or_create_probe("test.notification", "event")
+        probe.probe_name.should == "event"
+      end
+
+      it "registers probe argument types" do
+        subject.find_or_create_probe("test.notification", "event")
+        probe.probe_args.should == [:string, :string, :integer]
+      end
+
+      it "logs the new probe name" do
+        subject.find_or_create_probe("test.notification", "event")
+        logger.latest_entry.should == "Adding DTrace probe: test.notification::event"
+      end
+
+      it "enables the DTrace provider" do
+        provider.should_not be_enabled
+        subject.find_or_create_probe("test.notification", "event")
+        provider.should be_enabled
+      end
+
+      it "disables the DTrace provider before re-enabling it" do
+        subject.find_or_create_probe("first.notification", "event")
+        provider.should_receive(:disable)
+        subject.find_or_create_probe("second.notification", "event")
+        provider.should be_enabled
+      end
+    end
+
+    context "with an existing notification" do
+      before do
+        subject.find_or_create_probe("test.notification", "event")
+      end
+
+      it "should not create a new probe" do
+        expect {
+          subject.find_or_create_probe("test.notification", "event")
+        }.not_to change {
+          provider.probes.size
+        }
+      end
+    end
+  end
+
+  describe '.call' do
+    let(:probe) { double(:fire => true, :enabled? => false) }
+
+    it "registers a probe with probe_name 'event'" do
+      subject.should_receive(:find_or_create_probe).with("test.notification", "event").and_return(probe)
+      subject.call("test.notification", nil, nil, "event-id", {})
+    end
+
+    it "fires the probe" do
+      expect {
+        subject.call("test.notification", nil, nil, "event-id", {})
+      }.to change {
+        provider.fired_probes.size
+      }.by(1)
+
+      provider.fired_probes.last.should == ["event-id", "{}", 0]
+    end
+
+    context "timestamps" do
+      it "outputs time diff in nanoseconds" do
+        start_time = Time.now
+        end_time = start_time + 1
+
+        subject.call("test.notification", start_time, end_time, "event-id", {})
+
+        provider.fired_probes.last.should == ["event-id", "{}", 1000000000]
+      end
+
+      it "bounds time diffs by the maximum value of a C int" do
+        start_time = Time.now
+        end_time = start_time + 1000000
+
+        subject.call("test.notification", start_time, end_time, "event-id", {})
+
+        provider.fired_probes.last.should == ["event-id", "{}", 2147483647]
+      end
+    end
+  end
+
+  describe '.start' do
+    let(:probe) { double(:fire => true, :enabled? => false) }
+
+    it "registers a probe with probe_name 'entry'" do
+      subject.should_receive(:find_or_create_probe).with("test.notification", "entry").and_return(probe)
+      subject.start("test.notification", "event-id", {})
+    end
+
+    it "fires the probe" do
+      expect {
+        subject.start("test.notification", "event-id", {})
+      }.to change {
+        provider.fired_probes.size
+      }.by(1)
+
+      provider.fired_probes.last.should == ["event-id", "{}", 0]
+    end
+  end
+
+  describe '.finish' do
+    let(:probe) { double(:fire => true, :enabled? => false) }
+
+    it "registers a probe with probe_name 'exit'" do
+      subject.should_receive(:find_or_create_probe).with("test.notification", "exit").and_return(probe)
+      subject.finish("test.notification", "event-id", {})
+    end
+
+    it "fires the probe" do
+      expect {
+        subject.finish("test.notification", "event-id", {})
+      }.to change {
+        provider.fired_probes.size
+      }.by(1)
+
+      provider.fired_probes.last.should == ["event-id", "{}", 0]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,6 +4,8 @@
 # loaded once.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+#
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true

data/spec/support/test_logger.rb

@@ -0,0 +1,16 @@
+class TestLogger
+  def debug(string)
+    entries << string
+  end
+
+  def latest_entry
+    entries.last
+  end
+
+  private
+
+  def entries
+    @entries ||= []
+  end
+end
+

data/spec/support/test_provider.rb

@@ -0,0 +1,36 @@
+require 'rspec/mocks'
+
+class TestProvider
+  include RSpec::Mocks::ExampleMethods
+
+  attr_reader :probes, :fired_probes
+
+  def initialize
+    super
+    @probes = []
+    @fired_probes = []
+  end
+
+  def enabled?
+    @enabled
+  end
+
+  def probe(func, name, *args)
+    p = double('probe', :probe_func => func, :probe_name => name, :probe_args => args, :enabled? => true)
+
+    p.stub(:fire) do |*args|
+      fired_probes << args
+    end
+
+    probes << p
+    p
+  end
+
+  def disable
+    @enabled = false
+  end
+
+  def enable
+    @enabled = true
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-dtrace
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-16 00:00:00.000000000 Z
+date: 2012-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-usdt
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -54,15 +70,21 @@ files:
 - .gitignore
 - .rspec
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/rails-dtrace.rb
+- lib/rails-dtrace/provider.rb
 - lib/rails-dtrace/railtie.rb
 - lib/rails-dtrace/subscriber.rb
 - lib/rails-dtrace/version.rb
 - rails-dtrace.gemspec
+- spec/rails-dtrace/provider_spec.rb
+- spec/rails-dtrace/subscriber_spec.rb
 - spec/spec_helper.rb
+- spec/support/test_logger.rb
+- spec/support/test_provider.rb
 homepage: https://github.com/sax/rails-dtrace
 licenses: []
 post_install_message: 
@@ -77,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 860083072597597217
+      hash: 2731423727273104030
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -86,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 860083072597597217
+      hash: 2731423727273104030
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -94,4 +116,8 @@ signing_key:
 specification_version: 3
 summary: Add DTrace probes to Rails
 test_files:
+- spec/rails-dtrace/provider_spec.rb
+- spec/rails-dtrace/subscriber_spec.rb
 - spec/spec_helper.rb
+- spec/support/test_logger.rb
+- spec/support/test_provider.rb