table_sync 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfa9b3d17de49a2591644329464d45ba1ddfc6b9a56c76db6eb6c061b439f3e4
-  data.tar.gz: 7438f913929bd7eb6ae0b6e2d22fcb145b41a62d714aba7e989dcf2868bc7d70
+  metadata.gz: '079ab25e5512270ad9c1161f2a0f239fccb7954b5fbe56814605c39a72a87890'
+  data.tar.gz: 51b8c5718e91e03aaf7ce45421670999ef83ad7aaefea3961198a09f678149c2
 SHA512:
-  metadata.gz: ed0babc48e2b1918ba4ae126215083182c6a3eadec3f79136b68322e2d2563ef02871b82aa86d5f310c77bc8303fc6a38042d35dfba95dab71b7bea653bfb658
-  data.tar.gz: 11783a0f991fb7d3b39b18e820a82a3075e0f6690ab0bd0d1c5fcb229fa2a0090df673ceacc4e3ec05bc722a42f8657fdd376f18f8f715f27c838efdde5c357b
+  metadata.gz: fed258e3f7e24eed98df488c1b5d8ccef4732af5629001695c8053bcd239a46e52b79fef61d9febd627c7c44fe77b7d785f9f4b613aee8492161ec19f2d82288
+  data.tar.gz: baf41f7542804dadcdb2c29861bfe82724bdeb743c9b986cec943f0875b97568429c01c6afb4409e49b4f45680a0df5ea951d3bf5c06e874aed6d66a9ed16577

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [1.9.0] - 2019-07-23
+### Added
+- add notifications
+
 ## [1.8.0] - 2019-07-23
 ### Added
 - `debounce_time` option for publishing

data/docs/synopsis.md

