active_job_resque_solo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4831e5d461672f44d255b1adcfbd3c72650cbe25
+  data.tar.gz: 76626abe03c74ef1d7cc4135cebfccf101dac1ac
+SHA512:
+  metadata.gz: d7fce0cef4cefd50565ba4a944c9c0069f780fd463484714761b4aba9c0badabfadf78f4c788bf24bbbe6fee2c3de5a57d79d9b2f22cd25f61efa89e8d7f4367
+  data.tar.gz: 98e612019969deda8fa4fb83adeea9e4ae91ee9f2abda4de41209056d40f38b08413bdb0e96ea210c70dd7fbf438fdaf67253061b97d2bd379f05e60e2e98165

data/.gitignore

@@ -0,0 +1,21 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# byebug
+.byebug_history
+
+# vim
+*.swp
+
+# macOS
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

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 kinkadep@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 active_job_resque_solo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Phillip Kinkade
+
+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,104 @@
+# ActiveJobResqueSolo
+
+A plugin for ActiveJob with Resque to prevent duplicate enqueing of jobs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_job_resque_solo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_job_resque_solo
+
+## Usage
+
+In your job class, include the plugin:
+
+```ruby
+class MyJob < ActiveJob::Base
+
+  include ActiveJob::Plugins::Resque::Solo
+
+  queue_as :default
+
+  def perform(*args); end
+end
+```
+
+If an instance of the job with matching arguments is either waiting for a worker or currently executing,
+Solo will prevent a new instance of the job from being enqueued.
+
+You can control which named arguments are used to determine uniqueness in the queue:
+
+`solo_only_args`
+`solo_except_args`
+
+```ruby
+class MyJob < ActiveJob::Base
+
+  include ActiveJob::Plugins::Resque::Solo
+
+  # Only compare "user" args when checking for duplicate jobs.
+  solo_only_args :user
+
+  queue_as :default
+
+  def perform(user:, nonce:)
+  end
+end
+```
+
+Conversely, you can exclude arguments from being checked for duplicates.  This
+is useful when plugins add arguments of their own to your jobs.
+
+```ruby
+class MyJob < ActiveJob::Base
+
+  include ActiveJob::Plugins::Resque::Solo
+
+  solo_except_args :nonce, :retry_count
+
+  queue_as :default
+
+  def perform(user:, nonce:)
+  end
+end
+```
+
+## Duplicate enqueues are still possible
+
+While this plugin will greatly reduce duplicate instances of a job from being
+enqueued, there are two scenarios where duplicates may still be enqueued,
+so be sure to check out other gems for locking if your job is not idempotent.
+
+1. When multiple processes simultaneously attempt to enqueue the same job two or
+more may be enqueued.
+2. If your queue has many jobs, and workers remove a job during while Solo scans
+the queue, it's possible for the original enqueued job to be missed. Solo will allow
+the new instance of the job to be enqueued.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_job_resque_solo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveJobResqueSolo project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/active_job_resque_solo/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/active_job_resque_solo.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_job_resque_solo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_job_resque_solo"
+  spec.version       = ActiveJobResqueSolo::VERSION
+  spec.authors       = ["Phillip Kinkade"]
+  spec.email         = ["kinkadep@gmail.com"]
+
+  spec.summary       = %q{Prevents duplicate ActiveJob+Resque jobs from being enqueued.}
+  spec.description   = %q{If you are using ActiveJob with the Resque Adapter, this gem will help prevent duplicate jobs, based on arguments, from being enqueued to Resque.}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 4.2.0", "< 6"
+
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_job_resque_solo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_job/plugins/resque/solo.rb

