rocketjob 3.5.1 → 3.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb87d22625bed26c75bd82fd284f95bfd73d3e70c1aac45ef8ef9a49c6c94fae
-  data.tar.gz: 51878e58e9a051dcf3f284c1a33e4eb7e3e4e0f87c19f607459e2d1107127f87
+  metadata.gz: bd3505de7a318efb53880ef4c0f506a970d1ee30277f531bef7e2a9f257cf500
+  data.tar.gz: '085e0371c60662b51ba53c4e5e6e1b2e016cdc2e37de1b51a437e5477f907a22'
 SHA512:
-  metadata.gz: 96adc5a3bcd6ad53d86a8bd01b78546318690329de4c0230a7288d233b24a7b0eac47668b880cdd6c724dc861e2c27830dd34452d938e5da4e205b5982615b5c
-  data.tar.gz: d0c947bef27a6b1bc238ff8f04133709cf8339d2be34c951ae9c3a5c3f41cc4110584d78aee2ce44de988372c571942b1d40423f916b4bd57be2d3e809a9c96d
+  metadata.gz: a9a9441957a5405ed1d3d98bbe5bf0a45febbbdf8283c09de967f19abd1e5a7470cc871d66b804f8569ad90b48732fcd4d649e3d0c282b60be2b000bdd60adc8
+  data.tar.gz: d47b9c8a4eba0fd88798b76926da8c4073b0c26c6743ae3b54883535f278ea3317d6fb7901d57caf8506f710b5fdb7151b9acae65e7e2427bf2607a0c926231a

data/lib/rocket_job/jobs/on_demand_job.rb

@@ -74,23 +74,16 @@ module RocketJob
       include RocketJob::Plugins::Cron
       include RocketJob::Plugins::Retry
 
-      self.priority            = 90
-      self.description         = 'Generalized Job'
+      self.description         = 'On Demand Job'
       self.destroy_on_complete = false
       self.retry_limit         = 0
 
       # Be sure to store key names only as Strings, not Symbols
-      field :data, type: Hash, default: {}
-      field :code, type: String
+      field :data, type: Hash, default: {}, copy_on_restart: true
+      field :code, type: String, copy_on_restart: true
 
       validates :code, presence: true
-      validates_each :code do |job, attr, _value|
-        begin
-          job.send(:load_code)
-        rescue Exception => exc
-          job.errors.add(attr, "Failed to parse :code, #{exc.inspect}")
-        end
-      end
+      validate :validate_code
 
       before_perform :load_code
 
@@ -99,6 +92,12 @@ module RocketJob
       def load_code
         instance_eval("def perform\n#{code}\nend", __FILE__, __LINE__)
       end
+
+      def validate_code
+        load_code
+      rescue Exception => exc
+        errors.add(:code, "Failed to parse :code, #{exc.inspect}")
+      end
     end
   end
 end

data/lib/rocket_job/jobs/upload_file_job.rb

@@ -63,6 +63,8 @@ module RocketJob
           if original_file_name && defined?(IOStreams)
             streams = IOStreams.streams_for_file_name(original_file_name)
             job.upload(upload_file_name, streams: streams)
+            # job.upload sets the archived filename, we want it to be the original file name.
+            job.upload_file_name = original_file_name
           else
             job.upload(upload_file_name)
           end

data/lib/rocket_job/plugins/cron.rb

@@ -2,7 +2,13 @@ require 'active_support/concern'
 
 module RocketJob
   module Plugins
-    # Schedule jobs to run at set intervals.
+    # Allow jobs to run on a predefined schedule, much like a crontab.
+    #
+    # Notes:
+    # - No single point of failure since their is no centralized scheduler.
+    # - `cron_schedule` can be edited at any time via the web interface.
+    # - A scheduled job can be run at any time by calling `#run_now!` or
+    #   by clicking `Run Now` in the web interface.
     module Cron
       extend ActiveSupport::Concern
 
@@ -11,15 +17,8 @@ module RocketJob
 
         field :cron_schedule, type: String, class_attribute: true, user_editable: true, copy_on_restart: true
 
-        before_save :rocket_job_set_run_at
-
-        validates_each :cron_schedule do |record, attr, value|
-          begin
-            RocketJob::Plugins::Rufus::CronLine.new(value) if value
-          rescue ArgumentError => exc
-            record.errors.add(attr, exc.message)
-          end
-        end
+        validate :rocket_job_cron_valid
+        before_save :rocket_job_cron_set_run_at
 
         private
 
@@ -41,25 +40,6 @@ module RocketJob
         end
       end
 
-      # Returns [Time] at which this job was intended to run at.
-      #
-      # Takes into account any delays that could occur.
-      # Recommended to use this Time instead of Time.now in the `#perform` since the job could run outside its
-      # intended window. Especially if a failed job is only retried quite sometime later.
-      #
-      # Notes:
-      # * When `cron_schedule` is set, this would be the `run_at` time, otherwise it is the `created_at` time
-      #   since that would be the intended time for which this job is running.
-      def scheduled_at
-        run_at || created_at
-      end
-
-      # Make this job run now, regardless of the cron schedule.
-      # Upon completion the job will automatically reschedule itself.
-      def run_now!
-        update_attributes(run_at: nil) if cron_schedule
-      end
-
       # Returns [Time] the next time this job will be scheduled to run at.
       #
       # Parameters
