pub_sub_model_sync 1.0.beta2 → 1.0

data/lib/pub_sub_model_sync/service_base.rb

@@ -6,16 +6,16 @@ module PubSubModelSync
     SERVICE_KEY = 'service_model_sync'
 
     def listen_messages
-      raise 'method :listen_messages must be defined in service'
+      raise NoMethodError, 'method :listen_messages must be defined in service'
     end
 
     # @param _payload (Payload)
     def publish(_payload)
-      raise 'method :publish must be defined in service'
+      raise NoMethodError, 'method :publish must be defined in service'
     end
 
     def stop
-      raise 'method :stop must be defined in service'
+      raise NoMethodError, 'method :stop must be defined in service'
     end
 
     private
@@ -32,26 +32,13 @@ module PubSubModelSync
 
     # @param (String: Payload in json format)
     def process_message(payload_info)
-      retries ||= 0
       payload = decode_payload(payload_info)
       return payload.process unless same_app_message?(payload)
 
       log("Skipping message from same origin: #{[payload]}") if config.debug
     rescue => e
-      retry if can_retry_process_message?(e, payload, retries += 1)
-    end
-
-    def can_retry_process_message?(error, payload, retries)
-      error_payload = [payload, error.message, error.backtrace]
-      if retries <= 5
-        sleep(retries)
-        log("Error while starting to process a message (retrying #{retries} retries...): #{error_payload}", :error)
-        rescue_database_connection if lost_db_connection_err?(error)
-        true
-      else
-        log("Retried 5 times and error persists, exiting...: #{error_payload}", :error)
-        Process.exit!(true)
-      end
+      error_payload = [payload, e.message, e.backtrace]
+      log("Error while starting to process a message: #{error_payload}", :error)
     end
 
     # @return Payload
@@ -66,19 +53,5 @@ module PubSubModelSync
       key = payload.headers[:app_key]
       key && key == config.subscription_key
     end
-
-    def lost_db_connection_err?(error)
-      return true if error.class.name == 'PG::UnableToSend' # rubocop:disable Style/ClassEqualityComparison
-
-      error.message.match?(/lost connection/i)
-    end
-
-    def rescue_database_connection
-      log('Lost DB connection. Attempting to reconnect...', :warn)
-      ActiveRecord::Base.connection.reconnect!
-    rescue
-      log('Cannot reconnect to database, exiting...', :error)
-      Process.exit!(true)
-    end
   end
 end

data/lib/pub_sub_model_sync/service_google.rb

@@ -37,7 +37,7 @@ module PubSubModelSync
       message_topics = p_topic_names.map(&method(:find_topic))
       message_topics.each do |topic|
         topic.publish_async(encode_payload(payload), message_headers(payload)) do |res|
-          raise 'Failed to publish the message.' unless res.succeeded?
+          raise StandardError, 'Failed to publish the message.' unless res.succeeded?
         end
       end
     end

data/lib/pub_sub_model_sync/subscriber_concern.rb

@@ -10,7 +10,7 @@ module PubSubModelSync
 
     module ClassMethods
       # @param actions (Symbol|Array<Symbol>) Notification.action name: save|create|update|destroy|<any_other_action>
-      # @param mapping (Array<String>) Attributes mapping with aliasing support, sample: ["id", "full_name:name"]
+      # @param mapping (Array<String,Symbol>) Attributes mapping with aliasing support, sample: ["id", "full_name:name"]
       # @param settings (Hash<:from_klass, :to_action, :id, :if, :unless>)
       #   from_klass (String) Notification.class name
       #   to_action (Symbol|Proc):
@@ -19,15 +19,17 @@ module PubSubModelSync
       #   id (Symbol|Array<Symbol|String>) attribute(s) DB primary identifier(s). Supports for mapping format.
       #   if (Symbol|Proc|Array<Symbol>) Method or block called as the conformation before calling the callback
       #   unless (Symbol|Proc|Array<Symbol>) Method or block called as the negation before calling the callback
