rework of AS Notifications

Author: hmcfletch

lib/fast_jsonapi/instrumentation.rb

@@ -0,0 +1,2 @@
+require 'fast_jsonapi/instrumentation/serializable_hash'
+require 'fast_jsonapi/instrumentation/serialized_json'

lib/fast_jsonapi/instrumentation/serializable_hash.rb

@@ -0,0 +1,15 @@
+require 'active_support/notifications'
+
+module FastJsonapi
+  module ObjectSerializer
+
+    alias_method :serializable_hash_without_instrumentation, :serializable_hash
+
+    def serializable_hash
+      ActiveSupport::Notifications.instrument(SERIALIZABLE_HASH_NOTIFICATION, { name: self.class.name }) do
+        serializable_hash_without_instrumentation
+      end
+    end
+
+  end
+end

lib/fast_jsonapi/instrumentation/serialized_json.rb

@@ -0,0 +1,15 @@
+require 'active_support/notifications'
+
+module FastJsonapi
+  module ObjectSerializer
+
+    alias_method :serialized_json_without_instrumentation, :serialized_json
+
+    def serialized_json
+      ActiveSupport::Notifications.instrument(SERIALIZED_JSON_NOTIFICATION, { name: self.class.name }) do
+        serialized_json_without_instrumentation
+      end
+    end
+
+  end
+end

lib/fast_jsonapi/object_serializer.rb

@@ -5,30 +5,15 @@
 require 'active_support/inflector'
 require 'fast_jsonapi/serialization_core'
 
-begin
-  require 'skylight'
-  SKYLIGHT_ENABLED = true
-rescue LoadError
-  SKYLIGHT_ENABLED = false
-end
-
 module FastJsonapi
   module ObjectSerializer
     extend ActiveSupport::Concern
     include SerializationCore
 
-    included do
-      # Skylight integration
-      # To remove Skylight
-      # Remove the included do block
-      # Remove the Gemfile entry
-      if SKYLIGHT_ENABLED
-        include Skylight::Helpers
-
-        instrument_method :serializable_hash
-        instrument_method :to_json
-      end
+    SERIALIZABLE_HASH_NOTIFICATION = 'render.fast_jsonapi.serializable_hash'.freeze
+    SERIALIZED_JSON_NOTIFICATION = 'render.fast_jsonapi.serialized_json'.freeze
 
+    included do
       # Set record_type based on the name of the serializer class
       set_type(reflected_record_type) if reflected_record_type
     end

spec/lib/instrumentation/as_notifications_negative_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe FastJsonapi::ObjectSerializer do
+  include_context 'movie class'
+
+  context 'instrument' do
+
+    before(:each) do
+      options = {}
+      options[:meta] = { total: 2 }
+      options[:include] = [:actors]
+
+      @serializer = MovieSerializer.new([movie, movie], options)
+    end
+
+    context 'serializable_hash' do
+
+      it 'should send not notifications' do
+        events = []
+
+        ActiveSupport::Notifications.subscribe(FastJsonapi::ObjectSerializer::SERIALIZABLE_HASH_NOTIFICATION) do |*args|
+          events << ActiveSupport::Notifications::Event.new(*args)
+        end
+
+        serialized_hash = @serializer.serializable_hash
+
+        expect(events.length).to eq(0)
+
+        expect(serialized_hash.key?(:data)).to eq(true)
+        expect(serialized_hash.key?(:meta)).to eq(true)
+        expect(serialized_hash.key?(:included)).to eq(true)
+      end
+
+    end
+
+    context 'serialized_json' do
+
+      it 'should send not notifications' do
+        events = []
+
+        ActiveSupport::Notifications.subscribe(FastJsonapi::ObjectSerializer::SERIALIZED_JSON_NOTIFICATION) do |*args|
+          events << ActiveSupport::Notifications::Event.new(*args)
+        end
+
+        json = @serializer.serialized_json
+
+        expect(events.length).to eq(0)
+
+        expect(json.length).to be > 50
+      end
+
+    end
+
+  end
+
+end

spec/lib/instrumentation/as_notifications_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'fast_jsonapi/instrumentation'
+
+describe FastJsonapi::ObjectSerializer do
+  include_context 'movie class'
+
+  context 'instrument' do
+
+    before(:each) do
+      options = {}
+      options[:meta] = { total: 2 }
+      options[:include] = [:actors]
+
+      @serializer = MovieSerializer.new([movie, movie], options)
+    end
+
+    context 'serializable_hash' do
+
+      it 'should send notifications' do
+        events = []
+
+        ActiveSupport::Notifications.subscribe(FastJsonapi::ObjectSerializer::SERIALIZABLE_HASH_NOTIFICATION) do |*args|
+          events << ActiveSupport::Notifications::Event.new(*args)
+        end
+
+        serialized_hash = @serializer.serializable_hash
+
+        expect(events.length).to eq(1)
+
+        event = events.first
+
+        expect(event.duration).to be > 0
+        expect(event.payload).to eq({ name: 'MovieSerializer' })
+        expect(event.name).to eq(FastJsonapi::ObjectSerializer::SERIALIZABLE_HASH_NOTIFICATION)
+
+        expect(serialized_hash.key?(:data)).to eq(true)
+        expect(serialized_hash.key?(:meta)).to eq(true)
+        expect(serialized_hash.key?(:included)).to eq(true)
+      end
+
+    end
+
+    context 'serialized_json' do
+
+      it 'should send notifications' do
+        events = []
+
+        ActiveSupport::Notifications.subscribe(FastJsonapi::ObjectSerializer::SERIALIZED_JSON_NOTIFICATION) do |*args|
+          events << ActiveSupport::Notifications::Event.new(*args)
+        end
+
+        json = @serializer.serialized_json
+
+        expect(events.length).to eq(1)
+
+        event = events.first
+
+        expect(event.duration).to be > 0
+        expect(event.payload).to eq({ name: 'MovieSerializer' })
+        expect(event.name).to eq(FastJsonapi::ObjectSerializer::SERIALIZED_JSON_NOTIFICATION)
+
+        expect(json.length).to be > 50
+      end
+
+    end
+
+  end
+
+end