pgoutput-client 0.0.0 → 0.2.0

data/sig/pgoutput/client/lsn.rbs

@@ -0,0 +1,36 @@
+module Pgoutput
+  module Client
+    # PostgreSQL Log Sequence Number conversion helpers.
+    #
+    # PostgreSQL represents LSNs as two hexadecimal 32-bit halves separated by a
+    # slash, such as `0/16B6C50`. The replication protocol transmits the same WAL
+    # position as an unsigned 64-bit integer. This module converts between those
+    # two representations.
+    #
+    # @example Parse a textual LSN
+    #   Pgoutput::Client::LSN.parse("0/10")
+    #   # => 16
+    #
+    # @example Format an integer WAL position
+    #   Pgoutput::Client::LSN.format(16)
+    #   # => "0/10"
+    #
+    # @api public
+    module LSN
+      # Parse a PostgreSQL LSN string into an integer WAL position.
+      #
+      # @param value [#to_s] LSN string in `HEX/HEX` form
+      # @return [Integer] unsigned 64-bit WAL position
+      # @raise [ArgumentError] if the value is not a valid LSN string
+      def self?.parse: (untyped value) -> untyped
+
+      # Format an integer WAL position as a PostgreSQL LSN string.
+      #
+      # @param value [#to_int, #to_s] non-negative integer WAL position
+      # @return [String] LSN string in uppercase hexadecimal `HEX/HEX` form
+      # @raise [ArgumentError] if the value is negative or cannot be coerced to
+      #   an integer
+      def self?.format: (untyped value) -> ::String
+    end
+  end
+end

data/sig/pgoutput/client/runner.rbs

@@ -0,0 +1,99 @@
+module Pgoutput
+  module Client
+    # High-level logical replication client facade.
+    #
+    # `Runner` is the simplest public entry point for consumers that want to
+    # stream raw pgoutput payloads without manually managing a replication
+    # connection. It owns the connection lifecycle for one logical replication
+    # stream:
+    #
+    # 1. Build an immutable {Configuration} from keyword arguments.
+    # 2. Open a PostgreSQL replication connection.
+    # 3. Optionally create the configured replication slot.
+    # 4. Start logical replication.
+    # 5. Yield raw pgoutput payload bytes and {XLogData} metadata.
+    # 6. Close the connection when streaming exits.
+    #
+    # If a live stream loses its connection, the runner retries a small number
+    # of times with a backoff and resumes from the latest confirmed WAL
+    # position. Replay, checkpointing, and deduplication are not owned here;
+    # those concerns belong to the downstream CDC runtime and sink layer.
+    #
+    # @example Stream raw pgoutput messages
+    #   runner = Pgoutput::Client::Runner.new(
+    #     database_url: "postgres://localhost/app",
+    #     slot_name: "cdc_slot",
+    #     publication_names: ["app_publication"]
+    #   )
+    #
+    #   runner.start do |payload, metadata|
+    #     puts "received #{payload.bytesize} bytes at #{metadata.wal_end_lsn}"
+    #   end
+    #
+    # @see Configuration
+    # @see Connection
+    # @see Stream
+    # @api public
+    class Runner
+      @configuration: untyped
+
+      @stopped: untyped
+
+      @running: untyped
+
+      @stream: untyped
+
+      @resume_lsn: untyped
+
+      @acked_lsn: untyped
+
+      @slot_created: untyped
+
+      @last_error: untyped
+
+      @reconnect_attempts: untyped
+
+      DEFAULT_RECONNECT_ATTEMPTS: 3
+
+      DEFAULT_RECONNECT_BACKOFF: ::Float
+
+      attr_reader configuration: untyped
+
+      attr_reader last_error: untyped
+
+      def initialize: (**untyped options) -> void
+
+      def start: () ?{ (?) -> untyped } -> untyped
+
+      def stop: () -> nil
+
+      def restart: () ?{ (?) -> untyped } -> untyped
+
+      def running?: () -> bool
+
+      def stopped?: () -> bool
+
+      def connected?: () -> bool
+
+      def ack: (untyped lsn) -> untyped
+
+      def monitor: () -> Pgoutput::Client::RunnerState
+
+      private
+
+      def setup_connection: (untyped connection) -> untyped
+
+      def run_stream_cycle: (untyped configuration) { (?) -> untyped } -> untyped
+
+      def configuration_for_resume: () -> untyped
+
+      def normalize_lsn_value: (untyped value) -> untyped
+
+      def current_lsn_string: (untyped value) -> untyped
+
+      def reconnect_backoff_for: (untyped attempts) -> untyped
+
+      def sleep: (untyped duration) -> untyped
+    end
+  end
+end

data/sig/pgoutput/client/state.rbs