@@ -0,0 +1,118 @@
+module ActiveJob
+  module Plugins
+    module Resque
+      module Solo
+
+        def self.included(base_class)
+          base_class.extend(ClassMethods)
+
+          base_class.around_enqueue do |job, block|
+            base_class.solo_around_enqueue(job, block)
+          end
+        end
+
+        module ClassMethods
+          def resque_present?
+            ActiveJob::Base.queue_adapter == ActiveJob::QueueAdapters::ResqueAdapter
+          end
+
+          def solo_around_enqueue(job, block)
+            if resque_present?
+              # always ignore the ActiveJob symbol hash key.
+              @solo_except_args ||= []
+              @solo_except_args << "_aj_symbol_keys" unless @solo_except_args.include?("_aj_symbol_keys")
+
+              if !solo_job_enqueued?(job) && !solo_job_executing?(job)
+                block.call
+              end
+            else
+              # if resque is not present, always enqueue
+              block.call
+            end
+          end
+
+          def solo_only_args(*args)
+            @solo_only_args = args.compact.map(&:to_s).uniq
+            raise "Missing arguments for solo_only_args" if @solo_only_args.empty?
+          end
+
+          def solo_except_args(*args)
+            @solo_except_args = args.compact.map(&:to_s).uniq
+            raise "Missing arguments for solo_except_args" if @solo_except_args.empty?
+          end
+
+          def solo_job_enqueued?(job)
+            size = ::Resque.size(job.queue_name)
+            return false if size.zero?
+
+            page_size = 250
+            pages = (size/page_size).to_i + 1
+            jobs = []
+
+            # It's possible for this loop to skip jobs if they
+            # are dequeued while the loop is in progress.
+            (0..pages).each do |i|
+              page_start = i * page_size
+              page = ::Resque.peek(job.queue_name, page_start, page_size)
+              break if page.empty?
+              jobs += page
+            end
+
+            job_class, job_arguments = solo_job(job)
+
+            (jobs.size-1).downto(0) do |i|
+              scheduled_job = jobs[i]
+              return true if solo_job_enqueued_with_args?(job_class, job_arguments, scheduled_job)
+            end
+            false
+          end
+
+          def solo_job_executing?(job)
+            job_class, job_arguments = solo_job(job)
+
+            ::Resque.workers.any? do |worker|
+              processing = worker.processing
+              next false if processing.blank?
+              args = processing["payload"]["args"][0]
+              solo_job_with_args_eq?(job_class, job_arguments, args)
+            end
+          end
+
+          def solo_job_enqueued_with_args?(job_class, job_arguments, scheduled_job)
+            args = scheduled_job["args"][0]
+            solo_job_with_args_eq?(job_class, job_arguments, args)
+          end
+
+          def solo_job_with_args_eq?(job_class, job_arguments, wrapper_args)
+            return false if wrapper_args['job_class'] != job_class
+            encoded_arguments = wrapper_args['arguments']
+            encoded_arguments = solo_job_args(encoded_arguments)
+            encoded_arguments == job_arguments
+          end
+
+          def solo_job(job)
+            job_arguments = ActiveJob::Arguments.serialize(job.arguments)
+            job_arguments = solo_job_args(job_arguments)
+            job_class = job.class.name
+            [ job_class, job_arguments ]
+          end
+
+          def solo_job_args(args)
+            if args.present?
+              args.map do |arg|
+                if arg.is_a? Hash
+                  arg.keep_if { |k,v| @solo_only_args.include?(k.to_s) } if @solo_only_args.present?
+                  arg.keep_if { |k,v| !@solo_except_args.include?(k.to_s) } if @solo_except_args.present?
+                end
+
+                arg
+              end
+            end
+
+           args
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_job_resque_solo.rb

@@ -0,0 +1,3 @@
+require "active_job_resque_solo/version"
+require 'active_job/plugins/resque/solo'
+

data/lib/active_job_resque_solo/version.rb

@@ -0,0 +1,3 @@
+module ActiveJobResqueSolo
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: active_job_resque_solo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Phillip Kinkade
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: If you are using ActiveJob with the Resque Adapter, this gem will help
+  prevent duplicate jobs, based on arguments, from being enqueued to Resque.
+email:
+- kinkadep@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_job_resque_solo.gemspec
+- bin/console
+- bin/setup
+- lib/active_job/plugins/resque/solo.rb
+- lib/active_job_resque_solo.rb
+- lib/active_job_resque_solo/version.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.6.6
+signing_key: 
+specification_version: 4
+summary: Prevents duplicate ActiveJob+Resque jobs from being enqueued.
+test_files: []