pg-replication-protocol 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44b3fb2ad8e9ddb30400a0cf8acaf04a70c09d9ae0641e5e475bdf1394c85d5e
-  data.tar.gz: fd766d8b6157af89d017f9dbff382e80278614fe005320c26d7eb89c4f3c4701
+  metadata.gz: 07bd494baf2df079a175855749b79dc41460c5903a58e3cef89f7ac1304e6e9b
+  data.tar.gz: 28ad5dced1a6a73c84a62ce6eae434dbde34883378555c8bac7674d477928627
 SHA512:
-  metadata.gz: 387313faa12bfa5084ea78920f8d860b048d57050e574793e99c9b8fd922cfb60dff8f843a68ce1ba3d05dc010aa011a3b5816a9a8c703e522411c4fff48c1e9
-  data.tar.gz: 5df28c6e5fe755a34cf1544607b6439f903a6da5c38f355d41c9d4b8e6e1dbd834a01f2d2ab6cc46d0c9abd20ba98d0fc47fcbbda57146394f962ee59c2f22e1
+  metadata.gz: 7bd50c203eb711090bdbb0b16d745e46472d936191ac3c3653138bc9db42cecd6b1ed51a625eeae5194be3ca17c66e6f8a05dd4a860979a791d4fa54eee74139
+  data.tar.gz: 3ddaf038c9cdfab3c05c4ac2e6eac8c1799c7a0b1d334a4657b19a9251feeac835784bbdec5a94fba43260f50b932441cd49786f1f573c7a607687a742ef8eb4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pg-replication-protocol (0.0.2)
+    pg-replication-protocol (0.0.5)
       pg (~> 1.0)
 
 GEM
@@ -34,6 +34,7 @@ GEM
       testcontainers-core (~> 0.1)
 
 PLATFORMS
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES

data/README.md

@@ -1,5 +1,7 @@
 # PG::Replication
 
+Adds support to `pg` for listening to replication slots
+
 ## Usage
 
 Add to your Gemfile:
@@ -14,7 +16,7 @@ gem "pg-replication-protocol", require: "pg/replication"
 require "pg"
 require "pg/replication"
 
-# Important to create a connection with the `replication: "database"` flag
+# It is important to create a connection with the `replication: "database"` option
 connection = PG.connect(..., replication: "database")
 
 # Create a publication and a slot (in a real use case the slot will not be temporary)
