funktor 0.2.17 → 0.2.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7b7b575e4abcc04a0b771e3fb9afb912ee82015ed7aa6bcb17570fca0f392fa
-  data.tar.gz: 98d8caf556c78960b73a1ee40831d4165b01836831d65eb17014239450a5dce7
+  metadata.gz: 6e146325cc89da410fb6af4397911f20d66d681eaf14c7bd2919d41c97ab6e62
+  data.tar.gz: 4da3a83da0c561ed6ca5e51c84d0fa608063f5fa3d70dedde9a57aed279b91a2
 SHA512:
-  metadata.gz: 46b2e852ec64c6f4f5ea23422ec987e95941583f51fe8d76a254df36093c543a4b250c4de5f35abd32df1f9fd8db96df6655b397248697c134a208b8bc60d6f9
-  data.tar.gz: a7231805102b4a7b05ce8eade0c35c4798779e6ca88171a294137bc20a334e32da47927abdb607d00f83d3585d7dec0d5706c2f6a6baab2e5cbf769b768e4532
+  metadata.gz: 4860f967c03a2cf365c211f5d511591a8778c8570492499603bb6e888fb85e7c3ee7def2906fdc09762c9f166b3e1a503571df5fe4175a1cfeb2b153b37a5ba4
+  data.tar.gz: 1f32d8f5d968a08c7c0bd36eba892309b8511414bfc0d9ff2cc082dbd38496f8bdfb259ac7046e3d6f06707f994b7a947648eb1a15996c1f481afe112dad9034

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    funktor (0.2.17)
+    funktor (0.2.18)
       activesupport
       aws-sdk-sqs (~> 1.37)
       thor

data/lib/funktor.rb

@@ -3,16 +3,21 @@ require 'funktor/aws/sqs/event'
 require 'funktor/aws/sqs/record'
 require 'funktor/counter'
 require 'funktor/job'
+require 'funktor/logger'
 require 'funktor/worker'
 require 'funktor/middleware_chain'
 require 'funktor/incoming_job_handler'
-require 'funktor/active_job_handler'
 
 require 'json'
 
 module Funktor
   class Error < StandardError; end
 
+  DEFAULT_OPTIONS = {
+    error_handlers: [],
+    log_level: Logger::DEBUG # Set a high log level during early, active development
+  }
+
   def self.configure_job_pusher
     yield self
   end
@@ -55,9 +60,41 @@ module Funktor
   def self.dump_json(object)
     JSON.generate(object)
   end
+
+  def self.options
+    @options ||= DEFAULT_OPTIONS.dup
+  end
+
+  def self.options=(opts)
+    @options = opts
+  end
+
+  # Register a proc to handle any error which occurs within the Funktor active job handler.
+  #
+  #   Funktor.error_handlers << proc {|error, context| ErrorsAsAService.notify(error, context) }
+  #
+  # The default error handler logs errors to STDOUT
+  def self.error_handlers
+    options[:error_handlers]
+  end
+
+  def self.logger
+    @logger ||= Funktor::Logger.new($stdout, level: options[:log_level])
+  end
+
+  def self.logger=(logger)
+    if logger.nil?
+      self.logger.level = Logger::FATAL
+      return self.logger
+    end
+
+    @logger = logger
+  end
 end
 
 # TODO - Should we require this by default or let people opt in?
-# Is it a code smell that we need to include it at the bottom, after
+# TODO - Is it a code smell that we need to include these at the bottom, after
 # the main Funktor module is defined?
 require 'funktor/middleware/metrics'
+require 'funktor/error_handler'
+require 'funktor/active_job_handler'

data/lib/funktor/active_job_handler.rb

@@ -2,6 +2,7 @@ require 'aws-sdk-sqs'
 
 module Funktor
   class ActiveJobHandler
+    include Funktor::ErrorHandler
 
     def initialize
       @failed_counter = Funktor::Counter.new('failed')
@@ -28,8 +29,7 @@ module Funktor
         @processed_counter.incr(job)
       # rescue Funktor::Job::InvalidJsonError # TODO Make this work
       rescue Exception => e
-        puts "Error during processing: #{$!}"
-        puts "Backtrace:\n\t#{e.backtrace.join("\n\t")}"
+        handle_error(e, job)
         @failed_counter.incr(job)
         attempt_retry_or_bail(job)
       end

data/lib/funktor/error_handler.rb

@@ -0,0 +1,25 @@
+module Funktor
+  module ErrorHandler
+    class Logger
+      def call(error, context)
+        Funktor.logger.warn(Funktor.dump_json(context)) unless context.empty?
+        Funktor.logger.warn("#{error.class.name}: #{error.message}")
+        Funktor.logger.warn(error.backtrace.join("\n")) unless error.backtrace.nil?
+      end
+
+      Funktor.error_handlers << Funktor::ErrorHandler::Logger.new
+    end
+
+    def handle_error(error, context = {})
+      Funktor.error_handlers.each do |handler|
+        begin
+          handler.call(error, context)
+        rescue => new_error
+          Funktor.logger.error "!!! ERROR HANDLER THREW AN ERROR !!!"
+          Funktor.logger.error new_error
+          Funktor.logger.error new_error.backtrace.join("\n") unless new_error.backtrace.nil?
+        end
+      end
+    end
+  end
+end

data/lib/funktor/logger.rb

@@ -0,0 +1,5 @@
+require 'logger'
+module Funktor
+  class Logger < ::Logger
+  end
+end

data/lib/funktor/version.rb

@@ -1,3 +1,3 @@
 module Funktor
-  VERSION = "0.2.17"
+  VERSION = "0.2.18"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: funktor
 version: !ruby/object:Gem::Version
-  version: 0.2.17
+  version: 0.2.18
 platform: ruby
 authors:
 - Jeremy Green
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-02 00:00:00.000000000 Z
+date: 2021-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sqs
@@ -137,9 +137,11 @@ files:
 - lib/funktor/cli/templates/package.json
 - lib/funktor/cli/templates/serverless.yml
 - lib/funktor/counter.rb
+- lib/funktor/error_handler.rb
 - lib/funktor/fake_job_queue.rb
 - lib/funktor/incoming_job_handler.rb
 - lib/funktor/job.rb
+- lib/funktor/logger.rb
 - lib/funktor/middleware/metrics.rb
 - lib/funktor/middleware_chain.rb
 - lib/funktor/testing.rb