experimental-influxdb-rails 1.0.0.beta5

data/spec/support/rails5/app.rb

@@ -0,0 +1,44 @@
+require "action_controller/railtie"
+require "active_record"
+
+app = Class.new(Rails::Application)
+app.config.secret_key_base = "1234567890abcdef1234567890abcdef"
+app.config.secret_token = "1234567890abcdef1234567890abcdef"
+app.config.session_store :cookie_store, key: "_myapp_session"
+app.config.active_support.deprecation = :log
+app.config.eager_load = false
+app.config.root = __dir__
+Rails.backtrace_cleaner.remove_silencers!
+app.initialize!
+
+app.routes.draw do
+  resources :widgets
+end
+
+InfluxDB::Rails.configure do |config|
+end
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+ActiveRecord::Schema.define do
+  create_table :widgets, force: true do |t|
+    t.string :title
+
+    t.timestamps
+  end
+end
+
+class Widget < ActiveRecord::Base; end
+class ApplicationController < ActionController::Base; end
+class WidgetsController < ApplicationController
+  prepend_view_path File.join(__dir__, "..", "views")
+
+  def index
+    Widget.create!(title: "test")
+  end
+
+  def new
+    1 / 0
+  end
+end
+
+Object.const_set(:ApplicationHelper, Module.new)

data/spec/support/views/widgets/_item.html.erb

@@ -0,0 +1 @@
+<div>item</div

data/spec/support/views/widgets/index.html.erb

@@ -0,0 +1,5 @@
+<h1>Index page</h1>
+<div>
+  <%= render partial: 'item' %>
+  <%= render partial: 'item', collection: [1,2,3] %>
+</div>

data/spec/unit/backtrace_spec.rb

@@ -0,0 +1,85 @@
+require "spec_helper"
+
+RSpec.describe InfluxDB::Rails::Backtrace do
+  before do
+    @raw_backtrace = [
+      "/var/www/current/app/models/foo.rb:10:in `bar'",
+      "/var/www/current/app/models/foo.rb:19:in `baz'",
+      "/var/www/current/app/models/foo.rb:32:in `<main>'"
+    ]
+
+    @backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
+  end
+
+  it "should accept an exception into the initializer" do
+    expect(@backtrace.lines).not_to be_empty
+    expect(@backtrace.lines.count).to eq(3)
+  end
+
+  it "should correctly parse lines into their elements" do
+    line = @backtrace.lines.first
+
+    expect(line.file).to eq("/var/www/current/app/models/foo.rb")
+    expect(line.number).to eq("10")
+    expect(line.method).to eq("bar")
+  end
+
+  describe "#to_a" do
+    it "should return an array of lines" do
+      expect(@backtrace.to_a.is_a?(Array)).to be_truthy
+    end
+  end
+
+  context "nil backtrace" do
+    before do
+      @raw_backtrace = nil
+      @backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
+    end
+
+    it "should accept an exception into the initializer" do
+      expect(@backtrace.lines).to be_empty
+      expect(@backtrace.lines.count).to eq(0)
+    end
+
+    describe "#to_a" do
+      it "should return an array of lines" do
+        expect(@backtrace.to_a.is_a?(Array)).to be_truthy
+      end
+    end
+  end
+
+  describe "backtrace filters" do
+    before do
+      InfluxDB::Rails.configure do |config|
+        config.application_root = "/var/www/current"
+      end
+    end
+
+    it "should apply a single default backtrace filter correctly" do
+      filtered_backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
+
+      line = filtered_backtrace.lines.first
+      expect(line.file).to eq("[APP_ROOT]/app/models/foo.rb")
+    end
+
+    it "should all default backtrace filters correctly" do
+      extended_backtrace = @raw_backtrace.dup
+      extended_backtrace << "#{Gem.path.first}/lib/foo_gem.rb:1:in `blah'"
+
+      filtered_backtrace = InfluxDB::Rails::Backtrace.new(extended_backtrace)
+      expect(filtered_backtrace.lines.first.file).to eq("[APP_ROOT]/app/models/foo.rb")
+      expect(filtered_backtrace.lines.last.file).to eq("[GEM_ROOT]/lib/foo_gem.rb")
+    end
+
+    it "should allow the addition of custom backtrace filters" do
+      InfluxDB::Rails.configure do |config|
+        config.backtrace_filters << ->(line) { line.gsub(/foo/, "F00") }
+      end
+
+      filtered_backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
+
+      line = filtered_backtrace.lines.first
+      expect(line.file).to eq("[APP_ROOT]/app/models/F00.rb")
+    end
+  end
+end