@@ -80,6 +80,8 @@ TableSync.routing_metadata_callable = -> (klass, attributes) { attributes.slice(
 - `TableSync.exchange_name` defines the exchange name used for publishing (optional, falls back
 to default Rabbit gem configuration).
 
+- `TableSync.notifier` is a module that provides publish and recieve notifications.
+
 # Manual publishing
 
 `TableSync::Publisher.new(object_class, original_attributes, confirm: true, state: :updated, debounce_time: 45)` 
@@ -251,5 +253,49 @@ You can set callbacks like this:
 before_commit on: event, &block
 after_commit on: event, &block
 ```
-TableSync performs this callbacks after transaction commit as to avoid side effects. Block receives array of
-record attributes.
+TableSync performs this callbacks after transaction commit as to avoid side effects. Block receives array of record attributes.
+
+### Notifications
+
+#### ActiveSupport adapter
+
+You can use an already existing ActiveSupport adapter:
+```ruby
+  TableSync.notifier = TableSync::InstrumentAdapter::ActiveSupport
+```
+
+This instrumentation API is provided by Active Support. It allows to subscribe to notifications:
+
+```ruby
+ActiveSupport::Notifications.subscribe(/tablesync/) do |name, start, finish, id, payload|
+  # do something
+end
+```
+
+Types of events available:
+`"tablesync.receive.update"`, `"tablesync.receive.destroy"`, `"tablesync.publish.update"`
+and `"tablesync.publish.destroy"`.
+
+You have access to the payload, which contains  `event`, `direction`, `table` and `count`.
+
+```
+{
+  :event => :update,       # one of update / destroy
+  :direction => :publish,  # one of publish / receive
+  :table => "users",
+  :count => 1
+}
+```
+
+ See more at https://guides.rubyonrails.org/active_support_instrumentation.html
+
+
+#### Custom adapters
+
+You can also create a custom adapter. It is expected to respond to the following method:
+
+```ruby
+  def notify(table:, event:, direction:, count:)
+    # processes data about table_sync event
+  end
+```

data/lib/table_sync/batch_publisher.rb

@@ -17,8 +17,10 @@ class TableSync::BatchPublisher < TableSync::BasePublisher
 
   def publish_now
     return unless need_publish?
-
     Rabbit.publish(params)
+
+    TableSync::Instrument.notify table: TableSync.orm.table_name(object_class), event: event,
+                                 count: publishing_data[:attributes].size, direction: :publish
   end
 
   private
@@ -71,11 +73,15 @@ class TableSync::BatchPublisher < TableSync::BasePublisher
   def publishing_data
     {
       **super,
-      event: :update,
+      event: event,
       metadata: {},
     }
   end
 
+  def event
+    :update
+  end
+
   def attributes_for_sync
     return original_attributes_array if push_original_attributes?
 

data/lib/table_sync/instrument.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module TableSync::Instrument
+  module_function
+
+  def notify(*args)
+    TableSync.notifier&.notify(*args)
+  end
+end

data/lib/table_sync/instrument_adapter/active_support.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module TableSync::InstrumentAdapter
+  module ActiveSupport
+    module_function
+
+    def notify(table:, event:, direction:, count: 1)
+      ::ActiveSupport::Notifications.instrument "tablesync.#{direction}.#{event}",
+                                                count: count,
+                                                table: table.to_s,
+                                                event: event,
+                                                direction: direction
+    end
+  end
+end

data/lib/table_sync/model/active_record.rb

@@ -53,7 +53,7 @@ module TableSync::Model
     def upsert(data:, target_keys:, version_key:, first_sync_time_key:, default_values:)
       data = Array.wrap(data)
 
-      transaction do
+      result = transaction do
         data.map do |datum|
           conditions = datum.select { |k| target_keys.include?(k) }
 
@@ -71,13 +71,25 @@ module TableSync::Model
           row_to_hash(row)
         end.compact
       end
+
+      TableSync::Instrument.notify(
+        table: table_name, event: :update, count: result.count, direction: :receive,
+      )
+
+      result
     end
 
     def destroy(data)
-      transaction do
+      result = transaction do
         row = raw_model.lock("FOR UPDATE").find_by(data)&.destroy!
         [row_to_hash(row)]
       end
+
+      TableSync::Instrument.notify(
+        table: table_name, event: :destroy, count: result.count, direction: :receive,
+      )
+
+      result
     end
 
     def transaction(&block)
@@ -99,6 +111,10 @@ module TableSync::Model
       { schema: schema, name: name }
     end
 
+    def table_name
+      table_info[:name]
+    end
+
     def db
       @raw_model.connection
     end

data/lib/table_sync/model/sequel.rb

@@ -28,17 +28,24 @@ module TableSync::Model
         insert_data.each { |datum| datum[first_sync_time_key] = Time.current }
       end
 
-      dataset.returning
-             .insert_conflict(
-               target: target_keys,
-               update: upd_spec,
-               update_where: version_condition,
-             )
-             .multi_insert(insert_data)
+      result = dataset.returning
+                      .insert_conflict(
+                        target: target_keys,
+                        update: upd_spec,
+                        update_where: version_condition,
+                      )
+                      .multi_insert(insert_data)
+
+      TableSync::Instrument.notify table: table_name, count: result.count,
+                                   event: :update, direction: :receive
+      result
     end
 
     def destroy(data)
-      dataset.returning.where(data).delete
+      result = dataset.returning.where(data).delete
+      TableSync::Instrument.notify table: table_name, count: result.count,
+                                   event: :destroy, direction: :receive
+      result
     end
 
     def transaction(&block)

data/lib/table_sync/orm_adapter/active_record.rb

@@ -16,6 +16,10 @@ module TableSync::ORMAdapter
       object.attributes
     end
 
+    def table_name(object)
+      object.table_name
+    end
+
     def setup_sync(klass, **opts)
       debounce_time = opts.delete(:debounce_time)
 

data/lib/table_sync/orm_adapter/sequel.rb

@@ -16,6 +16,10 @@ module TableSync::ORMAdapter
       object.values
     end
 
+    def table_name(object)
+      object.table_name
+    end
+
     def setup_sync(klass, **opts)
       if_predicate     = to_predicate(opts.delete(:if), true)
       unless_predicate = to_predicate(opts.delete(:unless), false)

data/lib/table_sync/publisher.rb

@@ -34,6 +34,8 @@ class TableSync::Publisher < TableSync::BasePublisher
     return if !object && !destroyed?
 
     Rabbit.publish(params)
+    TableSync::Instrument.notify table: TableSync.orm.table_name(object_class),
+                                 event: event, direction: :publish
   end
 
   private
@@ -77,7 +79,7 @@ class TableSync::Publisher < TableSync::BasePublisher
   def publishing_data
     {
       **super,
-      event: (destroyed? ? :destroy : :update),
+      event: event,
       metadata: { created: created? },
     }
   end
@@ -100,6 +102,10 @@ class TableSync::Publisher < TableSync::BasePublisher
     TableSync.orm.find(object_class, needle)
   end
 
+  def event
+    destroyed? ? :destroy : :update
+  end
+
   def needle
     original_attributes.slice(*primary_keys)
   end

data/lib/table_sync/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TableSync
-  VERSION = "1.8.0"
+  VERSION = "1.9.0"
 end

data/lib/table_sync.rb

@@ -22,6 +22,8 @@ module TableSync
   require_relative "./table_sync/orm_adapter/sequel"
   require_relative "./table_sync/model/active_record"
   require_relative "./table_sync/model/sequel"
+  require_relative "./table_sync/instrument"
+  require_relative "./table_sync/instrument_adapter/active_support"
 
   class << self
     include Memery
@@ -31,6 +33,7 @@ module TableSync
     attr_accessor :routing_key_callable
     attr_accessor :exchange_name
     attr_accessor :routing_metadata_callable
+    attr_accessor :notifier
 
     def sync(*args)
       orm.setup_sync(*args)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: table_sync
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Umbrellio
@@ -263,6 +263,8 @@ files:
 - lib/table_sync/dsl.rb
 - lib/table_sync/errors.rb
 - lib/table_sync/event_actions.rb
+- lib/table_sync/instrument.rb
+- lib/table_sync/instrument_adapter/active_support.rb
 - lib/table_sync/model/active_record.rb
 - lib/table_sync/model/sequel.rb
 - lib/table_sync/orm_adapter/active_record.rb