@@ -72,10 +52,17 @@ module RocketJob
 
       private
 
-      def rocket_job_set_run_at
+      def rocket_job_cron_set_run_at
         return unless cron_schedule
         self.run_at = rocket_job_cron_next_time if cron_schedule_changed? && !run_at_changed?
       end
+
+      def rocket_job_cron_valid
+        return unless cron_schedule
+        RocketJob::Plugins::Rufus::CronLine.new(cron_schedule)
+      rescue ArgumentError => exc
+        errors.add(:cron_schedule, exc.message)
+      end
     end
   end
 end

data/lib/rocket_job/plugins/job/model.rb

@@ -259,6 +259,20 @@ module RocketJob
           running? && worker_name.present? ? [worker_name] : []
         end
 
+        # Clear `run_at` so that this job will run now.
+        def run_now!
+          update_attributes(run_at: nil) if run_at
+        end
+
+        # Returns [Time] at which this job was intended to run at.
+        #
+        # Takes into account any delays that could occur.
+        # Recommended to use this Time instead of Time.now in the `#perform` since the job could run outside its
+        # intended window. Especially if a failed job is only retried quite sometime later.
+        def scheduled_at
+          run_at || created_at
+        end
+
         # Returns [Hash] status of this job
         def as_json
           attrs = serializable_hash(methods: %i[seconds duration])

data/lib/rocket_job/plugins/restart.rb

@@ -114,7 +114,7 @@ module RocketJob
           end
           count += 1
         end
-        logger.warn("New job instance not started: #{job.errors.messages.inspect}")
+        logger.error("New job instance not started: #{job.errors.messages.inspect}")
         false
       end
     end

data/lib/rocket_job/plugins/singleton.rb

@@ -2,23 +2,28 @@ require 'active_support/concern'
 
 module RocketJob
   module Plugins
-    # Prevent more than one instance of this job class from running at a time
+    # Prevent this job from being saved if another is running, queued, or paused.
     module Singleton
       extend ActiveSupport::Concern
 
       included do
-        # Validation prevents a new job from being saved while one is already running
-        validates_each :state do |record, attr, _value|
-          if (record.running? || record.queued? || record.paused?) && record.rocket_job_singleton_active?
-            record.errors.add(attr, "Another instance of #{record.class.name} is already queued or running")
-          end
-        end
+        validate :rocket_job_singleton_check
+      end
+
+      # Returns [true|false] whether another instance of this job is already active
+      def rocket_job_singleton_active?
+        self.class.where(:state.in => %i[running queued], :id.ne => id).exists?
+      end
 
-        # Returns [true|false] whether another instance of this job is already active
-        def rocket_job_singleton_active?
-          self.class.where(:state.in => %i[running queued], :id.ne => id).exists?
-        end
+      private
+
+      # Validation prevents a new job from being saved while one is already running
+      def rocket_job_singleton_check
+        return unless (running? || queued? || paused?) && rocket_job_singleton_active?
+
+        errors.add(:state, "Another instance of #{self.class.name} is already running, queued, or paused")
       end
+
     end
   end
 end

data/lib/rocket_job/version.rb

@@ -1,3 +1,3 @@
 module RocketJob
-  VERSION = '3.5.1'.freeze
+  VERSION = '3.5.2'.freeze
 end

data/test/jobs/upload_file_job_test.rb

@@ -88,10 +88,18 @@ class UploadFileJobTest < Minitest::Test
 
       it 'calls upload with original_file_name' do
         job.job_class_name     = BatchTestJob.name
-        job.original_file_name = 'file.zip'
         job.perform_now
         assert created_job = UploadFileJobTest::BatchTestJob.first
         assert_equal __FILE__, created_job.upload_file_name
+        assert_nil created_job.saved_streams
+      end
+
+      it 'job retains the original_file_name when present' do
+        job.job_class_name     = BatchTestJob.name
+        job.original_file_name = 'file.zip'
+        job.perform_now
+        assert created_job = UploadFileJobTest::BatchTestJob.first
+        assert_equal 'file.zip', created_job.upload_file_name
         assert_equal %i[file zip], created_job.saved_streams
       end
     end

data/test/plugins/singleton_test.rb

@@ -75,7 +75,7 @@ module Plugins
           @job.start!
           job2 = SingletonJob.new
           refute job2.valid?
-          assert_equal ['Another instance of Plugins::SingletonTest::SingletonJob is already queued or running'], job2.errors.messages[:state]
+          assert_equal ['Another instance of Plugins::SingletonTest::SingletonJob is already running, queued, or paused'], job2.errors.messages[:state]
         end
 
         it 'passes if another job is active, but this job is not' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rocketjob
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.5.2
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-10 00:00:00.000000000 Z
+date: 2018-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aasm