operationable 0.2.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2acea623e67938b58cb568d705062a86d5005ce2
-  data.tar.gz: 6145faa763a9fe92e19852bf5bb91c2d95c4bb11
+  metadata.gz: 87e1e8d542b6b207ed3189bb0c75221a0d36511c
+  data.tar.gz: 486232650b057a3d541bbecf2768375ce9987e28
 SHA512:
-  metadata.gz: ef5a0e1e38e6978caa2f72d63ec45305ae6d39721957d841d20921459ca310d9018ea8de5a03e472f6dd8fdd7833d15e87c3ddeeb693850513da264e520cce72
-  data.tar.gz: e2bbd17615a9a4285b9be47939d6d73a4386f311f29387e50db200bfa0490724062193c411c5ecec6d65f8c25e442532136acde3bc307ff74e0b1aadd103a8ea
+  metadata.gz: 199c43f18a8d2710be243450544e640b12be0c0841cbeeb8af015a71eaf1858a4afe880c91f15f277eb344d442aa962c4cba60ef7d9d5ed6ed0a09cd6c34ab03
+  data.tar.gz: a0ec714a500f3e4dab37704edd1fafcfad723fe8933c341cb3dfcddf81ee2772b20969f48682641a5f2181254b829b4ecf3a494fdc89080ff171d848a7cd4b22

data/README.md

@@ -115,22 +115,20 @@ TODO: describe validators
 
 #Persistence and guaranteed delivery
 
-First add table to store operations and track their execution
+First add table to store operations and track their execution in pair with resque-status
 
 ```
-class CreateOperations < ActiveRecord::Migration[5.0]
+class CreateOperationCallbacks < ActiveRecord::Migration[5.0]
   def change
-    create_table :operations do |t|
-      t.string :name
-      t.integer :initiator_id
-      t.jsonb :params, default: {}
-      t.jsonb :callbacks, default: {}
+    create_table :operation_callbacks do |t|
+      t.string :status
+      t.text :message
+      t.string :uuid
+      t.json :q_options
+      t.json :props
 
       t.timestamps
     end
-
-    add_index :operations, :initiator_id
-    add_index :operations, :name
   end
 end
 ```

data/lib/jobs/operation_job.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 class OperationJob < ActiveJob::Base
+  include Operationable::Persisters::Base
   include Operationable::Persisters::Memory
-  # include Operationable::Persister
+  include Operationable::Persisters::Database
 
   queue_as do
     arguments.first[:q_options][:queue]
   end
 
   after_enqueue do |job|
-    create_status_hash(job)
+    create_status_hash
+    notify_database
   end
 
   around_perform do |job, block|

data/lib/models/operation_callback.rb

@@ -0,0 +1,16 @@
+# == Schema Information
+#
+# Table name: operation_callbacks
+#
+#  id         :integer          not null, primary key
+#  status     :string
+#  message    :text
+#  uuid       :string
+#  q_options  :json
+#  props      :json
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
+
+class OperationCallback < ActiveRecord::Base
+end

data/lib/operationable.rb

@@ -22,7 +22,7 @@ require 'operationable/runners/serial'
 require 'operationable/runners/separate'
 
 require 'jobs/operation_job'
-require 'models/operation'
+require 'models/operation_callback'
 
 require 'operations/create'
 require 'operations/destroy'

data/lib/operationable/persisters/base.rb

@@ -15,6 +15,93 @@ module Operationable
         STATUS_FAILED,
         STATUS_KILLED
       ].freeze
+
+      extend Forwardable
+      extend ActiveSupport::Concern
+
+      class Killed < RuntimeError; end
+      class NotANumber < RuntimeError; end
+
+      # attr_reader :uuid, :options
+
+      def uuid
+        self.job_id
+      end
+
+      def options
+        arguments.first
+      end
+
+      # Run by the Resque::Worker when processing this job. It wraps the <tt>perform</tt>
+      # method ensuring that the final status of the job is set regardless of error.
+      # If an error occurs within the job's work, it will set the status as failed and
+      # re-raise the error.
+      def safe_perform(job, block)
+        working
+        block.call
+        if status && status.failed?
+          on_failure(status.message) if respond_to?(:on_failure)
+          return
+        elsif status && !status.completed?
+          completed
+        end
+        on_success if respond_to?(:on_success)
+      rescue Killed
+        Resque::Plugins::Status::Hash.killed(uuid)
+        on_killed if respond_to?(:on_killed)
+      rescue => e
+        failed("The task failed because of an error: #{e}")
+        if respond_to?(:on_failure)
+          on_failure(e)
+        else
+          raise e
+        end
+      end
+
+      def name
+        "#{self.class.name}(#{callback_class_name} #{callback_method_name})"
+      end
+
+      def callback_class_name
+        arguments.first[:q_options][:callback_class_name]
+      end
+
+      def callback_method_name
+        arguments.first[:q_options][:callback_method_name]
+      end
+
+      def working
+        set_status({'status' => Operationable::Persisters::Base::STATUS_WORKING})
+      end
+
+      # set the status to 'failed' passing along any additional messages
+      def failed(*messages)
+        set_status({'status' => Operationable::Persisters::Base::STATUS_FAILED}, *messages)
+      end
+
+      # set the status to 'completed' passing along any addional messages
+      def completed(*messages)
+        set_status({
+          'status' => Operationable::Persisters::Base::STATUS_COMPLETED,
+          'message' => "Completed at #{Time.now}"
+        }, *messages)
+      end
+
+      # kill the current job, setting the status to 'killed' and raising <tt>Killed</tt>
+      def kill!
+        set_status({
+          'status' => Operationable::Persisters::Base::STATUS_KILLED,
+          'message' => "Killed at #{Time.now}"
+        })
+        raise Killed
+      end
+
+      private
+
+      def set_status(*args)
+        self.database_status = args
+        self.status = [status, {'name'  => name}, args].flatten
+      end
     end
   end
 end

