cloudtasker 0.3.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bfe3a94e07d56d772542ad9077272c8d04438f78f9640a1345a78c47e7dd6f9
-  data.tar.gz: c0af1564db1aab1f3a4b5927677dcb9a372010e3ea7903ca4d3d03f49efbbeb4
+  metadata.gz: e2a110c5354118a009e8620c887eb0c8bb9ff5c7aa63fefcf242ac9a649bd0e1
+  data.tar.gz: 58772d851865727f326bc30dfa3b94f170fe602eff264ce8661f2abd175033e9
 SHA512:
-  metadata.gz: 20e8f8b0a9330f439614bb6dca9437d297a068af5c576627646dc9a3583664b96a9589f3ea755d6c91d581c7fa5889baca560ca52cb5f3970980475e34f9ce11
-  data.tar.gz: 4c8f074f7f9c53ea4144d07a8c38fb107703c602e0b295a2f53c5d0443fb98f688580c1b31c2af7f505e41a39eed8a76105bce820b7a1a8f20454bafa0a1e497
+  metadata.gz: af8b0e59a08d7e65bcc46f03135c17932b69816c2282bc651b1ae60887bde3ea0e52af051accb5606f1c2d042dd15dc224313a6aa7b8e6222aeef01806147464
+  data.tar.gz: 8b9d7e921aca496913a36357a43e8e3c0f77e059ac31439b3ccbe749afde946117a9faca70de11ee50ed6a9ff97b3439889b90bdb30db534ba4ac7690a0e3bfb

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+## [v0.7.0](https://github.com/keypup-io/cloudtasker/tree/v0.7.0) (2019-11-25)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.6.0...v0.7.0)
+
+## [v0.6.0](https://github.com/keypup-io/cloudtasker/tree/v0.6.0) (2019-11-25)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.5.0...v0.6.0)
+
+## [v0.5.0](https://github.com/keypup-io/cloudtasker/tree/v0.5.0) (2019-11-25)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.4.0...v0.5.0)
+
+## [v0.4.0](https://github.com/keypup-io/cloudtasker/tree/v0.4.0) (2019-11-25)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.3.0...v0.4.0)
+
+## [v0.3.0](https://github.com/keypup-io/cloudtasker/tree/v0.3.0) (2019-11-25)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.2.0...v0.3.0)
+
+## [v0.2.0](https://github.com/keypup-io/cloudtasker/tree/v0.2.0) (2019-11-18)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.1.0...v0.2.0)
+
+## [v0.1.0](https://github.com/keypup-io/cloudtasker/tree/v0.1.0) (2019-11-17)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/c137feb1ceaaaa4e2fecac0d1f0b4c73151ae002...v0.1.0)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cloudtasker (0.3.0)
+    cloudtasker (0.8.0)
       activesupport
       fugit
       google-cloud-tasks
@@ -84,9 +84,19 @@ GEM
       tzinfo
     faraday (0.17.0)
       multipart-post (>= 1.2, < 3)
+    faraday-http-cache (2.0.0)
+      faraday (~> 0.8)
     fugit (1.3.3)
       et-orbi (~> 1.1, >= 1.1.8)
       raabro (~> 1.1)
