RubyGems - rollbar - Versions diffs - 2.7.1 → 2.8.0 - Mend

rollbar 2.7.1 → 2.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (34) hide show

checksums.yaml +4 -4
data/.gitignore +4 -0
data/.gitmodules +3 -0
data/.rubocop.yml +21 -0
data/.travis.yml +1 -4
data/CHANGELOG.md +25 -0
data/README.md +146 -4
data/Rakefile +5 -3
data/data/rollbar.snippet.js +1 -0
data/docs/configuration_options.md +281 -0
data/lib/rollbar.rb +122 -32
data/lib/rollbar/configuration.rb +18 -0
data/lib/rollbar/exceptions.rb +3 -0
data/lib/rollbar/js.rb +32 -0
data/lib/rollbar/js/frameworks.rb +6 -0
data/lib/rollbar/js/frameworks/rails.rb +29 -0
data/lib/rollbar/js/middleware.rb +129 -0
data/lib/rollbar/js/version.rb +5 -0
data/lib/rollbar/lazy_store.rb +83 -0
data/lib/rollbar/tasks/rollbar.cap +1 -1
data/lib/rollbar/version.rb +1 -1
data/lib/tasks/tasks.rake +13 -0
data/rollbar.gemspec +1 -1
data/spec/dummyapp/app/controllers/home_controller.rb +4 -0
data/spec/dummyapp/app/views/js/test.html.erb +1 -0
data/spec/dummyapp/app/views/layouts/simple.html.erb +18 -0
data/spec/dummyapp/config/initializers/rollbar.rb +5 -2
data/spec/dummyapp/config/routes.rb +1 -0
data/spec/rollbar/js/frameworks/rails_spec.rb +19 -0
data/spec/rollbar/js/middleware_spec.rb +154 -0
data/spec/rollbar/lazy_store_spec.rb +99 -0
data/spec/rollbar_spec.rb +272 -11
data/spec/spec_helper.rb +2 -8
metadata +26 -4

data/lib/rollbar/js/version.rb ADDED

@@ -0,0 +1,5 @@
+module Rollbar
+  module Js
+    VERSION = "0.1.0"
+  end
+end

data/lib/rollbar/lazy_store.rb ADDED

@@ -0,0 +1,83 @@
+module Rollbar
+  class LazyStore
+    attr_reader :loaded_data
+    private :loaded_data
+    attr_reader :raw
+    def initialize(initial_data)
+      initial_data ||= {}
+      @raw = initial_data
+      @loaded_data = {}
+    end
+    def eql?(other)
+      if other.is_a?(self.class)
+        raw.eql?(other.raw)
+      else
+        raw.eql?(other)
+      end
+    end
+    def ==(other)
+      if other.is_a?(self.class)
+        raw == other.raw
+      else
+        raw == other
+      end
+    end
+    # With this version of clone we ensure that the loaded_data is empty
+    def clone
+      self.class.new(raw.clone)
+    end
+    def [](key)
+      load_value(key)
+    end
+    def []=(key, value)
+      raw[key] = value
+      loaded_data.delete(key)
+      value
+    end
+    def data
+      raw.reduce({}) do |acc, (k, _)|
+        acc[k] = self[k]
+        acc
+      end
+    end
+    private
+    def load_value(key)
+      return loaded_data[key] if loaded_data.key?(key)
+      return unless raw.key?(key)
+      value = find_value(key)
+      loaded_data[key] = value
+      value
+    end
+    def find_value(key)
+      value = raw[key]
+      value.respond_to?(:call) ? value.call : value
+    end
+    def method_missing(method_sym, *args, &block)
+      return raw.send(method_sym, *args, &block) if raw.respond_to?(method_sym)
+      super
+    end
+    def respond_to?(method_sym)
+      super || raw.respond_to?(method_sym)
+    end
+  end
+end

data/lib/rollbar/tasks/rollbar.cap CHANGED

@@ -6,7 +6,7 @@ namespace :rollbar do
   desc 'Send the deployment notification to Rollbar.'
   task :deploy do