data/lib/operationable/persisters/database.rb

@@ -2,48 +2,28 @@
 module Operationable
   module Persisters
     module Database
-      class << self
-        def persist(callbacks, initiator_id, params, name)
-          ::Operation.create(
-          callbacks: callbacks.map { |callback|
-            {
-              status: Operationable::Persisters::Base::STATUS_INIT,
-              name: callback[:callback_method_name],
-              queue: callback[:queue]
-            }
-          },
-          initiator_id: initiator_id,
-          params: params,
-          name: name
-          )
-        end
-
-        def working(id, name)
-          update(id, name, Operationable::Persisters::Base::STATUS_WORKING)
-        end
-
-        def completed(id, name)
-          update(id, name, Operationable::Persisters::Base::STATUS_COMPLETED)
-        end
+      def self.create(q_options, props)
+        ::OperationCallback.create(
+          q_options: q_options, props: props, status: Operationable::Persisters::Base::STATUS_INIT
+        )
+      end
 
-        def around_call(id, name, block)
-          working(id, name)
-          block.call
-          completed(id, name)
-        end
+      def notify_database
+        self.database_status = [{status: Operationable::Persisters::Base::STATUS_QUEUED}]
+      end
 
-        private
+      def op_cb_id
+        arguments.first[:q_options][:op_cb_id]
+      end
 
-        def update(id, name, status)
-          op = ::Operation.find(id)
-          callbacks = op.callbacks.map do |cb|
-            cb['status'] = status if cb['name'] === name
-            cb
-          end
+      def database_status
+        ::OperationCallback.find(op_cb_id)
+      end
 
-          op.callbacks = callbacks
-          op.save
-        end
+      def database_status=(new_status)
+        ::OperationCallback.find(op_cb_id).update(
+          new_status.reduce({uuid: uuid}){ |acc, o| acc.merge(o) }
+        )
       end
     end
   end

data/lib/operationable/persisters/memory.rb

@@ -3,55 +3,10 @@
 module Operationable
   module Persisters
     module Memory
-      extend Forwardable
-      extend ActiveSupport::Concern
-
       autoload :Hash, 'resque/plugins/status/hash'
 
-      # The error class raised when a job is killed
-      class Killed < RuntimeError; end
-      class NotANumber < RuntimeError; end
-
-      attr_reader :uuid, :options
-
-      def create_status_hash(job)
-        Resque::Plugins::Status::Hash.create(self.job_id, arguments.first)
-      end
-
-      def uuid
-        self.job_id
-      end
-
-      def options
-        arguments.first
-      end
-
-      # Run by the Resque::Worker when processing this job. It wraps the <tt>perform</tt>
-      # method ensuring that the final status of the job is set regardless of error.
-      # If an error occurs within the job's work, it will set the status as failed and
-      # re-raise the error.
-      def safe_perform(job, block)
-        working
-
-        block.call
-
-        if status && status.failed?
-          on_failure(status.message) if respond_to?(:on_failure)
-          return
-        elsif status && !status.completed?
-          completed
-        end
-        on_success if respond_to?(:on_success)
-      rescue Killed
-        Resque::Plugins::Status::Hash.killed(uuid)
-        on_killed if respond_to?(:on_killed)
-      rescue => e
-        failed("The task failed because of an error: #{e}")
-        if respond_to?(:on_failure)
-          on_failure(e)
-        else
-          raise e
-        end
+      def create_status_hash
+        Resque::Plugins::Status::Hash.create(uuid, options)
       end
 
       # Set the jobs status. Can take an array of strings or hashes that are merged
@@ -65,10 +20,6 @@ module Operationable
         Resque::Plugins::Status::Hash.get(uuid)
       end
 
