rubyrep 1.1.0 → 1.1.1

data/History.txt

@@ -1,3 +1,8 @@
+== 1.1.1 2009-02-02
+
+* Feature: optional use of an SQL logger
+* Bug fix: under postgresql, rubyrep triggers now finds the pending_changes table also if not included in current search path
+
 == 1.1.0 2009-12-15
 
 * Feature: filtering of sync / replication events with custom specified functionality

data/lib/rubyrep/configuration.rb

@@ -10,8 +10,17 @@ module RR
     # Connection settings for the "right" database.
     # Takes a similar hash as ActiveRecord::Base.establish_connection.
     # Additional settings in case a proxy is used:
-    # * +proxy_host+: name or IP address of where the proxy is running
-    # * +proxy_port+: port on which the proxy is listening
+    # * :+proxy_host+: name or IP address of where the proxy is running
+    # * :+proxy_port+: port on which the proxy is listening
+    # Other additional settings:
+    # * :+logger+:
+    #   Specify an SQL statement logger for this database connection.
+    #   Can be either
+    #   * a logger instance itself (Logger or Log4r::Logger) or
+    #   * the parameter to create a Logger with Logger.new
+    #   Examples:
+    #     +config.left[:logger] = STDOUT
+    #     +config.right[:logger] = Logger.new('rubyrep_debug.log')
     attr_accessor :right
     
     # Returns true unless running on windows...

data/lib/rubyrep/connection_extenders/connection_extenders.rb

@@ -59,7 +59,7 @@ module RR
         DummyActiveRecord.establish_connection(config)
       end
       connection = DummyActiveRecord.connection
-
+      
       # Delete the database connection from ActiveRecords's 'memory'
       ActiveRecord::Base.connection_handler.connection_pools.delete DummyActiveRecord.name
       
@@ -98,25 +98,45 @@ module RR
     def self.connection_cache=(cache)
       @@connection_cache = cache
     end
+
+    # Installs the configured logger (if any) into the database connection.
+    # * +db_connection+: database connection (as produced by #db_connect)
+    # * +config+: database configuration (as provided to #db_connect)
+    def self.install_logger(db_connection, config)
+      if config[:logger]
+        if config[:logger].respond_to?(:debug)
+          logger = config[:logger]
+        else
+          logger = Logger.new(config[:logger])
+        end
+        db_connection.instance_variable_set :@logger, logger
+      end
+    end
     
     # Creates database connections by calling #db_connect_without_cache with the 
     # provided +config+ configuration hash.
     # A new database connection is created only if no according cached connection
     # is available.
     def self.db_connect(config)
-      config_dump = Marshal.dump config.reject {|key, | [:proxy_host, :proxy_port].include? key}
-      config_checksum = Digest::SHA1.hexdigest(config_dump)
-      @@connection_cache ||= {}
-      cached_db_connection = connection_cache[config_checksum]
-      if use_cache? and cached_db_connection and cached_db_connection.active?
-        cached_db_connection
-      else
+      if not use_cache?
         db_connection = db_connect_without_cache config
-        connection_cache[config_checksum] = db_connection if @@use_cache
-        db_connection
+      else
+        config_dump = Marshal.dump config.reject {|key, | [:proxy_host, :proxy_port, :logger].include? key}
+        config_checksum = Digest::SHA1.hexdigest(config_dump)
+        @@connection_cache ||= {}
+
+        db_connection = connection_cache[config_checksum]
+        unless db_connection and db_connection.active?
+          db_connection = db_connect_without_cache config
+          connection_cache[config_checksum] = db_connection
+        end
       end
+
+      install_logger db_connection, config
+
+      db_connection
     end
-    
+
     # If status == true: enable the cache. If status == false: don' use cache
     # Returns the old connection caching status
     def self.use_db_connection_cache(status)

data/lib/rubyrep/replication_extenders/postgresql_replication.rb

