cloudtasker 0.2.0 → 0.3.0

data/lib/cloudtasker/{task.rb → worker_handler.rb}

@@ -3,39 +3,13 @@
 require 'google/cloud/tasks'
 
 module Cloudtasker
-  # Build, serialize and schedule tasks on GCP Cloud Task
-  class Task
+  # Build, serialize and schedule tasks on the processing backend.
+  class WorkerHandler
     attr_reader :worker, :job_args
 
     # Alrogith used to sign the verification token
     JWT_ALG = 'HS256'
 
-    # TODO: Move to a dedicated CloudTask class
-    #
-    # Find a Cloud task
-    #
-    # @param [String] id The ID of the task.
-    #
-    # @return [Google::Cloud::Tasks::V2beta3::Task] The cloud task.
-    #
-    def self.find(id)
-      client.get_task(id)
-    rescue Google::Gax::RetryError
-      nil
-    end
-
-    # TODO: Move to a dedicated CloudTask class
-    #
-    # Delete a Cloud task
-    #
-    # @param [String] id The ID of the task.
-    #
-    def self.delete(id)
-      client.delete_task(id)
-    rescue Google::Gax::RetryError
-      nil
-    end
-
     #
     # Execute a task worker from a task payload
     #
@@ -48,15 +22,6 @@ module Cloudtasker
       worker.execute
     end
 
-    #
-    # Return the Google Cloud Task client.
-    #
-    # @return [Google::Cloud::Tasks] The Google Cloud Task client.
-    #
-    def self.client
-      @client ||= ::Google::Cloud::Tasks.new(version: :v2beta3)
-    end
-
     #
     # Prepare a new cloud task.
     #
@@ -66,37 +31,6 @@ module Cloudtasker
       @worker = worker
     end
 
-    #
-    # Return the Google Cloud Task client.
-    #
-    # @return [Google::Cloud::Tasks] The Google Cloud Task client.
-    #
-    def client
-      self.class.client
-    end
-
-    #
-    # Return the cloudtasker configuration. See Cloudtasker#configure.
-    #
-    # @return [Cloudtasker::Config] The library configuration.
-    #
-    def config
-      Cloudtasker.config
-    end
-
-    #
-    # Return the fully qualified path for the Cloud Task queue.
-    #
-    # @return [String] The queue path.
-    #
-    def queue_path
-      client.queue_path(
-        config.gcp_project_id,
-        config.gcp_location_id,
-        config.gcp_queue_id
-      )
-    end
-
     #
     # Return the full task configuration sent to Cloud Task
     #