-    on roles fetch(:rollbar_role) do
+    on primary fetch(:rollbar_role) do
       warn("You need to upgrade capistrano to '>= 3.1' version in order to correctly report deploys to Rollbar. (On 3.0, the reported revision will be incorrect.)") if Capistrano::VERSION =~ /^3\.0/
       uri    = URI.parse 'https://api.rollbar.com/api/1/deploy/'

data/lib/rollbar/version.rb CHANGED

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = "2.7.1"
+  VERSION = "2.8.0"
 end

data/lib/tasks/tasks.rake ADDED

@@ -0,0 +1,13 @@
+require 'fileutils'
+desc 'Update rollbar.js snippet'
+task :update_snippet do
+  input_path = File.expand_path("../../../rollbar.js/dist/rollbar.snippet.js", __FILE__)
+  output_path = File.expand_path("../../../data/rollbar.snippet.js", __FILE__)
+  output_dir = File.expand_path("../../../data/", __FILE__)
+  $stdout.write("Copying #{input_path} to #{output_path}\n")
+  FileUtils.mkdir_p(output_dir)
+  FileUtils.copy(input_path, output_path)
+end

data/rollbar.gemspec CHANGED

@@ -23,7 +23,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec-rails', '>= 2.14.0'
   gem.add_development_dependency 'database_cleaner', '~> 1.0.0'
   gem.add_development_dependency 'girl_friday', '>= 0.11.1'
-  gem.add_development_dependency 'sucker_punch', '>= 1.0.0' if RUBY_VERSION != '1.8.7'
+  gem.add_development_dependency 'sucker_punch', '~> 1.0.0' if RUBY_VERSION != '1.8.7'
   gem.add_development_dependency 'sidekiq', '>= 2.13.0' if RUBY_VERSION != '1.8.7'
   gem.add_development_dependency 'genspec', '>= 0.2.8'
   gem.add_development_dependency 'sinatra'

data/spec/dummyapp/app/controllers/home_controller.rb CHANGED

@@ -28,6 +28,10 @@ class HomeController < ApplicationController
     foo = bar
   end
+  def test_rollbar_js
+    render 'js/test', :layout => 'simple'
+  end
   def file_upload
     this = will_crash
   end

data/spec/dummyapp/app/views/js/test.html.erb ADDED

	@@ -0,0 +1 @@
1	+ Testing Rollbar JS

data/spec/dummyapp/app/views/layouts/simple.html.erb ADDED

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title><%= content_for?(:title) ? yield(:title) : "Dummyapp" %></title>
+    <meta name="description" content="<%= content_for?(:description) ? yield(:description) : "Dummyapp" %>">
+    <%= yield(:head) %>
+  </head>
+  <body class="<%= controller_name %> <%= action_name %>">
+    <div id="container" class="container">
+      <div id="main" role="main">
+        <%= yield %>
+      </div>
+      <footer>
+      </footer>
+    </div> <!--! end of #container -->
+  </body>
+</html>

data/spec/dummyapp/config/initializers/rollbar.rb CHANGED

@@ -1,7 +1,10 @@
 Rollbar.configure do |config|
   config.access_token = 'aaaabbbbccccddddeeeeffff00001111'
   config.request_timeout = 60
+  config.js_enabled = true
+  config.js_options = {
+    :foo => :bar
+  }
   # By default, Rollbar will try to call the `current_user` controller method
   # to fetch the logged-in user object, and then call that object's `id`,
   # `username`, and `email` methods to fetch those properties. To customize:
@@ -17,4 +20,4 @@ Rollbar.configure do |config|
   # Valid levels: 'critical', 'error', 'warning', 'info', 'debug', 'ignore'
   # 'ignore' will cause the exception to not be reported at all.
   # config.exception_level_filters.merge!('MyCriticalException' => 'critical')
-end unless ENV['SKIP_DUMMY_ROLLBAR'] == "true"
+end

data/spec/dummyapp/config/routes.rb CHANGED

