chillout 0.8.7 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6631dcadcf73b03ed3a10a4ef2e7d79ac081c3cf
-  data.tar.gz: e2097e2a4d295b7fd0f6c36f6eac008aad94523c
+  metadata.gz: 146543514bd9a57101ff6edfa2e7f4b9230c6b32
+  data.tar.gz: 8d99f8a62af72773cbe7344ccef119a435b066a1
 SHA512:
-  metadata.gz: d10872b0af3d30b51ef10dfaa6530e177cc1d3f329ea39a621127d691dc10d9befc1a73e4fc2e3029fa06c0605df6fc51369bf0d662f0f3babd603a8ec6fe61b
-  data.tar.gz: b1a7b075053a58cb0e06e7f75cac2f6c6c4ca255c7a8abe9056eae3c05ea9549ece21bc5341ff6ac263631f479466d4474f8c1571ec77f5b0e2024a2079639b7
+  metadata.gz: 61bc007ffd4972c0a1d6bbd38288e326e40f4a11609be28e9454438a4cae84e51d9c3a52245f8a8f703e8fca510033fefb62226d63432fc6967c70c43c256f32
+  data.tar.gz: d7d9a20333b07c7a11139609060ef23669602615859a94e6c452d74e3ab14d978122dd7c878dc9103cbdfbe265e2ef12d3a174c25d7a222622d67d005e38c245

data/.travis.yml

@@ -44,6 +44,14 @@ matrix:
     env: SAMPLE_APP=rails_5_0_3 STRATEGY=active_job SIDEKIQ_SUPPORTED=true
   - rvm: 2.4.1
     env: SAMPLE_APP=rails_5_1_1 STRATEGY=active_job SIDEKIQ_SUPPORTED=true
+  - rvm: 2.3.4
+    env: SAMPLE_APP=rails_4_0_0 STATE_MACHINE_VERSION=1.1.2
+  - rvm: 2.4.1
+    env: SAMPLE_APP=rails_5_1_1 STATE_MACHINES_ACTIVERECORD_VERSION=">=0.5"
+  - rvm: 2.4.1
+    env: SAMPLE_APP=rails_5_0_3 STATE_MACHINES_ACTIVERECORD_VERSION=0.4
+  - rvm: 2.4.1
+    env: SAMPLE_APP=rails_4_2_8 STATE_MACHINES_ACTIVERECORD_VERSION=0.3 STATE_MACHINES_VERSION=0.4
 notifications:
   slack:
     secure: 6IAlvKplFv94Vaf0LES197FFIgt5cs1fUFA9820mmeoTGLDQcN+4Hpv+2/NRRqrfb2k+V+uFKmsuY8azHBoKHLIzH6d1T0NS82j54Ti+tm0iFZaKLHVp8TxuIge0/e0Niamod5mMziLTg6KcM+zNBYcoxS3th1mQNWQ2mtD9JZ8=

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # chillout gem changes
 
+0.8.8
+-----
+
+- Introduced `state_machine` / `state_machines-activerecord` transitions monitoring.
+
 0.8.7
 -----
 

data/lib/chillout.rb

@@ -4,6 +4,7 @@ require "chillout/creations_container"
 require "chillout/custom_advanced_metric"
 require "chillout/middleware/creations_monitor"
 require "chillout/integrations/sidekiq"
+require "chillout/integrations/state_machine"
 require "chillout/subscribers/action_controller_notifications"
 require "chillout/server_side/dispatcher"
 require "chillout/server_side/server_side"

data/lib/chillout/integrations/state_machine.rb

