ap4r 0.3.2 → 0.3.3

data/lib/ap4r/mongrel_ap4r.rb

@@ -6,6 +6,8 @@ require 'rubygems'
 require 'mongrel'
 require 'ap4r/mongrel'
 
+Mongrel::Command::BANNER.gsub!("rails", "ap4r")
+
 module Ap4r::Mongrel
 
   module Command
@@ -17,6 +19,8 @@ module Ap4r::Mongrel
         klass.class_eval do |k|
           include(::Mongrel::Command::Base)
         end
+
+
         # TODO: Can subclass the return of RubyGems::GemPlugin ? 2007/04/16 by shino
       end
 

data/lib/ap4r/postgresql.sql

@@ -0,0 +1,13 @@
+CREATE TABLE reliable_msg_queues (
+  id character varying(255) NOT NULL default '',
+  queue character varying(255) NOT NULL default '',
+  headers text NOT NULL,
+  object text NOT NULL,
+  PRIMARY KEY  (id)
+);
+CREATE TABLE reliable_msg_topics (
+  topic character varying(255) NOT NULL default '',
+  headers text NOT NULL,
+  object text NOT NULL,
+  PRIMARY KEY  (topic)
+);

data/lib/ap4r/retention_history.rb

@@ -12,8 +12,8 @@ module ReliableMsg #:nodoc:
   class RetentionHistory
     include DRbUndumped
 
-    LOOP_INTERVAL = 3.seconds
-    SHELF_LIFE = 1.hour
+    LOOP_INTERVAL = 1.seconds
+    SHELF_LIFE = 10.minutes
 #    SHELF_LIFE = 10.seconds
     attr_reader :data
 

data/lib/ap4r/script/setup.rb

@@ -9,7 +9,6 @@ begin
   require 'active_support'
 rescue LoadError
   require 'rubygems'
-  gem 'active_support'
   require 'active_support'
 end
 

data/lib/ap4r/stored_message.rb

@@ -5,12 +5,12 @@
 begin 
   require 'active_record'
   require 'uuid'
+  require 'reliable-msg'
 rescue LoadError
   require 'rubygems'
-  gem 'activerecord'
   require 'activerecord'
-  gem 'uuid'
   require 'uuid'
+  require 'reliable-msg'
 end
 
 module Ap4r
@@ -23,11 +23,30 @@ module Ap4r
 
     STATUS_STORED = 0
     STATUS_FORWARDED = 1
-    STATUS_FAILED = -1
-
+    @@status_value_of = { :unforwarded => STATUS_STORED,
+                      :forwarded => STATUS_FORWARDED }
+    
     PHYSICAL = :physical
     LOGICAL = :logical
-
+    
+    def dumped_headers
+      # The warning occurs when putting backslash into binaly type in PostgreSQL.
+      if "postgresql" == Ap4r::StoredMessage.establish_connection.config[:adapter]
+        self.headers
+      else
+        Marshal::dump(self.headers)
+      end      
+    end
+    
+    def dumped_object
+      # The warning occurs when putting backslash into binaly type in PostgreSQL.
+      if "postgresql" == Ap4r::StoredMessage.establish_connection.config[:adapter]
+        self.object
+      else
+        Marshal::dump(self.object)
+      end      
+    end
+    
     # Insert queue information, such as queue name and message,  for next logic.
     #
     # duplication_check_id is generated from UUID and should be unique
@@ -42,8 +61,15 @@ module Ap4r
         s.duplication_check_id = UUID.new
         s.queue = queue_name
         s.status = STATUS_STORED
-        s.object = Marshal::dump(queue_message)
-        s.headers = Marshal::dump(rm_options)
+
+        # The warning occurs when putting backslash into binaly type in PostgreSQL.
+        if "postgresql" == Ap4r::StoredMessage.establish_connection.config[:adapter]
+          s.object = YAML.dump(queue_message)
+          s.headers = YAML.dump(rm_options)
+        else
+          s.object = Marshal::dump(queue_message)
+          s.headers = Marshal::dump(rm_options)
+        end
       end
 
       begin
@@ -86,5 +112,92 @@ module Ap4r
       self
     end
 
