coney_island 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfdbf69bc36cb56a1ad4e633be6df4f4edced0d0
-  data.tar.gz: 641fc25380b54f476f5f37f8c59c6d3570d4607b
+  metadata.gz: ad987b88af8e85b48fd63cbeddad3e131203b65b
+  data.tar.gz: 821581cc67935f4b287b75a4c5932634475232a6
 SHA512:
-  metadata.gz: fa96a5a9c6dcec63474fee276cb7be7b825f35788f533616b1b34e489b597a25f63e9f6153c46e2b074d2da1d72842725160bdb513079c591830d9bdd00c396a
-  data.tar.gz: c124f9e8b09631d6c6c114de3beca755fc40a210513f8b31ef82f3d67875baaf0e671ff6e56e24d337afbf826d4f8bf2118d8dc83fae101e0f9635a7d7db4dce
+  metadata.gz: 01203b116490b52af605167f6f854ac61a72fd37f750c73d364fd847fb4760526de6f814f67a970bd852c47dffab4af2ea499f9c44f927c7ee6039be0a6b3020
+  data.tar.gz: 02ba62d6b4d086a229abb37b6c18558e28bd06eb82c3efbce049344ebd844ad1054bd2e3a1050a75ea8a4740a10fde460a6f054ae396179aa1ee4f47c249909f

data/Rakefile

@@ -26,6 +26,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
+  t.warning = false
 end
 
 

data/lib/coney_island.rb

@@ -35,7 +35,18 @@ module ConeyIsland
   end
 
   def self.notifier
-    @notifier ||= "ConeyIsland::Notifiers::#{self.config[:notifier_service]}Notifier".constantize
+    case self.config[:notifier]
+    when :airbrake
+      Notifiers::AirbrakeNotifier
+    when :bugsnag
+      Notifiers::BugsnagNotifier
+    when :honeybadger
+      Notifiers::HoneybadgerNotifier
+    when :none
+      Notifiers::NullNotifier
+    else
+      fail ConfigurationError, "#{self.config[:notifier]} is an invalid notifier. Valid options: :airbrake, :bugsnag, :honeybadger, :none"
+    end
   end
 
   def self.config=(config_hash)
@@ -87,10 +98,18 @@ module ConeyIsland
     ConeyIsland::Submitter.cache_jobs
   end
 
+  def self.cached_jobs
+    ConeyIsland::Submitter.cached_jobs
+  end
+
   def self.stop_caching_jobs
     ConeyIsland::Submitter.stop_caching_jobs
   end
 
+  def self.caching_jobs(&blk)
+    ConeyIsland::Submitter.caching_jobs(&blk)
+  end
+
   def self.flush_jobs
     ConeyIsland::Submitter.flush_jobs
   end
@@ -99,7 +118,7 @@ module ConeyIsland
     ConeyIsland::Submitter.submit(*args)
   end
 
-  def self.poke_the_badger(message, context, attempts = 1)
+  def self.poke_the_badger(message, context = {}, attempts = 1)
     Timeout::timeout(3) do
       self.notifier.notify(message, context)
     end
@@ -111,18 +130,32 @@ module ConeyIsland
   end
 
   def self.default_settings
-    { work_queue: 'default', timeout: 30, delay: 0 }
+    { work_queue: 'default', timeout: 30, delay: 0, highlander: false }
   end
 
 end
 
+# RabbitMQ
+require 'bunny'
+# Active Support
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/string/inflections'
+
+require 'coney_island/configuration_error'
+require 'coney_island/job_argument_error'
+
+require 'coney_island/notifiers/base_notifier'
+require 'coney_island/notifiers/airbrake_notifier'
+require 'coney_island/notifiers/bugsnag_notifier'
 require 'coney_island/notifiers/honeybadger_notifier'
+require 'coney_island/notifiers/null_notifier'
+
 require 'coney_island/worker'
 require 'coney_island/job'
 require 'coney_island/submitter'