-      def ps_subscribe(actions, mapping = [], settings = {})
-        Array(actions).each do |action|
+      def ps_subscribe(actions, mapping = [], settings = {}, &block)
+        settings[:to_action] ||= block if block
+        Array(actions).map do |action|
           add_ps_subscriber(action, mapping, settings)
         end
       end
 
       # @param action (Symbol) Notification.action name
       # @param settings (Hash) @refer ps_subscribe.settings except(:id)
-      def ps_class_subscribe(action, settings = {})
+      def ps_class_subscribe(action, settings = {}, &block)
+        settings[:to_action] ||= block if block
         add_ps_subscriber(action, nil, settings.merge(mode: :klass))
       end
 

data/lib/pub_sub_model_sync/transaction.rb

@@ -19,7 +19,11 @@ module PubSubModelSync
     # @param payload (Payload)
     def add_payload(payload)
       payloads << payload
-      deliver_payloads if payloads.count >= max_buffer
+      log("Payload added to current transaction: #{payload.inspect}") if config.debug
+      return unless payloads.count >= max_buffer
+
+      log("Payloads buffer was filled, delivering current payloads: #{payloads.count}")
+      deliver_payloads
     end
 
     def finish # rubocop:disable Metrics/AbcSize
@@ -38,7 +42,7 @@ module PubSubModelSync
     end
 
     def rollback
-      log("rollback #{payloads.count} notifications", :warn) if children.any? && debug?
+      log("Rollback #{payloads.count} notifications", :warn) if children.any? && debug?
       self.children = []
       root&.rollback
       clean_publisher

data/lib/pub_sub_model_sync/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PubSubModelSync
-  VERSION = '1.0.beta2'
+  VERSION = '1.0'
 end

data/samples/README.md

@@ -0,0 +1,50 @@
+# Sample model sync
+This is a sample to sync information between rails applications using RabbitMQ
+
+## Installation
+* Create manually the required network to share rabbitMQ (just if not exist):   
+  ```docker network create shared_app_services```
+  
+* Start RabbitMQ server   
+  ```docker-compose up pubsub```
+
+* In another tab access to App1 to publish notifications (Wait for step 2)  
+  - Access to the application    
+    `cd samples/app1`    
+  
+  - Build docker and enter rails console    
+    ```docker-compose run app bash -c "rails db:migrate && rails c"```
+  
+  - Create a sample user    
+    ```ruby
+      user = User.create!(name: 'User 1', posts_attributes: [{ title: 'Post 1' }, { title: 'Post 2' }])
+    ```
+    Note: Check app2 console to see notifications (3 notifications)    
+    Note2: Access app2 console to see user and its posts
+    
+  - Update previous user
+    ```ruby
+      user.update!(name: 'User 1 changed', posts_attributes: user.posts.map { |post| { id: post.id, title: "#{post.title} changed" } })
+    ```
+    Note: Check app2 console to see notifications (3 notifications)    
+    Note2: Access app2 console to see changes for user and its posts
+    
+  - Destroy previous user
+    ```ruby
+      user.destroy!
+    ```    
+
+* In another tab access to App2 to listen notifications (Wait for step 2)      
+  - Access to the folder
+    `cd samples/app2`
+  
+  - Build docker and start listener (Received notifications will be printed here)       
+    ```docker-compose run listener```
+  
+  - Optional: Open another tab to access application to ensure synced data
+    ```docker-compose run listener bash -c "rails c```
+    ```ruby
+      user = User.last.inspect
+      user.posts.inspect
+    ```
+  

data/samples/app1/.gitattributes

