cloudtasker 0.12.rc10 → 0.12.rc11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5763bef46a0c554549150326375c3fb49c9eb77193b6862334dc1da72a5fe34f
-  data.tar.gz: 211272f9129642cb8c7260f639a6a76714161ac37c87dc5f073633a072781b44
+  metadata.gz: 1c7677889e31eccaadb3cf019f168e2d7133f10682379d0c2ccf1987da450105
+  data.tar.gz: 66ea1098cfbfdc9e5261dba0d6d033e44c8d84ee7623c464fc3bccd3999e708e
 SHA512:
-  metadata.gz: ac4012191c2878256abdc446eabc4cd4cf4ff822e426fc7a89e25c77ab2724c5b1d2e508fb88092ddde86680512797c50711d4188798a281cf275b3e03304a0e
-  data.tar.gz: 7a1558eed571862501a3e5a264cfa006014e9454c0f31cb915c9d5229aed6a9c47f539287cb447a226db4302b60d761496256791d9844cc8291164910ec8d6f5
+  metadata.gz: b7ccd9a1e2950d57f51dad86c847373c29caf753b092711cc9be167a8574cdaaec7eeff99dfe08fc3c0e29c4af1a7a21b04e92f36fcc6769b9e3b8f1561c6231
+  data.tar.gz: 7fc85d30cab6c80e8e64afa3285a50dfafb47f66dc214d228c758b7e19481239cf5900fad3bbbd29c3220658529eeeb106f12daf9e10f52a10f4d1bb10864354

data/CHANGELOG.md

@@ -1,8 +1,8 @@
 # Changelog
 
-## Latest RC [v0.12.rc10](https://github.com/keypup-io/cloudtasker/tree/v0.12.rc10) (2021-05-31)
+## Latest RC [v0.12.rc11](https://github.com/keypup-io/cloudtasker/tree/v0.12.rc11) (2021-06-26)
 
-[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.11.0...v0.12.rc10)
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.11.0...v0.12.rc11)
 
 **Improvements:**
 - ActiveJob: do not double log errors (ActiveJob has its own error logging)
@@ -12,6 +12,7 @@
 - Batch redis usage: cleanup batches as they get completed or become dead to avoid excessive redis usage with large batches.
 - Batch expansion: Inject `parent_batch` in jobs. Can be used to expand the parent batch the job is in.
 - Configuration: allow configuration of Cloud Tasks `dispatch deadline` at global and worker level
+- Configuration: allow specifying global `on_error` and `on_dead` callbacks for error reporting
 - Cron jobs: Use Redis Sets instead of key pattern matching for resource listing
 - Error logging: Use worker logger so as to include context (job args etc.)
 - Error logging: Do not log exception and stack trace separately, combine them instead.

data/README.md