@@ -0,0 +1,29 @@
+module Pgoutput
+  module Client
+    class RunnerStateData < Data
+      attr_reader running: bool
+      attr_reader stop_requested: bool
+      attr_reader connected: bool
+      attr_reader last_received_lsn: String?
+      attr_reader last_feedback_lsn: String?
+      attr_reader last_keepalive_at: Time?
+      attr_reader last_error: String?
+      attr_reader reconnect_attempts: Integer
+
+      def self.new: (
+        running: bool,
+        stop_requested: bool,
+        connected: bool,
+        last_received_lsn: String?,
+        last_feedback_lsn: String?,
+        last_keepalive_at: Time?,
+        last_error: String?,
+        reconnect_attempts: Integer
+      ) -> instance
+    end
+
+    class RunnerState < RunnerStateData
+      def stopped?: () -> bool
+    end
+  end
+end

data/sig/pgoutput/client/stream.rbs

@@ -0,0 +1,89 @@
+module Pgoutput
+  module Client
+    # Logical replication stream loop.
+    #
+    # `Stream` consumes PostgreSQL CopyData payloads from a {Connection}. It
+    # understands the two replication envelope message types used by PostgreSQL's
+    # streaming replication protocol:
+    #
+    # * `w` — XLogData, containing logical decoding plugin payload bytes.
+    # * `k` — primary keepalive, optionally requesting immediate feedback.
+    #
+    # The stream yields only XLogData plugin payloads. Keepalive messages are
+    # handled internally by updating the latest known WAL position and sending
+    # standby feedback when requested.
+    #
+    # @api private
+    class Stream
+      @connection: untyped
+
+      @configuration: untyped
+
+      @latest_lsn: untyped
+
+      @acked_lsn: untyped
+
+      @last_feedback_at: untyped
+
+      @last_keepalive_at: untyped
+
+      @running: untyped
+
+      @stop_requested: untyped
+
+      # Latest confirmed WAL position observed by this stream.
+      #
+      # @return [Integer]
+      attr_reader latest_lsn: untyped
+
+      attr_reader acked_lsn: untyped
+
+      attr_reader last_keepalive_at: untyped
+
+      # Build a stream loop.
+      #
+      # @param connection [Connection] replication connection
+      # @param configuration [Configuration] stream configuration
+      # @return [void]
+      def initialize: (connection: untyped, configuration: untyped, ?acked_lsn: untyped) -> void
+
+      # Start the stream loop.
+      #
+      # The method blocks while the stream is running. For every XLogData
+      # envelope, it yields the raw pgoutput payload and the parsed envelope
+      # metadata. When no CopyData payload is currently available, the loop
+      # pauses briefly before checking again.
+      #
+      # @yield [payload, metadata] called for each XLogData payload
+      # @yieldparam payload [String] frozen raw pgoutput payload bytes
+      # @yieldparam metadata [XLogData] parsed WAL envelope metadata
+      # @return [void]
+      # @raise [ArgumentError] if no block is provided
+      # @raise [ProtocolError] if an unknown or malformed replication message is
+      #   received
+      # @raise [ConnectionError] if standby feedback cannot be sent
+      def start: () ?{ (?) -> untyped } -> untyped
+
+      # Stop the stream loop after the current iteration.
+      #
+      # @return [void]
+      def stop: () -> nil
+
+      def running?: () -> bool
+
+      def ack: (untyped lsn) -> untyped
+
+      private
+
+      def process_copy_data: (untyped copy_data) { (untyped, untyped) -> untyped } -> untyped
+
+      def send_periodic_feedback: () -> (nil | untyped)
+
+      def send_feedback: (reply_requested: untyped) -> untyped
+
+      def normalize_lsn_value: (untyped value) -> untyped
+
+      def monotonic_time: () -> untyped
+    end
+  end
+end

data/sig/pgoutput/client/version.rbs

@@ -0,0 +1,8 @@
+module Pgoutput
+  module Client
+    # Current pgoutput-client gem version.
+    #
+    # @return [String]
+    VERSION: "0.1.0"
+  end
+end

data/sig/pgoutput/client/xlog_data.rbs

