tasque 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fe02e8efd7f9659a71065ff03456285a77c3738a
-  data.tar.gz: 0148d4b75800c0249624d34a50af1902857ad804
+SHA256:
+  metadata.gz: bf0b5935e1d4982bf36d127324ed8f3846b577c2ddacf031a339360626203e23
+  data.tar.gz: 64988b1ffc2200d333b289791978106686a04dd85fdb027b9bef62c5c0c4fb74
 SHA512:
-  metadata.gz: 5446b19a1112207b663a3d91045da3c32f24d3fd4affd5d4adda441a22c412c27dc258a5f18a38f83e1409418c4cf9d8047b50c18fc7ba0f16c6cca96343b9a3
-  data.tar.gz: 6af7d2e232ef54594ee8a0f9971693bbcd22666cbcc251fa0b7b3cebc3c9bdd9b30ac15079f0b10c5b74ee713b11dab0c4ae993f29aae6fb5dd8a9948d37536d
+  metadata.gz: 91853cbce23866722d4c39e7d045397d449b4078bd8e9902a7a1a823ef635f2721968f270e628b2060de7886ad03dd70c3d2147a6b85070f079de08b65ac7d71
+  data.tar.gz: 242a113c684536ab53dcf988b6ee3ddd95586b64cbbbceda4c5fede237950d19f8429719b6fbb85a4aa790cf9a2dd15efc96b65863eb1e783914ec9c240eb262

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    tasque (0.0.3)
+      activerecord
+      json
+      state_machine
+      timers
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.5)
+      activesupport (= 5.1.5)
+    activerecord (5.1.5)
+      activemodel (= 5.1.5)
+      activesupport (= 5.1.5)
+      arel (~> 8.0)
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    hitimes (1.2.6)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    insque (0.6.3)
+      json (> 2)
+      redis (> 2)
+    json (2.1.0)
+    minitest (5.11.3)
+    redis (4.0.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    sqlite3 (1.3.13)
+    state_machine (1.2.0)
+    thread_safe (0.3.6)
+    timers (4.1.2)
+      hitimes
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  insque
+  rspec
+  sqlite3
+  tasque!
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -48,12 +48,27 @@ Now to process the task:
     # register a handler for test tasks
     processor.add_handler('test') do |task|
       puts "Got task ##{task.id}. Task says: '#{task.params['text']}'"
+      task.complete!
       { log: 'got task, printed text' } # returning task result
     end
 
     # start processor and wait
     processor.start
     
+    
+### Using with Insque
+
+Tasque can send task and worker state updates via [Insque](https://github.com/Gropher/insque). 
+
+To enable this featute uncomment following lines in your tasque initializer: 
+
+    # Send task state updates and progress notifications via Insque
+    config.notify = true
+
+    # Send worker heartbeat via Insque
+    config.heartbeat = true
+    config.heartbeat_interval = 10 # seconds
+    
 
 ## Contributing
 

data/insque.local.yml

@@ -0,0 +1,10 @@
+version: '3.2'
+
+services:
+  redis:
+    image: redis
+    ports:
+      - target: 6379
+        published: 63790
+        protocol: tcp
+        mode: host

data/lib/tasque/processor.rb

@@ -35,6 +35,8 @@ module Tasque
           has_task = Tasque::Task.fetch(type) do |task|
             @handlers[type.to_sym].call(task)
           end
+        rescue ActiveRecord::Deadlocked
+          retry
         end while has_task
       end
     end

data/lib/tasque/version.rb

@@ -1,3 +1,3 @@
 module Tasque
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/tasque_spec.rb

@@ -0,0 +1,156 @@
+require 'json'
+require 'active_support/all'
+require 'active_record'
+require 'tasque'
+require 'insque'
+
+RSpec.describe 'tasque' do
+  before(:all) do
+    system "docker swarm init || true"
+    system "docker stack deploy -c insque.local.yml insque"
+    sleep 10
+    Insque.debug = false
+    Insque.sender = 'myapp'
+    Insque.redis_config = { host: 'localhost', port: 63790 }
+    Thread.abort_on_exception=true
+    ActiveRecord::Base.establish_connection(
+      :adapter   => 'sqlite3',
+      :database  => 'db/test.db'
+    )
+    ActiveRecord::Base.connection.execute('create table tasque_tasks(id INTEGER PRIMARY KEY AUTOINCREMENT, tag TEXT, task TEXT, params TEXT, result TEXT, worker TEXT, status TEXT DEFAULT "new", attempts INTEGER DEFAULT 0, progress INTEGER DEFAULT 0, priority INTEGER DEFAULT 0, started_at DATETIME, finished_at DATETIME, updated_at DATETIME, created_at DATETIME);')
+  end
+
+  after(:all) do
+    system "docker stack rm insque"
+    ActiveRecord::Base.connection.execute('drop table tasque_tasks;')
+  end
+
+  before(:each) do
+    Insque.redis.flushall
+    Tasque::Task.delete_all
+    Tasque.configure do |config|
+      config.worker = 'myworker'
+      config.check_interval = 1 # seconds
+      config.progress_interval = 1 # seconds
+      config.minimum_priority = nil
+      config.notify = false
+      config.heartbeat = false
+      config.heartbeat_interval = 1
+    end
+  end
+
+  it 'creates a task' do
+    Tasque::Task.create! task: 'test', params: { text: 'This is the test!' }
+    expect(Tasque::Task.count).to eq(1)
+  end
+
+  it 'processes a task' do
+    task = Tasque::Task.create! task: 'test', params: { text: 'This is the test!' }
+    processor_thread = Thread.new do
+      processor = Tasque::Processor.new
+      processor.add_handler('test') do |t|
+        t.complete!
+        { log: 'completed task' } 
+      end
+      processor.start
+    end
+    sleep 2
+    processor_thread.exit
+    task.reload
+    expect(task.status).to eq('complete')
+    expect(task.progress).to eq(100)
+  end 
+
+  it 'uses minimum priority' do
+    Tasque.config.minimum_priority = 10
+    task1 = Tasque::Task.create! task: 'test', priority: 1, params: { text: 'This is low priority!' }
+    task2 = Tasque::Task.create! task: 'test', priority: 100, params: { text: 'This is high priority!' }
+    processor_thread = Thread.new do
+      processor = Tasque::Processor.new
+      processor.add_handler('test') do |t|
+        t.complete!
+        { log: 'completed task' } 
+      end
+      processor.start
+    end
+    sleep 2
+    processor_thread.exit
+    task1.reload
+    task2.reload
+    expect(task1.status).to eq('new')
+    expect(task2.status).to eq('complete')
+  end 
+
+  it 'reports progress' do
+    task = Tasque::Task.create! task: 'test', params: { text: 'This is the test!' }
+    processor_thread = Thread.new do
+      processor = Tasque::Processor.new
+      processor.add_handler('test') do |t|
+        t.progress! 50
+        sleep 2
+        t.complete!
+        { log: 'completed task' } 
+      end
+      processor.start
+    end
+    sleep 2
+    task.reload
+    expect(task.status).to eq('processing')
+    expect(task.progress).to eq(50)
+    sleep 2
+    processor_thread.exit
+    task.reload
+    expect(task.status).to eq('complete')
+    expect(task.progress).to eq(100)
+  end
+
+  it 'reports errors' do
+    task = Tasque::Task.create! task: 'test', params: { text: 'This is the test!' }
+    processor_thread = Thread.new do
+      processor = Tasque::Processor.new
+      processor.add_handler('test') do |t|
+        raise 'Test Exception'
+        { log: 'completed task' } 
+      end
+      processor.start
+    end
+    sleep 2
+    processor_thread.exit
+    task.reload
+    expect(task.status).to eq('error')
+    expect(task.result['error']['exception']).to eq('Test Exception')
+  end
+
+  it 'uses insque notifications' do
+    Tasque.config.notify = true
+    janitor = Thread.new { Insque.janitor }
+    sleep 1
+    Tasque::Task.create! task: 'test', params: { text: 'This is the test!' }
+    processor_thread = Thread.new do
+      processor = Tasque::Processor.new
+      processor.add_handler('test') do |t|
+        t.complete!
+        { log: 'completed task' } 
+      end
+      processor.start
+    end
+    sleep 2
+    expect(Insque.redis.llen '{insque}inbox_myapp').to eq(3)
+    processor_thread.exit
+    janitor.exit
+  end
+
+  it 'uses heartbeat' do
+    Tasque.config.heartbeat = true
+    janitor = Thread.new { Insque.janitor }
+    sleep 1
+    processor_thread = Thread.new do
+      processor = Tasque::Processor.new
+      processor.start
+    end
+    sleep 4
+    expect(Insque.redis.llen '{insque}inbox_myapp').to eq(3)
+    processor_thread.exit
+    janitor.exit
+  end
+end

data/tasque.gemspec

@@ -21,4 +21,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency("timers")
   gem.add_dependency("state_machine")
   gem.add_dependency("json")
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('activesupport')
+  gem.add_development_dependency('sqlite3')
+  gem.add_development_dependency('insque')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tasque
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Yuri Gomozov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-13 00:00:00.000000000 Z
+date: 2018-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -66,6 +66,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: activesupport
+  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: sqlite3
+  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: insque
+  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: 'Task processing queue with states, history and priorities. Works with
   your favorite database. '
 email:
@@ -76,8 +132,11 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
+- db/test.db
+- insque.local.yml
 - lib/generators/tasque/install_generator.rb
 - lib/generators/tasque/templates/create_tasque_tasks.erb
 - lib/generators/tasque/templates/tasque.erb
@@ -87,6 +146,8 @@ files:
 - lib/tasque/task.rb
 - lib/tasque/task_error.rb
 - lib/tasque/version.rb
+- spec/spec_helper.rb
+- spec/tasque_spec.rb
 - tasque.gemspec
 homepage: https://github.com/Gropher/tasque
 licenses: []
@@ -107,8 +168,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: ActiveRecord based task queue
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/tasque_spec.rb