data/spec/unit/configuration_spec.rb

@@ -0,0 +1,125 @@
+require "spec_helper"
+
+RSpec.describe InfluxDB::Rails::Configuration do
+  before do
+    @configuration = InfluxDB::Rails::Configuration.new
+  end
+
+  describe "#ignore_user_agent?" do
+    it "should be true for user agents that have been set as ignorable" do
+      @configuration.ignored_user_agents = %w[Googlebot]
+      expect(@configuration.ignore_user_agent?("Googlebot/2.1")).to be_truthy
+    end
+
+    it "should be false for user agents that have not been set as ignorable" do
+      @configuration.ignored_user_agents = %w[Googlebot]
+      expect(@configuration.ignore_user_agent?("Mozilla/5.0")).to be_falsey
+    end
+
+    it "should be false if the ignored user agents list is empty" do
+      @configuration.ignored_user_agents = []
+      expect(@configuration.ignore_user_agent?("Googlebot/2.1")).to be_falsey
+    end
+
+    it "should be false if the ignored user agents list is inadvertently set to nil" do
+      @configuration.ignored_user_agents = nil
+      expect(@configuration.ignore_user_agent?("Googlebot/2.1")).to be_falsey
+    end
+  end
+
+  describe "#retry" do
+    it "defaults to nil" do
+      expect(InfluxDB::Rails.configuration.retry).to be_nil
+    end
+
+    it "can be updated" do
+      InfluxDB::Rails.configure do |config|
+        config.retry = 5
+      end
+      expect(InfluxDB::Rails.configuration.retry).to eql(5)
+    end
+  end
+
+  describe "#open_timeout" do
+    it "defaults to 5" do
+      expect(InfluxDB::Rails.configuration.open_timeout).to eql(5)
+    end
+
+    it "can be updated" do
+      InfluxDB::Rails.configure do |config|
+        config.open_timeout = 5
+      end
+      expect(InfluxDB::Rails.configuration.open_timeout).to eql(5)
+    end
+  end
+
+  describe "#read_timeout" do
+    it "defaults to 300" do
+      expect(InfluxDB::Rails.configuration.read_timeout).to eql(300)
+    end
+
+    it "can be updated" do
+      InfluxDB::Rails.configure do |config|
+        config.read_timeout = 5
+      end
+      expect(InfluxDB::Rails.configuration.read_timeout).to eql(5)
+    end
+  end
+
+  describe "#max_delay" do
+    it "defaults to 30" do
+      expect(InfluxDB::Rails.configuration.max_delay).to eql(30)
+    end
+
+    it "can be updated" do
+      InfluxDB::Rails.configure do |config|
+        config.max_delay = 5
+      end
+      expect(InfluxDB::Rails.configuration.max_delay).to eql(5)
+    end
+  end
+
+  describe "#time_precision" do
+    it "defaults to seconds" do
+      expect(InfluxDB::Rails.configuration.time_precision).to eql("s")
+    end
+
+    it "can be updated" do
+      InfluxDB::Rails.configure do |config|
+        config.time_precision = "ms"
+      end
+      expect(InfluxDB::Rails.configuration.time_precision).to eql("ms")
+    end
+  end
+
+  describe "#rails_app_name" do
+    it "defaults to nil" do
+      expect(InfluxDB::Rails.configuration.rails_app_name).to be(nil)
+    end
+
+    it "can be set to own name" do
+      InfluxDB::Rails.configure do |config|
+        config.rails_app_name = "my-app"
+      end
+
+      expect(InfluxDB::Rails.configuration.rails_app_name).to eq("my-app")
+    end
+  end
+
+  describe "#tags_middleware" do
+    let(:middleware) { InfluxDB::Rails.configuration.tags_middleware }
+    let(:tags_example) { { a: 1, b: 2 } }
+
+    it "by default returns unmodified tags" do
+      expect(middleware.call(tags_example)).to eq tags_example
+    end
+
+    it "can be updated" do
+      InfluxDB::Rails.configure do |config|
+        config.tags_middleware = ->(tags) { tags.merge(c: 3) }
+      end
+
+      expect(middleware.call(tags_example)).to eq(tags_example.merge(c: 3))
+    end
+  end
+end