-require 'coney_island/job_argument_error'
+require 'coney_island/jobs_cache'
 if defined?(Rails) && defined?(ActiveJob)
   require 'coney_island/coney_island_adapter'
 end
 require 'coney_island/performer'
-require 'bunny'

data/lib/coney_island/configuration_error.rb

@@ -0,0 +1,4 @@
+module ConeyIsland
+  class ConfigurationError < StandardError
+  end
+end

data/lib/coney_island/job.rb

@@ -6,7 +6,7 @@ module ConeyIsland
 
     def initialize(metadata, args)
       @args = args
-      @id = SecureRandom.uuid
+      @id = args['job_id'] || SecureRandom.uuid
       @dont_log = args['dont_log']
       self.log.info ("Starting job #{@id}: #{@args}") unless self.dont_log
       @delay = args['delay'].to_i if args['delay']
@@ -17,7 +17,7 @@ module ConeyIsland
       @class_name = args['klass']
       @klass = @class_name.constantize
       @method_args = args['args']
-      # Symbolize hash keys for consistency and for keyword arguments
+      # Symbolize hash keys for consistency and keyword arguments
       @method_args.each { |v| v.symbolize_keys! if v.is_a?(Hash) } if !!@method_args
       @attempts = args['attempt_count'] || 1
       @retry_limit = args['retry_limit'] || 3

data/lib/coney_island/jobs_cache.rb

@@ -0,0 +1,96 @@
+module ConeyIsland
+  # Handles job caching hijinks. This is especially useful for Rails apps where
+  # you can set Coney to cache jobs at the beginning of the request and flush
+  # them once you the request is served. Most methods are exposed by ConeyIsland
+  # so you'd just use ConeyIsland.cache_jobs, ConeyIsland.flush_jobs.
+  class JobsCache
+    delegate :submit!, to: Submitter
+
+    def initialize
+      @adapter = RequestStore
+    end
+
+    # Are we caching jobs?
+    def caching_jobs?
+      !! is_caching_jobs
+    end
+
+    # Start caching jobs
+    def cache_jobs
+      self.is_caching_jobs = true
+      self
+    end
+
+    # Stop caching jobs
+    def stop_caching_jobs
+      self.is_caching_jobs = false
+      self
+    end
+
+    # Caches jobs for the duration of the block, flushes them at the end.
+    def caching_jobs(&blk)
+      _was_caching = caching_jobs?
+      cache_jobs
+      blk.call
+      flush_jobs
+      self.is_caching_jobs = _was_caching
+      self
+    end
+
+    # Cache a job with the given args
+    def cache_job(*args)
+      self.cached_jobs[generate_id(*args)] = args
+      self
+    end
+
+    # Publish all the cached jobs
+    def flush_jobs
+      # Get all the jobs, one at a time, pulling from the list
+      while job = self.cached_jobs.shift
+        # Map the array to the right things
+        job_id, args = *job
+        # Submit! takes care of rescuing, error logging, etc and never caches
+        submit! args, job_id
+      end
+      self
+    end
+
+    # List of the currently cached jobs, anxiously waiting to be flushed
+    def cached_jobs
+      @adapter.store[:jobs] ||= {}
+    end
+
+    def clear
+      self.is_caching_jobs = false
+      self.cached_jobs  = {}
+    end
+
+    protected
+
+    def cached_jobs=(something)
+      @adapter.store[:jobs] = something
+    end
+
+    def is_caching_jobs
+      @adapter.store[:caching_jobs]
+    end
+
+    def is_caching_jobs=(boolean)
+      @adapter.store[:caching_jobs] = boolean
+    end
+
+    def generate_id(*args)
+      # Duplicate the args so we don't mess with the original
+      _args = args.dup
+      # Do we have job arguments and highlander is true?
+      if _args.last.is_a?(Hash) && !!ActiveSupport::HashWithIndifferentAccess.new(_args.pop)[:highlander]
+        # We simply generate an id based on the class, method, arguments signature
+        _args.map(&:to_s).join("-")
+      else
+        # We generate a new id every time
+        SecureRandom.uuid
+      end
+    end
+
+  end
+end

