cloudtasker 0.12.rc10 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5763bef46a0c554549150326375c3fb49c9eb77193b6862334dc1da72a5fe34f
-  data.tar.gz: 211272f9129642cb8c7260f639a6a76714161ac37c87dc5f073633a072781b44
+  metadata.gz: 2d051d238265fe5c1b1e48203c121e7284a26340026ff481e4c6240703de073b
+  data.tar.gz: bb785d5f8f7834bb1ef885c9bb939a43925e933c34abcf94a9609b292813b03d
 SHA512:
-  metadata.gz: ac4012191c2878256abdc446eabc4cd4cf4ff822e426fc7a89e25c77ab2724c5b1d2e508fb88092ddde86680512797c50711d4188798a281cf275b3e03304a0e
-  data.tar.gz: 7a1558eed571862501a3e5a264cfa006014e9454c0f31cb915c9d5229aed6a9c47f539287cb447a226db4302b60d761496256791d9844cc8291164910ec8d6f5
+  metadata.gz: 81926768a084ba79aff1ae466f7dc2a11ac883c0b57f6fd41787dbedf3434d0979762158728c4548217bd06b0df2692e8bffe8cbd3d02bda447336610d4de2c0
+  data.tar.gz: 1ce88e8633716f8ea379affd0ef7c705ec7fc48ebdd100c0e6f525fd0e5ca61ac4f3349dde3c53ee7815e23761dbd8cfa9e1d6d2f0b1e80f9892d1b92065c61b

data/.github/workflows/test.yml

@@ -1,10 +1,6 @@
 name: Test
 
-on:
-  push:
-    branches: [ master, 0.9-stable ]
-  pull_request:
-    branches: [ master, 0.9-stable ]
+on: [push, pull_request]
 
 jobs:
   build:

data/CHANGELOG.md

@@ -1,8 +1,48 @@
 # Changelog
 
-## Latest RC [v0.12.rc10](https://github.com/keypup-io/cloudtasker/tree/v0.12.rc10) (2021-05-31)
+## [v0.12.2](https://github.com/keypup-io/cloudtasker/tree/v0.12.2) (2021-12-31)
 