data/spec/unit/context_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+RSpec.describe InfluxDB::Rails::Context do
+  subject { described_class.new }
+
+  describe "#controller" do
+    it "does set and get" do
+      subject.controller = "Controller"
+      expect(subject.controller).to eq("Controller")
+    end
+  end
+
+  describe "#action" do
+    it "does get and set" do
+      subject.action = "action"
+      expect(subject.action).to eq("action")
+    end
+  end
+
+  describe "#location" do
+    before do
+      subject.controller = "Controller"
+      subject.action = "action"
+    end
+
+    it { expect(subject.location).to eq("Controller#action") }
+  end
+
+  describe "#reset" do
+    before do
+      subject.controller = "Controller"
+      subject.action = "action"
+    end
+
+    it "does reset the location" do
+      subject.reset
+      expect(subject.location).to be_empty
+    end
+  end
+end

data/spec/unit/exception_presenter_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+RSpec.describe InfluxDB::Rails::ExceptionPresenter do
+  before do
+    begin
+      1 / 0
+    rescue ZeroDivisionError => e
+      @exception = e
+    end
+  end
+
+  describe ".new" do
+    it "should create a new ExceptionPresenter" do
+      exception_presenter = InfluxDB::Rails::ExceptionPresenter.new(@exception)
+      expect(exception_presenter).to be_a(InfluxDB::Rails::ExceptionPresenter)
+    end
+
+    it "should accept an exception as a parameter" do
+      exception_presenter = InfluxDB::Rails::ExceptionPresenter.new(@exception)
+      expect(exception_presenter).not_to be_nil
+    end
+  end
+end

data/spec/unit/influxdb_rails_spec.rb