@@ -35,9 +35,10 @@ A local processing server is also available for development. This local server p
     2. [Logging context](#logging-context)
 9. [Error Handling](#error-handling)
     1. [HTTP Error codes](#http-error-codes)
-    2. [Error callbacks](#error-callbacks)
-    3. [Max retries](#max-retries)
-    4. [Dispatch deadline](#dispatch-deadline)
+    2. [Worker callbacks](#worker-callbacks)
+    3. [Global callbacks](#global-callbacks)
+    4. [Max retries](#max-retries)
+    5. [Dispatch deadline](#dispatch-deadline)
 10. [Testing](#testing)
     1. [Test helper setup](#test-helper-setup)
     2. [In-memory queues](#in-memory-queues)
@@ -369,6 +370,36 @@ Cloudtasker.configure do |config|
   # Default: 600 seconds (10 minutes)
   #
   # config.dispatch_deadline = 600
+
+  #
+  # Specify a proc to be invoked every time a job fails due to a runtime
+  # error.
+  #
+  # This hook is not invoked for DeadWorkerError. See on_dead instead.
+  #
+  # This is useful when you need to apply general exception handling, such
+  # as reporting errors to a third-party service like Rollbar or Bugsnag.
+  #
+  # Note: the worker argument might be nil, such as when InvalidWorkerError is raised.
+  #
+  # Supported since: v0.12.rc11
+  # 
+  # Default: no operation
+  #
+  # config.on_error = ->(error, worker) { Rollbar.error(error) }
+
+  #
+  # Specify a proc to be invoked every time a job dies due to too many
+  # retries.
+  #
+  # This is useful when you need to apply general exception handling, such
+  # logging specific messages/context when a job dies.
+  #
+  # Supported since: v0.12.rc11
+  # 
+  # Default: no operation
+  #
+  # config.on_dead = ->(error, worker) { Rollbar.error(error) }
 end
 ```
 
@@ -649,7 +680,7 @@ Jobs failing will automatically return the following HTTP error code to Cloud Ta
 | 404 | The job has specified an incorrect worker class.  |
 | 422 | An error happened during the execution of the worker (`perform` method) |
 
-### Error callbacks
+### Worker callbacks
 
 Workers can implement the `on_error(error)` and `on_dead(error)` callbacks to do things when a job fails during its execution:
 
@@ -677,6 +708,25 @@ class HandleErrorWorker
 end
 ```
 
+### Global callbacks
+**Supported since**: `0.12.rc11`  
+
+If you need to apply general exception handling logic to your workers you can specify `on_error` and `on_dead` hooks in the Cloudtasker configuration.
+
+This is useful if you need to report errors to third-party services such as Rollbar or Bugsnag.
+
+```ruby
+# config/initializers/cloudtasker.rb
+
+Cloudtasker.configure do |config|
+  #
+  # Report runtime and dead worker errors to Rollbar
+  #
+  config.on_error = -> (error, _worker) { Rollbar.error(error) }
+  config.on_dead = -> (error, _worker) { Rollbar.error(error) }
+end
+```
+
 ### Max retries
 
 By default jobs are retried 25 times - using an exponential backoff - before being declared dead. This number of retries can be customized locally on workers and/or globally via the Cloudtasker initializer.

data/lib/cloudtasker/config.rb

@@ -7,7 +7,8 @@ module Cloudtasker
   class Config
     attr_accessor :redis, :store_payloads_in_redis
     attr_writer :secret, :gcp_location_id, :gcp_project_id,
-                :gcp_queue_prefix, :processor_path, :logger, :mode, :max_retries, :dispatch_deadline
+                :gcp_queue_prefix, :processor_path, :logger, :mode, :max_retries,
+                :dispatch_deadline, :on_error, :on_dead
 
     # Max Cloud Task size in bytes
     MAX_TASK_SIZE = 100 * 1024 # 100 KB
@@ -51,6 +52,9 @@ module Cloudtasker
     MIN_DISPATCH_DEADLINE = 15 # seconds
     MAX_DISPATCH_DEADLINE = 30 * 60 # 30 minutes
 
+    # Default on_error Proc
+    DEFAULT_ON_ERROR = ->(error, worker) {}
+
     # The number of times jobs will be attempted before declaring them dead.
     #
     # With the default retry configuration (maxDoublings = 16 and minBackoff = 0.100s)
@@ -229,11 +233,31 @@ module Cloudtasker
     # @return [String] The cloudtasker secret
     #
     def secret
-      @secret || (
+      @secret ||= (
         defined?(Rails) && Rails.application.credentials&.dig(:secret_key_base)
       ) || raise(StandardError, SECRET_MISSING_ERROR)
     end
 
+    #
+    # Return a Proc invoked whenever a worker runtime error is raised.
+    # See Cloudtasker::WorkerHandler.with_worker_handling
+    #
+    # @return [Proc] A Proc handler
+    #
+    def on_error
+      @on_error || DEFAULT_ON_ERROR
+    end
+
+    #
+    # Return a Proc invoked whenever a worker DeadWorkerError is raised.
+    # See Cloudtasker::WorkerHandler.with_worker_handling
+    #
+    # @return [Proc] A Proc handler
+    #
+    def on_dead
+      @on_dead || DEFAULT_ON_ERROR
+    end
+
     #
     # Return the chain of client middlewares.
     #

data/lib/cloudtasker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cloudtasker
-  VERSION = '0.12.rc10'
+  VERSION = '0.12.rc11'
 end

data/lib/cloudtasker/worker_handler.rb

@@ -102,9 +102,11 @@ module Cloudtasker
       # Delete stored args payload if job is dead
       redis.del(args_payload_key) if args_payload_key
       log_execution_error(worker, e)
+      Cloudtasker.config.on_dead.call(e, worker)
       raise(e)
     rescue StandardError => e
       log_execution_error(worker, e)
+      Cloudtasker.config.on_error.call(e, worker)
       raise(e)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudtasker
 version: !ruby/object:Gem::Version
-  version: 0.12.rc10
+  version: 0.12.rc11
 platform: ruby
 authors:
 - Arnaud Lachaume
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-31 00:00:00.000000000 Z
+date: 2021-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -416,7 +416,7 @@ metadata:
   homepage_uri: https://github.com/keypup-io/cloudtasker
   source_code_uri: https://github.com/keypup-io/cloudtasker
   changelog_uri: https://github.com/keypup-io/cloudtasker/master/tree/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -432,7 +432,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubygems_version: 3.0.0
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Background jobs for Ruby using Google Cloud Tasks (beta)
 test_files: []