sidekiq_portal 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e413dfa69dae938ee861290b621eb99252cbcba42c09d1eaa541d1fb49e1675
-  data.tar.gz: 01d1b01fc9c84920425212d964763372c0f2c4129eb179129bd60932fde2b374
+  metadata.gz: 23dc75354e3f173ffc8fdaa30634f08509374eaecb190226344073c5e1ba0bbe
+  data.tar.gz: c457e2865d1fac05fc1822f4ba4fea2121b29c7649ffabcff91039cb50abde02
 SHA512:
-  metadata.gz: afcb5900eab9338ab000fd3f540f827ecc6e0c5b9907789e30f8b9c729bf970b771dfca679853b5484174c90361a48381298869b4447105a0a2c28670065578e
-  data.tar.gz: 7cac31cd6ad9a3da4a253afe6fbb47cd4344fbea1d73ca685b39c224d3d05cc53dd8c8320d77920a303224ce5548ce30c96f2c84d5720508c3990e2d5af61d92
+  metadata.gz: a156ef577a6b09f906819c16b31234ee6e053f2d4a179acdaf84089433b99669ea14101ded51cd211c45d01367acdd81d4eb5c2a389f6bdddb96c78db48f6dd9
+  data.tar.gz: 92e396e45095fe17dd02f2ad2c1b58fc3f5e342ec45771b78d8a89cba6491d54b22037fd697378234ce202e5fadeea505a42acadb8b3ca620c2b0bd8e2450148

data/.gitignore

@@ -7,10 +7,10 @@
 /spec/reports/
 /tmp/
 .rspec_status
-Gemfile.lock
 /.idea
 .ruby-version
 /.vscode/
 /spec/artifacts/
 /gemfiles/*.gemfile.lock
 *.gem
+Gemfile.lock

data/.rubocop.yml

@@ -5,7 +5,7 @@ inherit_gem:
     - lib/rubocop.rspec.yml
 
 AllCops:
-  TargetRubyVersion: 2.6.5
+  TargetRubyVersion: 2.4.9
   Include:
     - lib/**/*.rb
     - spec/**/*.rb

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.2.0] - 2020-01-04
+### Added
+- Sidekiq's job retry mechanism emulation;
+
 ## [0.1.1] - 2019-12-24
 
 ### Fixed

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Rustam Ibragimov
+Copyright (c) 2019-2020 Rustam Ibragimov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -54,9 +54,10 @@ require 'sidekiq_portal'
 
 ## Configuration
 
-- `default_timezone` (`UTC` by default) - global time zone for your jobs;
-- `retries_count` - Sidekiq's built-in retry mechanism simulation;
-- `scheduler_config` - `sidekiq-scheduler`-based scheduler configuration;;
+- `default_timezone` - global time zone for your jobs (`UTC` by default);
+- `retry_count` - Sidekiq's built-in retry mechanism simulation (`0` by default);
+- `retry_on` - retry only on a set of exceptions (`[StandardError]` by default);
+- `scheduler_config` - `sidekiq-scheduler`-based scheduler configuration (`{}` by default (non-configured));
 - `Sidekiq::Portal.reload!(&configuration)` - reload portal configurations;
 
 In your `spec_helper.rb`:
@@ -64,8 +65,9 @@ In your `spec_helper.rb`:
 ```ruby
 # portal configuration
 Sidekiq::Portal.setup! do |config|
-  config.default_timezone = 'UTC'
-  config.retries_count = 1
+  config.default_timezone = 'UTC' # 'UTC' by default
+  config.retry_count = 3 # 0 by default
+  config.retry_on = [StandardError] # [StandardError] by default
 
   # pre-defined sidekiq-scheduler configs (Rails example)
   config.scheduler_cofnig = Rails.application.config_for(:sidekiq)[:schedule]
@@ -146,8 +148,7 @@ end
 
 - `Sidekiq::Testing.portal!` test mode with support for `:inline` and `:fake`;
   (`Sidekiq::Testing.inline!` and `Sidekiq::Testing.fake` respectively);
-- support for `ActiveSupport::Timezone` instances in `default_timezone` config;
-- support for retries;
+- support for `ActiveSupport::TimeZone` instances in `default_timezone` config;
 - rspec matchers;
 - `#reload!` should use previosly defined settings?;
 - support for `Sidekiq::Worker` job backend;
