cloudtasker 0.1.0 → 0.6.0

data/lib/cloudtasker/unique_job/job.rb

@@ -10,6 +10,9 @@ module Cloudtasker
       # The default lock strategy to use. Defaults to "no lock".
       DEFAULT_LOCK = UniqueJob::Lock::NoOp
 
+      # Key Namespace used for object saved under this class
+      SUB_NAMESPACE = 'job'
+
       #
       # Build a new instance of the class.
       #
@@ -37,7 +40,7 @@ module Cloudtasker
         @lock_instance ||=
           begin
             # Infer lock class and get instance
-            lock_name = options[:lock] || options['lock']
+            lock_name = options[:lock]
             lock_klass = Lock.const_get(lock_name.to_s.split('_').collect(&:capitalize).join)
             lock_klass.new(self)
           rescue NameError
@@ -91,7 +94,7 @@ module Cloudtasker
       # @return [String] The global ID of the job
       #
       def unique_gid
-        [Config::KEY_NAMESPACE, unique_id].join('/')
+        [self.class.to_s.underscore, unique_id].join('/')
       end
 
       #

data/lib/cloudtasker/unique_job/lock/base_lock.rb

@@ -43,7 +43,7 @@ module Cloudtasker
           @conflict_instance ||=
             begin
               # Infer lock class and get instance
-              strategy_name = options[:on_conflict] || options['on_conflict']
+              strategy_name = options[:on_conflict]
               strategy_klass = ConflictStrategy.const_get(strategy_name.to_s.split('_').collect(&:capitalize).join)
               strategy_klass.new(job)
             rescue NameError

data/lib/cloudtasker/unique_job/lock/until_executed.rb

@@ -24,9 +24,11 @@ module Cloudtasker
         def execute
           job.lock!
           yield
-          job.unlock!
         rescue LockError
           conflict_instance.on_execute { yield }
+        ensure
+          # Unlock the job on any error to avoid deadlocks.
+          job.unlock!
         end
       end
     end

data/lib/cloudtasker/unique_job/lock/while_executing.rb

@@ -13,9 +13,11 @@ module Cloudtasker
         def execute
           job.lock!
           yield
-          job.unlock!
         rescue LockError
           conflict_instance.on_execute { yield }
+        ensure
+          # Unlock the job on any error to avoid deadlocks.
+          job.unlock!
         end
       end
     end

data/lib/cloudtasker/unique_job/middleware.rb

@@ -3,7 +3,6 @@
 require 'cloudtasker/redis_client'
 
 require_relative 'lock_error'
-require_relative 'config'
 
 require_relative 'conflict_strategy/base_strategy'
 require_relative 'conflict_strategy/raise'

data/lib/cloudtasker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cloudtasker
-  VERSION = '0.1.0'
+  VERSION = '0.6.0'
 end

data/lib/cloudtasker/worker.rb

@@ -6,7 +6,7 @@ module Cloudtasker
     # Add class method to including class
     def self.included(base)
       base.extend(ClassMethods)
-      base.attr_accessor :job_args, :job_id, :job_meta, :job_reenqueued
+      base.attr_accessor :job_args, :job_id, :job_meta, :job_reenqueued, :job_retries
     end
 
     #
@@ -44,7 +44,7 @@ module Cloudtasker
       return nil unless worker_klass.include?(self)
 
       # Return instantiated worker
-      worker_klass.new(payload.slice(:job_args, :job_id, :job_meta))
+      worker_klass.new(payload.slice(:job_args, :job_id, :job_meta, :job_retries))
     rescue NameError
       nil
     end
@@ -54,12 +54,12 @@ module Cloudtasker
       #
       # Set the worker runtime options.
       #
-      # @param [Hash] opts The worker options
+      # @param [Hash] opts The worker options.
       #
-      # @return [<Type>] <description>
+      # @return [Hash] The options set.
       #
       def cloudtasker_options(opts = {})
-        opt_list = opts&.map { |k, v| [k.to_s, v] } || [] # stringify
+        opt_list = opts&.map { |k, v| [k.to_sym, v] } || [] # symbolize
         @cloudtasker_options_hash = Hash[opt_list]
       end
 
@@ -69,7 +69,7 @@ module Cloudtasker
       # @return [Hash] The worker runtime options.
       #
       def cloudtasker_options_hash
-        @cloudtasker_options_hash
+        @cloudtasker_options_hash || {}
       end
 
       #
@@ -77,7 +77,7 @@ module Cloudtasker
       #
       # @param [Array<any>] *args List of worker arguments
       #