@@ -13,4 +13,5 @@ Dummy::Application.routes.draw do
   get '/set_session_data' => 'home#set_session_data'
   get '/use_session_data' => 'home#use_session_data'
+  get '/test_rollbar_js' => 'home#test_rollbar_js'
 end

data/spec/rollbar/js/frameworks/rails_spec.rb ADDED

@@ -0,0 +1,19 @@
+require 'spec_helper'
+describe ApplicationController, :type => 'request' do
+  before do
+    Rollbar.configure do |config|
+      config.js_options = { :foo => :bar }
+      config.js_enabled = true
+    end
+  end
+  it 'renders the snippet and config in the response', :type => 'request' do
+    get '/test_rollbar_js'
+    snippet_from_submodule = File.read(File.expand_path('../../../../../rollbar.js/dist/rollbar.snippet.js', __FILE__))
+    expect(response.body).to include("var _rollbarConfig = #{Rollbar::configuration.js_options.to_json};")
+    expect(response.body).to include(snippet_from_submodule)
+  end
+end

data/spec/rollbar/js/middleware_spec.rb ADDED

@@ -0,0 +1,154 @@
+require 'spec_helper'
+require 'rollbar/js/middleware'
+describe Rollbar::Js::Middleware do
+  subject { described_class.new(app, config) }
+  let(:env) { {} }
+  let(:config) { {} }
+  let(:app) do
+    proc do |_|
+      [status, headers, body]
+    end
+  end
+  let(:html) do
+    <<-END
+<html>
+  <head>
+    <link rel="stylesheet" href="url" type="text/css" media="screen" />
+    <script type="text/javascript" src="foo"></script>
+  </head>
+  <body>
+    <h1>Testing the middleware</h1>
+  </body>
+</html>
+END
+  end
+  let(:snippet) { 'THIS IS THE SNIPPET' }
+  let(:content_type) { 'text/html' }
+  before do
+    allow(subject).to receive(:js_snippet).and_return(snippet)
+  end
+  shared_examples "doesn't add the snippet or config", :add_js => false do
+    it "doesn't add the snippet or config" do
+      res_status, res_headers, response = subject.call(env)
+      new_body = response.join
+      expect(new_body).not_to include(snippet)
+      expect(new_body).not_to include(config[:options].to_json)
+      expect(new_body).to be_eql(body.join)
+      expect(res_status).to be_eql(status)
+      expect(res_headers['Content-Type']).to be_eql(content_type)
+    end
+  end
+  describe '#call' do
+    context 'with enabled config' do
+      let(:config) do
+        {
+          :enabled => true,
+          :options => { :foo => :bar }
+        }
+      end
+      context 'having a html 200 response' do
+        let(:body) { [html] }
+        let(:status) { 200 }
+        let(:headers) do
+          { 'Content-Type' => content_type }
+        end
+        it 'adds the config and the snippet to the response' do
+          res_status, res_headers, response = subject.call(env)
+          new_body = response.body.join
+          expect(new_body).to include(snippet)
+          expect(new_body).to include(config[:options].to_json)
+          expect(res_status).to be_eql(status)
+          expect(res_headers['Content-Type']).to be_eql(content_type)
+        end
+      end
+      context 'having a html 200 response without head', :add_js => false do
+        let(:body) { ['foobar'] }
+        let(:status) { 200 }
+        let(:headers) do
+          { 'Content-Type' => content_type }
+        end
+      end
+      context 'having a html 302 response', :add_js => false do
+        let(:body) { ['foobar'] }
+        let(:status) { 302 }
+        let(:headers) do
+          { 'Content-Type' => content_type }
+        end
+      end
+      context 'having the js already injected key in env', :add_js => false do
+        let(:body) { ['foobar'] }
+        let(:status) { 200 }
+        let(:headers) do
+          { 'Content-Type' => content_type }
+        end
+        let(:env) do
+          { described_class::JS_IS_INJECTED_KEY => true }
+        end
+      end
+      context 'having an attachment', :add_js => false do
+        let(:content_type) { 'text/plain' }
+        let(:body) { ['foobar'] }
+        let(:status) { 200 }
+        let(:headers) do
+          { 'Content-Disposition' => 'attachment',
+            'Content-Type' => content_type
+          }
+        end
+      end
+      context 'with an exception raised while adding the js', :add_js => false do
+        let(:body) { [html] }
+        let(:status) { 200 }
+        let(:headers) do
+          { 'Content-Type' => content_type }
+        end
+        before do
+          allow(subject).to receive(:add_js).and_raise(StandardError.new)
+        end
+      end
+    end
+    context 'having the config disabled', :add_js => false do
+      let(:body) { ['foobar'] }
+      let(:status) { 302 }
+      let(:headers) do
+        { 'Content-Type' => content_type }
+      end
+      let(:config) do
+        {
+          :enabled => false,
+          :options => { :foo => :bar }
+        }
+      end
+    end
+    context 'if the app raises' do
+      let(:exception) { StandardError.new }
+      let(:app) do
+        proc do |_|
+          raise exception
+        end
+      end
+      it 'propagates the exception' do
+        expect do
+          app.call(env)
+        end.to raise_exception(exception)
+      end
+    end
+  end
+end