@@ -0,0 +1,90 @@
+module Chillout
+  module Integrations
+
+    class StateMachineTransitionMeasurement
+
+      def initialize(instance, transition, started, finished)
+        @class     = instance.class.name
+
+        @attribute = transition.attribute.to_s
+        @event     = transition.event.to_s
+        @from      = transition.from.to_s
+        @to        = transition.to.to_s
+
+        @started   = started.utc
+        @finished  = finished.utc
+        @duration = 1000.0 * (@finished.to_f - @started.to_f)
+      end
+
+      def job_class
+        @class
+      end
+
+      def as_measurements()
+        [{
+          series: "#{@class}##{@attribute}",
+          tags: {
+            class: @class,
+            attribute: @attribute,
+            event: @event,
+            from: @from,
+            to: @to,
+          },
+          timestamp: @finished.iso8601,
+          values: {
+            value: 1,
+            duration: @duration.to_f,
+          },
+        }]
+      end
+
+    end
+
+    class StateMachine
+
+      def available?
+        if defined?(::StateMachines::Integrations::ActiveRecord::VERSION) && defined?(::ActiveRecord)
+          return Gem::Version.new(::StateMachines::Integrations::ActiveRecord::VERSION) >= Gem::Version.new('0.3.0')
+        end
+        if defined?(::StateMachine) && defined?(::ActiveRecord)
+          require 'state_machine/version'
+          return Gem::Version.new(::StateMachine::VERSION) >= Gem::Version.new('1.1.2')
+        end
+      rescue
+        false
+      end
+
+      def enable(client)
+        callback_class = defined?(::StateMachine::Callback) ? ::StateMachine::Callback : ::StateMachines::Callback
+        ActiveRecord::Base.subclasses.select do |klass|
+          klass.respond_to?(:state_machines)
+        end.each do |klass|
+          klass.state_machines.each_value do |state_machine|
+            state_machine.callbacks[:before].unshift(
+              callback_class.new(:around, &callback(client))
+            )
+          end
+        end
+      end
+
+      private
+
+      def callback(client)
+        Proc.new do |instance, transition, block|
+          started = Time.now.utc
+          block.call
+          finished = Time.now.utc
+          client.enqueue(StateMachineTransitionMeasurement.new(
+            instance,
+            transition,
+            started,
+            finished,
+          ))
+          true
+        end
+      end
+
+    end
+
+  end
+end

data/lib/chillout/railtie.rb

@@ -4,15 +4,24 @@ require 'chillout/listener_injector'
 module Chillout
   class Railtie < Rails::Railtie
     config.chillout = ActiveSupport::OrderedOptions.new
+    chillout_init = nil
+
     initializer "chillout.creations_listener_initialization" do |rails_app|
       chillout_config = rails_app.config.chillout
       if chillout_config.present?
-        RailsInitializer.new(rails_app, chillout_config, Rails.logger).start
+        chillout_init = RailsInitializer.new(rails_app, chillout_config, Rails.logger)
+        chillout_init.start
       else
         Rails.logger.debug "[Chillout] Not enabled for #{Rails.env}"
       end
     end
 
+    initializer "chillout.after_eager_load", after: :eager_load! do
+      if chillout_init
+        chillout_init.after_eager_load
+      end
+    end
+
     rake_tasks do
       load "chillout/tasks.rb"
     end
@@ -53,6 +62,11 @@ module Chillout
       Chillout.client = client
     end
 
+    def after_eager_load
+      state_machine = Integrations::StateMachine.new
+      state_machine.enable(Chillout.client) if state_machine.available?
+    end
+
     private
 
     def options

data/lib/chillout/version.rb

@@ -1,3 +1,3 @@
 module Chillout
-  VERSION = "0.8.7"
+  VERSION = "0.8.8"
 end

