rocketjob 6.0.0.rc2 → 6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6568c1307b7d42a0968df0335e3177967a8223838eceecbe0b3c0cab72c398af
-  data.tar.gz: 1109611ffce2fe4aed881f5bd9d017681546f06d62330ffc21873adbef12c179
+  metadata.gz: 10ef66caa28110774987fdeff06af1a4906ed724bc307bf55d012e1104a9eca8
+  data.tar.gz: b0384cccd5d694a3431c6c9cb7d004603c4b79865929b8c2bb249b4b66e937a2
 SHA512:
-  metadata.gz: 073adf2196d6d0cfd5c06ad8776374a1a14618b5fbd49a550e9d8df587b0a17fd95b4dad34a60d8812a2c5f4046974e22bcf616512d77442ea28145d9bd374d2
-  data.tar.gz: ee9b6d35149f7d7799071485f2e4032d47303d3452a4b7c70c5422019a66615938dba90e1e27090a4f33b635df6f565871efd3152f5a2f2a5cb03a61168b3755
+  metadata.gz: 331a1c21ad9c2b481e67d5d3857e3158dd23a7bb6524dd872773e0aad0e0c5edb4e02d4a60be6498bc212e2517c81c027ce7f22d6b378e9d5772c391669c4347
+  data.tar.gz: e46cdffa443cc75d5dbed5f396ec84fb19fd12bad5b48bbddad7d310526a941bd837f778da8391460e40c575caed62c6e0329adc99ae8c58b07ada694cb1684c

data/README.md