@@ -155,6 +156,9 @@ end
 - more specs;
 - documentation and examples for instance-based portals (`Sidekiq::Portal.new(&configuration)`);
 - job execution randomization (for jobs which should be invoked at the same time);
+- configurable in-line invokations (with job list config);
+- configurable and conditional portal invokation (run over all specs or only over the one or etc)
+  (suitable for unit tests);
 
 ## License
 

data/lib/portal/config.rb

@@ -21,14 +21,35 @@ class Sidekiq::Portal::Config < Qonfig::DataSet
   # @since 0.1.0
   DEFAUL_RETRIES_COUNT = 0
 
+  # @return [Array<Exception>]
+  #
+  # @api private
+  # @since 0.1.0
+  RETRY_ON_EXCEPTIONS = [StandardError].freeze
+
+  # @since 0.1.0
   setting :default_timezone, DEFAULT_TIMEZONE
-  setting :retries_count, DEFAUL_RETRIES_COUNT
+  # @since 0.1.0
+  setting :retry_count, DEFAUL_RETRIES_COUNT
+  # @since 0.1.0
+  setting :retry_on, RETRY_ON_EXCEPTIONS
+  # @since 0.1.0
   setting :scheduler_config, EMPTY_SCHEDULER_CONFIG
 
+  # @since 0.1.0
   validate :default_timezone do |value|
     value.is_a?(String) && !ActiveSupport::TimeZone[value].nil?
   end
 
-  validate :retries_count, :integer, strict: true
+  # @since 0.1.0
+  validate :retry_on do |value|
+    value.is_a?(Array) && (value.all? do |exception_klass|
+      exception_klass.is_a?(Class) && exception_klass <= ::Exception
+    end)
+  end
+
+  # @since 0.1.0
+  validate :retry_count, :integer, strict: true
+  # @since 0.1.0
   validate :scheduler_config, :hash, strict: true
 end

data/lib/portal/job_manager.rb

@@ -52,7 +52,7 @@ class Sidekiq::Portal::JobManager
       .map!(&:time_points)
       .tap(&:flatten!)
       .tap(&:sort!)
-      .tap(&:uniq)
+      .tap(&:uniq!)
       .tap { |points| points.select! { |point| point <= Time.current } }
   end
 

data/lib/portal/job_manager/builder.rb

@@ -10,19 +10,18 @@ class Sidekiq::Portal::JobManager::Builder
     # @api private
     # @since 0.1.0
     def build(config)
-      new(config.settings.scheduler_config, config.settings.default_timezone).build
+      new(config).build
     end
   end
 
-  # @param scheduled_jobs_config [Hash]
-  # @param timezone [String]
+  # @param config [Sidekiq::Portal::Config]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
-  def initialize(scheduled_jobs_config, timezone)
-    @scheduled_jobs_config = scheduled_jobs_config
-    @timezone = timezone
+  def initialize(config)
+    @scheduled_jobs_config = config.settings.scheduler_config
+    @timezone = config.settings.default_timezone
   end
 
   # @return [Sidekiq::Portal::Manager]

data/lib/portal/job_runner.rb

@@ -5,14 +5,74 @@
 class Sidekiq::Portal::JobRunner
   require_relative 'job_runner/builder'
 
+  # @param retry_count [Integer]
+  # @parma retry_on_exceptions [Array<Class<Exception>>]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(retry_count, retry_on_exceptions)
+    @retry_count = retry_count
+    @retry_on_exceptions = retry_on_exceptions
+  end
+
   # @param job [Sidekiq::Portal::Job]
   #
   # @api private
   # @since 0.1.0
   def run(job)
