postqueue 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2edb04093f702ef2fb42d716de3ebdc71c9a65f3
-  data.tar.gz: f2148b265f5669b0b8a81610d1b355d7e8a9036e
+  metadata.gz: 6849910b76abd215646bad9dc1f6af63d586e445
+  data.tar.gz: 19eca3b819e0b69db20d0b3a8a5e4eb4816a6100
 SHA512:
-  metadata.gz: 6b2a2098f86dfa48039e57e3c61d7491c22f19cb0e016af0af0e055d561dc0ff91605e0b3b2a4ae3c5f16acda96aa4e606a8fb4a9d326e97740bca50f2e5a615
-  data.tar.gz: 9bb0c84cb618a457d5410ef7c2337035ffe15573085940011730165a2b1791b5f05f4a2bf8ca766ea879d7a6d68ebe00e179147ba3fc7ac5247647363dc813a9
+  metadata.gz: 5af615c665298638e1e319f633ceacda6cedc2216f31b54fa2616031b6151ca5549e1612b22bd3a4cf581e467f3736825374b0501e05b44a77e8d80b9269d48a
+  data.tar.gz: 2b56b04af5a9a4a2d83d15aeb5e7aee6ffc345404c969f881e3156eeac8a8cf167d62d22bf249d47e07f9d94b1acbb130a5b3e645a1cee93932122f8ca4cc240

data/README.md

@@ -137,15 +137,21 @@ or an operation-specific batch_size:
 
 ## Test mode
 
-During unit tests it is likely preferrable to process queue items in synchronous fashion (i.e. as they come in).
-You can enable this mode via:
+Postqueue works usually in an async mode: queue items that are enqueued are kept in a queue,
+and must be picked up later explicitely for processing (via one of the `process`, `process_one` or `process_until_empty` methods).
 
-    Postqueue.async_processing = false
+During unit tests it is likely preferrable to process queue items in synchronous fashion -
+if you are interested in actual processing - or, at least, in a mode which validates that
+the `op` value is valid (that means that a handler is registered for that op). You can
+change the processing mode via
 
-You can also enable this on a queue-by-queue base via:
+    # can be :sync, :async, :verify
+    Postqueue.processing = :sync
+
+You can also change the processing mnode on a queue-by-queue base:
 
     Postqueue.new do |queue|
-      queue.async_processing = false
+      queue.processing = :sync
     end
 
 ## Installation

data/lib/postqueue/cli.rb

@@ -21,18 +21,21 @@ module Postqueue
         count = Postqueue.enqueue op: options.op, entity_id: options.entity_ids
         Postqueue.logger.info "Enqueued #{count} queue items"
       when "process"
-        connect_to_instance!
+        connect_to_rails!
         Postqueue.process batch_size: 1
       when "run"
-        connect_to_instance!
+        connect_to_rails!
         Postqueue.run!
       end
     end
 
-    def connect_to_instance!
-      path = "#{Dir.getwd}/config/postqueue.rb"
-      Postqueue.logger.info "Loading postqueue configuration from #{path}"
-      load path
+    def connect_to_rails!
+      if File.exists?("config/environment.rb")
+        load "config/environment.rb"
+      else
+        logger.warn "Trying to load postqueue configuration from config/postqueue.rb"
+        load "config/postqueue.rb"
+      end
     end
 
     def connect_to_database!

data/lib/postqueue/default_queue.rb

@@ -14,5 +14,6 @@ module Postqueue
   def_delegators :default_queue, :enqueue
   def_delegators :default_queue, :item_class, :batch_sizes, :on
   def_delegators :default_queue, :process, :process_one
+  def_delegators :default_queue, :processing
   def_delegators :default_queue, :run, :run!
 end

data/lib/postqueue/item/enqueue.rb

@@ -19,6 +19,7 @@ module Postqueue
     end
 
     def self.enqueue_many(op:, entity_ids:, ignore_duplicates:) #:nodoc:
+      entity_ids = Array(entity_ids)
       entity_ids.uniq! if ignore_duplicates
 
       transaction do

data/lib/postqueue/logger.rb

@@ -4,6 +4,14 @@ module Postqueue
   end
 
   def self.logger
-    @logger ||= Logger.new(STDOUT)
+    @logger || default_logger
+  end
+
+  def self.default_logger
+    defined?(Rails) ? Rails.logger : stdout_logger
+  end
+
+  def self.stdout_logger
+    @stdout_logger ||= Logger.new(STDOUT)
   end
 end

data/lib/postqueue/queue/callback.rb

@@ -9,7 +9,7 @@ module Postqueue
     end
 
     def to_s
-      "#{queue.item_class.table_name}: Unknown operation #{op} with #{entity_ids.count} entities"
+      "#{queue.item_class.table_name}: Unknown operation #{op.inspect} with #{entity_ids.count} entities"
     end
   end
 

data/lib/postqueue/queue.rb

@@ -11,20 +11,27 @@ module Postqueue
     # maximum number of processing attempts.
     attr_reader :max_attemps
 
-    def async_processing?
-      @async_processing
-    end
+    VALID_PROCESSING_VALUES = [ :async, :sync, :verify ]
+
+    # sets or return the processing mode. This must be one of :async, :sync
+    # or :verify
+    def processing(processing = nil)
+      return @processing if processing.nil?
 
-    attr_writer :async_processing
+      unless VALID_PROCESSING_VALUES.include?(processing)
+        raise ArgumentError, "Invalid processing value, must be one of #{VALID_PROCESSING_VALUES.inspect}"
+      end
+      @processing = processing
+    end
 
     def initialize(&block)
       @batch_sizes = {}
       @item_class = ::Postqueue::Item
       @default_batch_size = 1
       @max_attemps = 5