@@ -0,0 +1,63 @@
+module Pgoutput
+  module Client
+    class ReplicationXLogData < Data
+      attr_reader wal_start: Integer
+      attr_reader wal_end: Integer
+      attr_reader server_clock: Integer
+      attr_reader payload: String
+
+      def self.new: (
+        Integer wal_start,
+        Integer wal_end,
+        Integer server_clock,
+        String payload
+      ) -> instance
+    end
+
+    # Immutable XLogData replication envelope.
+    #
+    # PostgreSQL wraps logical decoding plugin output in an XLogData CopyData
+    # payload while streaming replication is active. The payload layout is:
+    #
+    # ```text
+    # Byte 0      : message tag `w`
+    # Bytes 1-8   : WAL start position, unsigned 64-bit big-endian
+    # Bytes 9-16  : WAL end position, unsigned 64-bit big-endian
+    # Bytes 17-24 : server clock, PostgreSQL timestamp format
+    # Bytes 25..  : logical decoding plugin payload
+    # ```
+    #
+    # Instances are created through {.parse} and made shareable so they can cross
+    # Ractor boundaries with their frozen payload bytes.
+    #
+    # @attr_reader wal_start [Integer] WAL position where this message begins
+    # @attr_reader wal_end [Integer] WAL position after this message
+    # @attr_reader server_clock [Integer] PostgreSQL server timestamp in
+    #   microseconds since 2000-01-01 UTC
+    # @attr_reader payload [String] frozen raw logical decoding plugin payload
+    class XLogData < ReplicationXLogData
+      # Parse an XLogData CopyData payload.
+      #
+      # @param bytes [String] raw CopyData payload beginning with `w`
+      # @return [XLogData] immutable parsed envelope
+      # @raise [ProtocolError] if the payload is empty, has the wrong message
+      #   tag, or is too short to contain the required fields
+      def self.parse: (untyped bytes) -> untyped
+
+      # Starting WAL position formatted as a PostgreSQL LSN string.
+      #
+      # @return [String]
+      def wal_start_lsn: () -> untyped
+
+      # Ending WAL position formatted as a PostgreSQL LSN string.
+      #
+      # @return [String]
+      def wal_end_lsn: () -> untyped
+
+      # @param binary [String]
+      # @param offset [Integer]
+      # @return [Integer]
+      def self.unpack_u64: (untyped binary, untyped offset) -> untyped
+    end
+  end
+end

metadata

@@ -1,15 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: pgoutput-client
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ken C. Demanawa
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
-description: Write a longer description or delete this line.
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Transport-only PostgreSQL logical replication client for receiving pgoutput
+  CopyData payloads.
 email:
 - kenneth.c.demanawa@gmail.com
 executables: []
@@ -17,20 +32,44 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/pgoutput/client.rb
+- lib/pgoutput/client/commands.rb
+- lib/pgoutput/client/configuration.rb
+- lib/pgoutput/client/connection.rb
+- lib/pgoutput/client/errors.rb
+- lib/pgoutput/client/feedback.rb
+- lib/pgoutput/client/keepalive.rb
+- lib/pgoutput/client/lsn.rb
+- lib/pgoutput/client/runner.rb
+- lib/pgoutput/client/state.rb
+- lib/pgoutput/client/stream.rb
 - lib/pgoutput/client/version.rb
-- sig/pgoutput/client.rbs
-homepage: https://github.com/kanutocd/pgoutput-client
+- lib/pgoutput/client/xlog_data.rb
+- lib/pgoutput_client.rb
+- sig/pg.rbs
+- sig/pgoutput/client/commands.rbs
+- sig/pgoutput/client/configuration.rbs
+- sig/pgoutput/client/connection.rbs
+- sig/pgoutput/client/errors.rbs
+- sig/pgoutput/client/feedback.rbs
+- sig/pgoutput/client/keepalive.rbs
+- sig/pgoutput/client/lsn.rbs
+- sig/pgoutput/client/runner.rbs
+- sig/pgoutput/client/state.rbs
+- sig/pgoutput/client/stream.rbs
+- sig/pgoutput/client/version.rbs
+- sig/pgoutput/client/xlog_data.rbs
+homepage: https://kanutocd.github.io/pgoutput-client/
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/kanutocd/pgoutput-client
+  homepage_uri: https://kanutocd.github.io/pgoutput-client/
   source_code_uri: https://github.com/kanutocd/pgoutput-client
   changelog_uri: https://github.com/kanutocd/pgoutput-client/blob/main/CHANGELOG.md
+  documentation_uri: https://kanutocd.github.io/pgoutput-client/
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -45,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: PostgreSQL pgoutput logical replication transport client.
 test_files: []

data/CODE_OF_CONDUCT.md

@@ -1,10 +0,0 @@
-# Code of Conduct
-
-"pgoutput-client" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
-
-* Participants will be tolerant of opposing views.
-* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
-* When interpreting the words and actions of others, participants should always assume good intentions.
-* Behaviour which can be reasonably considered harassment will not be tolerated.
-
-If you have any concerns about behaviour within this project, please contact us at ["kenneth.c.demanawa@gmail.com"](mailto:"kenneth.c.demanawa@gmail.com").

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/sig/pgoutput/client.rbs

@@ -1,6 +0,0 @@
-module Pgoutput
-  module Client
-    VERSION: String
-    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-  end
-end