midget_jobs 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b97d31874a18423a96d2ac76fa0137db3ba641cd02753138f1b75d6a59f830e
+  data.tar.gz: 053f4aa574341fed2479523d8ca320f0e974c445fc4ceaeec39c49ad675da294
+SHA512:
+  metadata.gz: 65507a94451f88790e18a4d692d19b971b02d476e62df55349775d09ea9c467d7c8749c2557d686f6fd6a3cb6d15881ab0fb764542df3f0833054df83a8f9c25
+  data.tar.gz: 49615de063d22529e7bf1a08b132621e13d07b7e32772431a42e4fe7e3054cc194e983e2fa9b65dc388b66649e25489ff3ddf1959fca6f4b7485fc985a07b605

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+/midget_jobs-*.*.*.gem
+/Gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 2.0.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 chmel@jchsoft.cz. 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,15 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in midget_job.gemspec
+gemspec
+
+group :test do
+  gem 'minitest'
+  gem 'minitest-reporters'
+  gem 'minitest-stub_any_instance'
+
+  gem 'minitest-reporters'
+  gem 'activerecord'
+  gem 'pg'
+  gem 'activesupport'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Josef Chmel
+
+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,43 @@
+# MidgetJob
+
+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/midget_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 'midget_job'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install midget_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]/midget_job. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MidgetJob project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/midget_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 "midget_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/db/database.yml

@@ -0,0 +1,8 @@
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  pool: 5
+
+test:
+  <<: *default
+  database: midgets_jobs_test

data/db/migrate/20191022104513_create_midget_jobs.rb

@@ -0,0 +1,13 @@
+class CreateMidgetJobs < ActiveRecord::Migration[6.0]
+  def change
+    create_table :midget_jobs do |t|
+      t.string :job_id
+      t.string :queue
+      t.jsonb :serialized
+      t.datetime :run_at
+
+      t.timestamps
+    end
+    add_index :midget_jobs, :queue
+  end
+end

data/db/migrate/20191022104514_create_midget_triggers.rb

@@ -0,0 +1,19 @@
+class CreateMidgetTriggers < ActiveRecord::Migration[6.0]
+  def change
+    execute <<-SQL
+      CREATE OR REPLACE FUNCTION notice_midget_job_insert() RETURNS trigger AS $$
+        DECLARE
+          channel_name varchar DEFAULT (TG_TABLE_NAME || '_notices');
+        BEGIN
+          PERFORM pg_notify(channel_name, json_build_object('action', TG_OP, 'id', NEW.id)::text);
+
+          RETURN NEW;
+        END;
+      $$ LANGUAGE plpgsql;
+
+      CREATE TRIGGER notice_on_insert
+        AFTER INSERT ON public.midget_jobs FOR EACH ROW
+        EXECUTE PROCEDURE notice_midget_job_insert();
+    SQL
+  end
+end

data/lib/active_job/queue_adapters/midget_job_adapter.rb

@@ -0,0 +1,33 @@
+require 'midget_jobs/job'
+
+module ActiveJob
+  module QueueAdapters
+    class MidgetJobAdapter
+      attr_accessor(:perform_enqueued_jobs, :perform_enqueued_at_jobs, :filter, :reject, :queue)
+
+      def enqueue(job) #:nodoc:
+        Rails.logger.debug "job: #{job}"
+        JobWrapper.enqueue job
+      end
+
+      def enqueue_at(job, timestamp) #:nodoc:
+        Rails.logger.debug "job: #{job}, #{timestamp}"
+        JobWrapper.enqueue job, at: timestamp
+      end
+
+      def enqueued_jobs
+        JobWrapper.enqueued_jobs
+      end
+
+      def performed_jobs
+        []
+      end
+
+      class JobWrapper < MidgetJobs::Job
+        def run(serialized_job)
+          Base.execute serialized_job
+        end
+      end
+    end
+  end
+end

data/lib/generators/midget_jobs/USAGE

@@ -0,0 +1,10 @@
+Description:
+    This generator creates an initializer file at config/initializers and migrations to db/migrate
+
+Example:
+    rails generate midget_jobs:install
+
+    This will create:
+        config/initializers/midget_jobs.rb
+        db/migrate/#{Time.now.strftime "%Y%m%d%H%M%S"}_create_midget_jobs.rb
+        db/migrate/#{Time.now.strftime "%Y%m%d%H%M%S"}_create_midget_triggers.rb