@@ -0,0 +1,78 @@
+require "spec_helper"
+
+RSpec.describe InfluxDB::Rails do
+  before do
+    InfluxDB::Rails.configure do |config|
+      config.application_name = "my-rails-app"
+      config.ignored_environments = []
+      config.time_precision = "ms"
+    end
+  end
+
+  describe ".current_timestamp" do
+    let(:timestamp) { 1_513_009_229_111 }
+
+    it "should return the current timestamp in the configured precision" do
+      expect(Process).to receive(:clock_gettime)
+        .with(Process::CLOCK_REALTIME, :millisecond)
+        .and_return(timestamp)
+
+      expect(InfluxDB::Rails.current_timestamp).to eq(timestamp)
+    end
+  end
+
+  describe ".ignorable_exception?" do
+    it "should be true for exception types specified in the configuration" do
+      class DummyException < RuntimeError; end
+      exception = DummyException.new
+
+      InfluxDB::Rails.configure do |config|
+        config.ignored_exceptions << "DummyException"
+      end
+
+      expect(InfluxDB::Rails.ignorable_exception?(exception)).to be_truthy
+    end
+
+    it "should be true for exception types specified in the configuration" do
+      exception = ActionController::RoutingError.new("foo")
+      expect(InfluxDB::Rails.ignorable_exception?(exception)).to be_truthy
+    end
+
+    it "should be false for valid exceptions" do
+      exception = ZeroDivisionError.new
+      expect(InfluxDB::Rails.ignorable_exception?(exception)).to be_falsey
+    end
+  end
+
+  describe "rescue" do
+    it "should transmit an exception when passed" do
+      expect(InfluxDB::Rails.client).to receive(:write_point)
+
+      InfluxDB::Rails.rescue do
+        raise ArgumentError, "wrong"
+      end
+    end
+
+    it "should also raise the exception when in an ignored environment" do
+      InfluxDB::Rails.configure do |config|
+        config.ignored_environments = %w[development test]
+      end
+
+      expect do
+        InfluxDB::Rails.rescue do
+          raise ArgumentError, "wrong"
+        end
+      end.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "rescue_and_reraise" do
+    it "should transmit an exception when passed" do
+      expect(InfluxDB::Rails.client).to receive(:write_point)
+
+      expect do
+        InfluxDB::Rails.rescue_and_reraise { raise ArgumentError, "wrong" }
+      end.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/unit/middleware/render_subscriber_spec.rb

@@ -0,0 +1,92 @@
+require "spec_helper"
+require "shared_examples/data"
+
+RSpec.describe InfluxDB::Rails::Middleware::RenderSubscriber do
+  let(:config) { InfluxDB::Rails::Configuration.new }
+  let(:logger) { double(:logger) }
+
+  before do
+    allow(config).to receive(:application_name).and_return("my-rails-app")
+    allow(config).to receive(:ignored_environments).and_return([])
+    allow(config).to receive(:time_precision).and_return("ms")
+  end
+
+  describe ".call" do
+    let(:start)   { Time.at(1_517_567_368) }
+    let(:finish)  { Time.at(1_517_567_370) }
+    let(:series_name) { "series_name" }
+    let(:payload) { { identifier: "index.html", count: 43, cache_hits: 42 } }
+    let(:data) do
+      {
+        values:    {
+          value:      2000,
+          count:      43,
+          cache_hits: 42
+        },
+        tags:      {
+          filename: "index.html",
+          location: "Foo#bar",
+        },
+        timestamp: 1_517_567_370_000
+      }
+    end
+
+    subject { described_class.new(config, series_name) }
+
+    before do
+      InfluxDB::Rails.current.controller = "Foo"
+      InfluxDB::Rails.current.action = "bar"
+    end
+
+    after do
+      InfluxDB::Rails.current.reset
+    end
+
+    context "successfully" do
+      it "writes to InfluxDB" do
+        expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(
+          series_name, data
+        )
+        subject.call("name", start, finish, "id", payload)
+      end
+
+      it_behaves_like "with additional data", ["series_name"]
+
+      context "with an empty value" do
+        before do
+          payload[:count] = nil
+          data[:values].delete(:count)
+        end
+
+        it "does not write empty value" do
+          expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(
+            series_name, data
+          )
+          subject.call("name", start, finish, "id", payload)
+        end
+      end
+
+      context "disabled" do
+        subject { described_class.new(config, nil) }
+
+        it "does not write a data point" do
+          expect_any_instance_of(InfluxDB::Client).not_to receive(:write_point)
+          subject.call("name", start, finish, "id", payload)
+        end
+      end
+    end
+
+    context "unsuccessfully" do
+      before do
+        allow(config).to receive(:logger).and_return(logger)
+        InfluxDB::Rails.configuration = config
+      end
+
+      it "does log exceptions" do
+        allow_any_instance_of(InfluxDB::Client).to receive(:write_point).and_raise("boom")
+        expect(logger).to receive(:error).with(/boom/)
+        subject.call("name", start, finish, "id", payload)
+      end
+    end
+  end
+end