@@ -17,21 +17,177 @@ Checkout https://rocketjob.io/
 * Questions? Join the chat room on Gitter for [rocketjob support](https://gitter.im/rocketjob/support)
 * [Report bugs](https://github.com/rocketjob/rocketjob/issues)
 
-## Rocket Job v5
+## Rocket Job v6
 
 - Support for Ruby v3 and Rails 6.
-- Multiple output file support through extended `output_categories` capability.
-    - File output formats for each category. For example: CSV, PSV, JSON, etc.
-- Support for AWS DocumentDB as the data store.
+- Major enhancements in Batch job support:
+    - Direct built-in Tabular support for all input and output categories.
+    - Multiple output file support, each with its own settings for:
+        - Compression
+            - GZip, Zip, BZip2 (Chunked for much faster loading into Apache Spark).
+        - Encryption
+            - PGP, Symmetric Encryption.
+        - File format
+            - CSV, PSV, JSON, Fixed Format, xlsx.
+- Significant error handling improvements, especially around throttle failures
+  that used to result in "hanging" jobs.
+- Support AWS DocumentDB in addition to MongoDB as the data store.
 - Removed use of Symbols to meet Symbol deprecation in MongoDB and Mongoid.
 
-The following plugins have been deprecated and will be removed in Rocket Job v5.1
-- RocketJob::Batch::Tabular::Input
-- RocketJob::Batch::Tabular::Output
+### Upgrading to Rocket Job v6
+
+The following plugins have been deprecated and are no longer loaded by default.
+- `RocketJob::Batch::Tabular::Input`
+- `RocketJob::Batch::Tabular::Output`
+
+If your code relies on these plugins and you still want to upgrade to Rocket Job v6,
+add the following require statement to any jobs that still use them:
+
+~~~ruby
+require "rocket_job/batch/tabular"
+~~~
+
+It is important to migrate away from these plugins, since they will be removed in a future release.
+
+#### Scheduled Jobs
+
+For any scheduled jobs that include the `RocketJob::Plugins::Cron` plugin, the default behavior has changed
+so that the scheduled job instance is created immediately after the currently scheduled instance starts.
+
+To maintain the old behavior of creating the job when it fails, aborts, or completes, add the following line
+to each of the applicable jobs:
+
+~~~ruby
+self.cron_after_start = false
+~~~
+
+Additionally, scheduled jobs will now prevent a new one from being created when another scheduled instance 
+of the same job is already queued, or running with the _same_ `cron_schedule`.
+
+To maintain the old behavior of allowing multiple instances with the same cron schedule, add the following
+line to each of the applicable jobs:
+
+~~~ruby
+self.cron_singleton = false
+~~~
+
+##### Singleton
+
+Since Scheduled jobs now implement their own singleton logic, remove the singleton plugin from any scheduled jobs.
+
+#### Upgrading Batch Jobs to Rocket Job v6
+
+Rocket Job v6 replaces the array of symbol type for `input_categories` and `output_categories`
+with an array of `RocketJob::Category::Input` and `RocketJob::Category::Output`.
+
+Jobs that added or modified the input or output categories need to be upgraded. For example:
+~~~ruby
+class MyJob < RocketJob::Job
+  include RocketJob::Batch
+  
+  self.output_categories = [:main, :errors, :ignored]
+end
+~~~
+
+Needs to be changed to:
+~~~ruby
+class MyJob < RocketJob::Job
+  include RocketJob::Batch
+  
+  output_category name: :main
+  output_category name: :errors
+  output_category name: :ignored
+end
+~~~
+
+##### slice_size, encrypt, compress
+
+These fields have been removed from the job itself:
+~~~ruby
+class MyJob < RocketJob::Job
+  include RocketJob::Batch
+  
+  self.slice_sice = 1_000
+  self.encrypt    = true
+  self.compress   = true
+end
+~~~
+
+They are now specified on the `input_category` as follows:
+- `slice_size` just moves under `input_category`. 
+- `encrypt` becomes an option to `serializer`.
+- `compress` is now the default for all batch jobs so is not needed.
+
+If the serializer is set to `encrypt` then it is automatically compressed.
+
+~~~ruby
+class MyJob < RocketJob::Job
+  include RocketJob::Batch
+  
+  input_category slice_sice: 1_000, serializer: :encrypt
+end
+~~~
+
+##### collect_output, collect_nil_output
+
+The following fields have been moved from the job itself:
+~~~ruby
+class MyJob < RocketJob::Job
+  include RocketJob::Batch
+  
+  self.collect_output     = true
+  self.collect_nil_output = true
+end
+~~~
+
+Into the corresponding `output_category`:
+- `collect_output` no longer has any meaning. Output is collected anytime an `output_category` is defined.
+- `collect_nil_output` is now the option `nils` on the `output_category. 
+  It defaults to `false` so that by default any `nil` output from the `perform` method is not collected. 
+~~~ruby
+class MyJob < RocketJob::Job
+  include RocketJob::Batch
+
+  output_category nils: true
+end
+~~~
+
+##### name
+
+For both `input_category` and `output_category`, when the `name` argument is not supplied
+it defaults to `:main`.
+
+For Example:
+~~~ruby
+class MyJob < RocketJob::Job
+  include RocketJob::Batch
+
+  input_category name: :main, serializer: :encrypt
+  output_category name: :main
+end
+~~~
+
+Is the same as:
+~~~ruby
+class MyJob < RocketJob::Job
+  include RocketJob::Batch
+
+  input_category serializer: :encrypt
+  output_category
+end
+~~~
+
+##### Existing and inflight jobs
+
+When migrating to Rocket Job 6, it is recommended to load every job and then save it back again as part of the 
+deployment. When the job loads it will automatically convert itself from the old schema to the new v6 schema.
+
+In flight jobs should not be affected, other than it is important to shutdown all running batch 
+servers _before_ running any new instances.
 
 ## Rocket Job v4
 
-Rocket Job Pro is now open source and included in Rocket Job. 
+Rocket Job Pro is now fully open source and included in Rocket Job under the Apache License. 
 
 The `RocketJob::Batch` plugin now adds batch processing capabilities to break up a single task into many
 concurrent workers processing slices of the entire job at the same time. 

data/lib/rocket_job/batch/categories.rb

@@ -72,34 +72,37 @@ module RocketJob
       end
 
       def input_category(category_name = :main)
+        return category_name if category_name.is_a?(Category::Input)
+        raise(ArgumentError, "Cannot supply Output Category to input category") if category_name.is_a?(Category::Output)
+
+        # Initialize categories when this method is called before initialization is complete
+        rocketjob_categories_assign if input_categories.empty?
+
         category_name = category_name.to_sym
-        category      = nil
-        # .find does not work against this association
-        input_categories.each { |catg| category = catg if catg.name == category_name }
-        unless category
-          # Auto-register main input category if missing
-          if category_name == :main
-            category              = Category::Input.new
-            self.input_categories = [category]
-          else
-            raise(ArgumentError,
-                  "Unknown Input Category: #{category_name.inspect}. Registered categories: #{input_categories.collect(&:name).join(',')}")
-          end
-        end
-        category
+        # find does not work against this association
+        input_categories.each { |category| return category if category.name == category_name }
+
+        raise(
+          ArgumentError,
+          "Unknown Input Category: #{category_name.inspect}. Registered categories: #{input_categories.collect(&:name).join(',')}"
+        )
       end
 
       def output_category(category_name = :main)
+        return category_name if category_name.is_a?(Category::Output)
+        raise(ArgumentError, "Cannot supply Input Category to output category") if category_name.is_a?(Category::Input)
+
+        # Initialize categories when this method is called before initialization is complete
+        rocketjob_categories_assign if output_categories.empty? && self.class.defined_output_categories
+
         category_name = category_name.to_sym
-        category      = nil
         # .find does not work against this association
-        output_categories.each { |catg| category = catg if catg.name == category_name }
-        unless category
-          raise(ArgumentError,
-                "Unknown Output Category: #{category_name.inspect}. Registered categories: #{output_categories.collect(&:name).join(',')}")
-        end
+        output_categories.each { |category| return category if category.name == category_name }
 
-        category
+        raise(
+          ArgumentError,
+          "Unknown Output Category: #{category_name.inspect}. Registered categories: #{output_categories.collect(&:name).join(',')}"
+        )
       end
 
       # Returns [true|false] whether the named category has already been defined
@@ -150,7 +153,7 @@ module RocketJob
             end
         end
 
-        return if !self.class.defined_output_categories || !output_categories.empty?
+        return if !output_categories.empty? || !self.class.defined_output_categories
 
         # Input categories defaults to nil if none was set in the class
         self.output_categories = self.class.defined_output_categories.deep_dup
@@ -160,7 +163,6 @@ module RocketJob
       def rocketjob_categories_output_render
         return if @rocket_job_output.nil?
 
-        # TODO: ..
         return unless output_categories
         return if output_categories.empty?
 
@@ -214,7 +216,7 @@ module RocketJob
         category.tabular.render(row)
       end
 
-      # Migrate existing v4 batch jobs to v5.0
+      # Migrate existing v5 batch jobs to v6
       def rocketjob_categories_migrate
         return unless attribute_present?(:input_categories) && self[:input_categories]&.first.is_a?(Symbol)
 

data/lib/rocket_job/batch/io.rb

@@ -14,11 +14,9 @@ module RocketJob
       #     Default: None ( Uses the single default input collection for this job )
       #     Validates: This value must be one of those listed in #input_categories
       def input(category = :main)
-        raise(ArgumentError, "Cannot supply Output Category to input category") if category.is_a?(Category::Output)
+        category = input_category(category)
 
-        category = input_category(category) unless category.is_a?(Category::Input)
-
-        (@inputs ||= {})[category.name] ||= RocketJob::Sliced.factory(:input, category, self)
+        (@inputs ||= {})[category.name] ||= category.data_store(self)
       end
 
       # Returns [RocketJob::Sliced::Output] output collection for holding output slices
@@ -30,11 +28,9 @@ module RocketJob
       #     Default: None ( Uses the single default output collection for this job )
       #     Validates: This value must be one of those listed in #output_categories
       def output(category = :main)
-        raise(ArgumentError, "Cannot supply Input Category to output category") if category.is_a?(Category::Input)
-
-        category = output_category(category) unless category.is_a?(Category::Output)
+        category = output_category(category)
 
-        (@outputs ||= {})[category.name] ||= RocketJob::Sliced.factory(:output, category, self)
+        (@outputs ||= {})[category.name] ||= category.data_store(self)
       end
 
       # Rapidly upload individual records in batches.
@@ -59,19 +55,19 @@ module RocketJob
       #     The category or the name of the category to access or download data from
       #     Default: None ( Uses the single default output collection for this job )
       #     Validates: This value must be one of those listed in #input_categories
-      def lookup_collection(category = :main)
-        category = input_category(category) unless category.is_a?(Category::Input)
-
-        collection = (@lookup_collections ||= {})[category.name]
-
-        unless collection
-          collection_name = "rocket_job.inputs.#{id}"
-          collection_name << ".#{category.name}" unless category.name == :main
-
-          @lookup_collections[category.name] ||=
-            LookupCollection.new(Sliced::Slice.collection.database, collection_name)
-        end
-      end
+      # def lookup_collection(category = :main)
+      #   category = input_category(category) unless category.is_a?(Category::Input)
+      #
+      #   collection = (@lookup_collections ||= {})[category.name]
+      #
+      #   unless collection
+      #     collection_name = "rocket_job.inputs.#{id}"
+      #     collection_name << ".#{category.name}" unless category.name == :main
+      #
+      #     @lookup_collections[category.name] ||=
+      #       LookupCollection.new(Sliced::Slice.collection.database, collection_name)
+      #   end
+      # end
 
       # Upload the supplied file, io, IOStreams::Path, or IOStreams::Stream.
       #
@@ -154,53 +150,7 @@ module RocketJob
       # * If an io stream is supplied, it is read until it returns nil.
       # * Only use this method for UTF-8 data, for binary data use #input_slice or #input_records.
       # * CSV parsing is slow, so it is usually left for the workers to do.
-      def upload(stream = nil, file_name: nil, category: :main, stream_mode: :line, on_first: nil, **args, &block)
-        raise(ArgumentError, "Either stream, or a block must be supplied") unless stream || block
-
-        category = input_category(category) unless category.is_a?(Category::Input)
-        stream ||= category.file_name
-        path     = nil
-
-        if stream
-          path               = IOStreams.new(stream)
-          path.file_name     = file_name if file_name
-          category.file_name = path.file_name
-
-          # Auto detect the format based on the upload file name if present.
-          if category.format == :auto
-            format = path.format
-            if format
-              # Rebuild tabular with the above file name
-              category.reset_tabular
-              category.format = format
-            end
-          end
-        end
-
-        # Tabular transformations required for upload?
-        if category.tabular?
-          # Remove non-printable characters from tabular input formats
-          # Cannot change the length of fixed width lines
-          replace = category.format == :fixed ? " " : ""
-          path&.option_or_stream(:encode, encoding: "UTF-8", cleaner: :printable, replace: replace)
-
-          # Extract the header line during the file upload when needed.
-          on_first = rocket_job_upload_header_lambda(category, on_first) if category.tabular.header?
-        end
-
-        count =
-          if block
-            input(category).upload(on_first: on_first, &block)
-          else
-            input(category).upload(on_first: on_first) do |io|
-              path.each(stream_mode, **args) { |line| io << line }
-            end
-          end
-
-        self.record_count = (record_count || 0) + count
-        count
-      end
-
+      #
       # Upload results from an Arel into RocketJob::SlicedJob.
       #
       # Params
@@ -227,18 +177,13 @@ module RocketJob
       #
       # Example: Upload user_name and zip_code
       #   arel = User.where(country_code: 'US')
-      #   job.upload_arel(arel, :user_name, :zip_code)
+      #   job.upload_arel(arel, columns: [:user_name, :zip_code])
       #
       # Notes:
       # * Only call from one thread at a time against a single instance of this job.
       # * The record_count for the job is set to the number of records returned by the arel.
       # * If an exception is raised while uploading data, the input collection is cleared out
       #   so that if a job is retried during an upload failure, data is not duplicated.
-      def upload_arel(arel, *column_names, category: :main, &block)
-        count             = input(category).upload_arel(arel, *column_names, &block)
-        self.record_count = (record_count || 0) + count
-        count
-      end
 
       # Upload the result of a MongoDB query to the input collection for processing
       # Useful when an entire MongoDB collection, or part thereof needs to be
@@ -266,24 +211,19 @@ module RocketJob
       #   criteria = User.where(state: 'FL')
       #   job.record_count = job.upload_mongo_query(criteria)
       #
-      # Example: Upload just the supplied column
+      # Example: Upload only the specified column(s)
       #   criteria = User.where(state: 'FL')
-      #   job.record_count = job.upload_mongo_query(criteria, :zip_code)
+      #   job.record_count = job.upload_mongo_query(criteria, columns: [:zip_code])
       #
       # Notes:
       # * Only call from one thread at a time against a single instance of this job.
       # * The record_count for the job is set to the number of records returned by the monqo query.
       # * If an exception is raised while uploading data, the input collection is cleared out
       #   so that if a job is retried during an upload failure, data is not duplicated.
-      def upload_mongo_query(criteria, *column_names, category: :main, &block)
-        count             = input(category).upload_mongo_query(criteria, *column_names, &block)
-        self.record_count = (record_count || 0) + count
-        count
-      end
 
       # Upload sliced range of integer requests as arrays of start and end ids.
       #
-      # Returns [Integer] last_id - start_id + 1.
+      # Returns [Integer] the number of slices uploaded.
       #
       # Uploads one range per slice so that the response can return multiple records
       # for each slice processed
@@ -302,17 +242,11 @@ module RocketJob
       # * The record_count for the job is set to: last_id - start_id + 1.
       # * If an exception is raised while uploading data, the input collection is cleared out
       #   so that if a job is retried during an upload failure, data is not duplicated.
-      def upload_integer_range(start_id, last_id, category: :main)
-        input(category).upload_integer_range(start_id, last_id)
-        count             = last_id - start_id + 1
-        self.record_count = (record_count || 0) + count
-        count
-      end
 
       # Upload sliced range of integer requests as an arrays of start and end ids
       # starting with the last range first
       #
-      # Returns [Integer] last_id - start_id + 1.
+      # Returns [Integer] the number of slices uploaded.
       #
       # Uploads one range per slice so that the response can return multiple records
       # for each slice processed.
@@ -334,14 +268,102 @@ module RocketJob
       # * The record_count for the job is set to: last_id - start_id + 1.
       # * If an exception is raised while uploading data, the input collection is cleared out
       #   so that if a job is retried during an upload failure, data is not duplicated.
-      def upload_integer_range_in_reverse_order(start_id, last_id, category: :main)
-        input(category).upload_integer_range_in_reverse_order(start_id, last_id)
-        count             = last_id - start_id + 1
+
+      def upload(object = nil, category: :main, file_name: nil, stream_mode: nil, on_first: nil, columns: nil, slice_batch_size: nil, **args, &block)
+        input_collection = input(category)
+
+        if block
+          raise(ArgumentError, "Cannot supply both an object to upload, and a block.") if object
+          if stream_mode || columns || slice_batch_size || args.size > 0
+            raise(ArgumentError, "Unknown keyword arguments when uploading a block. Only accepts :category, :file_name, or :on_first")
+          end
+
+          category           = input_category(category)
+          category.file_name = file_name if file_name
+
+          # Extract the header line during the upload when applicable.
+          extract_header = category.extract_header_callback(on_first)
+
+          count             = input_collection.upload(on_first: extract_header, slice_batch_size: slice_batch_size, &block)
+          self.record_count = (record_count || 0) + count
+          return count
+        end
+
+        count =
+          case object
+          when Range
+            if file_name || stream_mode || on_first || args.size > 0
+              raise(ArgumentError, "Unknown keyword arguments when uploading a Range. Only accepts :category, :columns, or :slice_batch_size")
+            end
+
+            first = object.first
+            last  = object.last
+            if first < last
+              input_collection.upload_integer_range(first, last, slice_batch_size: slice_batch_size || 1_000)
+            else
+              input_collection.upload_integer_range_in_reverse_order(last, first, slice_batch_size: slice_batch_size || 1_000)
+            end
+          when Mongoid::Criteria
+            if file_name || stream_mode || on_first || args.size > 0
+              raise(ArgumentError, "Unknown keyword arguments when uploading a Mongoid::Criteria. Only accepts :category, :columns, or :slice_batch_size")
+            end
+
+            input_collection.upload_mongo_query(object, columns: columns, slice_batch_size: slice_batch_size, &block)
+          when defined?(ActiveRecord::Relation) ? ActiveRecord::Relation : false
+            if file_name || stream_mode || on_first || args.size > 0
+              raise(ArgumentError, "Unknown keyword arguments when uploading an ActiveRecord::Relation. Only accepts :category, :columns, or :slice_batch_size")
+            end
+
+            input_collection.upload_arel(object, columns: columns, slice_batch_size: slice_batch_size, &block)
+
+          else
+            raise(ArgumentError, "Unknown keyword argument :columns when uploading a file") if columns
+
+            category = input_category(category)
+
+            # Extract the header line during the upload when applicable.
+            extract_header = category.extract_header_callback(on_first)
+            path = category.upload_path(object, original_file_name: file_name)
+
+            input_collection.upload(on_first: extract_header, slice_batch_size: slice_batch_size) do |io|
+              path.each(stream_mode || :line, **args) { |line| io << line }
+            end
+
+          end
+
+        self.record_count = (record_count || 0) + count
+        count
+      end
+
+      # @deprecated
+      def upload_arel(arel, *column_names, category: :main, &block)
+        count             = input(category).upload_arel(arel, columns: column_names, &block)
         self.record_count = (record_count || 0) + count
         count
       end
 
-      # Upload the supplied slices for processing by workers
+      # @deprecated
+      def upload_mongo_query(criteria, *column_names, category: :main, &block)
+        count             = input(category).upload_mongo_query(criteria, columns: column_names, &block)
+        self.record_count = (record_count || 0) + count
+        count
+      end
+
+      # @deprecated
+      def upload_integer_range(start_id, last_id, category: :main, slice_batch_size: 1_000)
+        count             = input(category).upload_integer_range(start_id, last_id, slice_batch_size: slice_batch_size)
+        self.record_count = (record_count || 0) + count
+        count
+      end
+
+      # @deprecated
+      def upload_integer_range_in_reverse_order(start_id, last_id, category: :main, slice_batch_size: 1_000)
+        count             = input(category).upload_integer_range_in_reverse_order(start_id, last_id, slice_batch_size: slice_batch_size)
+        self.record_count = (record_count || 0) + count
+        count
+      end
+
+      # Upload the supplied slice for processing by workers
       #
       # Updates the record_count after adding the records
       #
@@ -427,50 +449,28 @@ module RocketJob
         # Store the output file name in the category
         category.file_name = stream if !block && (stream.is_a?(String) || stream.is_a?(IOStreams::Path))
 
-        if output_collection.binary?
-          raise(ArgumentError, "A `header_line` is not supported with binary output collections") if header_line
-
-          return output_collection.download(&block) if block
+        header_line ||= category.render_header
 
-          IOStreams.new(stream || category.file_name).stream(:none).writer(**args) do |io|
-            output_collection.download { |record| io << record[:binary] }
-          end
-        else
-          header_line ||= category.render_header
+        return output_collection.download(header_line: header_line, &block) if block
 
-          return output_collection.download(header_line: header_line, &block) if block
+        raise(ArgumentError, "Missing mandatory `stream` or `category.file_name`") unless stream || category.file_name
 
-          raise(ArgumentError, "Missing mandatory `stream` or `category.file_name`") unless stream || category.file_name
+        if output_collection.slice_class.binary_format
+          binary_header_line = output_collection.slice_class.to_binary(header_line) if header_line
 
+          # Don't overwrite supplied stream options if any
+          stream = stream&.is_a?(IOStreams::Stream) ? stream.dup : IOStreams.new(category.file_name)
+          stream.remove_from_pipeline(output_collection.slice_class.binary_format)
+          stream.writer(**args) do |io|
+            # TODO: Binary formats should return the record count, instead of the slice count.
+            output_collection.download(header_line: binary_header_line) { |record| io.write(record) }
+          end
+        else
           IOStreams.new(stream || category.file_name).writer(:line, **args) do |io|
             output_collection.download(header_line: header_line) { |record| io << record }
           end
         end
       end
-
-      private
-
-      # Return a lambda to extract the header row from the uploaded file.
-      def rocket_job_upload_header_lambda(category, on_first)
-        case category.mode
-        when :line
-          lambda do |line|
-            category.tabular.parse_header(line)
-            category.cleanse_header!
-            category.columns = category.tabular.header.columns
-            # Call chained on_first if present
-            on_first&.call(line)
-          end
-        when :array
-          lambda do |row|
-            category.tabular.header.columns = row
-            category.cleanse_header!
-            category.columns = category.tabular.header.columns
-            # Call chained on_first if present
-            on_first&.call(line)
-          end
-        end
-      end
     end
   end
 end