cloudtasker 0.3.0 → 0.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +33 -0
- data/Gemfile.lock +19 -2
- data/README.md +149 -14
- data/Rakefile +6 -0
- data/app/controllers/cloudtasker/worker_controller.rb +8 -6
- data/cloudtasker.gemspec +3 -2
- data/docs/BATCH_JOBS.md +27 -2
- data/docs/CRON_JOBS.md +20 -14
- data/exe/cloudtasker +13 -1
- data/lib/cloudtasker.rb +0 -1
- data/lib/cloudtasker/backend/google_cloud_task.rb +41 -8
- data/lib/cloudtasker/backend/memory_task.rb +5 -3
- data/lib/cloudtasker/backend/redis_task.rb +18 -9
- data/lib/cloudtasker/batch/batch_progress.rb +11 -2
- data/lib/cloudtasker/batch/job.rb +24 -9
- data/lib/cloudtasker/cli.rb +6 -5
- data/lib/cloudtasker/cloud_task.rb +4 -2
- data/lib/cloudtasker/config.rb +14 -8
- data/lib/cloudtasker/cron/job.rb +2 -2
- data/lib/cloudtasker/cron/schedule.rb +37 -21
- data/lib/cloudtasker/local_server.rb +44 -22
- data/lib/cloudtasker/redis_client.rb +7 -8
- data/lib/cloudtasker/unique_job/job.rb +2 -2
- data/lib/cloudtasker/version.rb +1 -1
- data/lib/cloudtasker/worker.rb +46 -10
- data/lib/cloudtasker/worker_handler.rb +5 -3
- data/lib/cloudtasker/worker_logger.rb +1 -1
- data/lib/cloudtasker/worker_wrapper.rb +52 -0
- data/lib/tasks/setup_queue.rake +12 -2
- metadata +20 -5
- data/lib/cloudtasker/railtie.rb +0 -10
@@ -5,7 +5,7 @@ require 'google/cloud/tasks'
|
|
5
5
|
module Cloudtasker
|
6
6
|
# Build, serialize and schedule tasks on the processing backend.
|
7
7
|
class WorkerHandler
|
8
|
-
attr_reader :worker
|
8
|
+
attr_reader :worker
|
9
9
|
|
10
10
|
# Alrogith used to sign the verification token
|
11
11
|
JWT_ALG = 'HS256'
|
@@ -46,7 +46,8 @@ module Cloudtasker
|
|
46
46
|
'Authorization' => "Bearer #{Authenticator.verification_token}"
|
47
47
|
},
|
48
48
|
body: worker_payload.to_json
|
49
|
-
}
|
49
|
+
},
|
50
|
+
queue: worker.job_queue
|
50
51
|
}
|
51
52
|
end
|
52
53
|
|
@@ -64,7 +65,8 @@ module Cloudtasker
|
|
64
65
|
#
|
65
66
|
def worker_payload
|
66
67
|
@worker_payload ||= {
|
67
|
-
worker: worker.
|
68
|
+
worker: worker.job_class_name,
|
69
|
+
job_queue: worker.job_queue,
|
68
70
|
job_id: worker.job_id,
|
69
71
|
job_args: worker.job_args,
|
70
72
|
job_meta: worker.job_meta.to_h
|
@@ -11,7 +11,7 @@ module Cloudtasker
|
|
11
11
|
end
|
12
12
|
|
13
13
|
# Only log the job meta information by default (exclude arguments)
|
14
|
-
DEFAULT_CONTEXT_PROCESSOR = ->(worker) { worker.to_h.slice(:worker, :job_id, :job_meta) }
|
14
|
+
DEFAULT_CONTEXT_PROCESSOR = ->(worker) { worker.to_h.slice(:worker, :job_id, :job_meta, :job_queue) }
|
15
15
|
|
16
16
|
#
|
17
17
|
# Build a new instance of the class.
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'cloudtasker/worker'
|
4
|
+
|
5
|
+
module Cloudtasker
|
6
|
+
# A worker class used to schedule jobs without actually
|
7
|
+
# instantiating the worker class. This is useful for middlewares
|
8
|
+
# needing to enqueue jobs in a Rails initializer. Rails 6 complains
|
9
|
+
# about instantiating workers in an iniitializer because of autoloading
|
10
|
+
# in zeitwerk mode.
|
11
|
+
#
|
12
|
+
# Downside of this wrapper: any cloudtasker_options specified on on the
|
13
|
+
# worker_class will be ignored.
|
14
|
+
#
|
15
|
+
# See: https://github.com/rails/rails/issues/36363
|
16
|
+
#
|
17
|
+
class WorkerWrapper
|
18
|
+
include Worker
|
19
|
+
|
20
|
+
attr_accessor :worker_name
|
21
|
+
|
22
|
+
#
|
23
|
+
# Build a new instance of the class.
|
24
|
+
#
|
25
|
+
# @param [String] worker_class The name of the worker class.
|
26
|
+
# @param [Hash] **opts The worker arguments.
|
27
|
+
#
|
28
|
+
def initialize(worker_name:, **opts)
|
29
|
+
@worker_name = worker_name
|
30
|
+
super(opts)
|
31
|
+
end
|
32
|
+
|
33
|
+
#
|
34
|
+
# Override parent. Return the underlying worker class name.
|
35
|
+
#
|
36
|
+
# @return [String] The worker class.
|
37
|
+
#
|
38
|
+
def job_class_name
|
39
|
+
worker_name
|
40
|
+
end
|
41
|
+
|
42
|
+
#
|
43
|
+
# Return a new instance of the worker with the same args and metadata
|
44
|
+
# but with a different id.
|
45
|
+
#
|
46
|
+
# @return [Cloudtasker::WorkerWrapper] <description>
|
47
|
+
#
|
48
|
+
def new_instance
|
49
|
+
self.class.new(worker_name: worker_name, job_queue: job_queue, job_args: job_args, job_meta: job_meta)
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
data/lib/tasks/setup_queue.rake
CHANGED
@@ -1,10 +1,20 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
3
|
require 'cloudtasker/backend/google_cloud_task'
|
4
|
+
require 'cloudtasker/config'
|
5
|
+
|
6
|
+
ENV['GOOGLE_AUTH_SUPPRESS_CREDENTIALS_WARNINGS'] ||= 'true'
|
4
7
|
|
5
8
|
namespace :cloudtasker do
|
6
|
-
desc 'Setup
|
9
|
+
desc 'Setup a Cloud Task queue. (default options: ' \
|
10
|
+
"name=#{Cloudtasker::Config::DEFAULT_JOB_QUEUE}, " \
|
11
|
+
"concurrency=#{Cloudtasker::Config::DEFAULT_QUEUE_CONCURRENCY}, " \
|
12
|
+
"retries=#{Cloudtasker::Config::DEFAULT_QUEUE_RETRIES})"
|
7
13
|
task setup_queue: :environment do
|
8
|
-
Cloudtasker::Backend::GoogleCloudTask.setup_queue
|
14
|
+
puts Cloudtasker::Backend::GoogleCloudTask.setup_queue(
|
15
|
+
name: ENV['name'],
|
16
|
+
concurrency: ENV['concurrency'],
|
17
|
+
retries: ENV['retries']
|
18
|
+
)
|
9
19
|
end
|
10
20
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: cloudtasker
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.8.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Arnaud Lachaume
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-11-
|
11
|
+
date: 2019-11-27 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: activesupport
|
@@ -108,6 +108,20 @@ dependencies:
|
|
108
108
|
- - "~>"
|
109
109
|
- !ruby/object:Gem::Version
|
110
110
|
version: '2.0'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: github_changelog_generator
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - ">="
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - ">="
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0'
|
111
125
|
- !ruby/object:Gem::Dependency
|
112
126
|
name: rake
|
113
127
|
requirement: !ruby/object:Gem::Requirement
|
@@ -234,7 +248,7 @@ dependencies:
|
|
234
248
|
- - ">="
|
235
249
|
- !ruby/object:Gem::Version
|
236
250
|
version: '0'
|
237
|
-
description:
|
251
|
+
description: Background jobs for Ruby using Google Cloud Tasks (beta)
|
238
252
|
email:
|
239
253
|
- arnaud.lachaume@keypup.io
|
240
254
|
executables:
|
@@ -247,6 +261,7 @@ files:
|
|
247
261
|
- ".rubocop.yml"
|
248
262
|
- ".travis.yml"
|
249
263
|
- Appraisals
|
264
|
+
- CHANGELOG.md
|
250
265
|
- CODE_OF_CONDUCT.md
|
251
266
|
- Gemfile
|
252
267
|
- Gemfile.lock
|
@@ -307,7 +322,6 @@ files:
|
|
307
322
|
- lib/cloudtasker/local_server.rb
|
308
323
|
- lib/cloudtasker/meta_store.rb
|
309
324
|
- lib/cloudtasker/middleware/chain.rb
|
310
|
-
- lib/cloudtasker/railtie.rb
|
311
325
|
- lib/cloudtasker/redis_client.rb
|
312
326
|
- lib/cloudtasker/testing.rb
|
313
327
|
- lib/cloudtasker/unique_job.rb
|
@@ -329,6 +343,7 @@ files:
|
|
329
343
|
- lib/cloudtasker/worker.rb
|
330
344
|
- lib/cloudtasker/worker_handler.rb
|
331
345
|
- lib/cloudtasker/worker_logger.rb
|
346
|
+
- lib/cloudtasker/worker_wrapper.rb
|
332
347
|
- lib/tasks/setup_queue.rake
|
333
348
|
homepage: https://github.com/keypup-io/cloudtasker
|
334
349
|
licenses:
|
@@ -356,5 +371,5 @@ rubyforge_project:
|
|
356
371
|
rubygems_version: 2.7.9
|
357
372
|
signing_key:
|
358
373
|
specification_version: 4
|
359
|
-
summary:
|
374
|
+
summary: Background jobs for Ruby using Google Cloud Tasks (beta)
|
360
375
|
test_files: []
|