pg-replication-protocol 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b47169a6a877e1d68022faad3c47e2b49fda70e9e4925f931e4ed211055cc717
-  data.tar.gz: 68a845688a3a7ad74b5b858319d72a7f85c5d484923a890c34d9069cc05a7d02
+  metadata.gz: 7eb14ee3cd0484e8160ed1bc27a841178bb5bb19a35304d46992c8d7accad5be
+  data.tar.gz: 51e43b8bcba5ee2db08b08962418ae0ff6ab6657076ca586984c279fe6603f6e
 SHA512:
-  metadata.gz: 7ba1e8821d066d3f82a5ba37a8b8d73066baea146e34ee022996a391568e17c7d08e298c3061f7ebbf22d37f7099c54f01521845ff5f4b727249e7c4fb84456b
-  data.tar.gz: 3df84fdf551747d54ef62160ee3423068378d0fafd3c7015f5f263072e2139825f074b2f4f95614d434920c842af453a0bff65b837f320f0fdc45c6547a706c7
+  metadata.gz: 0e86a9fcaa6a3497d6b211004551219fd9080adbca09977de836c53766780088fcb6c42966e461b8517026ef310ab67134c52d20fef396adf1807c06bf004ffe
+  data.tar.gz: 7e21681ae16444dc1a43450074a574ea81edfd554ce6362c13befad60f651c637c887416fd58befdf1bb8e5f604efd946a6e253486c584b562bb790a1e644864

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pg-replication-protocol (0.0.2)
+    pg-replication-protocol (0.0.3)
       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/pg_output.rb

@@ -11,7 +11,7 @@ module PG
       Type = Data.define(:oid, :namespace, :name)
       Insert = Data.define(:oid, :new)
       Update = Data.define(:oid, :key, :old, :new)
-      Delete = Data.define(:oid, :old)
+      Delete = Data.define(:oid, :key, :old)
       Truncate = Data.define(:oid)
       Tuple = Data.define(:type, :data)
       Column = Data.define(:flags, :name, :oid, :modifier) do
@@ -115,14 +115,23 @@ module PG
           )
 
         in "D"
+          oid = buffer.read_int32
+          key = []
+          old = []
+
+          until buffer.eof?
+            case buffer.read_char
+            when "K"
+              key = PGOutput.read_tuples(buffer)
+            when "O"
+              old = PGOutput.read_tuples(buffer)
+            end
+          end
+
           PGOutput::Delete.new(
-            oid: buffer.read_int32,
-            old: case buffer.read_char
-              when "N", "K"
-                PGOutput.read_tuples(buffer)
-              else
-                []
-              end,
+            oid:,
+            key:,
+            old:,
           )
 
         in "T"

data/lib/pg/replication/version.rb

@@ -2,6 +2,6 @@
 
 module PG
   module Replication
-    VERSION = "0.0.2"
+    VERSION = "0.0.4"
   end
 end

data/lib/pg/replication.rb

@@ -8,10 +8,8 @@ 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
 
       start_query = "START_REPLICATION SLOT #{slot} #{logical ? "LOGICAL" : "PHYSICAL"} #{location}"
       unless params.empty?
@@ -23,14 +21,14 @@ module PG
       end
       query(start_query)
 
-      last_processed_lsn = 0
+      @last_confirmed_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
+                standby_status_update(write_lsn: @last_confirmed_lsn)
+                last_keep_alive = Time.now
+                y << msg
+                @last_confirmed_lsn = lsn
+
+              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,17 @@ 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
   end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pg-replication-protocol
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Rodrigo Navarro
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-17 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: []