+    # List the records which have specified status.
+    # The statuses are :forwarded, :unforwarded and :all.
+    # :unforwarded means unprocessed or error during forward process.
+    def self.find_status_of(status = :unforwarded)
+      case status
+      when :all
+        StoredMessage.find(:all)
+      when :forwarded, :unforwarded
+        StoredMessage.find(:all, :conditions => { :status => @@status_value_of[status] })
+      else
+        puts "Undefined status: #{status.to_s}."
+        puts "Usage: Ap4r::StoredMessage.find_on [ :forwarded | :unforwarded | :all ]"
+      end
+    end
+
+    # Return id, queue_name and created date time.
+    def to_summary_string
+      return "#{self.id}, #{self.queue}, #{self.created_at}"
+    end
+    
+    # Update status value.
+    def self.update_status(id, status)
+      return "undefined status: #{status}" unless @@status_value_of.keys.include? status
+      stored_message = StoredMessage.find(id)
+      
+      before_status = stored_message.status
+      after_status = @@status_value_of[status]
+      
+      stored_message.status = after_status
+      stored_message.save!
+    end
+    
+    # Try to forward the ONE message which status is unforwarded.
+    # If the message is forwarded successfully, the status will be "1" that means forwarded.
+    def self.reforward(id)
+      stored_message = StoredMessage.find(id)
+      if stored_message.status == @@status_value_of[:forwarded]
+        raise "The message (id = #{id}) was already forwarded." 
+      end
+      stored_message.forward_and_update_status
+    end
+    
+    # Try to forward all messages which status are unforwarded.
+    # This method issue commit command to database every transaction_num.
+    def self.reforward_all(transaction_num = 10)
+      
+      stored_messages = StoredMessage.find(:all, 
+                                           :conditions => {:status => @@status_value_of[:unforwarded]})
+      total_num = stored_messages.size
+      failed_num = 0
+      
+      0.step(total_num, transaction_num) do |offset|
+        target_sms = stored_messages[offset..(offset + transaction_num - 1)]
+        next if target_sms.empty?
+        begin
+          StoredMessage.transaction do
+            target_sms.each do |target_sm|
+              target_sm.forward_and_update_status
+            end
+          end
+        rescue Exception => error
+          puts error.message
+          failed_num += target_sms.size
+        end
+      end
+      return [total_num - failed_num, failed_num]
+    end
+        
+    def forward_and_update_status
+      queue_name     = self.queue
+      
+      # The warning occurs when putting backslash into binaly type in PostgreSQL.
+      if "postgresql" == Ap4r::StoredMessage.establish_connection.config[:adapter]
+        queue_headers  = YAML.load(self.headers)
+        queue_messages = YAML.load(self.object)
+      else
+        queue_headers  = Marshal::load(self.headers)
+        queue_messages = Marshal::load(self.object)
+      end
+
+      q = ::ReliableMsg::Queue.new(queue_name, :drb_uri => Ap4r::AsyncHelper::Base::DRUBY_URI)
+      q.put(queue_messages, queue_headers)
+
+      self.status = STATUS_FORWARDED
+      self.save!
+    end
+    
   end
 end

data/lib/ap4r/version.rb

@@ -8,7 +8,7 @@ module Ap4r
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 3
-    TINY  = 2
+    TINY  = 3
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/ap4r/xxx_create_table_for_saf.rb

@@ -0,0 +1,21 @@
+# Author:: Kiwamu Kato
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
+class CreateTableForSaf < ActiveRecord::Migration
+  def self.up
+    create_table :stored_messages do |t|
+      t.column :duplication_check_id, :string, :null => false
+      t.column :queue, :string, :null => false
+      t.column :headers, :binary, :null => false
+      t.column :object, :binary, :null => false
+      t.column :status, :integer, :null => false
+      t.column :created_at, :datetime, :null => false
+      t.column :updated_at, :datetime, :null => false
+    end
+  end
+
+  def self.down
+    drop_table :stored_messages
+  end
+end

data/lib/ap4r/xxx_create_table_for_saf_to_postgresql.rb

@@ -0,0 +1,21 @@
+# Author:: Kiwamu Kato
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
+class CreateTableForSaf < ActiveRecord::Migration
+  def self.up
+    create_table :stored_messages do |t|
+      t.column :duplication_check_id, :string, :null => false
+      t.column :queue, :string, :null => false
+      t.column :headers, :text, :null => false
+      t.column :object, :text, :null => false
+      t.column :status, :integer, :null => false
+      t.column :created_at, :datetime, :null => false
+      t.column :updated_at, :datetime, :null => false
+    end
+  end
+
+  def self.down
+    drop_table :stored_messages
+  end
+end

data/rails_plugin/ap4r/init.rb

@@ -0,0 +1,11 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2007 Future Architect Inc.
+# Licence:: MIT Licence
+
+require 'ap4r_client'
+
+class ActionController::Base
+  def ap4r
+    @ap4r_client ||= ::Ap4r::Client.new(self)
+  end
+end

data/rails_plugin/ap4r/lib/ap4r/queue_put_stub.rb

@@ -0,0 +1,21 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2007 Future Architect Inc.
+# Licence:: MIT Licence
+
+module Ap4r
+  module AsyncHelper
+    module Base
+      def queued_messages
+        return @queued_messages if @queued_messages
+        @queued_messages = Hash.new {|hash, key| hash[key] = []}
+        return @queued_messages
+      end
+
+      private
+      def __queue_put(queue_name, message, headers)
+        queued_messages[queue_name] << {:headers => headers, :body => message}
+      end
+
+    end
+  end
+end