@@ -106,7 +40,7 @@ module Cloudtasker
       {
         http_request: {
           http_method: 'POST',
-          url: config.processor_url,
+          url: Cloudtasker.config.processor_url,
           headers: {
             'Content-Type' => 'application/json',
             'Authorization' => "Bearer #{Authenticator.verification_token}"
@@ -133,7 +67,7 @@ module Cloudtasker
         worker: worker.class.to_s,
         job_id: worker.job_id,
         job_args: worker.job_args,
-        job_meta: worker.job_meta
+        job_meta: worker.job_meta.to_h
       }
     end
 
@@ -142,16 +76,15 @@ module Cloudtasker
     # before running a task.
     #
     # @param [Integer, nil] interval The time to wait.
+    # @param [Integer, nil] time_at The time at which the job should run.
     #
-    # @return [Google::Protobuf::Timestamp, nil] The protobuff timestamp
+    # @return [Integer, nil] The Unix timestamp.
     #
     def schedule_time(interval: nil, time_at: nil)
       return nil unless interval || time_at
 
-      # Generate protobuf timestamp
-      timestamp = Google::Protobuf::Timestamp.new
-      timestamp.seconds = (time_at || Time.now).to_i + interval.to_i
-      timestamp
+      # Generate the complete Unix timestamp
+      (time_at || Time.now).to_i + interval.to_i
     end
 
     #
@@ -160,7 +93,7 @@ module Cloudtasker
     # @param [Integer, nil] interval How to wait before running the task.
     #   Leave to `nil` to run now.
     #
-    # @return [Google::Cloud::Tasks::V2beta3::Task] The Google Task response
+    # @return [Cloudtasker::CloudTask] The Google Task response
     #
     def schedule(interval: nil, time_at: nil)
       # Generate task payload
@@ -169,7 +102,7 @@ module Cloudtasker
       ).compact
 
       # Create and return remote task
-      client.create_task(queue_path, task)
+      CloudTask.create(task)
     end
   end
 end

data/lib/cloudtasker/worker_logger.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Cloudtasker
+  # Add contextual information to logs generated
+  # by workers
+  class WorkerLogger
+    attr_accessor :worker
+
+    class << self
+      attr_accessor :log_context_processor
+    end
+
+    # Only log the job meta information by default (exclude arguments)
+    DEFAULT_CONTEXT_PROCESSOR = ->(worker) { worker.to_h.slice(:worker, :job_id, :job_meta) }
+
+    #
+    # Build a new instance of the class.
+    #
+    # @param [Cloudtasker::Worker] worker The worker.
+    #
+    def initialize(worker)
+      @worker = worker
+    end
+
+    #
+    # Return the Proc responsible for formatting the log payload.
+    #
+    # @return [Proc] The context processor.
+    #
+    def context_processor
+      @context_processor ||= worker.class.cloudtasker_options_hash[:log_context_processor] ||
+                             self.class.log_context_processor ||
+                             DEFAULT_CONTEXT_PROCESSOR
+    end
+
+    #
+    # The block to pass to log messages.
+    #
+    # @return [Proc] The log block.
+    #
+    def log_block
+      @log_block ||= proc { context_processor.call(worker) }
+    end
+
+    #
+    # Return the Cloudtasker logger.
+    #
+    # @return [Logger, any] The cloudtasker logger.
+    #
+    def logger
+      Cloudtasker.logger
+    end
+
+    #
+    # Format main log message.
+    #
+    # @param [String] msg The message to log.
+    #
+    # @return [String] The formatted log message
+    #
+    def formatted_message(msg)
+      "[Cloudtasker][#{worker.job_id}] #{msg}"
+    end
+
+    #
+    # Log an info message.
+    #
+    # @param [String] msg The message to log.
+    # @param [Proc] &block Optional context block.
+    #
+    def info(msg, &block)
+      log_message(:info, msg, &block)
+    end
+
+    #
+    # Log an error message.
+    #
+    # @param [String] msg The message to log.
+    # @param [Proc] &block Optional context block.
+    #
+    def error(msg, &block)
+      log_message(:error, msg, &block)
+    end
+
+    #
+    # Log an fatal message.
+    #
+    # @param [String] msg The message to log.
+    # @param [Proc] &block Optional context block.
+    #
+    def fatal(msg, &block)
+      log_message(:fatal, msg, &block)
+    end
+
+    #
+    # Log an debut message.
+    #
+    # @param [String] msg The message to log.
+    # @param [Proc] &block Optional context block.
+    #
+    def debug(msg, &block)
+      log_message(:debug, msg, &block)
+    end
+
+    #
+    # Delegate all methods to the underlying logger.
+    #
+    # @param [String, Symbol] name The method to delegate.
+    # @param [Array<any>] *args The list of method arguments.
+    # @param [Proc] &block Block passed to the method.
+    #
+    # @return [Any] The method return value
+    #
+    def method_missing(name, *args, &block)
+      if logger.respond_to?(name)
+        logger.send(name, *args, &block)
+      else
+        super
+      end
+    end
+
+    #
+    # Check if the class respond to a certain method.
+    #
+    # @param [String, Symbol] name The name of the method.
+    # @param [Boolean] include_private Whether to check private methods or not. Default to false.
+    #
+    # @return [Boolean] Return true if the class respond to this method.
+    #
+    def respond_to_missing?(name, include_private = false)
+      logger.respond_to?(name) || super
+    end
+
+    private
+
+    #
+    # Log a message for the provided log level.
+    #
+    # @param [String, Symbol] level The log level
+    # @param [String] msg The message to log.
+    # @param [Proc] &block Optional context block.
+    #
+    def log_message(level, msg, &block)
+      payload_block = block || log_block
+
+      # ActiveSupport::Logger does not support passing a payload through a block on top
+      # of a message.
+      if defined?(ActiveSupport::Logger) && logger.is_a?(ActiveSupport::Logger)
+        logger.send(level) { "#{formatted_message(msg)} -- #{payload_block.call}" }
+      else
+        logger.send(level, formatted_message(msg), &payload_block)
+      end
+    end
+  end
+end

data/lib/tasks/setup_queue.rake

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'cloudtasker/backend/google_cloud_task'
+
+namespace :cloudtasker do
+  desc 'Setup the Cloud Task queue'
+  task setup_queue: :environment do
+    Cloudtasker::Backend::GoogleCloudTask.setup_queue
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudtasker
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Arnaud Lachaume
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-18 00:00:00.000000000 Z
+date: 2019-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -220,10 +234,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Manage GCP Cloud Tasks in your app. (under development)
+description: Manage GCP Cloud Tasks in your app. (alpha)
 email:
 - arnaud.lachaume@keypup.io
-executables: []
+executables:
+- cloudtasker
 extensions: []
 extra_rdoc_files: []
 files:
@@ -231,6 +246,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- Appraisals
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -243,27 +259,57 @@ files:
 - bin/setup
 - cloudtasker.gemspec
 - config/routes.rb
+- docs/BATCH_JOBS.md
+- docs/CRON_JOBS.md
+- docs/UNIQUE_JOBS.md
+- exe/cloudtasker
+- gemfiles/.bundle/config
+- gemfiles/google_cloud_tasks_1.0.gemfile
+- gemfiles/google_cloud_tasks_1.0.gemfile.lock
+- gemfiles/google_cloud_tasks_1.1.gemfile
+- gemfiles/google_cloud_tasks_1.1.gemfile.lock
+- gemfiles/google_cloud_tasks_1.2.gemfile
+- gemfiles/google_cloud_tasks_1.2.gemfile.lock
+- gemfiles/google_cloud_tasks_1.3.gemfile
+- gemfiles/google_cloud_tasks_1.3.gemfile.lock
+- gemfiles/rails_4.0.gemfile
+- gemfiles/rails_4.1.gemfile
+- gemfiles/rails_4.2.gemfile
+- gemfiles/rails_5.0.gemfile
+- gemfiles/rails_5.1.gemfile
+- gemfiles/rails_5.2.gemfile
+- gemfiles/rails_5.2.gemfile.lock
+- gemfiles/rails_6.0.gemfile
+- gemfiles/rails_6.0.gemfile.lock
 - lib/cloudtasker.rb
 - lib/cloudtasker/authentication_error.rb
 - lib/cloudtasker/authenticator.rb
+- lib/cloudtasker/backend/google_cloud_task.rb
+- lib/cloudtasker/backend/memory_task.rb
+- lib/cloudtasker/backend/redis_task.rb
 - lib/cloudtasker/batch.rb
 - lib/cloudtasker/batch/batch_progress.rb
 - lib/cloudtasker/batch/extension/worker.rb
 - lib/cloudtasker/batch/job.rb
 - lib/cloudtasker/batch/middleware.rb
 - lib/cloudtasker/batch/middleware/server.rb
+- lib/cloudtasker/cli.rb
+- lib/cloudtasker/cloud_task.rb
 - lib/cloudtasker/config.rb
 - lib/cloudtasker/cron.rb
 - lib/cloudtasker/cron/job.rb
 - lib/cloudtasker/cron/middleware.rb
 - lib/cloudtasker/cron/middleware/server.rb
 - lib/cloudtasker/cron/schedule.rb
+- lib/cloudtasker/dead_worker_error.rb
 - lib/cloudtasker/engine.rb
 - lib/cloudtasker/invalid_worker_error.rb
+- lib/cloudtasker/local_server.rb
 - lib/cloudtasker/meta_store.rb
 - lib/cloudtasker/middleware/chain.rb
+- lib/cloudtasker/railtie.rb
 - lib/cloudtasker/redis_client.rb
-- lib/cloudtasker/task.rb
+- lib/cloudtasker/testing.rb
 - lib/cloudtasker/unique_job.rb
 - lib/cloudtasker/unique_job/conflict_strategy/base_strategy.rb
 - lib/cloudtasker/unique_job/conflict_strategy/raise.rb
@@ -281,6 +327,9 @@ files:
 - lib/cloudtasker/unique_job/middleware/server.rb
 - lib/cloudtasker/version.rb
 - lib/cloudtasker/worker.rb
+- lib/cloudtasker/worker_handler.rb
+- lib/cloudtasker/worker_logger.rb
+- lib/tasks/setup_queue.rake
 homepage: https://github.com/keypup-io/cloudtasker
 licenses:
 - MIT
@@ -307,5 +356,5 @@ rubyforge_project:
 rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
-summary: Manage GCP Cloud Tasks in your app. (under development)
+summary: Manage GCP Cloud Tasks in your app. (alpha)
 test_files: []