data/lib/coney_island/notifiers/airbrake_notifier.rb

@@ -1,9 +1,11 @@
 module ConeyIsland
   module Notifiers
-    class AirbrakeNotifier
-      def self.notify(message, extra_params)
+    class AirbrakeNotifier < BaseNotifier
+      def self.notify(message, extra_params = {})
         Airbrake.notify(message, extra_params)
+      rescue NameError => e
+        fail ConfigurationError, fail_message(:airbrake, "Airbrake")
       end
     end
   end
-end
+end

data/lib/coney_island/notifiers/base_notifier.rb

@@ -0,0 +1,15 @@
+module ConeyIsland
+  module Notifiers
+    class BaseNotifier
+      def self.notify(message = "", extra_params = {})
+        # NOOP
+      end
+
+      protected
+
+      def self.fail_message(notifier_symbol, notifier_class)
+        "You have specified #{notifier_symbol} as your notifier, but #{notifier_class} doesn't seem to be installed. Try adding #{notifier_symbol} to your Gemfile."
+      end
+    end
+  end
+end

data/lib/coney_island/notifiers/bugsnag_notifier.rb

@@ -0,0 +1,11 @@
+module ConeyIsland
+  module Notifiers
+    class BugsnagNotifier < BaseNotifier
+      def self.notify(message, extra_params = {})
+        Bugsnag.notify(message, meta_data: extra_params)
+      rescue NameError => e
+        fail ConfigurationError, fail_message(:bugsnag, "Bugsnag")
+      end
+    end
+  end
+end

data/lib/coney_island/notifiers/honeybadger_notifier.rb

@@ -1,9 +1,11 @@
 module ConeyIsland
   module Notifiers
-    class HoneybadgerNotifier
-      def self.notify(message, extra_params)
+    class HoneybadgerNotifier < BaseNotifier
+      def self.notify(message, extra_params = {})
         Honeybadger.notify(message, { context: extra_params })
+      rescue NameError => e
+        fail ConfigurationError, fail_message(:honeybadger, "Honeybadger")
       end
     end
   end
-end
+end

data/lib/coney_island/notifiers/null_notifier.rb

@@ -0,0 +1,6 @@
+module ConeyIsland
+  module Notifiers
+    class NullNotifier < BaseNotifier
+    end
+  end
+end

data/lib/coney_island/performer.rb

@@ -3,18 +3,20 @@ module ConeyIsland
 
     def self.included(base)
       base.extend ClassMethods
+      delegate :get_coney_settings, to: :class
       # http://apidock.com/rails/Class/class_attribute
       base.class_attribute :coney_island_settings
     end
 
+
     def method_missing(method_name, *args)
       method_str = method_name.to_s
       if method_str =~ /.*_async$/
         synchronous_method = method_str.sub(/_async$/, '')
         if self.respond_to?(:id) && self.class.respond_to?(:find)
-          ConeyIsland.submit(self.class, synchronous_method, instance_id: self.id, args: args)
+          ConeyIsland.submit(self.class, synchronous_method, instance_id: self.id, args: args, highlander: get_coney_settings[:highlander])
         else
-          ConeyIsland.submit(self.class, synchronous_method, singleton: true, args: args)
+          ConeyIsland.submit(self.class, synchronous_method, singleton: true, args: args, highlander: get_coney_settings[:highlander])
         end
       else
         super
@@ -31,8 +33,13 @@ module ConeyIsland
       #   :timeout - Timeout the job with retry. The timeout value is a number
       #     of seconds. By default ConeyIsland will retry 3 times before bailing
       #     out.
+      #   :highlander - There can only be one job with the same arguments per
+      # request lifecycle. This makes it so that even if you enqueue the same
+      # job with the same arguments twice, it will only fire once.
+      # Only makes sense when caching jobs (like in a Rails app where you can
+      # cache jobs and flush them all at once after the end of the request)
       def set_background_defaults(options = {})