data/spec/rollbar/lazy_store_spec.rb ADDED

@@ -0,0 +1,99 @@
+require 'spec_helper'
+require 'rollbar/lazy_store'
+describe Rollbar::LazyStore do
+  subject { Rollbar::LazyStore.new(data) }
+  let(:lazy_value) do
+    proc { :bar }
+  end
+  let(:data) do
+    {
+      :somekey => :value,
+      :foo => lazy_value
+    }
+  end
+  describe '#[]' do
+    it 'gets the regular values' do
+      expect(subject[:somekey]).to be_eql(:value)
+    end
+    it 'gets the lazy values and evaluates them just once' do
+      expect(lazy_value).to receive(:call).once.and_call_original
+      value1 = subject[:foo]
+      value2 = subject[:foo]
+      expect(value1).to be_eql(:bar)
+      expect(value2).to be_eql(:bar)
+    end
+  end
+  describe '#[]=' do
+    before do
+      # load data in :foo
+      subject[:foo]
+    end
+    it 'sets the data and clears the loaded data' do
+      subject[:foo] = 'something-else'
+      expect(subject[:foo]).to be_eql('something-else')
+    end
+  end
+  describe '#eql?' do
+    context 'passing a Hash' do
+      it 'checks correctly eql?' do
+        expect(subject.eql?(data)).to be(true)
+        expect(subject.eql?({})).to be(false)
+      end
+    end
+    context 'passing a LazyStore' do
+      it 'checks correctly eql?' do
+        expect(subject.eql?(Rollbar::LazyStore.new(data))).to be(true)
+        expect(subject.eql?(Rollbar::LazyStore.new({}))).to be(false)
+      end
+    end
+  end
+  describe '#==' do
+    context 'passing a Hash' do
+      it 'checks correctly eql?' do
+        expect(subject == data).to be(true)
+        expect(subject == {}).to be(false)
+      end
+    end
+    context 'passing a LazyStore' do
+      it 'checks correctly eql?' do
+        expect(subject == Rollbar::LazyStore.new(data)).to be(true)
+        expect(subject == Rollbar::LazyStore.new({})).to be(false)
+      end
+    end
+  end
+  describe '#data' do
+    it 'returns the data with lazy values loaded' do
+      value = subject.data
+      expected_value = {
+        :somekey => :value,
+        :foo => :bar
+      }
+      expect(value).to be_eql(expected_value)
+    end
+  end
+  describe '#clone' do
+    it 'returns a new object, with same data and empty loaded_data' do
+      new_scope = subject.clone
+      expect(new_scope.instance_variable_get('@loaded_data')).to be_empty
+      expect(new_scope.raw).to be_eql(subject.raw)
+    end
+  end
+end