+    github_changelog_generator (1.15.0)
+      activesupport
+      faraday-http-cache
+      multi_json
+      octokit (~> 4.6)
+      rainbow (>= 2.2.1)
+      rake (>= 10.0)
+      retriable (~> 3.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     google-cloud-tasks (1.3.1)
@@ -100,7 +110,7 @@ GEM
       googleauth (~> 0.9)
       grpc (~> 1.24)
       rly (~> 0.2.3)
-    google-protobuf (3.10.1-universal-darwin)
+    google-protobuf (3.11.0-universal-darwin)
     googleapis-common-protos (1.3.9)
       google-protobuf (~> 3.0)
       googleapis-common-protos-types (~> 1.0)
@@ -143,6 +153,8 @@ GEM
     nio4r (2.5.2)
     nokogiri (1.10.5)
       mini_portile2 (~> 2.4.0)
+    octokit (4.14.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
     os (1.0.1)
     parallel (1.18.0)
     parser (2.6.5.0)
@@ -181,6 +193,7 @@ GEM
     rainbow (3.0.0)
     rake (10.5.0)
     redis (4.1.3)
+    retriable (3.1.2)
     rly (0.2.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -214,6 +227,9 @@ GEM
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
     signet (0.12.0)
       addressable (~> 2.3)
       faraday (~> 0.9)
@@ -249,6 +265,7 @@ DEPENDENCIES
   appraisal
   bundler (~> 2.0)
   cloudtasker!
+  github_changelog_generator
   rails
   rake (~> 10.0)
   rspec (~> 3.0)

data/README.md

@@ -10,6 +10,30 @@ Cloudtasker also provides optional modules for running [cron jobs](docs/CRON_JOB
 
 A local processing server is also available in development. This local server processes jobs in lieu of Cloud Tasks and allow you to work offline.
 
+## Summary
+
+1. [Installation](#installation)
+2. [Get started with Rails](#get-started-with-rails)
+3. [Configuring Cloudtasker](#configuring-cloudtasker)
+    1. [Cloud Tasks authentication & permissions](#cloud-tasks-authentication--permissions)
+    2. [Cloudtasker initializer](#cloudtasker-initializer)
+4. [Enqueuing jobs](#enqueuing-jobs)
+5. [Managing worker queues](#managing-worker-queues)
+    1. [Creating queues](#creating-queues)
+    2. [Assigning queues to workers](#assigning-queues-to-workers)
+6. [Extensions](#extensions)
+7. [Working locally](#working-locally)
+    1. [Option 1: Cloudtasker local server](#option-1-cloudtasker-local-server)
+    2. [Option 2: Using ngrok](#option-2-using-ngrok)
+8. [Logging](#logging)
+    1. [Configuring a logger](#configuring-a-logger)
+    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)
+10. [Best practices building workers](#best-practices-building-workers)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -77,7 +101,7 @@ Launch Rails and the local Cloudtasker processing server (or add `cloudtasker` t
 > cloudtasker
 ```
 
-Open a Rails console and enqueue your job
+Open a Rails console and enqueue some jobs
 ```ruby
   # Process job as soon as possible
   DummyWorker.perform_async('foo')
@@ -136,13 +160,31 @@ Cloudtasker.configure do |config|
   # config.secret = 'some-long-token'
 
   # 
-  # Specify the details of your Google Cloud Task queue.
+  # Specify the details of your Google Cloud Task location.
   #
   # This not required in development using the Cloudtasker local server.
   #
   config.gcp_location_id = 'us-central1' # defaults to 'us-east1'
   config.gcp_project_id = 'my-gcp-project'
-  config.gcp_queue_id = 'my-queue'
+
+  #
+  # Specify the namespace for your Cloud Task queues.
+  #
+  # The gem assumes that a least a default queue named 'my-app-default'
+  # exists in Cloud Tasks. You can create this default queue using the
+  # gcloud SDK or via the `rake cloudtasker:setup_queue` task if you use Rails.
+  #
+  # Workers can be scheduled on different queues. The name of the queue
+  # in Cloud Tasks is always assumed to be prefixed with the prefix below.
+  #
+  # E.g.
+  # Setting `cloudtasker_options queue: 'critical'` on a worker means that
+  # the worker will be pushed to 'my-app-critical' in Cloud Tasks.
+  #
+  # Specific queues can be created in Cloud Tasks using the gcloud SDK or
+  # via the `rake cloudtasker:setup_queue name=<queue_name>` task.
+  # 
+  config.gcp_queue_prefix = 'my-app'
 
   # 
   # Specify the publicly accessible host for your application
@@ -194,7 +236,7 @@ Cloudtasker.configure do |config|
 end
 ```
 
-If your queue does not exist in Cloud Tasks you should [create it using the gcloud sdk](https://cloud.google.com/tasks/docs/creating-queues). 
+If the default queue `<gcp_queue_prefix>-default` does not exist in Cloud Tasks you should [create it using the gcloud sdk](https://cloud.google.com/tasks/docs/creating-queues). 
 
 Alternatively with Rails you can simply run the following rake task if you have queue admin permissions (`cloudtasks.queues.get` and `cloudtasks.queues.create`).
 ```bash
@@ -214,10 +256,15 @@ MyWorker.perform_in(5 * 60, arg1, arg2)
 # or with Rails
 MyWorker.perform_in(5.minutes, arg1, arg2)
 
-# Worker will be processed on specific date
+# Worker will be processed on a specific date
 MyWorker.perform_at(Time.parse('2025-01-01 00:50:00Z'), arg1, arg2)
 # also with Rails
 MyWorker.perform_at(3.days.from_now, arg1, arg2)
+
+# With all options, including which queue to run the worker on.
+MyWorker.schedule(args: [arg1, arg2], time_at: Time.parse('2025-01-01 00:50:00Z'), queue: 'critical')
+# or
+MyWorker.schedule(args: [arg1, arg2], time_in: 5 * 60, queue: 'critical')
 ```
 
 Cloudtasker also provides a helper for re-enqueuing jobs. Re-enqueued jobs keep the same worker id. Some middlewares may rely on this to track the fact that that a job didn't actually complete (e.g. Cloustasker batch). This is optional and you can always fallback to using exception management (raise an error) to retry/re-enqueue jobs.
@@ -241,6 +288,52 @@ class FetchResourceWorker
 end
 ```
 
+## Managing worker queues
+
+Cloudtasker allows you to manage several queues and distribute workers across them based on job priority. By default jobs are pushed to the `default` queue, which is `<gcp_queue_prefix>-default` in Cloud Tasks.
+
+### Creating queues
+
+More queues can be created using the gcloud sdk or the `cloudtasker:setup_queue` rake task.
+
+E.g. Create a `critical` queue with a concurrency of 5 via the gcloud SDK
+```bash
+gcloud tasks queues create <gcp_queue_prefix>-critical --max-concurrent-dispatches=5
+```
+
+E.g. Create a `real-time` queue with a concurrency of 15 via the rake task (Rails only)
+```bash
+rake cloudtasker:setup_queue name=real-time concurrency=15
+```
+
+When running the Cloudtasker local processing server, you can specify the concurrency for each queue using:
+```bash
+cloudtasker -q critical,5 -q important,4 -q default,3
+```
+
+### Assigning queues to workers
+
+Queues can be assigned to workers via the `cloudtasker_options` directive on the worker class:
+
+```ruby
+# app/workers/critical_worker.rb
+
+class CriticalWorker
+  include Cloudtasker::Worker
+
+  cloudtasker_options queue: :critical
+
+  def perform(some_arg)
+    logger.info("This is a critical job run with arg=#{some_arg}.")
+  end
+end
+```
+
+Queues can also be assigned at runtime when scheduling a job:
+```ruby
+CriticalWorker.schedule(args: [1], queue: :important)
+```
+
 ## Extensions
 Cloudtasker comes with three optional features:
 - Cron Jobs [[docs](docs/CRON_JOBS.md)]: Run jobs at fixed intervals.
@@ -272,8 +365,6 @@ end
 
 The Cloudtasker server can then be started using:
 ```bash
-cloudtasker
-# or
 bundle exec cloudtasker
 ```
 
@@ -284,13 +375,18 @@ web: rails s
 worker: cloudtasker
 ```
 
+Note that the local development server runs with `5` concurrent threads by default. You can tune the number of threads per queue by running `cloudtasker` the following options:
+```bash
+cloudtasker -q critical,5 -q important,4 -q default,3
+```
+
 ### Option 2: Using ngrok
 
 Want to test your application end to end with Google Cloud Task? Then [ngrok](https://ngrok.io) is the way to go.
 
 First start your ngrok tunnel and take note of the :
 ```bash
-ngrok tls 3000
+ngrok http 3000
 ```
 
 Take note of your ngrok domain and configure Cloudtasker to use Google Cloud Task in development via ngrok.
@@ -299,9 +395,9 @@ Take note of your ngrok domain and configure Cloudtasker to use Google Cloud Tas
 
 Cloudtasker.configure do |config|
   # Specify your Google Cloud Task queue configuration
-  # config.gcp_location_id = 'us-central1'
-  # config.gcp_project_id = 'my-gcp-project'
-  # config.gcp_queue_id = 'my-queue'
+  config.gcp_location_id = 'us-central1'
+  config.gcp_project_id = 'my-gcp-project'
+  config.gcp_queue_prefix = 'my-app'
 
   # Use your ngrok domain as the processor host
   config.processor_host = 'https://your-tunnel-id.ngrok.io'
@@ -394,7 +490,7 @@ Jobs failing will automatically return an HTTP error to Cloud Task and trigger a
 Jobs failing will automatically return the following HTTP error code to Cloud Tasks, based on the actual reason:
 
 | Code | Description |
-|------|-------------|-----------|
+|------|-------------|
 | 205 | The job is dead and has been removed from the queue |
 | 404 | The job has specified an incorrect worker class.  |
 | 422 | An error happened during the execution of the worker (`perform` method) |
@@ -566,6 +662,45 @@ Rails.cache.write(payload_id, data)
 BigPayloadWorker.perform_async(payload_id)
 ```
 
+### Sizing the concurrency of your queues
+
+When defining the max concurrency concurrency of your queues (`max_concurrent_dispatches` in Cloud Tasks) you must keep in mind the maximum number of threads that your application provides. Otherwise your application threads may eventually get exhausted and your users will experience outages if all your web threads are busy running jobs.
+
+#### With server based applications
+
+Let's consider an application deployed in production with 3 instances, each having `RAILS_MAX_THREADS` set to `20`. This gives us a total of `60` threads available.
+
+Now let's say that we distribute jobs across two queues: `default` and `critical`. We can set the concurrency of each each queue depending on the profile of the application:
+
+E.g. 1: The application serves requests from web users and runs backgrounds jobs in a balanced way
+```
+concurrency for default queue: 20
+concurrency for critical queue: 10
+
+Total threads consumed by jobs at most: 30
+Total threads always available to web users at worst: 30
+```
+
+E.g. 2: The application is a micro-service API heavily focused on running jobs (e.g. data processing)
+```
+concurrency for default queue: 35
+concurrency for critical queue: 15
+
+Total threads consumed by jobs at most: 50
+Total threads always available to web users at worst: 10
+```
+
+Also always ensure that your total number of threads does not exceed the available number of database connections (if you use any).
+
+#### With serverless applications
+
+In a serverless context your application will be scaled up/down based on traffic. When we say 'traffic' this includes requests from Cloud Tasks to run jobs.
+
+Because your application is auto-scaled - and assuming you haven't set a maximum - your job processing capacity if theoretically unlimited. The main limiting factor in a serverless context becomes external constraints such as the number of database connections available.
+
+To size the concurrency of your queues you should therefore take the most limiting factor - which is often the database connection pool size for RDBMS databases - and use the calculations of the previous section with this limiting factor as the capping parameter instead of the threads.
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -574,7 +709,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/alachaum/cloudtasker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/keypup-io/cloudtasker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -582,7 +717,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Cloudtasker project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alachaum/cloudtasker/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Cloudtasker project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/keypup-io/cloudtasker/blob/master/CODE_OF_CONDUCT.md).
 
 ## Author
 

data/Rakefile

@@ -2,7 +2,13 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'github_changelog_generator/task'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = 'keypup-io'
+  config.project = 'cloudtasker'
+end

data/app/controllers/cloudtasker/worker_controller.rb

@@ -16,13 +16,15 @@ module Cloudtasker
     # Run a worker from a Cloud Task payload
     #
     def run
-      WorkerHandler.execute_from_payload!(
-        request.params.slice(:worker, :job_id, :job_args, :job_meta).merge(
-          job_retries: job_retries
-        )
-      )
+      # Build payload
+      payload = request.params
+                       .slice(:worker, :job_id, :job_args, :job_meta, :job_queue)
+                       .merge(job_retries: job_retries)
+
+      # Process payload
+      WorkerHandler.execute_from_payload!(payload)
       head :no_content
-    rescue Cloudtasker::DeadWorkerError
+    rescue DeadWorkerError
       # 205: job will NOT be retried
       head :reset_content
     rescue InvalidWorkerError

data/cloudtasker.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Arnaud Lachaume']
   spec.email         = ['arnaud.lachaume@keypup.io']
 
-  spec.summary       = 'Manage GCP Cloud Tasks in your app. (alpha)'
-  spec.description   = 'Manage GCP Cloud Tasks in your app. (alpha)'
+  spec.summary       = 'Background jobs for Ruby using Google Cloud Tasks (beta)'
+  spec.description   = 'Background jobs for Ruby using Google Cloud Tasks (beta)'
   spec.homepage      = 'https://github.com/keypup-io/cloudtasker'
   spec.license       = 'MIT'
 
@@ -38,6 +38,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'github_changelog_generator'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '0.76.0'

data/docs/BATCH_JOBS.md

@@ -9,7 +9,7 @@ The Cloudtasker batch job extension allows to add sub-jobs to regular jobs. This
 You can enable batch jobs by adding the following to your cloudtasker initializer:
 ```ruby
 # The batch job extension is optional and must be explicitly required
-require 'cloudtasker/batch_job'
+require 'cloudtasker/batch'
 
 Cloudtasker.configure do |config|
   # Specify your redis url.
@@ -59,8 +59,33 @@ The following callbacks are available on your workers to track the progress of t
 | `on_child_dead` | `The child job` | Invoked when a child has exhausted all of its retries |s
 | `on_batch_complete` | none | Invoked when all chidren have finished or died  |
 
+## Queue management
+
+Jobs added to a batch inherit the queue of the parent. It is possible to specify a different queue when adding a job to a batch using `add_to_queue` batch method.
+
+E.g.
+
+```ruby
+def perform
+  batch.add_to_queue(:critical, SubWorker, arg1, arg2, arg3)
+end
+```
+
 ## Batch completion
 
 Batches complete when all children have successfully completed or died (all retries exhausted).
 
-Jobs that fail in a batch will be retried based on the `max_retries` setting configured globally or on the worker itself. The batch will be considered `pending` while workers retry. Therefore it may be a good idea to reduce the number of retries on your workers using `cloudtasker_options max_retries: 5` to ensure your batches don't hang for too long.
+Jobs that fail in a batch will be retried based on the `max_retries` setting configured globally or on the worker itself. The batch will be considered `pending` while workers retry. Therefore it may be a good idea to reduce the number of retries on your workers using `cloudtasker_options max_retries: 5` to ensure your batches don't hang for too long.
+
+## Batch progress tracking
+
+You can access progression statistics in callback using `batch.progress`. See the [BatchProgress](../lib/cloudtasker/batch/batch_progress.rb) class for more details.
+
+E.g.
+```ruby
+def on_batch_node_complete(_child_job)
+  logger.info("Total: #{batch.progress.total}")
+  logger.info("Completed: #{batch.progress.completed}")
+  logger.info("Progress: #{batch.progress.percent.to_i}%")
+end
+```