-      # @return [Google::Cloud::Tasks::V2beta3::Task] The Google Task response
+      # @return [Cloudtasker::CloudTask] The Google Task response
       #
       def perform_async(*args)
         perform_in(nil, *args)
@@ -89,7 +89,7 @@ module Cloudtasker
       # @param [Integer, nil] interval The delay in seconds.
       # @param [Array<any>] *args List of worker arguments.
       #
-      # @return [Google::Cloud::Tasks::V2beta3::Task] The Google Task response
+      # @return [Cloudtasker::CloudTask] The Google Task response
       #
       def perform_in(interval, *args)
         new(job_args: args).schedule(interval: interval)
@@ -101,11 +101,20 @@ module Cloudtasker
       # @param [Time, Integer] time_at The time at which the job should run.
       # @param [Array<any>] *args List of worker arguments
       #
-      # @return [Google::Cloud::Tasks::V2beta3::Task] The Google Task response
+      # @return [Cloudtasker::CloudTask] The Google Task response
       #
       def perform_at(time_at, *args)
         new(job_args: args).schedule(time_at: time_at)
       end
+
+      #
+      # Return the numbeer of times this worker will be retried.
+      #
+      # @return [Integer] The number of retries.
+      #
+      def max_retries
+        cloudtasker_options_hash[:max_retries] || Cloudtasker.config.max_retries
+      end
     end
 
     #
@@ -114,10 +123,20 @@ module Cloudtasker
     # @param [Array<any>] job_args The list of perform args.
     # @param [String] job_id A unique ID identifying this job.
     #
-    def initialize(job_args: [], job_id: nil, job_meta: {})
+    def initialize(job_args: [], job_id: nil, job_meta: {}, job_retries: 0)
       @job_args = job_args
       @job_id = job_id || SecureRandom.uuid
       @job_meta = MetaStore.new(job_meta)
+      @job_retries = job_retries || 0
+    end
+
+    #
+    # Return the Cloudtasker logger instance.
+    #
+    # @return [Logger, any] The cloudtasker logger.
+    #
+    def logger
+      @logger ||= WorkerLogger.new(self)
     end
 
     #
@@ -126,9 +145,22 @@ module Cloudtasker
     # @return [Any] The result of the perform.
     #
     def execute
-      Cloudtasker.config.server_middleware.invoke(self) do
-        perform(*job_args)
+      logger.info('Starting job...')
+      resp = Cloudtasker.config.server_middleware.invoke(self) do
+        begin
+          perform(*job_args)
+        rescue StandardError => e
+          try(:on_error, e)
+          return raise(e) unless job_dead?
+
+          # Flag job as dead
+          logger.info('Job dead')
+          try(:on_dead, e)
+          raise(DeadWorkerError, e)
+        end
       end
+      logger.info('Job done')
+      resp
     end
 
     #
@@ -138,11 +170,11 @@ module Cloudtasker
     #
     # @param [Time, Integer] interval The time at which the job should run
     #
-    # @return [Google::Cloud::Tasks::V2beta3::Task] The Google Task response
+    # @return [Cloudtasker::CloudTask] The Google Task response
     #
     def schedule(interval: nil, time_at: nil)
       Cloudtasker.config.client_middleware.invoke(self) do
-        Task.new(self).schedule(interval: interval, time_at: time_at)
+        WorkerHandler.new(self).schedule(interval: interval, time_at: time_at)
       end
     end
 
@@ -155,7 +187,7 @@ module Cloudtasker
     #
     # @param [Integer] interval Delay to wait before processing the job again (in seconds).
     #
-    # @return [Google::Cloud::Tasks::V2beta3::Task] The Google Task response
+    # @return [Cloudtasker::CloudTask] The Google Task response
     #
     def reenqueue(interval)
       @job_reenqueued = true
@@ -182,7 +214,8 @@ module Cloudtasker
         worker: self.class.to_s,
         job_id: job_id,
         job_args: job_args,
-        job_meta: job_meta.to_h
+        job_meta: job_meta.to_h,
+        job_retries: job_retries
       }
     end
 
@@ -207,5 +240,15 @@ module Cloudtasker
     def ==(other)
       other.is_a?(self.class) && other.job_id == job_id
     end
+
+    #
+    # Return true if the job has excceeded its maximum number
+    # of retries
+    #
+    # @return [Boolean] True if the job is dead
+    #
+    def job_dead?
+      job_retries >= Cloudtasker.config.max_retries
+    end
   end
 end

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