pg-replication-protocol 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b723f4c6b03faf3c0ef5a638da7c08d4d65e6a0b723d4a7f00578333705803fc
+  data.tar.gz: 87577bceaff85726653296a50fd508113be910ecbe305c120d86c12f05ae1276
+SHA512:
+  metadata.gz: 7693f24a4bee5fd0fdf232c18a126fc9f1728a2bad982c4225ebaa7ec7452158a1ec4ffe95f27b7793d7d2184cdeba6d8eb0561c61984c3687eb67d4ad3715b0
+  data.tar.gz: 97e43186afd2876c52dbaa7d0e8b9235bbdddcc9edcb0e5a5cede9d69617efb08040468de0dcdfbc13966ee93fedcfd6bd9387edb8c63ec173df4622dd3ca6cf

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    pg-replication-protocol (0.0.1)
+      pg (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    pg (1.5.9)
+    rake (13.2.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  pg-replication-protocol!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.4.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Rodrigo Navarro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1 @@
+# Pg::Replication::Protocol

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/pg/replication/buffer.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+require "stringio"
+
+module PG
+  module Replication
+    class Buffer
+      attr_reader :buffer
+
+      def self.from_string(str)
+        new(StringIO.new(str))
+      end
+
+      def initialize(buffer)
+        @buffer = buffer
+      end
+
+      def read_char
+        read_int8.chr
+      end
+
+      def read_bool
+        read_int8 == 1
+      end
+
+      def read_int8
+        @buffer.read(1).unpack("C").first
+      end
+
+      def read_int16
+        @buffer.read(2).unpack("n").first
+      end
+
+      def read_int32
+        @buffer.read(4).unpack("N").first
+      end
+
+      def read_int64
+        @buffer.read(8).unpack("Q>").first
+      end
+
+      def read_timestamp
+        usecs = Time.new(2_000, 1, 1, 0, 0, 0, 0).to_i * 10**6 + read_int64
+        Time.at(usecs / 10**6, usecs % 10**6, :microsecond)
+      end
+
+      def read_cstring
+        str = String.new
+        loop do
+          case read_char
+          in "\0"
+            return str
+          in chr
+            str << chr
+          end
+        end
+      end
+
+      def read(size = nil)
+        @buffer.read(size)
+      end
+
+      def eof?
+        @buffer.eof?
+      end
+    end
+  end
+end

data/lib/pg/replication/pg_output.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+module PG
+  module Replication
+    module PGOutput
+      Begin = Data.define(:final_lsn, :timestamp, :xid)
+      Message = Data.define(:transactional, :lsn, :prefix, :content)
+      Commit = Data.define(:lsn, :end_lsn, :timestamp)
+      Origin = Data.define(:commit_lsn, :name)
+      Relation = Data.define(:oid, :namespace, :name, :replica_identity, :columns)
+      Type = Data.define(:oid, :namespace, :name)
+      Insert = Data.define(:oid, :new)
+      Update = Data.define(:oid, :key, :old, :new)
+      Delete = Data.define(:oid, :old)
+      Truncate = Data.define(:oid)
+      Tuple = Data.define(:type, :data)
+      Column = Data.define(:flags, :name, :oid, :modifier)
+
+      def self.read_message(buffer)
+        case buffer.read_char
+        in "B"
+          PGOutput::Begin.new(
+            final_lsn: buffer.read_int64,
+            timestamp: buffer.read_timestamp,
+            xid: buffer.read_int32,
+          )
+
+        in "M"
+          PGOutput::Message.new(
+            transactional: buffer.read_bool,
+            lsn: buffer.read_int64,
+            prefix: buffer.read_cstring,
+            content: case buffer.read_int32
+              in 0
+                nil
+              in n
+                buffer.read(n)
+            end,
+          )
+
+        in "C"
+          buffer.read_int8 # Unused bytes
+          PGOutput::Commit.new(
+            lsn: buffer.read_int64,
+            end_lsn: buffer.read_int64,
+            timestamp: buffer.read_timestamp,
+          )
+
+        in "O"
+          PGOutput::Origin.new(
+            commit_lsn: buffer.read_int64,
+            name: buffer.read_cstring,
+          )
+
+        in "R"
+          PGOutput::Relation.new(
+            oid: buffer.read_int32,
+            namespace: buffer.read_cstring,
+            name: buffer.read_cstring,
+            replica_identity: buffer.read_int8,
+            columns: case buffer.read_int16
+              in 0
+                []
+              in size
+                size.times.map do
+                  PGOutput::Column.new(
+                    flags: buffer.read_int8,
+                    name: buffer.read_cstring,
+                    oid: buffer.read_int32,
+                    modifier: buffer.read_int32,
+                  )
+                end
+            end
+          )
+
+        in "Y"
+          PGOutput::Type.new(
+            oid: buffer.read_int32,
+            namespace: buffer.read_cstring,
+            name: buffer.read_cstring,
+          )
+
+        in "I"
+          PGOutput::Insert.new(
+            oid: buffer.read_int32,
+            new: case a = buffer.read_char
+              when "N"
+                PGOutput.read_tuples(buffer)
+              else
+                []
+              end,
+          )
+
+        in "U"
+          oid = buffer.read_int32
+          key = []
+          new = []
+          old = []
+
+          until buffer.eof?
+            case buffer.read_char
+            when "K"
+              key = PGOutput.read_tuples(buffer)
+            when "N"
+              new = PGOutput.read_tuples(buffer)
+            when "O"
+              old = PGOutput.read_tuples(buffer)
+            end
+          end
+
+          PGOutput::Update.new(
+            oid:,
+            key:,
+            old:,
+            new:,
+          )
+
+        in "D"
+          PGOutput::Delete.new(
+            oid: buffer.read_int32,
+            old: case buffer.read_char
+              when "N", "K"
+                PGOutput.read_tuples(buffer)
+              else
+                []
+              end,
+          )
+
+        in "T"
+          PGOutput::Truncate.new(
+            oid: buffer.read_int32,
+            data: buffer.buffer,
+          )
+
+        in unknown
+          raise "Unknown PGOutput message type: #{unknown}"
+        end
+      end
+
+      def self.read_tuples(buffer)
+        buffer.read_int16.times.map { read_tuple(buffer) }
+      end
+
+      def self.read_tuple(buffer)
+        case buffer.read_char
+        in type if type == "n"
+          Tuple.new(type:, data: nil)
+        in type
+          size = buffer.read_int32
+          data = buffer.read(size)
+          Tuple.new(type:, data:)
+        end
+      end
+    end
+  end
+end

data/lib/pg/replication/protocol.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "pg"
+require_relative "version"
+require_relative "buffer"
+require_relative "pg_output"
+require_relative "stream"
+
+module PG
+  module Replication
+    module Protocol
+      XLogData = Data.define(:lsn, :current_lsn, :server_time, :data)
+      PrimaryKeepalive = Data.define(:current_lsn, :server_time, :asap)
+
+      def self.read_message(buffer)
+        case buffer.read_char
+        in "k"
+          PrimaryKeepalive.new(
+            current_lsn: buffer.read_int64,
+            server_time: buffer.read_timestamp,
+            asap: buffer.read_bool,
+          )
+
+        in "w"
+          XLogData.new(
+            lsn: buffer.read_int64,
+            current_lsn: buffer.read_int64,
+            server_time: buffer.read_timestamp,
+            data: buffer
+              .read
+              .then { |msg| Buffer.from_string(msg) }
+              .then { |msg| PGOutput.read_message(msg) },
+          )
+
+        in unknown
+          raise "Unknown replication message type: #{unknown}"
+        end
+      end
+    end
+
+    def start_pgoutput_replication_slot(slot, publications, location: "0/0", keep_alive_time: 10)
+      publications = Array(publications)
+        .map { |name| quote_ident(name) }
+        .map { |name| "'#{name}'" }
+        .join(",")
+
+      query(<<~SQL)
+        START_REPLICATION SLOT
+        #{slot} LOGICAL #{location}
+        ("proto_version" '1', "publication_names" #{publications})
+      SQL
+
+      last_keep_alive = Time.now
+      last_processed_lsn = 0
+
+      stream = PG::Replication::Stream.new(self)
+      stream.lazy.map do |msg|
+        case msg
+        in PG::Replication::Protocol::XLogData(lsn:, data:)
+          last_processed_lsn = lsn
+          data
+        in PG::Replication::Protocol::PrimaryKeepalive(server_time:, asap: true)
+          stream.standby_status_update(write_lsn: last_processed_lsn)
+          next
+        in PG::Replication::Protocol::PrimaryKeepalive(server_time:)
+          now = Time.now
+          if now - last_keep_alive > keep_alive_time
+            stream.standby_status_update(write_lsn: last_processed_lsn)
+            last_keep_alive = now
+          end
+          next
+        end
+      end
+    end
+  end
+
+  Connection.send(:include, Replication)
+end

data/lib/pg/replication/stream.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module PG
+  module Replication
+    class Stream
+      include Enumerable
+
+      def initialize(connection)
+        @connection = connection
+      end
+
+      def each
+        loop do
+          @connection.consume_input
+
+          next if @connection.is_busy
+
+          case @connection.get_copy_data(async: true)
+          in nil
+            @connection.get_last_result
+            break
+          in false
+            IO.select([@connection.socket_io], nil, nil)
+            next
+          in data
+            buffer = Buffer.new(StringIO.new(data))
+            yield Protocol.read_message(buffer)
+          end
+        end
+      end
+
+      def standby_status_update(
+        write_lsn:,
+        flush_lsn: write_lsn,
+        apply_lsn: write_lsn,
+        timestamp: Time.now,
+        reply: false
+      )
+        msg = [
+          "r".bytes.first,
+          write_lsn,
+          flush_lsn,
+          apply_lsn,
+          (timestamp - Time.new(2000, 1, 1, 0, 0, 0, 0)) * 10**6,
+          reply ? 1 : 0,
+        ].pack("CQ>Q>Q>Q>C")
+
+        @connection.put_copy_data(msg)
+        @connection.flush
+      end
+    end
+  end
+end

data/lib/pg/replication/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module PG
+  module Replication
+    VERSION = "0.0.1"
+  end
+end

data/pg-replication-protocol.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/pg/replication/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "pg-replication-protocol"
+  spec.version = PG::Replication::VERSION
+  spec.authors = ["Rodrigo Navarro"]
+  spec.email = ["rnavarro@rnavarro.com.br"]
+
+  spec.summary = "Postgres replication protocol"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = "https://github.com/reu/pg-replication-protocol-rb"
+  spec.metadata["source_code_uri"] = "https://github.com/reu/pg-replication-protocol-rb"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pg", "~> 1.0"
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: pg-replication-protocol
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rodrigo Navarro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description:
+email:
+- rnavarro@rnavarro.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pg/replication/buffer.rb
+- lib/pg/replication/pg_output.rb
+- lib/pg/replication/protocol.rb
+- lib/pg/replication/stream.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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Postgres replication protocol
+test_files: []