dj_split 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf5708e6d48391f29f9fd9bc0078565bebb81f5e9fba0c3af68a8226c056a37f
+  data.tar.gz: 9d2b8d1693ebbb6f3db39e1211bd00df31cd4a52a64e360610a8abc0d6ba6ab9
+SHA512:
+  metadata.gz: 9a5c7689ddf7cd61d3a35769d51f2c9525bc755a08f436468d6253030fc81996e1a774b816e7efb51a91eab6b192c09be20745c408d4cbda49e0e962819d786e
+  data.tar.gz: 8f00fc971c82fde43505e06efc246c635d6d51ece03669e4c2fba0bc1577ea21cacd37b10525de0a7d880259092c14203dfab1c83647908d14424e44c2e4e6df

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle
+coverage
+doc/
+pkg
+tmp
+Gemfile.lock
+bin/
+tmp
+log

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nehalamin93@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dj_split.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Md Nehal Amin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# Delayed Job Split Feature
+
+Class [**"DjSplit::Split"**](https://github.com/nehalamin93/dj_split/blob/master/lib/dj_split/split.rb) is designed to **Split Time Taking Delayed Jobs, Crons, Bulk Operations, etc** into **smaller size multiple Delayed Jobs**.
+These **Jobs** should be **mutually exclusive** of each other and should be able to run **concurrently**.
+
+These **Jobs** can be picked by **Delayed Job Workers** within or across **Multiple Servers**. 
+
+Class behaves like **Delayed Job Worker**, it also **picks and processes delayed job** entries.
+
+**Splitting** will be done on **one parameter** only.
+
+## Purpose
+
+To distribute the load among **Multiple Workers**.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dj_split' or gem 'dj_split', :git => 'https://github.com/nehalamin93/dj_split.git'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dj_split
+
+Run the required database migrations:
+
+    $ script/rails generate dj_split
+    $ rake db:migrate
+
+## Usage
+
+```ruby
+class A
+  def self.function1(user_ids_array1, other_attr1)
+    #do something
+  end
+end
+```
+      $ A.function1(user_ids_array1, other_attr1)
+
+  can be replace by:
+
+      $ DjSplit::Split.new(queue_options: {queue: queue_name}, split_options: {size: 1000, by: 2}).enqueue(A, "function1", user_ids_array1, other_attr1)
+
+## Note
+
+* Arguments must be in exact order.
+* "enqueue" parameters are (object/class, function_name, arguments of that function)
+* split_options[:size] is splitting size
+* split_options[:by] is position of splitting attribute in the enqueue function. In above example, splitting attribute is user_ids_array1 and has position 2(>=2).
+
+* Here we are splitting on the basis of user_ids_array1. 
+* We can also specify the: splitting_size, Otherwise it will take default Optimal Splitting Size
+* After splitting and enqueuing, instead of waiting for the sub-jobs to be complete this function will behave like delayed job worker and will pick and process the sub-jobs instead of blocking.
+
+## What DjSplit::Enqueue does
+
+* Split the mentioned parameter into array of chunks(arrays) of size = split_options[:size]. 
+* Loop through the array and insert each chunk into Delayed Job queue(array element is placed in place of splitting params)
+* Queue jobs will be picked and executed by workers
+* Instead of waiting for jobs to be picked and processed by workers this function will also pick and process those job
+
+## Contributing
+
+* Bug reports and pull requests are welcome on GitHub at https://github.com/nehalamin93/dj_split.
+* Fork it
+* Create your feature branch (git checkout -b my-new-feature)
+* Commit your changes (git commit -am 'Add some feature')
+* Push to the branch (git push origin my-new-feature)
+* Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DjSplit project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nehalamin93/dj_split/blob/master/CODE_OF_CONDUCT.md).
+
+<!-- ## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). -->

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/dj_split.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dj_split/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dj_split"
+  spec.version       = DjSplit::VERSION
+  spec.authors       = ["Md Nehal Amin"]
+  spec.email         = ["nehalamin93@gmail.com"]
+
+  spec.summary       = %q{Splitting, Enqueuing and Executing time taking jobs(eg: Delayed Job) without Blocking.}
+  spec.description   = %q{Gem is designed to Split Time Taking Jobs(delayed jobs, crons, bulk operations, etc.) into smaller size independent Delayed Jobs. These Delayed Jobs can pick by multiple workers in single or multiple servers. After splitting and enqueuing, the gem will wait for the sub-jobs to be complete and also process sub-jobs instead of blocking.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "5.11.3"
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency "mocha", "~> 1.2"
+
+  spec.add_dependency 'delayed_job', '>= 3.0'
+  spec.add_dependency 'sqlite3'
+  spec.add_dependency 'delayed_job_active_record', '>= 0.4'
+  spec.add_development_dependency 'rails'
+end

data/lib/dj_split/dj_activerecord_overrides.rb

@@ -0,0 +1,24 @@
+module Delayed
+  module Backend
+    module ActiveRecord
+      class Job < ::ActiveRecord::Base
+        def self.reserve(worker, max_run_time = Worker.max_run_time)
+          # scope to filter to records that are "ready to run"
+          ready_scope = ready_to_run(worker.name, max_run_time)
+
+          # scope to filter to the single next eligible job
+          ready_scope = ready_scope.where("priority >= ?", Worker.min_priority) if Worker.min_priority
+          ready_scope = ready_scope.where("priority <= ?", Worker.max_priority) if Worker.max_priority
+          unless worker.split_group_id
+            ready_scope = ready_scope.where(queue: Worker.queues) if Worker.queues.any?
+          end
+          # filter only jobs with worker job group id
+          ready_scope = ready_scope.where(split_group_id: worker.split_group_id) if worker.split_group_id
+          ready_scope = ready_scope.by_priority
+
+          reserve_with_scope(ready_scope, worker, db_time_now)
+        end
+      end
+    end
+  end
+end

data/lib/dj_split/dj_worker_overrides.rb

@@ -0,0 +1,5 @@
+module Delayed
+  class Worker
+    attr_accessor :split_group_id
+  end
+end

data/lib/dj_split/split.rb

@@ -0,0 +1,109 @@
+module DjSplit
+  class Split
+
+    OPTIMAL_SPLIT_SIZE = 200
+    DEFAULT_SPLIT_INDEX = 2
+
+    def initialize(options)
+      @queue_options  = options[:queue_options] || {}
+      @split_group_id = get_random_split_group_id
+      @queue_options.merge!(split_group_id: @split_group_id)
+      @split_options = options[:split_options] || {}
+    end
+
+    def enqueue(object, method_name, *args)
+      splitting_index = get_splitting_index
+      sliced_ids_array = get_sliced_ids(args[splitting_index])
+
+      sliced_ids_array.each do |slice_set|
+        args[splitting_index] = slice_set
+        delayed_job_object = Delayed::PerformableMethod.new(object, method_name.to_sym, args)
+        Delayed::Job.enqueue(delayed_job_object, @queue_options) 
+      end
+
+      wait_check_and_execute_delayed_jobs
+    end
+
+    private
+
+    def wait_check_and_execute_delayed_jobs
+      while(pending_jobs_of_group_id?)
+        pick_and_invoke_delayed_job
+      end
+
+      waiting_for_other_workers_to_process_jobs
+      handle_failed_jobs
+    end
+
+    def pick_and_invoke_delayed_job
+      worker_object = Delayed::Worker.new
+      worker_object.split_group_id = @split_group_id
+      worker_object.work_off(1)
+    end
+
+    def pending_jobs_of_group_id?
+      Delayed::Job.where(split_group_id: @split_group_id, locked_at: nil).exists?
+    end
+
+    def waiting_for_other_workers_to_process_jobs
+      count = 0
+      while(jobs_processed_by_other_workers_currently?)
+        count += 1
+        sleep(1.0/5.0)
+        handle_stale_jobs if check_stale_jobs?(count)
+      end
+    end
+
+    # handles a scenario when Job is locked by a worker and worker got killed
+    def handle_stale_jobs
+      stale_jobs = get_processing_jobs_by_other_workers.select{ |dj| !get_delayed_jobs_pids.include?(dj.locked_by.split("pid:")[1].strip) }
+      raise "Stale Delayed Jobs of Group Id(#{@split_group_id}): #{stale_jobs.pluck(:id)}" if stale_jobs.present?
+    end
+
+    def get_processing_jobs_by_other_workers
+      Delayed::Job.where(split_group_id: @split_group_id, failed_at: nil).where.not(locked_by: nil)
+    end
+
+    def get_delayed_jobs_pids
+      bash_op = `ps aux | grep delayed_job  | grep -v 'grep' | grep -v 'bin/sh' | grep -v 'tail' | grep -v 'ruby' | grep -v 'trace'` 
+      processes = bash_op.split("\n")
+      pid_array = []
+      processes.each do |process|
+        split_process = process.split(" ")
+        pid_array << split_process[1]
+      end
+      pid_array
+    end
+
+    def handle_failed_jobs
+      failed_jobs = Delayed::Job.where(split_group_id: @split_group_id).where.not(failed_at: nil)
+      raise "Failed Delayed Jobs of Group Id(#{@split_group_id}): #{failed_jobs.pluck(:id)}" if failed_jobs.exists?
+    end
+
+    def jobs_processed_by_other_workers_currently?
+      Delayed::Job.where(split_group_id: @split_group_id, failed_at: nil).exists?
+    end
+
+    def get_split_size
+      @split_options[:size] || OPTIMAL_SPLIT_SIZE
+    end
+
+    def get_sliced_ids(ids) 
+      ids.each_slice(get_split_size)
+    end
+
+    def get_splitting_index
+      (@split_options[:by] || DEFAULT_SPLIT_INDEX) - 2
+    end
+
+    # Collision is still OK. Probabilty of collision is negligible. 
+    def get_random_split_group_id
+      Time.now.to_i.to_s[5..-1] + rand(1000000000).to_s
+    end
+
+    # Check for stale jobs 1 out of 2000 times.
+    def check_stale_jobs?(count)
+      (count%2000 == 1999) 
+    end
+  end 
+end

data/lib/dj_split/version.rb

@@ -0,0 +1,3 @@
+module DjSplit
+  VERSION = "1.0.0"
+end

data/lib/dj_split.rb

@@ -0,0 +1,8 @@
+require 'active_support'
+require 'active_record'
+require 'delayed_job'
+require 'delayed_job_active_record'
+require 'dj_split/version'
+require 'dj_split/dj_activerecord_overrides'
+require 'dj_split/dj_worker_overrides'
+require 'dj_split/split.rb'

data/lib/generators/dj_split/dj_split_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+class DjSplitGenerator < Rails::Generators::Base
+
+  include Rails::Generators::Migration
+  
+  def self.source_root
+     @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def create_migration_file
+    migration_template('migration.rb', 'db/migrate/add_split_group_id_to_delayed_jobs.rb') if defined?(ActiveRecord)
+  end
+
+  def self.next_migration_number(dirname)
+    next_migration_number = current_migration_number(dirname) + 1
+    if ActiveRecord::Base.timestamped_migrations
+      [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+    else
+      "%.3d" % next_migration_number
+    end
+  end
+end

data/lib/generators/dj_split/templates/migration.rb

@@ -0,0 +1,10 @@
+class AddSplitGroupIdToDelayedJobs < ActiveRecord::Migration
+  def self.up
+    add_column :delayed_jobs, :split_group_id, :string, :limit => 20
+    add_index :delayed_jobs, :split_group_id
+  end
+  
+  def self.down
+    remove_column :delayed_jobs, :split_group_id, :string
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: dj_split
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Md Nehal Amin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: delayed_job
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: delayed_job_active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem is designed to Split Time Taking Jobs(delayed jobs, crons, bulk operations,
+  etc.) into smaller size independent Delayed Jobs. These Delayed Jobs can pick by
+  multiple workers in single or multiple servers. After splitting and enqueuing, the
+  gem will wait for the sub-jobs to be complete and also process sub-jobs instead
+  of blocking.
+email:
+- nehalamin93@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dj_split.gemspec
+- lib/dj_split.rb
+- lib/dj_split/dj_activerecord_overrides.rb
+- lib/dj_split/dj_worker_overrides.rb
+- lib/dj_split/split.rb
+- lib/dj_split/version.rb
+- lib/generators/dj_split/dj_split_generator.rb
+- lib/generators/dj_split/templates/migration.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: 'Splitting, Enqueuing and Executing time taking jobs(eg: Delayed Job) without
+  Blocking.'
+test_files: []