sidekiq_publisher 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db0cc3968f944fe60726607aeb9d41d7b4ecbc850c8720c69997acbd32baf53d
-  data.tar.gz: 22de3301c98a4c891d6e43afe03c60ec7705b6fe63c46160980a98f5076ba740
+  metadata.gz: 4a5c547481b5ced12b2104fae37180f6e69afb53e56e33c63aa3ab5341c17cde
+  data.tar.gz: 8726552f9f5e2713e10125763b67210515ca450be70450facbb0d2a0b5d969ee
 SHA512:
-  metadata.gz: 488744676ef141fb303944c8b059863527b11c14c63776a92973136c629cca89febc08b8cff8a4cdf760878bd7cdab3a2f0e4e4e4176043f0ad0364bfb1878a1
-  data.tar.gz: 84b761ecc88849906fd34093fd65d29d146df4e9010c5f601c53ff692c2fefce36fde127b7af2b9cf97f97630ca0e30359249928b883dabca22feea3d5f2740d
+  metadata.gz: 343cf4ef74e8e0a30be17386f8174976b328ccb842f75203f994af0f1d0a83112214c8f03e6dea00f4aacab50aeef695457203d561e2df596224b16ba9375eea
+  data.tar.gz: 29b3a7ffee99df51593c59786c712ea8af6468baf866879a40a3aaf2404435fcaaa5549cab8b7d2c5575a124d5c57f06c2aa9d7abefee06359b9c80abfaef815

data/CHANGELOG.md

@@ -1,4 +1,13 @@
 # sidekiq_publisher
 
+## v0.2.0
+- Add caching for job class constant lookup.
+- Add metrics for the number of jobs published and purged.
+- Add ActiveSupport as a runtime dependency.
+
+## v0.1.1
+- Publish Sidekiq jobs with the `created_at` value from when the job was inserted
+  into the table.
+
 ## v0.1.0
 - Initial version

data/README.md

@@ -38,11 +38,26 @@ This gem uses the following configuration:
 
 * **logger**: the logger for this gem to use.
 * **exception_reporter**: a Proc that will be called with an exception
+* **metrics_reporter**: an optional object to record metrics. See below.
 * **batch_size**: the maximum number of jobs that will be enqueued to Sidekiq
   together
 * **job_retention_period**: the duration that published jobs will be kept in
   Postgres after they have been enqueued to Sidekiq
     
+### Metrics Reporter
+
+The metrics reporter that can be configured with an object that is expected to
+respond to the following API:
+
+```ruby
+count(metric_name, count)
+```
+
+Metrics will be reported for:
+
+- the number of jobs published in each batch
+- the number of jobs purged
+
 ## Usage
 
 ### ActiveJob Adapter

data/lib/sidekiq_publisher.rb

@@ -13,9 +13,13 @@ module SidekiqPublisher
   DEFAULT_JOB_RETENTION_PERIOD = 1.day.freeze
 
   class << self
-    attr_accessor :logger, :exception_reporter
+    attr_accessor :logger, :exception_reporter, :metrics_reporter
     attr_writer :batch_size, :job_retention_period
 
+    def configure
+      yield self
+    end
+
     def batch_size
       @batch_size || DEFAULT_BATCH_SIZE
     end
@@ -29,6 +33,7 @@ module SidekiqPublisher
       @batch_size = nil
       @job_retention_period = nil
       @exception_reporter = nil
+      @metrics_reporter = nil
     end
   end
 end

data/lib/sidekiq_publisher/job.rb

@@ -6,7 +6,7 @@ module SidekiqPublisher
   class Job < ActiveRecord::Base
     self.table_name = "sidekiq_publisher_jobs"
 
-    BATCH_KEYS = %i(id job_id job_class args run_at queue wrapped).freeze
+    BATCH_KEYS = %i(id job_id job_class args run_at queue wrapped created_at).freeze
 
     before_create :ensure_job_id
     before_save :ensure_string_job_class