-        options = options.dup.symbolize_keys.slice(:work_queue, :delay, :timeout)
+        options = options.dup.symbolize_keys.slice(:work_queue, :delay, :timeout, :highlander)
         self.coney_island_settings = get_coney_settings.merge(options)
       end
 
@@ -46,7 +53,7 @@ module ConeyIsland
         method_str = method_name.to_s
         if method_str =~ /.*_async$/
           synchronous_method = method_str.sub(/_async$/, '')
-          ConeyIsland.submit(self, synchronous_method, args: args)
+          ConeyIsland.submit(self, synchronous_method, args: args, highlander: get_coney_settings[:highlander])
         else
           super
         end

data/lib/coney_island/submitter.rb

@@ -3,6 +3,11 @@ module ConeyIsland
   # ease of testing and thread safety.
   class Submitter
 
+    class << self
+      delegate :caching_jobs?, :caching_jobs, :cached_jobs, :cache_job, :cache_jobs,
+        :stop_caching_jobs, :flush_jobs, to: :jobs_cache
+    end
+
     def self.run_inline
       @run_inline = true
     end
@@ -23,41 +28,29 @@ module ConeyIsland
       @tcp_connection_retries
     end
 
-    def self.submit(*args)
-      if RequestStore.store[:cache_jobs]
-        job_id = SecureRandom.uuid
-        RequestStore.store[:jobs][job_id] = args
-      else
-        self.submit!(args)
-      end
+    def self.jobs_cache
+      @jobs_cache ||= JobsCache.new
     end
 
-    def self.submit!(args)
-      if @run_inline
-        self.submit_all!(args)
+    def self.submit(*args)
+      if caching_jobs?
+        cache_job(*args)
       else
-        begin
-          self.submit_all!(args)
-        rescue StandardError => e
-          Rails.logger.error(e)
-          ConeyIsland.poke_the_badger(e,{
-            code_source: "ConeyIsland::Submitter.submit!",
-            message: "Error submitting job",
-            job_args: args
-            })
-        end
+        submit!(args)
       end
     end
 
-    def self.submit_all!(args)
-      if :all_cached_jobs == args
-        Rails.logger.info("ConeyIsland::Submitter.submit! about to iterate over this many jobs: #{RequestStore.store[:jobs].length}")
-        RequestStore.store[:jobs].each do |job_id,job_args|
-          self.publish_job(job_args,job_id)
-        end
-      else
-        self.publish_job(args)
-      end
+    def self.submit!(args, job_id = nil)
+      Rails.logger.info "Submitting job #{job_id}: #{args}"
+      publish_job(args, job_id)
+    rescue StandardError => e
+      Rails.logger.error(e)
+      ConeyIsland.poke_the_badger(e,{
+        code_source: "ConeyIsland::Submitter.submit!",
+        message: "Error submitting job",
+        job_args: args
+        })
+      fail e if running_inline?
     end
 
     def self.connection=(conn)
@@ -154,6 +147,7 @@ module ConeyIsland
       @connection
     end
 
+    # TODO: Document me
     def self.publish_job(args, job_id = nil)
       # Map arguments
       klass, method_name, job_args = *args
@@ -203,19 +197,6 @@ module ConeyIsland
       true
     end
 
-    def self.cache_jobs
-      RequestStore.store[:cache_jobs] = true
-      RequestStore.store[:jobs] = {}
-    end
-
-    def self.flush_jobs
-      self.submit!(:all_cached_jobs) if RequestStore.store[:jobs].any?
-    end
-
-    def self.stop_caching_jobs
-      RequestStore.store[:cache_jobs] = false
-    end
-
     protected
 
     # Publishes a job to a delayed queue exchange
@@ -242,4 +223,3 @@ module ConeyIsland
 
   end
 end
-

data/lib/coney_island/version.rb

@@ -1,3 +1,3 @@
 module ConeyIsland
-  VERSION = "0.13.1"
+  VERSION = "0.14.0"
 end