-      def name
-        "#{self.class.name}(#{options.inspect unless options.empty?})"
-      end
-
       # Checks against the kill list if this specific job instance should be killed
       # on the next iteration
       def should_kill?
@@ -89,10 +40,6 @@ module Operationable
         }, *messages)
       end
 
-      def working
-        set_status({'status' => Operationable::Persisters::Base::STATUS_WORKING})
-      end
-
       # sets the status of the job for the current itteration. You should use
       # the <tt>at</tt> method if you have actual numbers to track the iteration count.
       # This will kill the job if it has been added to the kill list with
@@ -102,33 +49,6 @@ module Operationable
         set_status({'status' => Operationable::Persisters::Base::STATUS_WORKING}, *messages)
       end
 
-      # set the status to 'failed' passing along any additional messages
-      def failed(*messages)
-        set_status({'status' => Operationable::Persisters::Base::STATUS_FAILED}, *messages)
-      end
-
-      # set the status to 'completed' passing along any addional messages
-      def completed(*messages)
-        set_status({
-          'status' => Operationable::Persisters::Base::STATUS_COMPLETED,
-          'message' => "Completed at #{Time.now}"
-        }, *messages)
-      end
-
-      # kill the current job, setting the status to 'killed' and raising <tt>Killed</tt>
-      def kill!
-        set_status({
-          'status' => Operationable::Persisters::Base::STATUS_KILLED,
-          'message' => "Killed at #{Time.now}"
-        })
-        raise Killed
-      end
-
-      private
-
-      def set_status(*args)
-        self.status = [status, {'name'  => self.name}, args].flatten
-      end
     end
   end
 end

data/lib/operationable/runners/base.rb

@@ -14,6 +14,11 @@ module Operationable
         initialize_callbacks
       end
 
+      def store_callback(q_options)
+        op_cb = ::Operationable::Persisters::Database.create(q_options, props)
+        q_options.merge({op_cb_id: op_cb.id})  
+      end
+
       def persist_operation
         @persist_operation ||= ::Operationable::Persisters::Database.persist(check_callbacks, user.id, props, operation_class_name)
       end

data/lib/operationable/runners/separate.rb

@@ -14,23 +14,15 @@ module Operationable
       end
 
       def q_options(callback_method_name, queue)
-        { type: 'separate',
+        store_callback({ type: 'separate',
           callback_class_name: callback_class_name,
           callback_method_name: callback_method_name,
-          queue: queue,
-          op_id: persist_operation.id }
+          queue: queue })
       end
 
       def self.call(q_options:, props:)
         q_options[:callback_class_name].constantize.new(props).method(q_options[:callback_method_name]).call
       end
-
-      # TODO: No sense, due to performance deterioration, better use postgres/mysql database
-      # def self.call(q_options, props)
-      #   ::Operationable::Persister.around_call(q_options[:op_id], q_options[:callback_method_name], -> {
-      #     q_options[:callback_class_name].constantize.new(props).method(q_options[:callback_method_name]).call
-      #   })
-      # end
     end
   end
 end

data/lib/operationable/runners/serial.rb

@@ -18,23 +18,11 @@ module Operationable
         q_options[:callback_names].each { |method_name| instance.method(method_name).call }
       end
 
-      # TODO: No sense, due to performance deterioration, better use postgres/mysql database
-      # def self.call(q_options, props)
-      #   instance = q_options[:callback_class_name].constantize.new(props)
-      #
-      #   q_options[:callback_names].each do |method_name|
-      #     ::Operationable::Persister.around_call(q_options[:op_id], method_name, -> {
-      #       instance.method(method_name).call
-      #     })
-      #   end
-      # end
-
       def q_options
-        { type: 'serial',
+        store_callback({ type: 'serial',
           callback_class_name: callback_class_name,
           callback_names: callback_names,
-          queue: queue,
-          op_id: persist_operation.id }
+          queue: queue })
       end
 
       private

data/lib/operationable/version.rb

@@ -1,3 +1,3 @@
 module Operationable
-  VERSION = "0.2.8"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: operationable
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.0
 platform: ruby
 authors:
 - Kirill Suhodolov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-11 00:00:00.000000000 Z
+date: 2017-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -114,7 +114,7 @@ files:
 - bin/console
 - bin/setup
 - lib/jobs/operation_job.rb
-- lib/models/operation.rb
+- lib/models/operation_callback.rb
 - lib/operationable.rb
 - lib/operationable/builder.rb
 - lib/operationable/callback.rb

data/lib/models/operation.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-# == Schema Information
-#
-# Table name: operations
-#
-#  id           :integer          not null, primary key
-#  name         :string
-#  initiator_id :integer
-#  params       :json
-#  callbacks    :json
-#  created_at   :datetime         not null
-#  updated_at   :datetime         not null
-#
-
-class Operation < ActiveRecord::Base
-end