@@ -25,25 +27,26 @@ connection.query('CREATE_REPLICATION_SLOT some_slot TEMPORARY LOGICAL "pgoutput"
 tables = {}
 
 # Start a pgoutput plugin replication slot message stream
-connection.start_pgoutput_replication_slot(slot, publications).each do |msg|
+# The `messages: true` option is required to be able to decode `PG::Replication::PGOutput::Message`
+connection.start_pgoutput_replication_slot(slot, publications, messages: true).each do |msg|
   case msg
-  in PG::Replication::PGOutput::Relation(oid:, name:, columns:)
-    # We receive this message on the first row of each table
+  in PG::Replication::Protocol::XLogData(data: PG::Replication::PGOutput::Relation(oid:, name:, columns:))
+    # This message is received on the first row of each table, or when there are schema changes
     tables[oid] = { name:, columns: }
 
-  in PG::Replication::PGOutput::Begin
+  in PG::Replication::Protocol::XLogData(data: PG::Replication::PGOutput::Begin)
     puts "Transaction start"
 
-  in PG::Replication::PGOutput::Commit
+  in PG::Replication::Protocol::XLogData(data: PG::Replication::PGOutput::Commit)
     puts "Transaction end"
 
-  in PG::Replication::PGOutput::Insert(oid:, new:)
+  in PG::Replication::Protocol::XLogData(data: PG::Replication::PGOutput::Insert(oid:, new:))
     puts "Insert #{tables[oid][:name]}"
     new.zip(tables[oid][:columns]).each do |tuple, col|
       puts "#{col.name}: #{tuple.data || "NULL"}"
     end
 
-  in PG::Replication::PGOutput::Update(oid:, new:, old:)
+  in PG::Replication::Protocol::XLogData(data: PG::Replication::PGOutput::Update(oid:, new:, old:))
     puts "Update #{tables[oid][:name]}"
     if !old.empty? && new != old
       new.zip(old, tables[oid][:columns]).each do |new, old, col|
@@ -53,9 +56,12 @@ connection.start_pgoutput_replication_slot(slot, publications).each do |msg|
       end
     end
 
-  in PG::Replication::PGOutput::Delete(oid:)
+  in PG::Replication::Protocol::XLogData(data: PG::Replication::PGOutput::Delete(oid:))
     puts "Delete #{tables[oid][:name]}"
 
+  in PG::Replication::Protocol::XLogData(data: PG::Replication::PGOutput::Message(prefix:, content:))
+    puts "Message #{prefix}: #{content}"
+
   else
     nil
   end

data/lib/pg/replication/version.rb

@@ -2,6 +2,6 @@
 
 module PG
   module Replication
-    VERSION = "0.0.3"
+    VERSION = "0.0.5"
   end
 end

data/lib/pg/replication.rb

@@ -8,10 +8,9 @@ require_relative "replication/protocol"
 
 module PG
   module Replication
-    def start_replication_slot(slot, logical: true, location: "0/0", **params)
-      keep_alive_secs = query(<<~SQL).getvalue(0, 0)&.to_i || 10
-        SELECT setting FROM pg_catalog.pg_settings WHERE name = 'wal_receiver_status_interval'
-      SQL
+    def start_replication_slot(slot, logical: true, auto_keep_alive: true, location: "0/0", **params)
+      keep_alive_secs = wal_receiver_status_interval
+      @last_confirmed_lsn = confirmed_slot_lsn(slot) || 0
 
       start_query = "START_REPLICATION SLOT #{slot} #{logical ? "LOGICAL" : "PHYSICAL"} #{location}"
       unless params.empty?
@@ -23,14 +22,13 @@ module PG
       end
       query(start_query)
 
-      last_processed_lsn = 0
       last_keep_alive = Time.now
 
       Enumerator
         .new do |y|
           loop do
-            if Time.now - last_keep_alive > keep_alive_secs
-              standby_status_update(write_lsn: last_processed_lsn)
+            if auto_keep_alive && Time.now - last_keep_alive > keep_alive_secs
+              standby_status_update(write_lsn: @last_confirmed_lsn)
               last_keep_alive = Time.now
             end
 
@@ -47,37 +45,40 @@ module PG
               next
 
             in data
-              buffer = Buffer.new(StringIO.new(data))
-              y << Protocol.read_message(buffer)
+              case (msg = Protocol.read_message(Buffer.new(StringIO.new(data))))
+              in Protocol::XLogData(lsn:, data:) if auto_keep_alive
+                y << msg
+                standby_status_update(write_lsn: lsn)
+                @last_confirmed_lsn = lsn
+                last_keep_alive = Time.now
+
+              in Protocol::PrimaryKeepalive(server_time:, asap: true) if auto_keep_alive
+                standby_status_update(write_lsn: @last_confirmed_lsn)
+                last_keep_alive = Time.now
+                y << msg
+
+              else
+                y << msg
+              end
             end
           end
         end
         .lazy
-        .filter_map do |msg|
-          case msg
-          in Protocol::XLogData(lsn:, data:)
-            last_processed_lsn = lsn
-            standby_status_update(write_lsn: last_processed_lsn)
-            last_keep_alive = Time.now
-            data
-
-          in Protocol::PrimaryKeepalive(server_time:, asap: true)
-            standby_status_update(write_lsn: last_processed_lsn)
-            last_keep_alive = Time.now
-            next
-
-          else
-            next
-          end
-        end
     end
 
     def start_pgoutput_replication_slot(slot, publication_names, **kwargs)
       publication_names = publication_names.join(",")
 
       start_replication_slot(slot, **kwargs.merge(proto_version: "1", publication_names:))
-        .map { |data| data.force_encoding(internal_encoding) }
-        .map { |data| PGOutput.read_message(Buffer.from_string(data)) }
+        .map do |msg|
+          case msg
+          in Protocol::XLogData(data:, lsn:)
+            data = data.force_encoding(internal_encoding)
+            msg.with(data: PGOutput.read_message(Buffer.from_string(data)))
+          else
+            msg
+          end
+        end
     end
 
     def standby_status_update(
@@ -98,6 +99,27 @@ module PG
 
       put_copy_data(msg)
       flush
+      @last_confirmed_lsn = [@last_confirmed_lsn, write_lsn].compact.max
+    end
+
+    def last_confirmed_lsn
+      @last_confirmed_lsn
+    end
+
+    def wal_receiver_status_interval
+      query(<<~SQL).getvalue(0, 0)&.to_i || 10
+        SELECT setting FROM pg_catalog.pg_settings WHERE name = 'wal_receiver_status_interval'
+      SQL
+    end
+
+    def confirmed_slot_lsn(slot)
+      lsn = query(<<~SQL).getvalue(0, 0)
+        SELECT confirmed_flush_lsn FROM pg_replication_slots WHERE slot_name = '#{slot}'
+      SQL
+      high, low = lsn.split("/")
+      (high.to_i(16) << 32) + low.to_i(16)
+    rescue StandardError
+      nil
     end
   end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pg-replication-protocol
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Rodrigo Navarro
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-29 00:00:00.000000000 Z
+date: 2025-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -24,7 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description:
 email:
 - rnavarro@rnavarro.com.br
 executables: []
@@ -43,13 +41,11 @@ files:
 - lib/pg/replication/protocol.rb
 - lib/pg/replication/version.rb
 - pg-replication-protocol.gemspec
-homepage:
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/reu/pg-replication-protocol-rb
   source_code_uri: https://github.com/reu/pg-replication-protocol-rb
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -64,8 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Postgres replication protocol
 test_files: []