data/rails_plugin/ap4r/lib/ap4r/service_handler.rb

@@ -0,0 +1,165 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2007 Future Architect Inc.
+# Licence:: MIT Licence
+
+require 'rubygems'
+require 'erb'
+require 'yaml'
+require 'reliable-msg'
+require 'ap4r'
+require 'timeout'
+
+module Ap4r
+
+  class ServiceHandler
+
+    def initialize(config_file = RAILS_ROOT + "/config/test_async.yml")
+      raise "please create config/test_async.yml to configure ap4r service." unless File.exist?(config_file)
+
+      config = {}
+      File.open(config_file, "r") do |input|
+        YAML.load_documents(ERB.new(input.read).result) do |doc|
+          config.merge! doc
+        end
+      end
+      @test_config = config["ap4r"]
+      @root_dir = @test_config["root_dir"]
+      @config_file = @test_config["config_file"]
+      @test_server_config = ReliableMsg::Config.new(File.join(@root_dir, @config_file))
+      raise "config file #{@test_server_config.path} NOT exist!" unless @test_server_config.exist?
+
+      @test_server_config.load_no_create
+      @qm = nil
+    end
+
+    def qm
+      @qm ||= DRbObject.new_with_uri("druby://localhost:#{@test_server_config.drb["port"]}")
+    end
+
+    # Starts ap4r service.
+    def start_ap4r_service(wait_until_started = true)
+      command = "ruby #{@test_config["start_ruby_args"]} #{@root_dir}/script/mongrel_ap4r " +
+        "start -d -c #{@root_dir} -A #{@config_file} -p 13038"
+      message = "Starting Mongrel(AP4R)"
+      execute_command(command, message, false)
+      if wait_until_started
+        print "and waiting..."
+        wait_until_alive
+      end
+      puts "Done."
+    end
+
+    # Stops ap4r service.
+    def stop_ap4r_service
+      command = "ruby #{@test_config["stop_ruby_args"]} #{@root_dir}/script/mongrel_ap4r " +
+        "stop -c #{@root_dir}"
+      message = "Terminating Mongrel(AP4R)"
+      execute_command(command, message, false)
+      @qm = nil
+    end
+
+    # Starts rails service.
+    # Invokes mongrel_rails, so mongrel_rails should be installed.
+    def start_rails_service
+      # TODO: Can use script/server? It's more general. 2007/05/31 by shino
+      command = "mongrel_rails start -d --environment test"
+      message = "Starting Mongrel(Rails)"
+      execute_command(command, message)
+    end
+
+    # Stops rails service.
+    def stop_rails_service
+      #     puts "read pid"
+      #     pid = File.read('log/mongrel.pid').to_i
+      #     puts "send signal to #{pid}"
+      #     Process.kill(:TERM, `cat log/mongrel.pid`.to_i)
+      #     puts "done"
+      #     return
+      command = "mongrel_rails stop"
+      #    command = "kill " + `cat log/mongrel.pid`
+      #    command = "sh -c 'mongrel_rails stop'"
+      message = "Terminating Mongrel(Rails)"
+      execute_command(command, message, false)
+    end
+
+    # Starts rails service and ap4r service.
+    # After block execution, stops both.
+    def with_services
+      begin
+        start_rails_service
+        begin
+          start_ap4r_service
+          yield
+        ensure
+          stop_ap4r_service
+        end
+      ensure
+        stop_rails_service
+      end
+    end
+
+    def start_dispatchers
+      qm.dispatchers.start
+    end
+
+    def stop_dispatchers
+      qm.dispatchers.stop
+    end
+
+    def clear(*queues)
+      raise "not yet implemented"
+      queues.each do |queue|
+        q = ReliableMsg::Queue.new(queue)
+        loop do
+          break unless q.get
+        end
+      end
+    end
+
+    def wait_for_saf_forward
+      50.times do
+        count = ::Ap4r::StoredMessage.count(:conditions => {:status => ::Ap4r::StoredMessage::STATUS_STORED})
+        break if count == 0
+        sleep 0.2
+      end
+    end
+
+    def wait_all_done
+      50.times do
+        break if flag = qm.no_active_message?
+        sleep 0.2
+      end
+    end
+
+    def dlq
+      qm.list :queue => "$dlq"
+    end
+
+    private
+    def execute_command(command, message, with_done_message = true)
+      command += ";"         # force to execute via shell
+      print "#{message} with command: #{command}..."
+      begin
+        timeout(10) do
+          result = system("#{command}")
+          # TODO: handle result 2007/08/29 by shino
+          puts "Done." if with_done_message
+        end
+      rescue TimeoutError
+        puts "!!! command timed out !!!"
+      end
+    end
+
+    def wait_until_alive(message = nil)
+      50.times do
+        print message if message
+        begin
+          break if qm.alive?
+        rescue => e
+          # ignore
+        end
+        sleep 0.2
+      end
+    end
+  end
+end