data/lib/generators/midget_jobs/install_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module MidgetJobs
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    desc 'This generator creates an initializer file at config/initializers and migrations to db/migrate'
+
+    def copy_install_file
+      copy_file "midget_job_initializer.rb", "config/initializers/midget_jobs.rb"
+      copy_file "create_midget_jobs.rb", "db/migrate/#{Time.now.strftime "%Y%m%d%H%M%S"}_create_midget_jobs.rb"
+      copy_file "create_midget_triggers.rb", "db/migrate/#{(Time.now + 1).strftime "%Y%m%d%H%M%S"}_create_midget_triggers.rb"
+    end
+  end
+end

data/lib/generators/midget_jobs/templates/create_midget_jobs.rb

@@ -0,0 +1,13 @@
+class CreateMidgetJobs < ActiveRecord::Migration[6.0]
+  def change
+    create_table :midget_jobs do |t|
+      t.string :job_id
+      t.string :queue
+      t.jsonb :serialized
+      t.datetime :run_at
+
+      t.timestamps
+    end
+    add_index :midget_jobs, :queue
+  end
+end

data/lib/generators/midget_jobs/templates/create_midget_triggers.rb

@@ -0,0 +1,19 @@
+class CreateMidgetTriggers < ActiveRecord::Migration[6.0]
+  def change
+    execute <<-SQL
+      CREATE OR REPLACE FUNCTION notice_midget_job_insert() RETURNS trigger AS $$
+        DECLARE
+          channel_name varchar DEFAULT (TG_TABLE_NAME || '_notices');
+        BEGIN
+          PERFORM pg_notify(channel_name, json_build_object('action', TG_OP, 'id', NEW.id)::text);
+
+          RETURN NEW;
+        END;
+      $$ LANGUAGE plpgsql;
+
+      CREATE TRIGGER notice_on_insert
+        AFTER INSERT ON public.midget_jobs FOR EACH ROW
+        EXECUTE PROCEDURE notice_midget_job_insert();
+    SQL
+  end
+end

data/lib/generators/midget_jobs/templates/midget_job_initializer.rb

@@ -0,0 +1,8 @@
+Rails.application.config.active_job.queue_adapter = :midget_job
+Rails.application.config.x.midget_jobs.at_once = 4
+
+if $0 =~ /rails/ || $0 =~ /puma/
+  Rails.application.config.after_initialize do
+    MidgetJobs.initialize_workers
+  end
+end

data/lib/midget_jobs/job.rb

@@ -0,0 +1,37 @@
+require 'models/midget_job'
+require 'midget_jobs/scheduler'
+
+module MidgetJobs
+  class Job
+    class << self
+      attr_reader :scheduler
+      # @param [ActiveJob::Base] job
+      # @param [Time] at
+      def enqueue(job, at: nil)
+        MidgetJob.create!(job_id: job.job_id, queue: job.queue_name, serialized: job.serialize, run_at: (at or 1.second.from_now))
+      end
+
+      def enqueued_jobs
+        MidgetJob.all
+      end
+
+      def schedule
+        @scheduler = MidgetJobs::Scheduler.new.call
+      end
+
+      def process_notification(hash_data)
+        Rails.logger.info "#{self.name}.#{__method__}(#{hash_data})"
+        case hash_data[:action]
+          when 'INSERT'
+            @scheduler.wakeup!
+          else
+            raise "unknown action #{hash_data[:action]}"
+        end
+      end
+    end
+
+    def run(serialized_job)
+      raise NotImplementedError, "serialized_job: #{serialized_job}"
+    end
+  end
+end

data/lib/midget_jobs/scheduler.rb

@@ -0,0 +1,42 @@
+module MidgetJobs
+  class Scheduler
+    def call
+      Rails.logger.info "#{self.class.name} starting"
+      @thread = Thread.new do
+        Rails.logger.info "#{self.class.name} started and waiting for jobs"
+        loop do
+          sleep_till_next_job
+          process_available_jobs
+        end
+      end
+      @thread.abort_on_exception = true
+      self
+    end
+
+    def wakeup!
+      @thread.wakeup
+    end
+
+    private
+
+    def process_available_jobs
+      MidgetJob.transaction do
+        MidgetJob.for_processing.limit(Rails.configuration.x.midget_jobs.at_once).lock("FOR UPDATE SKIP LOCKED").each do |midget_job|
+          Rails.logger.info "#{self.class.name} firing midget_job: #{midget_job.id}"
+          midget_job.fire_thread
+          midget_job.destroy!
+        end
+      end
+    end
+
+    # interval till next job or 0 if there is no job - meaning sleep for ever or till wakeup
+    def sleep_till_next_job
+      most_current = MidgetJob.order(run_at: :asc).first
+      if most_current
+        sleep [most_current.run_at.to_f - Time.current.to_f, 0.001].max
+      else
+        Thread.stop
+      end
+    end
+  end
+end