@@ -34,6 +34,7 @@ module SidekiqPublisher
       SidekiqPublisher.logger.info("#{name} purging expired published jobs.")
       count = purgeable.delete_all
       SidekiqPublisher.logger.info("#{name} purged #{count} expired published jobs.")
+      SidekiqPublisher.metrics_reporter.try(:count, "sidekiq_publisher:purged", count)
     end
 
     def self.unpublished_batches(batch_size: SidekiqPublisher.batch_size)
@@ -43,22 +44,6 @@ module SidekiqPublisher
       end
     end
 
-    # TODO: this method was just for testing and may be removed
-    def publish
-      Sidekiq::Client.push(sidekiq_item)
-    end
-
-    def sidekiq_item
-      {
-        "jid" => job_id,
-        "class" => job_class.constantize,
-        "args" => args,
-        "at" => run_at,
-        "queue" => queue,
-        "wrapped" => wrapped,
-      }.tap(&:compact!)
-    end
-
     private
 
     def ensure_job_id

data/lib/sidekiq_publisher/publisher.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
 require "sidekiq_publisher/client"
+require "active_support/core_ext/object/try"
 
 module SidekiqPublisher
   class Publisher
     extend PrivateAttr
 
-    private_attr_reader :client
+    private_attr_reader :client, :job_class_cache
 
     def initialize
       @client = SidekiqPublisher::Client.new
+      @job_class_cache = {}
     end
 
     def publish
@@ -17,11 +19,12 @@ module SidekiqPublisher
         items = batch.map do |job|
           {
             "jid" => job[:job_id],
-            "class" => job[:job_class].constantize,
+            "class" => lookup_job_class(job[:job_class]),
             "args" => job[:args],
             "at" => job[:run_at],
             "queue" => job[:queue],
             "wrapped" => job[:wrapped],
+            "created_at" => job[:created_at].to_f,
           }.tap(&:compact!)
         end
 
@@ -40,7 +43,14 @@ module SidekiqPublisher
     rescue StandardError => ex
       failure_warning(__method__, ex)
     ensure
-      update_jobs_as_published!(batch) if pushed_count.present? && published_count.nil?
+      published_count = update_jobs_as_published!(batch) if pushed_count.present? && published_count.nil?
+      metrics_reporter.try(:count, "sidekiq_publisher:published", published_count)
+    end
+
+    def lookup_job_class(name)
+      job_class_cache.fetch(name) do
+        job_class_cache[name] = name.constantize
+      end
     end
 
     def update_jobs_as_published!(jobs)
@@ -64,5 +74,9 @@ module SidekiqPublisher
     def logger
       SidekiqPublisher.logger
     end
+
+    def metrics_reporter
+      SidekiqPublisher.metrics_reporter
+    end
   end
 end

data/lib/sidekiq_publisher/version.rb

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

data/sidekiq_publisher.gemspec

@@ -9,11 +9,9 @@ Gem::Specification.new do |spec|
   spec.version       = SidekiqPublisher::VERSION
   spec.authors       = ["ezCater, Inc"]
   spec.email         = ["engineering@ezcater.com"]
-
   spec.summary       = "Publisher for enqueuing jobs to Sidekiq"
   spec.description   = spec.summary
   spec.homepage      = "https://github.com/ezcater/sidekiq_publisher"
-
   spec.license       = "MIT"
 
   # Set "allowed_push_post" to control where this gem can be published.
@@ -23,7 +21,6 @@ Gem::Specification.new do |spec|
   else
     raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end
-  # rubocop:enable Style/GuardClause
 
   excluded_files = %w(.circleci/config.yml
                       .github/PULL_REQUEST_TEMPLATE.md
@@ -59,6 +56,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov"
 
   spec.add_runtime_dependency "activerecord-postgres_pub_sub"
+  spec.add_runtime_dependency "activesupport", "~> 5.1.4"
   spec.add_runtime_dependency "private_attr"
   spec.add_runtime_dependency "sidekiq", "~> 5.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_publisher
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-16 00:00:00.000000000 Z
+date: 2018-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -206,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
 - !ruby/object:Gem::Dependency
   name: private_attr
   requirement: !ruby/object:Gem::Requirement