sync_machine 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 382d073ea7c61af6da6f38ca3a9c014e4913a7b5fd381b6a84e5f0403edacca8
-  data.tar.gz: 67e6f4008630a67ae804f9530f9905fcdd78137e991369f1f43412386dd2074b
+  metadata.gz: 102155af0851cece6b27470411c50f11c945be750d08c6acb98093b011f65e85
+  data.tar.gz: 956031cb81b308903a5606d43c877eed613f4c3a3302b655592f1ce891197357
 SHA512:
-  metadata.gz: eb69f9a240373ca62e4817c8f5c15c2dfafc14a1e46211dc254608cb031e423104e1ba2ee382e660543cc9414b63cdd49e2293502f5e6bc7434d8a706bbbf2bc
-  data.tar.gz: bcd1474c68ebb58a04169bdd26ae940268cb289968db9855a58e81b15607fae69f364040503d04cda10e03f4d5de8d23a51f4ca1b8d20450878460224d2c42d3
+  metadata.gz: 0e0718d0e199a23ca685eccd530cffa3bdd49969925536d2881fea680126aa96a83a8ebae0ea871e93179670928df40b4564962c02d10641bf2b92d6159f571a
+  data.tar.gz: 52ac953901aed56ca103e58e7285fc15bb2acdec89a9ad9f88531b01e91d080aaed78892e9d835b6df6e55b7219c475681fd10708d79b1f94557b4a269ac633a

data/.rubocop.yml

@@ -17,6 +17,9 @@ Layout/SpaceInsideHashLiteralBraces:
 Layout/TrailingBlankLines:
   Enabled: false
 
+Lint/RescueException:
+  Enabled: false
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'

data/lib/sync_machine/ensure_publication_worker.rb

@@ -10,7 +10,7 @@ module SyncMachine
 
     [:build, :check_publishable, :publish, :after_publish].each do |hook|
       define_singleton_method(hook) do |&block|
-        hooks[hook] = block
+        hooks[hook] = Hook.new(hook.to_s, block)
       end
     end
 
@@ -35,5 +35,19 @@ module SyncMachine
       subject_class = sync_module.subject_class
       subject_class.find(subject_id)
     end
+
+    # Wrap build, check_publishable, etc blocks.
+    class Hook
+      def initialize(name, block)
+        @name = name
+        @block = block
+      end
+
+      def call(*args)
+        TracerAdapters.tracer_adapter.start_active_span(@name) do
+          @block.call(*args)
+        end
+      end
+    end
   end
 end

data/lib/sync_machine/find_subjects_worker.rb

@@ -11,7 +11,7 @@ module SyncMachine
 
     def self.add_hook(meth, block)
       sync_module = SyncMachine.sync_module(self)
-      hooks[meth] = Hook.new(sync_module, block)
+      hooks[meth] = Hook.new(meth.to_s, sync_module, block)
     end
     private_class_method :add_hook
 
@@ -52,20 +52,23 @@ module SyncMachine
 
     # Wrap a "subject_ids_from_*" block.
     class Hook
-      def initialize(sync_module, block)
+      def initialize(name, sync_module, block)
+        @name = name.to_s
         @sync_module = sync_module
         @block = block
       end
 
       def call(record, changed_keys)
-        raw_source_ids = if @block.arity == 2
-                           @block.call(record, changed_keys)
-                         else
-                           @block.call(record)
-                         end
-        Array.wrap(raw_source_ids).map { |raw_source_id|
-          @sync_module.orm_adapter.record_id_for_job(raw_source_id)
-        }
+        TracerAdapters.tracer_adapter.start_active_span(@name) do
+          raw_source_ids = if @block.arity == 2
+                             @block.call(record, changed_keys)
+                           else
+                             @block.call(record)
+                           end
+          Array.wrap(raw_source_ids).map { |raw_source_id|
+            @sync_module.orm_adapter.record_id_for_job(raw_source_id)
+          }
+        end
       end
     end
   end

data/lib/sync_machine/orm_adapters/active_record_adapter.rb

@@ -1,8 +1,8 @@
 begin
   require 'wisper/activerecord'
 rescue LoadError