@@ -0,0 +1,8 @@
+# See https://git-scm.com/docs/gitattributes for more about git attribute files.
+
+# Mark the database schema as having been generated.
+db/schema.rb linguist-generated
+
+
+# Mark any vendored files as having been vendored.
+vendor/* linguist-vendored

data/samples/app1/.gitignore

@@ -0,0 +1,28 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-*
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key

data/samples/app1/Dockerfile

@@ -0,0 +1,13 @@
+FROM ruby:2.7.1 AS builder
+
+# Allow apt to work with https-based sources
+RUN apt-get update -yqq && apt-get install -yqq --no-install-recommends apt-transport-https
+
+RUN mkdir /app
+WORKDIR /app
+
+# backend
+COPY Gemfile.lock Gemfile /app/
+RUN gem install bundler && bundle install
+
+COPY . /app

data/samples/app1/Gemfile

@@ -0,0 +1,37 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails', branch: 'main'
+gem 'rails', '~> 6.1.3', '>= 6.1.3.2'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3', '~> 1.4'
+# Use Puma as the app server
+gem 'puma', '~> 5.0'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+# gem 'jbuilder', '~> 2.7'
+# Use Active Model has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Reduces boot times through caching; required in config/boot.rb
+gem 'bootsnap', '>= 1.4.4', require: false
+
+# Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
+# gem 'rack-cors'
+
+gem 'pub_sub_model_sync'
+gem 'bunny' # to use rabbit-mq pub/sub service
+gem 'annotate'
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+end
+
+group :development do
+  gem 'listen', '~> 3.3'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

data/samples/app1/Gemfile.lock

@@ -0,0 +1,171 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activejob (= 6.1.3.2)
+      activerecord (= 6.1.3.2)
+      activestorage (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      mail (>= 2.7.1)
+    actionmailer (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      actionview (= 6.1.3.2)
+      activejob (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.3.2)
+      actionview (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activerecord (= 6.1.3.2)
+      activestorage (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.3.2)
+      activesupport (= 6.1.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.3.2)
+      activesupport (= 6.1.3.2)
+      globalid (>= 0.3.6)
+    activemodel (6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activerecord (6.1.3.2)
+      activemodel (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activestorage (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activejob (= 6.1.3.2)
+      activerecord (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      marcel (~> 1.0.0)
+      mini_mime (~> 1.0.2)
+    activesupport (6.1.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    amq-protocol (2.3.2)
+    annotate (3.1.1)
+      activerecord (>= 3.2, < 7.0)
+      rake (>= 10.4, < 14.0)
+    bootsnap (1.7.5)
+      msgpack (~> 1.0)
+    builder (3.2.4)
+    bunny (2.17.0)
+      amq-protocol (~> 2.3, >= 2.3.1)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    erubi (1.10.0)
+    ffi (1.15.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    listen (3.5.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    loofah (2.9.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.1)
+    method_source (1.0.0)
+    mini_mime (1.0.3)
+    mini_portile2 (2.5.1)
+    minitest (5.14.4)
+    msgpack (1.4.2)
+    nio4r (2.5.7)
+    nokogiri (1.11.3)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    pub_sub_model_sync (1.0.beta1)
+      rails
+    puma (5.3.1)
+      nio4r (~> 2.0)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.3.2)
+      actioncable (= 6.1.3.2)
+      actionmailbox (= 6.1.3.2)
+      actionmailer (= 6.1.3.2)
+      actionpack (= 6.1.3.2)
+      actiontext (= 6.1.3.2)
+      actionview (= 6.1.3.2)
+      activejob (= 6.1.3.2)
+      activemodel (= 6.1.3.2)
+      activerecord (= 6.1.3.2)
+      activestorage (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      bundler (>= 1.15.0)
+      railties (= 6.1.3.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rake (13.0.3)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    spring (2.1.1)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  annotate
+  bootsnap (>= 1.4.4)
+  bunny
+  byebug
+  listen (~> 3.3)
+  pub_sub_model_sync (= 1.0.beta2)
+  puma (~> 5.0)
+  rails (~> 6.1.3, >= 6.1.3.2)
+  spring
+  sqlite3 (~> 1.4)
+  tzinfo-data
+
+BUNDLED WITH
+   2.1.4