@@ -15,6 +15,25 @@ module RR
       end
       private :key_clause
 
+      # Returns the schema prefix (including dot) that will be used by the
+      # triggers to write into the rubyrep infrastructure tables.
+      # To avoid setting the wrong prefix, it will only return a schema prefix
+      # if the current search path
+      # * consists of only a single schema
+      # * does not consists of a variable search path
+      #   (i. e. the default "$user")
+      def schema_prefix
+        unless @schema_prefix
+          search_path = select_one("show search_path")['search_path']
+          if search_path =~ /[,$]/
+            @schema_prefix = ""
+          else
+            @schema_prefix = %("#{search_path}".)
+          end
+        end
+        @schema_prefix
+      end
+
       # Creates or replaces the replication trigger function.
       # See #create_replication_trigger for a descriptions of the +params+ hash.
       def create_or_replace_replication_trigger_function(params)
@@ -39,13 +58,13 @@ module RR
             BEGIN
               #{activity_check}
               IF (TG_OP = 'DELETE') THEN
-                INSERT INTO #{params[:log_table]}(change_table, change_key, change_type, change_time) 
+                INSERT INTO #{schema_prefix}#{params[:log_table]}(change_table, change_key, change_type, change_time)
                   SELECT '#{params[:table]}', #{key_clause('OLD', params)}, 'D', now();
               ELSIF (TG_OP = 'UPDATE') THEN
-                INSERT INTO #{params[:log_table]}(change_table, change_key, change_new_key, change_type, change_time)
+                INSERT INTO  #{schema_prefix}#{params[:log_table]}(change_table, change_key, change_new_key, change_type, change_time)
                   SELECT '#{params[:table]}', #{key_clause('OLD', params)}, #{key_clause('NEW', params)}, 'U', now();
               ELSIF (TG_OP = 'INSERT') THEN
-                INSERT INTO #{params[:log_table]}(change_table, change_key, change_type, change_time)
+                INSERT INTO  #{schema_prefix}#{params[:log_table]}(change_table, change_key, change_type, change_time)
                   SELECT '#{params[:table]}', #{key_clause('NEW', params)}, 'I', now();
               END IF;
               RETURN NULL; -- result is ignored since this is an AFTER trigger
@@ -71,7 +90,7 @@ module RR
         execute(<<-end_sql)
           CREATE TRIGGER "#{params[:trigger_name]}"
           AFTER INSERT OR UPDATE OR DELETE ON "#{params[:table]}"
-              FOR EACH ROW EXECUTE PROCEDURE "#{params[:trigger_name]}"();
+              FOR EACH ROW EXECUTE PROCEDURE #{schema_prefix}"#{params[:trigger_name]}"();
         end_sql
       end
 

data/lib/rubyrep/version.rb

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

data/spec/connection_extenders_registration_spec.rb

@@ -2,6 +2,37 @@ require File.dirname(__FILE__) + '/spec_helper.rb'
 
 include RR
 
+describe ConnectionExtenders do
+  before(:each) do
+    Initializer.configuration = standard_config
+  end
+
+  it "db_connect should install the already created logger" do
+    configuration = deep_copy(Initializer.configuration)
+    io = StringIO.new
+    logger = Logger.new(io)
+    configuration.left[:logger] = logger
+    session = Session.new configuration
+    session.left.select_one "select 'left_query'"
+    session.right.select_one "select 'right_query'"
+
+    io.string.should =~ /left_query/
+    io.string.should_not =~ /right_query/
+  end
+
+  it "db_connect should create and install the specified logger" do
+    configuration = deep_copy(Initializer.configuration)
+    io = StringIO.new
+    configuration.left[:logger] = io
+    session = Session.new configuration
+    session.left.select_one "select 'left_query'"
+    session.right.select_one "select 'right_query'"
+
+    io.string.should =~ /left_query/
+    io.string.should_not =~ /right_query/
+  end
+end
+
 describe ConnectionExtenders, "Registration" do
   before(:each) do
     Initializer.configuration = standard_config