data/lib/midget_jobs/version.rb

@@ -0,0 +1,3 @@
+module MidgetJobs
+  VERSION = "0.1.1"
+end

data/lib/midget_jobs.rb

@@ -0,0 +1,13 @@
+require "midget_jobs/version"
+require 'active_job/queue_adapters/midget_job_adapter'
+require 'midget_jobs/job'
+require 'midget_jobs/scheduler'
+require 'models/midget_job'
+
+module MidgetJobs
+  class Error < StandardError; end
+  def self.initialize_workers
+    MidgetJobs::Job.schedule
+    MidgetJob.listen_notifications
+  end
+end

data/lib/models/concerns/postgres_notifications_listener.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PostgresNotificationsListener
+  def listen_notifications
+    Rails.logger.info "#{self.name} listening_job started"
+    Thread.new do
+      Rails.logger.info "#{self.name} listening_job running on #{self.name.pluralize.underscore}_notices"
+      self.connection.execute "LISTEN #{self.name.pluralize.underscore}_notices"
+      loop do
+        Rails.logger.info "#{self.name} listening_job wait_for_notify"
+        begin
+          self.connection.raw_connection.wait_for_notify do |event, pid, payload|
+            data = JSON.parse payload, symbolize_names: true
+            Rails.logger.info "postgres #{event.inspect}, pid: #{pid.inspect}, data: #{data.inspect}"
+            process_notification(data)
+          end
+        rescue StandardError => error
+          Rails.logger.error "-------------Ex #{self.name} listening_job wait_for_notify #{error}----------------"
+          retry
+        end
+      end
+    end.abort_on_exception = true
+  end
+end

data/lib/models/midget_job.rb

@@ -0,0 +1,25 @@
+require 'models/concerns/postgres_notifications_listener'
+
+class MidgetJob < ActiveRecord::Base
+  extend PostgresNotificationsListener
+
+  scope :for_processing, -> { where('run_at < ?', Time.current) }
+
+  validates :job_id, :queue, :serialized, :run_at, presence: true
+
+  def fire_thread
+    Rails.logger.info "#{self.class.name}.fire_thread started"
+    Thread.new do
+      Rails.logger.info "#{self.class.name}.fire_thread execute serialized job"
+      begin
+        ActiveJob::Base.execute serialized
+      rescue => detail
+        Rails.logger.error detail.cause
+      end
+    end
+  end
+
+  def self.process_notification(hash_data)
+    MidgetJobs::Job.process_notification hash_data
+  end
+end

data/midget_job.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "midget_jobs/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "midget_jobs"
+  spec.version       = MidgetJobs::VERSION
+  spec.authors       = ["josefchmel"]
+  spec.email         = ["chmel@jchsoft.cz"]
+
+  spec.summary       = %q{Small background job scheduler closely related with Rails ActiveJob.}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/jchsoft/midget_jobs"
+  spec.license       = "MIT"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jchsoft/midget_jobs"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: midget_jobs
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- josefchmel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- chmel@jchsoft.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- db/database.yml
+- db/migrate/20191022104513_create_midget_jobs.rb
+- db/migrate/20191022104514_create_midget_triggers.rb
+- lib/active_job/queue_adapters/midget_job_adapter.rb
+- lib/generators/midget_jobs/USAGE
+- lib/generators/midget_jobs/install_generator.rb
+- lib/generators/midget_jobs/templates/create_midget_jobs.rb
+- lib/generators/midget_jobs/templates/create_midget_triggers.rb
+- lib/generators/midget_jobs/templates/midget_job_initializer.rb
+- lib/midget_jobs.rb
+- lib/midget_jobs/job.rb
+- lib/midget_jobs/scheduler.rb
+- lib/midget_jobs/version.rb
+- lib/models/concerns/postgres_notifications_listener.rb
+- lib/models/midget_job.rb
+- midget_job.gemspec
+homepage: https://github.com/jchsoft/midget_jobs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jchsoft/midget_jobs
+  source_code_uri: https://github.com/jchsoft/midget_jobs
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Small background job scheduler closely related with Rails ActiveJob.
+test_files: []