expire_job 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b6c0ff8fff557e50c0ce28558015e5d6bd70bc655713657bd9a6b258bb61091
+  data.tar.gz: 762f0676a3e84d5686d4ad2aeb592b8f5057130be12d2e3881a1b3481282797c
+SHA512:
+  metadata.gz: 6fb30b4e1ff8a36840c42c7d50c14c2635b8137642d3d09a1b470edc2292545500c9121bb81b76ee02918a2ed4810712ab7a642a36327fd44b4cc4ebe0234426
+  data.tar.gz: fa9561f802d63343966c6208a371b7696e2396df411b013d84a0cd88f02c92212c07f84d87c259592ed09bc9b238026892e434de2cbded8c93c25b4821ca1291

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/.idea/

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to:
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake" /></Settings>

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.1.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 ts_3156@yahoo.co.jp. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in expire_job.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    expire_job (0.1.0)
+      sidekiq (> 6.0, < 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    connection_pool (2.2.2)
+    minitest (5.11.3)
+    rack (2.2.2)
+    rack-protection (2.0.8.1)
+      rack
+    rake (12.3.2)
+    redis (4.1.4)
+    sidekiq (6.0.7)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      rack-protection (>= 2.0.0)
+      redis (>= 4.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  expire_job!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 ts-3156
+
+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,44 @@
+# ExpireJob
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/expire_job`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'expire_job'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install expire_job
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/expire_job. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/expire_job/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 ExpireJob project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/expire_job/blob/master/CODE_OF_CONDUCT.md).

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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "expire_job"
+
+# 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/expire_job.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/expire_job/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "expire_job"
+  spec.version       = ExpireJob::VERSION
+  spec.authors       = ["ts-3156"]
+  spec.email         = ["ts_3156@yahoo.co.jp"]
+
+  spec.summary       = "Set an expiry to Sidekiq jobs"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/egotter/expire_job"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/egotter/expire_job"
+  spec.metadata["changelog_uri"] = "https://github.com/egotter/expire_job"
+
+  # 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|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq", ["> 6.0", "< 7.0"]
+end

data/lib/expire_job/version.rb

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

data/lib/expire_job.rb

@@ -0,0 +1,103 @@
+require 'time'
+require 'logger'
+
+require "expire_job/version"
+
+module ExpireJob
+  class Middleware
+    def call(worker, msg)
+      if worker.respond_to?(:expire_in)
+        picked_time = pick_enqueued_at(msg)
+        if perform_expire_check(worker, msg['args'], worker.expire_in, picked_time)
+          yield
+        end
+      else
+        yield
+      end
+    end
+
+    def perform_expire_check(worker, args, expire_in, enqueued_at)
+      if enqueued_at.nil?
+        logger.warn { "Can not expire this job because enqueued_at is not found. args=#{truncate(args.inspect)}" }
+        return true
+      end
+
+      if enqueued_at < Time.now - expire_in
+        logger.info { "Skip expired job. args=#{truncate(args.inspect)}" }
+
+        perform_callback(worker, :after_expire, args)
+
+        false
+      else
+        true
+      end
+    end
+
+    def pick_enqueued_at(msg)
+      args = msg['args']
+      enqueued_at = nil
+
+      if args.is_a?(Array) && args.size >= 1 && args.last.is_a?(Hash)
+        enqueued_at = parse_time(args.last['enqueued_at'])
+        logger.info { "enqueued_at was found in args. enqueued_at=#{enqueued_at}" } if enqueued_at
+      end
+
+      if enqueued_at.nil?
+        # The msg has both created_at and enqueued_at.
+        #   created_at: is a time when #perform_async or #perform_in is called
+        #   enqueued_at: is a time when the job is inserted into a queue
+        enqueued_at = parse_time(msg['created_at']) # TODO Use enqueued_at?
+        logger.debug { "enqueued_at was found in msg. enqueued_at=#{enqueued_at}" } if enqueued_at
+      end
+
+      enqueued_at
+    end
+
+    def parse_time(value)
+      puts value.inspect
+      if value.to_s.match?(/\d+\.\d+/)
+        Time.at(value)
+      else
+        Time.parse(value)
+      end
+    rescue => e
+      logger.warn { "Can not parse this value. value=#{value.inspect}" }
+      nil
+    end
+
+    def perform_callback(worker, callback_name, args)
+      if worker.respond_to?(callback_name)
+        parameters = worker.method(callback_name).parameters
+
+        begin
+          if parameters.empty?
+            worker.send(callback_name)
+          else
+            worker.send(callback_name, *args)
+          end
+        rescue ArgumentError => e
+          message = "The number of parameters of the callback method (#{parameters.size}) is not the same as the number of arguments (#{args.size})"
+          raise ArgumentError.new("#{self.class}:#{worker.class} #{message} callback_name=#{callback_name} args=#{args.inspect} parameters=#{parameters.inspect}")
+        end
+      end
+    end
+
+    def truncate(text, length: 100)
+      if text.length > length
+        text.slice(0, length)
+      else
+        text
+      end
+    end
+
+    def logger
+      if defined?(::Sidekiq)
+        ::Sidekiq.logger
+      elsif defined?(::Rails)
+        ::Rails.logger
+      else
+        ::Logger.new(STDOUT)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: expire_job
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ts-3156
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: Set an expiry to Sidekiq jobs
+email:
+- ts_3156@yahoo.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rakeTasks"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- expire_job.gemspec
+- lib/expire_job.rb
+- lib/expire_job/version.rb
+homepage: https://github.com/egotter/expire_job
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/egotter/expire_job
+  source_code_uri: https://github.com/egotter/expire_job
+  changelog_uri: https://github.com/egotter/expire_job
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Set an expiry to Sidekiq jobs
+test_files: []