data/test/acceptance/client_sends_state_machine_metrics_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+class ClientSendsStateMachineMetrics < AcceptanceTestCase
+
+  def test_client_sends_state_machine_metrics
+    test_app      = TestApp.new
+    test_endpoint = TestEndpoint.new(port: 8085)
+    test_user     = TestUser.new
+
+    test_endpoint.listen
+    test_app.boot(chillout_port: 8085)
+    if ENV['STRATEGY'] != 'active_job'
+      assert test_endpoint.has_received_information_about_startup
+    end
+    test_user.transition_entity('Yay')
+    assert transition = test_endpoint.has_one_state_machine_metric
+
+    assert_equal "Entity#state", transition["series"]
+    assert_equal "Entity", transition["tags"]["class"]
+    assert_equal "state", transition["tags"]["attribute"]
+    assert_equal "ignite", transition["tags"]["event"]
+    assert_equal "parked", transition["tags"]["from"]
+    assert_equal "idling", transition["tags"]["to"]
+
+    assert_equal 1, transition["values"]["value"]
+    assert_operator 100, :<, transition["values"]["duration"]
+    assert_operator 600, :>, transition["values"]["duration"]
+
+    assert transition = test_endpoint.has_one_state_machine_metric
+
+    assert_equal "Entity#state", transition["series"]
+    assert_equal "Entity", transition["tags"]["class"]
+    assert_equal "state", transition["tags"]["attribute"]
+    assert_equal "shift_up", transition["tags"]["event"]
+    assert_equal "idling", transition["tags"]["from"]
+    assert_equal "first_gear", transition["tags"]["to"]
+
+    assert_equal 1, transition["values"]["value"]
+    assert_operator   0, :<, transition["values"]["duration"]
+    assert_operator 200, :>, transition["values"]["duration"]
+  ensure
+    test_app.shutdown if test_app
+  end
+
+end

data/test/support/rails_4_0_0/Gemfile

@@ -3,3 +3,4 @@ source 'https://rubygems.org'
 gem 'rails', '4.0.0'
 gem 'sqlite3'
 gem 'chillout', :path => '../../../'
+gem "state_machine", ENV['STATE_MACHINE_VERSION'] || ">= 1.2"

data/test/support/rails_4_0_0/app/controllers/entities_controller.rb

@@ -31,7 +31,7 @@ class EntitiesController < ApplicationController
   end
 
   def create
-    @entity = Entity.new(params.require(:entity).permit!)
+    @entity = Entity.new(params.require(:entity).permit!.merge(state: "parked"))
 
     respond_to do |format|
       if @entity.save

data/test/support/rails_4_0_0/app/controllers/transitions_controller.rb

@@ -0,0 +1,8 @@
+class TransitionsController < ApplicationController
+  def create
+    e = Entity.new(state: "parked")
+    e.ignite
+    e.shift_up
+    head :ok
+  end
+end

data/test/support/rails_4_0_0/app/models/entity.rb

@@ -1,2 +1,36 @@
 class Entity < ActiveRecord::Base
-end
+  state_machine :initial => :parked do
+    before_transition :parked => any - :parked, do: :put_on_seatbelt
+    after_transition any => :parked do |vehicle, _transition|
+      vehicle.seatbelt = 'off'
+    end
+    around_transition :benchmark
+
+    event :ignite do
+      transition :parked => :idling
+    end
+
+    event :shift_up do
+      transition :idling => :first_gear,
+        :first_gear => :second_gear,
+        :second_gear => :third_gear
+    end
+
+    state :first_gear, :second_gear do
+      validates_presence_of :seatbelt_on
+    end
+  end
+
+  def put_on_seatbelt
+    sleep(0.1)
+    self.seatbelt = 'on'
+  end
+
+  def benchmark
+    yield
+  end
+
+  def seatbelt_on
+    self.seatbelt == 'on'
+  end
+end

data/test/support/rails_4_0_0/config/routes.rb

@@ -1,4 +1,5 @@
 Rails400::Application.routes.draw do
   resources :entities
   resources :purchases, only: %i(create)
+  resources :transitions, only: %i(create)
 end

data/test/support/rails_4_0_0/db/schema.rb

@@ -15,6 +15,8 @@ ActiveRecord::Schema.define(:version => 20130103115400) do
 
   create_table "entities", :force => true do |t|
     t.string   "name"
+    t.string   "state"
+    t.string   "seatbelt"
     t.datetime "created_at", :null => false
     t.datetime "updated_at", :null => false
   end

data/test/support/rails_4_0_13/Gemfile

@@ -3,3 +3,4 @@ source 'https://rubygems.org'
 gem 'rails', '4.0.13'
 gem 'sqlite3'
 gem 'chillout', :path => '../../../'
+gem "state_machine", ENV['STATE_MACHINE_VERSION'] || ">= 1.2"

data/test/support/rails_4_0_13/app/controllers/entities_controller.rb

@@ -31,7 +31,7 @@ class EntitiesController < ApplicationController
   end
 
   def create
