delayed_job_prevent_duplicate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0239b2cca535272939571db36a7694c86008c0fc57dd1fd946c10c35b30f9160'
+  data.tar.gz: f69616afd47037e85e3f248f9f4a398a00c99b91e3f484c547de82f1782de933
+SHA512:
+  metadata.gz: d0a0587190b5e6c93f51c8bbb4e31424173ebe8b31e33dfcbc070bda3bcc9daf557b0c39b7d9434e7d24fd4c8a0e68dda036f0113174b83b4f0e3ffc0b214188
+  data.tar.gz: abb1515c6a31575ddea9b6e1b1f87ef386d0f5768f743a2c5d5218e563cef630522d9390ed7705c8bea5d9afa603f04128934fdc84ece66ec1c0b42f8d8f198c

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-09-07
+
+- Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in delayed_job_prevent_duplicate.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 noesya
+
+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,46 @@
+# DelayedJobPreventDuplicate
+
+The purpose of this gem is to prevent to re-enqueue on DelayedJob a task already enqueued.  
+So we set a "signature" attached to every task enqueued which is a composite from the class and the id of the object, and the method called.  
+And then when creating a new job we look in the "pending" jobs if there is another one with the same signature (not in the "working" one because a task can be executed and yet you want to re-excute it because of any change). 
+
+## Note
+
+This gem is based based on the [synth](https://github.com/synth) work: https://gist.github.com/synth/fba7baeffd083a931184
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'delayed_job_prevent_duplicate'
+```
+
+This line should be added after including the gem 'delayed_job'
+
+And then execute:
+
+    $ bundle install
+
+Next, you need to run the generator: 
+
+```ruby
+rails g delayed_job_prevent_duplicate
+```
+  
+All should be fine now!  
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/noesya/delayed_job_prevent_duplicate.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Bibliography
+
+https://groups.google.com/g/delayed_job/c/gZ9bFCdZrsk#2a05c39a192e630c
+https://github.com/collectiveidea/delayed_job/blob/master/lib/delayed/backend/base.rb
+https://github.com/ignatiusreza/activejob-trackable

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "delayed_job_prevent_duplicate"
+
+# 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/delayed_job_prevent_duplicate.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/delayed_job_prevent_duplicate/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "delayed_job_prevent_duplicate"
+  spec.version       = DelayedJobPreventDuplicate::VERSION
+  spec.authors       = ["pabois"]
+  spec.email         = ["pierreandre.boissinot@noesya.coop"]
+
+  spec.summary       = "Prevent delayed_job to enqueue a task already enqueued"
+  spec.description   = "Improve Delayed Job to prevent a task already enqueued to be enqueue a second time."
+  spec.homepage      = "https://github.com/noesya/delayed_job_prevent_duplicate"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/noesya/delayed_job_prevent_duplicate/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "delayed_job",  [">= 3.0", "< 5"]
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/delayed_duplicate_prevention_plugin.rb

@@ -0,0 +1,76 @@
+# based on https://gist.github.com/synth/fba7baeffd083a931184
+
+require 'delayed_job'
+
+class DelayedDuplicatePreventionPlugin < Delayed::Plugin
+
+  module SignatureConcern
+    extend ActiveSupport::Concern
+
+    included do
+      before_validation :add_signature
+      validate :prevent_duplicate
+    end
+
+    private
+
+    def add_signature
+      self.signature = generate_signature
+      self.args = self.payload_object.args
+    end
+
+    def generate_signature
+      pobj = payload_object
+      if pobj.object.respond_to?(:id) and pobj.object.id.present?
+        sig = "#{pobj.object.class}"
+        sig += ":#{pobj.object.id}" 
+      else
+        sig = "#{pobj.object}"
+      end
+
+      sig += "##{pobj.method_name}"
+      return sig
+    end    
+
+    def prevent_duplicate
+      if DuplicateChecker.duplicate?(self)
+        Rails.logger.warn "Found duplicate job(#{self.signature}), ignoring..."
+        errors.add(:base, "This is a duplicate") 
+      end
+    end
+  end
+
+  class DuplicateChecker
+    attr_reader :job
+
+    def self.duplicate?(job)
+      new(job).duplicate?
+    end
+
+    def initialize(job)
+      @job = job
+    end
+
+    def duplicate?
+      possible_dupes.any? { |possible_dupe| args_match?(possible_dupe, job) }
+    end
+
+    private
+
+    def possible_dupes
+      possible_dupes = Delayed::Job.where(attempts: 0, locked_at: nil)  # Only jobs not started, otherwise it would never compute a real change if the job is currently running
+                                   .where(signature: job.signature)     # Same signature
+      possible_dupes = possible_dupes.where.not(id: job.id) if job.id.present?
+      possible_dupes
+    end
+
+    def args_match?(job1, job2)
+      # TODO: make this logic robust
+      normalize_args(job1.args) == normalize_args(job2.args)
+    end
+
+    def normalize_args(args)
+      args.kind_of?(String) ? YAML.load(args) : args
+    end
+  end
+end

data/lib/delayed_job_prevent_duplicate/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DelayedJobPreventDuplicate
+  VERSION = "0.1.0"
+end

data/lib/delayed_job_prevent_duplicate.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "delayed_job_prevent_duplicate/version"
+
+module DelayedJobPreventDuplicate
+  class Error < StandardError; end
+ 
+  require 'delayed_duplicate_prevention_plugin'
+
+  Delayed::Backend::ActiveRecord::Job.send(:include, DelayedDuplicatePreventionPlugin::SignatureConcern)
+  Delayed::Worker.plugins << DelayedDuplicatePreventionPlugin
+end

data/lib/generators/delayed_job_prevent_duplicate_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module DelayedJobPreventDuplicate
+  class DelayedJobPreventDuplicateGenerator < ::Rails::Generators::Base
+
+    include Rails::Generators::Migration
+    source_root File.expand_path("../templates", __FILE__)
+
+    def self.next_migration_number(path)
+      unless @prev_migration_nr
+        @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+      else
+        @prev_migration_nr += 1
+      end
+     @prev_migration_nr.to_s
+    end
+
+    def copy_migration
+      migration_template "migration.rb", "db/migrate/add_signature_to_delayed_job.rb", migration_version: migration_version
+    end
+
+    def migration_version
+      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+    end
+
+  end
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class AddSignatureToDelayedJob < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_column :delayed_jobs, :signature, :string
+    add_column :delayed_jobs, :args, :text
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: delayed_job_prevent_duplicate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pabois
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: delayed_job
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Improve Delayed Job to prevent a task already enqueued to be enqueue
+  a second time.
+email:
+- pierreandre.boissinot@noesya.coop
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- delayed_job_prevent_duplicate.gemspec
+- lib/.DS_Store
+- lib/delayed_duplicate_prevention_plugin.rb
+- lib/delayed_job_prevent_duplicate.rb
+- lib/delayed_job_prevent_duplicate/version.rb
+- lib/generators/delayed_job_prevent_duplicate_generator.rb
+- lib/generators/templates/migration.rb
+homepage: https://github.com/noesya/delayed_job_prevent_duplicate
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/noesya/delayed_job_prevent_duplicate
+  source_code_uri: https://github.com/noesya/delayed_job_prevent_duplicate
+  changelog_uri: https://github.com/noesya/delayed_job_prevent_duplicate/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Prevent delayed_job to enqueue a task already enqueued
+test_files: []