-    return unless job.timeline.time_has_come?
+    return unless time_has_come?(job)
+    actualize_internal_job_state(job)
+    perform(job)
+  end
+
+  private
+
+  # @return [Integer]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :retry_count
+
+  # @return [Arrray<Class<Exception>>]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :retry_on_exceptions
+
+  # @param job [Sidekiq::Portal::Job]
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.1.0
+  def time_has_come?(job)
+    job.timeline.time_has_come?
+  end
 
+  # @param job [Sidekiq::Portal::Job]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def actualize_internal_job_state(job)
     job.timeline.actualize_time!
+  end
+
+  # @param job [Sidekiq::Portal::Job]
+  # @param perform_attempt [Integer]
+  # @return [void]
+  #
+  # @raise [Exception]
+  #
+  # @api private
+  # @since 0.1.0
+  def perform(job, perform_attempt = 1)
     job.klass.perform_later
+  rescue => error
+    if retry_on_exceptions.include?(error.class)
+      (perform_attempt == retry_count) ? raise(error) : perform(job, perform_attempt.next)
+    else
+      raise(error)
+    end
   end
 end

data/lib/portal/job_runner/builder.rb

@@ -10,7 +10,10 @@ module Sidekiq::Portal::JobRunner::Builder
     # @api private
     # @since 0.1.0
     def build(config)
-      Sidekiq::Portal::JobRunner.new
+      Sidekiq::Portal::JobRunner.new(
+        config.settings.retry_count,
+        config.settings.retry_on
+      )
     end
   end
 end

data/lib/portal/version.rb

@@ -10,6 +10,6 @@ module Sidekiq
     #
     # @api public
     # @since 0.1.0
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

data/sidekiq_portal.gemspec

@@ -13,9 +13,9 @@ Gem::Specification.new do |spec|
   spec.email = ['iamdaiver@icloud.com']
 
   spec.summary =
-    'Sidekiq::Portal - emulate job activity in tests when you work with time traveling.'
+    'Sidekiq::Portal - scheduled jobs invocation emulation for test environments '
   spec.description =
-    'Sidekiq::Portal - emulate job activity in tests when you work with time traveling.'
+    'Sidekiq::Portal - emulate scheduled job activity in tests when you work with time traveling.'
 
   spec.homepage = 'https://github.com/0exp/sidekiq_portal'
   spec.license = 'MIT'
@@ -30,16 +30,16 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'qonfig', '~> 0.23'
   spec.add_dependency 'fugit', '~> 1.3'
-  spec.add_dependency 'activesupport', '>= 4'
+  spec.add_dependency 'activesupport', '>= 4', '< 7'
 
-  spec.add_development_dependency 'armitage-rubocop', '~> 0.77'
+  spec.add_development_dependency 'armitage-rubocop', '~> 0.78'
   spec.add_development_dependency 'rspec', '~> 3.9.0'
   spec.add_development_dependency 'simplecov', '~> 0.17.1'
 
-  spec.add_development_dependency 'sidekiq', '>= 5'
+  spec.add_development_dependency 'sidekiq', '>= 5', '< 7'
   spec.add_development_dependency 'timecop', '~> 0.9'
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'pry', '~> 0.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_portal
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-24 00:00:00.000000000 Z
+date: 2020-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: qonfig
@@ -45,6 +45,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -52,20 +55,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: armitage-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.77'
+        version: '0.78'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.77'
+        version: '0.78'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +107,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -108,6 +117,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -126,46 +138,46 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Sidekiq::Portal - emulate job activity in tests when you work with time
-  traveling.
+        version: '0.12'
+description: Sidekiq::Portal - emulate scheduled job activity in tests when you work
+  with time traveling.
 email:
 - iamdaiver@icloud.com
 executables: []
@@ -225,8 +237,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Sidekiq::Portal - emulate job activity in tests when you work with time traveling.
+summary: Sidekiq::Portal - scheduled jobs invocation emulation for test environments
 test_files: []