-    @entity = Entity.new(params.require(:entity).permit!)
+    @entity = Entity.new(params.require(:entity).permit!.merge(state: "parked"))
 
     respond_to do |format|
       if @entity.save

data/test/support/rails_4_0_13/app/controllers/transitions_controller.rb

@@ -0,0 +1,8 @@
+class TransitionsController < ApplicationController
+  def create
+    e = Entity.new(state: "parked")
+    e.ignite
+    e.shift_up
+    head :ok
+  end
+end

data/test/support/rails_4_0_13/app/models/entity.rb

@@ -1,2 +1,36 @@
 class Entity < ActiveRecord::Base
-end
+  state_machine :initial => :parked do
+    before_transition :parked => any - :parked, do: :put_on_seatbelt
+    after_transition any => :parked do |vehicle, _transition|
+      vehicle.seatbelt = 'off'
+    end
+    around_transition :benchmark
+
+    event :ignite do
+      transition :parked => :idling
+    end
+
+    event :shift_up do
+      transition :idling => :first_gear,
+        :first_gear => :second_gear,
+        :second_gear => :third_gear
+    end
+
+    state :first_gear, :second_gear do
+      validates_presence_of :seatbelt_on
+    end
+  end
+
+  def put_on_seatbelt
+    sleep(0.1)
+    self.seatbelt = 'on'
+  end
+
+  def benchmark
+    yield
+  end
+
+  def seatbelt_on
+    self.seatbelt == 'on'
+  end
+end

data/test/support/rails_4_0_13/config/routes.rb

@@ -1,4 +1,5 @@
 Rails400::Application.routes.draw do
   resources :entities
   resources :purchases, only: %i(create)
+  resources :transitions, only: %i(create)
 end

data/test/support/rails_4_0_13/db/schema.rb

@@ -15,6 +15,8 @@ ActiveRecord::Schema.define(:version => 20130103115400) do
 
   create_table "entities", :force => true do |t|
     t.string   "name"
+    t.string   "state"
+    t.string   "seatbelt"
     t.datetime "created_at", :null => false
     t.datetime "updated_at", :null => false
   end

data/test/support/rails_4_1_0/Gemfile

@@ -3,3 +3,4 @@ source 'https://rubygems.org'
 gem 'rails', '4.1.0'
 gem 'sqlite3'
 gem 'chillout', :path => '../../../'
+gem "state_machine", ENV['STATE_MACHINE_VERSION'] || ">= 1.2"

data/test/support/rails_4_1_0/app/controllers/entities_controller.rb

@@ -31,7 +31,7 @@ class EntitiesController < ApplicationController
   end
 
   def create
-    @entity = Entity.new(params.require(:entity).permit!)
+    @entity = Entity.new(params.require(:entity).permit!.merge(state: "parked"))
 
     respond_to do |format|
       if @entity.save

data/test/support/rails_4_1_0/app/controllers/transitions_controller.rb

@@ -0,0 +1,8 @@
+class TransitionsController < ApplicationController
+  def create
+    e = Entity.new(state: "parked")
+    e.ignite
+    e.shift_up
+    head :ok
+  end
+end

data/test/support/rails_4_1_0/app/models/entity.rb

@@ -1,2 +1,36 @@
 class Entity < ActiveRecord::Base
-end
+  state_machine :initial => :parked do
+    before_transition :parked => any - :parked, do: :put_on_seatbelt
+    after_transition any => :parked do |vehicle, _transition|
+      vehicle.seatbelt = 'off'
+    end
+    around_transition :benchmark
+
+    event :ignite do
+      transition :parked => :idling
+    end
+
+    event :shift_up do
+      transition :idling => :first_gear,
+        :first_gear => :second_gear,
+        :second_gear => :third_gear
+    end
+
+    state :first_gear, :second_gear do
+      validates_presence_of :seatbelt_on
+    end
+  end
+
+  def put_on_seatbelt
+    sleep(0.1)
+    self.seatbelt = 'on'
+  end
+
+  def benchmark
+    yield
+  end
+
+  def seatbelt_on
+    self.seatbelt == 'on'
+  end
+end