@@ -34,7 +65,7 @@ describe ConnectionExtenders, "Registration" do
     
     ConnectionExtenders.db_connect Initializer.configuration.left
   end
-    
+
   it "db_connect should use jdbc configuration adapter and extender under jruby" do
     fake_ruby_platform 'java' do
       mock_active_record :once

data/spec/postgresql_schema_support_spec.rb

@@ -7,6 +7,7 @@ require File.dirname(__FILE__) + "/../config/test_config.rb"
 describe "PostgreSQL schema support" do
   before(:each) do
     config = deep_copy(standard_config)
+    config.options[:rep_prefix] = 'rx'
     config.left[:schema_search_path] = 'rr'
     config.right[:schema_search_path] = 'rr'
     Initializer.configuration = config
@@ -79,7 +80,7 @@ describe "PostgreSQL schema support" do
 
     it "sequence_values should pick the table in the target schema" do
       session = Session.new
-      session.left.sequence_values('rr', 'rr_duplicate').keys.should == ["rr_duplicate_id_seq"]
+      session.left.sequence_values('rx', 'rr_duplicate').keys.should == ["rr_duplicate_id_seq"]
     end
 
     it "clear_sequence_setup should pick the table in the target schema" do
@@ -150,6 +151,24 @@ describe "PostgreSQL schema support" do
       end
     end
 
+    it "initializer should create tables in target schema" do
+      session = nil
+      begin
+        config = deep_copy(Initializer.configuration)
+        config.options[:rep_prefix] = 'ry'
+        session = Session.new config
+        session.left.begin_db_transaction
+
+        initializer = ReplicationInitializer.new(session)
+        initializer.create_change_log(:left)
+
+        # no exception ==> means table was created in target schema
+        session.left.select_one("select id from rr.ry_pending_changes")
+      ensure
+        session.left.rollback_db_transaction if session
+      end
+    end
+
     it "create_trigger, trigger_exists? and drop_trigger should work" do
       session = nil
       begin
@@ -160,6 +179,17 @@ describe "PostgreSQL schema support" do
         initializer.create_trigger :left, 'rr_trigger_test'
         initializer.trigger_exists?(:left, 'rr_trigger_test').
           should be_true
+
+        # Verify that the trigger can find the pending_changes table even if
+        # current search_path does not include it.
+        session.left.execute "set search_path = 'public'"
+        session.left.execute <<-EOF
+          insert into rr.rr_trigger_test(first_id, second_id) values(10, 11)
+        EOF
+        session.left.execute "set search_path = 'rr'"
+        session.left.select_one("select change_key from rx_pending_changes")['change_key'].
+          should == "first_id|10|second_id|11"
+
         initializer.drop_trigger(:left, 'rr_trigger_test')
         initializer.trigger_exists?(:left, 'rr_trigger_test').
           should be_false

data/tasks/database.rake

@@ -94,6 +94,14 @@ def create_postgres_schema(config)
     create_table :rr_duplicate do |t|
       t.column :name, :string
     end
+
+    create_table :rx_pending_changes do |t|
+      t.column :change_table, :string
+      t.column :change_key, :string
+      t.column :change_new_key, :string
+      t.column :change_type, :string
+      t.column :change_time, :timestamp
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rubyrep
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors: 
 - Arndt Lehmann
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-14 00:00:00 +09:00
+date: 2010-02-03 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,7 +40,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 2.4.0
     version: 
 description: Asynchronous master-master replication of relational databases.
 email: mail@arndtlehman.com
@@ -207,6 +207,8 @@ files:
 - tasks/website.rake
 has_rdoc: true
 homepage: http://rubyrep.rubyforge.org
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -228,9 +230,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rubyrep
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Asynchronous master-master replication of relational databases.
 test_files: []