-      @async_processing = Postqueue.async_processing?
       @idempotent_operations = {}
       @batch_sizes = {}
+      @processing = :async
 
       on :missing_handler do |op, entity_ids|
         raise MissingHandler, queue: self, op: op, entity_ids: entity_ids
@@ -49,7 +56,15 @@ module Postqueue
       enqueued_items = item_class.enqueue op: op, entity_id: entity_id, ignore_duplicates: idempotent_operation?(op)
       return enqueued_items unless enqueued_items > 0
 
-      process_until_empty(op: op) unless async_processing?
+      case processing
+      when :async
+        :nop
+      when :sync
+        process_until_empty(op: op)
+      when :verify
+        raise(MissingHandler, queue: self, op: op, entity_ids: [entity_id]) unless callback_for(op: op)
+      end
+
       enqueued_items
     end
   end

data/lib/postqueue/railtie.rb

@@ -0,0 +1,17 @@
+module Postqueue
+  class Railtie < Rails::Railtie
+    # initializer "postqueue.configure_rails_initialization" do
+    #   Postqueue.load_config_from "config/postqueue.rb"
+    # end
+  end
+
+  # def self.load_config_from(path)
+  #   @config_file = path
+  # end
+  #
+  # def self.load_config
+  #   return unless @config_file
+  #   load @config_file
+  #   @config_file = nil
+  # end
+end

data/lib/postqueue/version.rb

@@ -1,3 +1,3 @@
 module Postqueue
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/lib/postqueue.rb

@@ -5,19 +5,11 @@ require_relative "postqueue/queue"
 require_relative "postqueue/default_queue"
 
 module Postqueue
-  def self.new(*args, &block)
-    ::Postqueue::Queue.new(*args, &block)
+  class << self
+    def new(*args, &block)
+      ::Postqueue::Queue.new(*args, &block)
+    end
   end
-
-  def self.async_processing=(async_processing)
-    @async_processing = async_processing
-  end
-
-  def self.async_processing?
-    @async_processing
-  end
-
-  self.async_processing = true
 end
 
 # require_relative 'postqueue/railtie' if defined?(Rails)

data/spec/postqueue/enqueue_spec.rb

@@ -5,7 +5,7 @@ describe "enqueuing" do
   let(:items) { queue.item_class.all }
   let(:item)  { queue.item_class.first }
 
-  context "when enqueueing entries" do
+  context "when enqueueing individual items" do
     before do
       queue.enqueue op: "myop", entity_id: 12
     end
@@ -15,6 +15,16 @@ describe "enqueuing" do
       expect(item.entity_id).to eq(12)
     end
 
+    it "enqueues arrays" do
+      queue.enqueue op: "myop", entity_id: [13,14,15]
+      expect(items.pluck(:entity_id)).to eq([12,13,14,15])
+    end
+
+    it "enqueues sets" do
+      queue.enqueue op: "myop", entity_id: Set.new([13,14,15])
+      expect(items.pluck(:entity_id)).to eq([12,13,14,15])
+    end
+
     it "sets defaults" do
       expect(item.created_at).to be > (Time.now - 1.second)
       expect(item.next_run_at).to be > (Time.now - 1.second)

data/spec/postqueue/{syncmode_spec.rb → process_mode_spec.rb}

@@ -1,16 +1,8 @@
 require "spec_helper"
 
-describe "sync_processing" do
+describe "process mode" do
   let(:callback_invocations) { @callback_invocations ||= [] }
 
-  before :all do
-    Postqueue.async_processing = false
-  end
-
-  after :all do
-    Postqueue.async_processing = true
-  end
-
   let(:queue) do
     Postqueue.new do |queue|
       queue.on "op" do |op, entity_ids|
@@ -24,6 +16,7 @@ describe "sync_processing" do
 
   context "when enqueuing in sync mode" do
     before do
+      queue.processing :sync
       queue.enqueue op: "op", entity_id: 12
     end
 
@@ -35,4 +28,25 @@ describe "sync_processing" do
       expect(items.count).to eq(0)
     end
   end
+
+  context "when enqueuing in test mode" do
+    before do
+      queue.processing :verify
+      queue.enqueue op: "op", entity_id: 12
+    end
+
+    it "does not process the items" do
+      expect(callback_invocations.length).to eq(0)
+    end
+
+    it "does not remove items" do
+      expect(items.count).to eq(1)
+    end
+
+    it "raises an error for invalid ops" do
+      expect {
+        queue.enqueue op: "invalid", entity_id: 12
+      }.to raise_error(Postqueue::MissingHandler)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postqueue
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - radiospiel
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -175,6 +175,7 @@ files:
 - lib/postqueue/queue/processing.rb
 - lib/postqueue/queue/runner.rb
 - lib/postqueue/queue/select_and_lock.rb
+- lib/postqueue/railtie.rb
 - lib/postqueue/version.rb
 - lib/tracker.rb
 - lib/tracker/advisory_lock.rb
@@ -187,8 +188,8 @@ files:
 - spec/postqueue/idempotent_ops_spec.rb
 - spec/postqueue/postqueue_spec.rb
 - spec/postqueue/process_errors_spec.rb
+- spec/postqueue/process_mode_spec.rb
 - spec/postqueue/process_spec.rb
-- spec/postqueue/syncmode_spec.rb
 - spec/postqueue/wildcard_spec.rb
 - spec/spec_helper.rb
 - spec/support/configure_active_record.rb