business_flow 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16d25ddb5bb71fa37b36cdf7613fea34a42fb002
-  data.tar.gz: 0e7d23ca4de021b1c1eee8e6d67a45b3f4e14079
+  metadata.gz: fd72338d1a50d4e2597d104d79a249faac06b5a9
+  data.tar.gz: 58a7c0c6680cb8ebc91ff6d40152191352d6cf16
 SHA512:
-  metadata.gz: c0e76c159e0ee3acbc44519d617510df07a9dab54a5c3d3801c2608555a919306ed2822115363a819638b0fe76e5e6e5c09fe40e92f96e4fe698872bb83e3c81
-  data.tar.gz: 07bc1f3138665a9957d8695225cdf41c8b135a6f2d706406f68abfade38f531df7f6adfcd0e01037976685109af10d78cf54d6877228684b35729e2869514313
+  metadata.gz: af2687926347dbc52c4a7a3040f34366b75e3b99e95fe23afc07b2e7efa78aec92c5439b6d7866e82f66bd52ea613269482d550eac5db8d63b91a5034de8bd4a
+  data.tar.gz: f08c8deb55ca25440d726f928df1edec81eee3972d88b599460f83b0026b7c1022f06575d8c556dde46c46834050f218d98707a5ceed60366714c037e094f571

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    business_flow (0.11.1)
+    business_flow (0.12.0)
       activemodel (>= 3.0)
       activesupport (>= 3.0)
 

data/lib/business_flow/cacheable.rb

@@ -69,12 +69,22 @@ module BusinessFlow
       def with_cache(flow, &blk)
         add_cache_key_to_result_class
         catch(:halt_step) do
-          return cache_store.fetch(flow.cache_key,
-                                   cache_options.to_store_options(flow), &blk)
+          return instrument_cache_fetch(flow, &blk)
         end
         raise FlowFailedException, flow
       end
 
+      def instrument_cache_fetch(flow)
+        instrument(:cache, flow) do |payload|
+          payload[:cache_hit] = false if payload
+          cache_store.fetch(flow.cache_key,
+                            cache_options.to_store_options(flow)) do
+            payload[:cache_hit] = true if payload
+            yield
+          end
+        end
+      end
+
       RESULT_FINALIZE = proc do |cache_key|
         @cache_key = cache_key
         raise FlowFailedException, self if errors?

data/lib/business_flow/dsl.rb

@@ -85,6 +85,10 @@ module BusinessFlow
         end
       end
 
+      def instrument(_name, _flow)
+        yield nil
+      end
+
       def result_from(flow)
         finalize_result_provider
         # We use instance_variable_get here instead of making it part of

data/lib/business_flow/instrument.rb

@@ -9,9 +9,30 @@ module BusinessFlow
 
     # Contains methods that we add to the DSL
     module ClassMethods
+      INSTRUMENTATION_PREFIX = 'business_flow'.freeze
+
+      def instrument(name, flow)
+        payload = { flow: flow }
+        ActiveSupport::Notifications.instrument(
+          "#{INSTRUMENTATION_PREFIX}.#{name}.#{instrumentation_name}", payload
+        ) do
+          yield payload
+        end
+      end
+
       def instrument_steps
         step_executor ::BusinessFlow::InstrumentedStepExecutor
       end
+
+      def instrumentation_name
+        @instrumentation_name ||=
+          to_s.underscore.freeze
+      end
+
+      def event_name
+        @event_name ||=
+          "#{INSTRUMENTATION_PREFIX}.flow.#{instrumentation_name}".freeze
+      end
     end
   end
 end

data/lib/business_flow/instrumented_executor.rb

@@ -18,11 +18,11 @@ module BusinessFlow
     end
 
     def flow_name
-      @flow_name ||= flow.class.to_s.underscore
+      @flow_name ||= flow.class.instrumentation_name
     end
 
     def flow_event_name
-      @flow_event_name ||= "business_flow.flow.#{flow_name}"
+      @flow_event_name ||= flow.class.event_name
     end
   end
 end

data/lib/business_flow/version.rb

@@ -1,3 +1,3 @@
 module BusinessFlow
-  VERSION = '0.11.1'.freeze
+  VERSION = '0.12.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: business_flow
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Alex Scarborough