-[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.12.1...v0.12.2)
+
+**Fixed bugs:**
+- Local server: Fix race condition on thread processing. See [#46](https://github.com/keypup-io/cloudtasker/pull/46)
+- Non-Rails: Fix `arguments_missing?` check for non-rails projects.
+
+## [v0.12.1](https://github.com/keypup-io/cloudtasker/tree/v0.12.1) (2021-08-25)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.12.0...v0.12.1)
+
+**Fixed bugs:**
+- Dependencies: Require `try` from `activesupport`. This was preventing non-Rails projects from properly running Cloudtasker jobs.
+- WorkerController: remove useless inheritance from local ApplicationController. The parent controller was not always loaded on Rails 5 which in turn created issues with authenticity token. Fixes [#40](https://github.com/keypup-io/cloudtasker/issues/40)
+
+## [v0.11.1](https://github.com/keypup-io/cloudtasker/tree/v0.11.1) (2021-08-25)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.11.0...v0.11.1)
+
+**Fixed bugs:**
+- Dependencies: Require `try` from `activesupport`. This was preventing non-Rails projects from properly running Cloudtasker jobs.
+- WorkerController: remove useless inheritance from local ApplicationController. The parent controller was not always loaded on Rails 5 which in turn created issues with authenticity token. Fixes [#40](https://github.com/keypup-io/cloudtasker/issues/40)
+
+## [v0.10.2](https://github.com/keypup-io/cloudtasker/tree/v0.10.2) (2021-08-25)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.10.1...v0.10.2)
+
+**Fixed bugs:**
+- Dependencies: Require `try` from `activesupport`. This was preventing non-Rails projects from properly running Cloudtasker jobs.
+- WorkerController: remove useless inheritance from local ApplicationController. The parent controller was not always loaded on Rails 5 which in turn created issues with authenticity token. Fixes [#40](https://github.com/keypup-io/cloudtasker/issues/40)
+
+## [v0.9.5](https://github.com/keypup-io/cloudtasker/tree/v0.9.5) (2021-08-25)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.9.4...v0.9.5)
+
+**Fixed bugs:**
+- Dependencies: Require `try` from `activesupport`. This was preventing non-Rails projects from properly running Cloudtasker jobs.
+- WorkerController: remove useless inheritance from local ApplicationController. The parent controller was not always loaded on Rails 5 which in turn created issues with authenticity token. Fixes [#40](https://github.com/keypup-io/cloudtasker/issues/40)
+
+## [v0.12.0](https://github.com/keypup-io/cloudtasker/tree/v0.12.0) (2021-08-19)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.11.0...v0.12.0)
 
 **Improvements:**
 - ActiveJob: do not double log errors (ActiveJob has its own error logging)
@@ -12,6 +52,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.
@@ -24,7 +65,7 @@
 **Fixed bugs:**
 - Retries: Enforce job retry limit on job processing. There was an edge case where jobs could be retried indefinitely on batch callback errors.
 
-## [v0.11.0](https://github.com/keypup-io/cloudtasker/tree/v0.11.0) (2021-03-11)
+## [v0.11.0](https://github.com/keypup-io/cloudtasker/tree/v0.11.0) (2020-11-23)
 
 [Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.10.0...v0.11.0)
 

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)
@@ -364,11 +365,41 @@ Cloudtasker.configure do |config|
   # This option can also be configured on a per worker basis via
   # the cloudtasker_options directive.
   #
-  # Supported since: v0.12.rc8
+  # Supported since: v0.12.0
   #
   # 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.0
+  # 
+  # 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.0
+  # 
+  # 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.0`  
+
+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.
@@ -740,7 +790,7 @@ end
 ```
 
 ### Dispatch deadline
-**Supported since**: `0.12.rc8`  
+**Supported since**: `0.12.0`  
 
 By default Cloud Tasks will automatically timeout your jobs after 10 minutes, independently of your server HTTP timeout configuration.
 

data/app/controllers/cloudtasker/worker_controller.rb

@@ -2,7 +2,10 @@
 
 module Cloudtasker
   # Handle execution of workers
-  class WorkerController < ApplicationController
+  class WorkerController < ActionController::Base
+    # No need for CSRF verification on API endpoints
+    skip_before_action :verify_authenticity_token
+
     # Authenticate all requests.
     before_action :authenticate!
 

data/docs/BATCH_JOBS.md

@@ -48,7 +48,7 @@ end
 ```
 
 ## Example: Expanding the parent batch
-**Note**: `parent_batch` is available since `0.12.rc10`
+**Note**: `parent_batch` is available since `0.12.0`
 
 ```ruby
 # All the jobs will be attached to the top parent batch.
@@ -123,7 +123,7 @@ def on_batch_node_complete(_child_job)
 end
 ```
 
-**Since:** `v0.12.rc5`  
+**Since:** `v0.12.0`  
 By default the `progress` method only considers the direct child jobs to evaluate the batch progress. You can pass `depth: somenumber` to the `progress` method to calculate the actual batch progress in a more granular way. Be careful however that this method recursively calculates progress on the sub-batches and is therefore expensive.
 
 E.g.

data/docs/CRON_JOBS.md

@@ -65,3 +65,42 @@ if File.exist?(schedule_file) && !Rails.env.test?
 end
 ```
 
+## Limitations
+GCP Cloud Tasks does not allow tasks to be scheduled more than 30 days (720h) in the future. Cron schedules should therefore be limited to 30 days intervals at most.
+
+If you need to schedule a job to run on a monthly basis (e.g. on the first of the month), schedule this job to run every day then add the following logic in your job:
+```ruby
+#
+# Cron schedule (8am UTC every day): 0 8 * * *
+#
+class MyMonthlyWorker
+  include Cloudtasker::Worker
+
+  def perform(*args)
+    # Abort unless we're the first of the month
+    return unless Time.current.day == 1
+
+    # ... job logic
+  end
+end
+```
+
+The same approach can be used to schedule a job every quarter.
+```ruby
+#
+# Cron schedule (8am UTC every day): 0 8 * * *
+#
+class MyQuarterlyWorker
+  include Cloudtasker::Worker
+
+  def perform(*args)
+    # Abort unless we're the first month of a quarter (Jan, Apr, Jul, Oct)
+    return unless Time.current.month == 1
+    
+    # Abort unless we're the first of the month
+    return unless Time.current.day == 1
+
+    # ... job logic
+  end
+end
+```