-  Kernel.abort(
-    "Please install the wisper-activerecord gem when using SyncMachine with ActiveRecord."
+  SyncMachine.abort_with_installation_hint(
+    'wisper-activerecord', 'ActiveRecord'
   )
 end
 

data/lib/sync_machine/orm_adapters/mongoid_adapter.rb

@@ -1,9 +1,7 @@
 begin
   require 'wisper/mongoid'
 rescue LoadError
-  Kernel.abort(
-    "Please install the fhwang-wisper-mongoid gem when using SyncMachine with Mongoid."
-  )
+  SyncMachine.abort_with_installation_hint('fhwang-wisper-mongoid', 'Mongoid')
 end
 
 module SyncMachine

data/lib/sync_machine/railtie.rb

@@ -6,6 +6,21 @@ module SyncMachine
         require("sync_machine/orm_adapters/active_record_adapter")
       Module.const_defined?(:Mongoid) && \
         require("sync_machine/orm_adapters/mongoid_adapter")
+      if Module.const_defined?(:OpenTracing)
+        begin
+          require 'sidekiq-opentracing'
+        rescue LoadError
+          SyncMachine.abort_with_installation_hint(
+            'sfx-sidekiq-opentracing', 'OpenTracing'
+          )
+        end
+      end
+    end
+
+    config.after_initialize do
+      if Module.const_defined?(:OpenTracing)
+        Sidekiq::Tracer.instrument(tracer: OpenTracing.global_tracer)
+      end
     end
   end
 end

data/lib/sync_machine/tracer_adapters/open_tracing_adapter.rb

@@ -0,0 +1,37 @@
+module SyncMachine
+  module TracerAdapters
+    # Adapt OpenTracing for use with SyncMachine.
+    module OpenTracingAdapter
+      def self.start_active_span(name, &block)
+        scope = tracer.start_active_span(
+          name,
+          child_of: parent_span.context,
+          tags: tags
+        )
+        block.call
+      rescue Exception => exception
+        log_errors(scope.span, exception) if scope
+        raise exception
+      ensure
+        scope.close if scope
+      end
+
+      def self.log_errors(span, exception)
+        span.set_tag('error', true)
+        span.log_kv(event: 'error', :'error.object' => exception)
+      end
+
+      def self.parent_span
+        OpenTracing.active_span
+      end
+
+      def self.tags
+        { 'component' => 'SyncMachine', 'span.kind' => 'server' }
+      end
+
+      def self.tracer
+        OpenTracing.global_tracer
+      end
+    end
+  end
+end

data/lib/sync_machine/tracer_adapters.rb

@@ -0,0 +1,21 @@
+require 'sync_machine/tracer_adapters/open_tracing_adapter'
+
+module SyncMachine
+  # Adapt SyncMachine functionality to a specific distributed tracer.
+  module TracerAdapters
+    def self.tracer_adapter
+      if const_defined?(:OpenTracing)
+        OpenTracingAdapter
+      else
+        NullAdapter
+      end
+    end
+
+    # Do not log spans anywhere.
+    module NullAdapter
+      def self.start_active_span(_name)
+        yield
+      end
+    end
+  end
+end

data/lib/sync_machine/version.rb

@@ -1,3 +1,3 @@
 module SyncMachine
-  VERSION = "1.1.1".freeze
+  VERSION = "1.2.0".freeze
 end

data/lib/sync_machine.rb

@@ -5,6 +5,7 @@ require "sync_machine/change_listener"
 require "sync_machine/ensure_publication"
 require "sync_machine/ensure_publication_worker"
 require "sync_machine/find_subjects_worker"
+require "sync_machine/tracer_adapters"
 require "sync_machine/orm_adapters"
 require "sync_machine/version"
 require "sync_machine/railtie" if defined?(Rails::Railtie)
@@ -12,6 +13,12 @@ require "sync_machine/railtie" if defined?(Rails::Railtie)
 # A mini-framework for intelligently publishing complex model changes to an
 # external API..
 module SyncMachine
+  def self.abort_with_installation_hint(gem_name, dependency)
+    Kernel.abort(
+      "Please install the #{gem_name} gem when using SyncMachine with #{dependency}."
+    )
+  end
+
   # Force loading of all relevant classes.  Should only be necessary when
   # running your application in a way that it defers loading constants, i.e.,
   # Rails' development or test mode.

data/sync_machine.gemspec

@@ -44,6 +44,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "factory_bot"
   spec.add_development_dependency "fhwang-wisper-mongoid"
   spec.add_development_dependency "mongoid"
+  spec.add_development_dependency "opentracing"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec_junit_formatter"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sync_machine
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Francis Hwang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-25 00:00:00.000000000 Z
+date: 2019-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -236,6 +250,8 @@ files:
 - lib/sync_machine/orm_adapters/active_record_adapter.rb
 - lib/sync_machine/orm_adapters/mongoid_adapter.rb
 - lib/sync_machine/railtie.rb
+- lib/sync_machine/tracer_adapters.rb
+- lib/sync_machine/tracer_adapters/open_tracing_adapter.rb
 - lib/sync_machine/version.rb
 - sync_machine.gemspec
 homepage: https://github.com/fhwang/sync_machine