pgoutput-client 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a179cfe8d0274992c3f3690f097d47e3b948002dcc30de7aa2b499d6e33a664
-  data.tar.gz: 4fe772473f4926b0586ae819dc47f68c9b9d84cd95de343ceddf43ea6be96052
+  metadata.gz: 3dd08a56a5b98573babde8d5aa72e02c44668877803a5272006879c28bd69ebd
+  data.tar.gz: c385343185a60a6304ecc276b5f6fac207cb5791fb8035823d863620b238ebda
 SHA512:
-  metadata.gz: 8f3bd156e1bd93334370744f148b719b27a97bee0becca0b10bc45a3eb088e952b0f57bfb2fbaae94d5f3b3d59c26e98a7e39921c176775cc2b1118d16ac253e
-  data.tar.gz: 8fc1960bf9ee93f6558b008dfdf8bf456026d8cf13909639a148a9e7d568ca7b64236d2a895110018deccae6a9213e39f7b0dac1a9b685a087c73eb477174c50
+  metadata.gz: 687bd8396cdf3b7a9e019c6cf2c7d584cfa2dcd273dcb5a4c662079d059c03aa2c55b487f9b1d8f58cc82ebfc36421d9d65c774f1fbb6ec6e65ba811418cb82e
+  data.tar.gz: 8d5e7c7a2b172084071006ca893e85fcff841539919bab78065a5a70d61fed89929dcd469b0837e959a164a7c3c882734bce24405c2660400c1f06b159e56401

data/CHANGELOG.md

@@ -1,5 +1,34 @@
-## [Unreleased]
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+### Added
+
+- Placeholder for future development.
+
+---
 
 ## [0.1.0] - 2026-05-31
 
-- Initial release
+### Added
+
+- Initial transport-only PostgreSQL logical replication client.
+- Added `Pgoutput::Client::Runner` facade.
+- Added immutable configuration object.
+- Added LSN parse and format helpers.
+- Added XLogData envelope parsing.
+- Added primary keepalive parsing.
+- Added standby feedback payload builder.
+- Added replication command builders.
+- Added `PG::Connection` wrapper.
+- Added logical replication stream loop.
+- Added RBS signatures.
+- Added Minitest test suite.
+- Added README and examples.
+
+### Notes
+
+This release intentionally does not parse pgoutput protocol messages or decode PostgreSQL values.

data/LICENSE.txt

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2026 Ken C. Demanawa
+Copyright (c) 2026 Kenneth C. Demanawa
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ 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 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,43 +1,336 @@
-# Pgoutput::Client
+# pgoutput-client
 
-TODO: Delete this and the text below, and describe your gem
+[![Gem Version](https://badge.fury.io/rb/pgoutput-client.svg)](https://badge.fury.io/rb/pgoutput-client)
+[![CI](https://github.com/kanutocd/pgoutput-client/workflows/CI/badge.svg)](https://github.com/kanutocd/pgoutput-client/actions)
+[![Coverage Status](https://codecov.io/gh/kanutocd/pgoutput-client/branch/main/graph/badge.svg)](https://codecov.io/gh/kanutocd/pgoutput-client)
+[![Ruby Version](https://img.shields.io/badge/ruby-%3E%3D%203.4-ruby.svg)](https://www.ruby-lang.org/en/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pgoutput/client`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+A transport-only PostgreSQL logical replication client for receiving raw `pgoutput` payloads in Ruby.
+
+`pgoutput-client` connects to PostgreSQL using logical replication, starts a `pgoutput` replication stream, receives `CopyData` messages, handles keepalives, sends standby feedback, and yields raw pgoutput payload bytes to downstream gems such as `pgoutput-parser` and `pgoutput-decoder`.
+
+It intentionally does **not** parse row-change messages or decode PostgreSQL values.
+
+---
+
+## Requirements
+
+- Ruby 3.4+
+- PostgreSQL 10+
+- `pg` gem
+- PostgreSQL publication and logical replication slot
+
+---
+
+## Ecosystem Position
+
+```text
+PostgreSQL logical replication
+        │
+        ▼
+pgoutput-client
+        │
+        ▼
+CopyData / pgoutput payloads
+        │
+        ▼
+pgoutput-parser
+        │
+        ▼
+Protocol messages
+        │
+        ▼
+pgoutput-decoder
+        │
+        ▼
+Decoded row events
+```
+
+`pgoutput-client` is the transport layer only.
+
+---
+
+## Features
+
+- Opens PostgreSQL logical replication connections
+- Builds replication commands
+- Supports `CREATE_REPLICATION_SLOT`
+- Supports `DROP_REPLICATION_SLOT`
+- Supports `START_REPLICATION SLOT ... LOGICAL ...`
+- Parses XLogData envelopes
+- Parses primary keepalive messages
+- Builds standby feedback messages
+- Provides LSN parse/format helpers
+- Yields raw pgoutput payload bytes
+- Includes RBS signatures
+- Includes Minitest coverage
+- No audit, parser, or decoder concerns
+
+---
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+```ruby
+gem "pgoutput-client"
+```
+
+Then:
+
+```bash
+bundle install
+```
+
+Require:
+
+```ruby
+require "pgoutput-client"
+```
+
+---
+
+## Quick Start
+
+```ruby
+require "pgoutput-client"
+
+client =
+  Pgoutput::Client::Runner.new(
+    database_url: ENV.fetch("DATABASE_URL"),
+    slot_name: "my_slot",
+    publication_names: ["my_publication"],
+    auto_create_slot: true
+  )
+
+client.start do |payload, metadata|
+  puts "WAL end: #{metadata.wal_end_lsn}"
+  puts "Raw pgoutput payload bytes: #{payload.bytesize}"
+end
+```
+
+---
+
+## Using With pgoutput-parser
+
+```ruby
+require "pgoutput-client"
+require "pgoutput"
+
+client = Pgoutput::Client::Runner.new(
+  database_url: ENV.fetch("DATABASE_URL"),
+  slot_name: "my_slot",
+  publication_names: ["my_publication"]
+)
+
+tracker = Pgoutput::RelationTracker.new
+
+client.start do |payload, metadata|
+  message = tracker.process(payload)
+  p [metadata.wal_end_lsn, message]
+end
+```
+
+---
+
+## Using With pgoutput-decoder
+
+```ruby
+require "pgoutput-client"
+require "pgoutput"
+require "pgoutput/decoder"
+
+tracker = Pgoutput::RelationTracker.new
+decoder = Pgoutput::Decoder.new
+
+client.start do |payload, metadata|
+  protocol_message = tracker.process(payload)
+  event = decoder.decode(protocol_message)
+  p [metadata.wal_end_lsn, event]
+end
+```
+
+---
+
+## What This Gem Does
+
+```text
+PostgreSQL replication connection
+        │
+        ▼
+CopyData stream
+        │
+        ▼
+XLogData / Keepalive handling
+        │
+        ▼
+Raw pgoutput payloads
+```
+
+It owns:
+
+- Replication connection setup
+- Replication command generation
+- CopyData reading
+- XLogData envelope parsing
+- Keepalive handling
+- Standby status feedback
+- LSN conversion
+
+---
+
+## What This Gem Does Not Do
+
+It does not:
+
+- Parse pgoutput row messages
+- Decode PostgreSQL OIDs
+- Build application events
+- Group transactions
+- Run processor pipelines
+- Manage Ractor worker pools
+- Store audit records
+
+Those responsibilities belong to higher layers.
 
-Install the gem and add to the application's Gemfile by executing:
+---
+
+## Logical Replication Setup
+
+Example PostgreSQL setup:
+
+```sql
+ALTER SYSTEM SET wal_level = logical;
+
+CREATE PUBLICATION my_publication FOR TABLE users, posts;
+```
+
+Create a slot automatically:
+
+```ruby
+Pgoutput::Client::Runner.new(
+  database_url: ENV.fetch("DATABASE_URL"),
+  slot_name: "my_slot",
+  publication_names: ["my_publication"],
+  auto_create_slot: true
+)
+```
+
+Or create the slot yourself:
+
+```sql
+SELECT * FROM pg_create_logical_replication_slot('my_slot', 'pgoutput');
+```
+
+---
+
+## Public API
+
+### Pgoutput::Client::Runner
+
+High-level facade.
+
+```ruby
+client = Pgoutput::Client::Runner.new(...)
+client.start { |payload, metadata| ... }
+```
+
+### Pgoutput::Client::Configuration
+
+Immutable configuration object.
+
+### Pgoutput::Client::Connection
+
+Thin wrapper around `PG::Connection` for replication commands.
+
+### Pgoutput::Client::Stream
+
+Consumes CopyData messages and yields pgoutput payloads.
+
+### Pgoutput::Client::LSN
+
+```ruby
+Pgoutput::Client::LSN.parse("0/16B6C50")
+Pgoutput::Client::LSN.format(23_817_296)
+```
+
+### Pgoutput::Client::XLogData
+
+Represents a WAL data envelope.
+
+### Pgoutput::Client::Keepalive
+
+Represents a primary keepalive message.
+
+### Pgoutput::Client::Feedback
+
+Builds standby status update payloads.
+
+---
+
+## Ractor Position
+
+The replication connection itself is stateful and ordered. It should normally run as a single reader.
+
+Downstream parsing, decoding, and processing can be parallelized with Ractors:
+
+```text
+pgoutput-client reader
+        │
+        ▼
+Ractor-safe queue
+        │
+        ▼
+parser / decoder / processor pools
+```
+
+---
+
+## Rake Tasks
+
+### Default
+
+Run them all
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle exec rake
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+### Code Linting and Formatting
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle exec rake rubocop
 ```
 
-## Usage
+### Testing
 
-TODO: Write usage instructions here
+```bash
+bundle exec rake test
+```
 
-## Development
+With coverage:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```bash
+COVERAGE=true bundle exec rake test
+```
+---
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Type Checking
 
-## Contributing
+```bash
+bundle exec rbs:validate
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pgoutput-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/pgoutput-client/blob/main/CODE_OF_CONDUCT.md).
+---
 
-## License
+### Documentation
+
+```bash
+bundle exec rake yard
+```
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+---
 
-## Code of Conduct
+## License
 
-Everyone interacting in the Pgoutput::Client project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pgoutput-client/blob/main/CODE_OF_CONDUCT.md).
+MIT.

data/lib/pgoutput/client/commands.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Pgoutput
+  module Client
+    # SQL command builders for PostgreSQL replication-mode commands.
+    #
+    # PostgreSQL replication commands are issued on a connection opened with the
+    # replication parameter enabled. The methods in this module render the small
+    # command subset needed by `pgoutput-client` and rely on {Configuration} to
+    # validate identifier-like values before interpolation.
+    #
+    # @api private
+    module Commands
+      module_function
+
+      # Render a `CREATE_REPLICATION_SLOT` command.
+      #
+      # Temporary slots are requested only when
+      # {Configuration#temporary_slot} is true.
+      #
+      # @example Permanent slot
+      #   Commands.create_replication_slot(config)
+      #   # => "CREATE_REPLICATION_SLOT cdc_slot LOGICAL pgoutput"
+      #
+      # @param configuration [Configuration] replication configuration
+      # @return [String] SQL command suitable for `PG::Connection#exec`
+      def create_replication_slot(configuration)
+        temporary = configuration.temporary_slot ? " TEMPORARY" : ""
+        "CREATE_REPLICATION_SLOT #{configuration.slot_name}#{temporary} LOGICAL #{configuration.plugin}"
+      end
+
+      # Render a `DROP_REPLICATION_SLOT` command.
+      #
+      # @param configuration [Configuration] replication configuration
+      # @return [String] SQL command suitable for `PG::Connection#exec`
+      def drop_replication_slot(configuration)
+        "DROP_REPLICATION_SLOT #{configuration.slot_name}"
+      end
+
+      # Render a `START_REPLICATION SLOT ... LOGICAL ...` command.
+      #
+      # The command includes the pgoutput options required by PostgreSQL:
+      # `proto_version` and `publication_names`. Optional pgoutput switches such
+      # as `binary` and `messages` are emitted only when enabled.
+      #
+      # @param configuration [Configuration] replication configuration
+      # @return [String] SQL command suitable for `PG::Connection#exec`
+      def start_replication(configuration)
+        options = {
+          "proto_version" => configuration.proto_version.to_s,
+          "publication_names" => configuration.publication_names.join(","),
+          "binary" => configuration.binary ? "true" : nil,
+          "messages" => configuration.messages ? "true" : nil
+        }.compact
+
+        rendered_options = options.map { |key, value| %("#{key}" '#{value}') }.join(", ")
+
+        "START_REPLICATION SLOT #{configuration.slot_name} LOGICAL #{configuration.start_lsn_string} (#{rendered_options})"
+      end
+    end
+  end
+end

data/lib/pgoutput/client/configuration.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+module Pgoutput
+  module Client
+    # Immutable configuration for a PostgreSQL logical replication stream.
+    #
+    # A configuration describes how `pgoutput-client` should connect to
+    # PostgreSQL and how it should request logical replication from the server.
+    # It deliberately contains transport-level settings only; parsing pgoutput
+    # records and decoding PostgreSQL values belong to downstream layers.
+    #
+    # The object freezes itself and its string/array attributes during
+    # initialization so it can be safely shared by transport components without
+    # defensive copying.
+    #
+    # @example Minimal configuration
+    #   config = Pgoutput::Client::Configuration.new(
+    #     database_url: "postgres://localhost/app",
+    #     slot_name: "cdc_slot",
+    #     publication_names: "app_publication"
+    #   )
+    #
+    # @example Start from a known LSN and request binary values from pgoutput
+    #   config = Pgoutput::Client::Configuration.new(
+    #     database_url: ENV.fetch("DATABASE_URL"),
+    #     slot_name: "cdc_slot",
+    #     publication_names: %w[app_publication],
+    #     start_lsn: "0/16B6C50",
+    #     binary: true
+    #   )
+    #
+    # @api public
+    class Configuration
+      # Default logical decoding output plugin.
+      #
+      # @return [String]
+      DEFAULT_PLUGIN = "pgoutput"
+
+      # Default pgoutput protocol version.
+      #
+      # @return [Integer]
+      DEFAULT_PROTO_VERSION = 1
+
+      # Default interval, in seconds, between standby status feedback messages.
+      #
+      # @return [Float]
+      DEFAULT_FEEDBACK_INTERVAL = 10.0
+
+      # @!attribute [r] database_url
+      #   PostgreSQL connection URL.
+      #   @return [String]
+      # @!attribute [r] slot_name
+      #   Logical replication slot name.
+      #   @return [String]
+      # @!attribute [r] publication_names
+      #   Publication names requested from pgoutput.
+      #   @return [Array<String>]
+      # @!attribute [r] start_lsn
+      #   Optional normalized starting LSN.
+      #   @return [String, nil]
+      # @!attribute [r] plugin
+      #   Logical decoding output plugin name.
+      #   @return [String]
+      # @!attribute [r] proto_version
+      #   pgoutput protocol version.
+      #   @return [Integer]
+      # @!attribute [r] binary
+      #   Whether to request binary column values from pgoutput.
+      #   @return [Boolean]
+      # @!attribute [r] messages
+      #   Whether to request logical decoding messages from pgoutput.
+      #   @return [Boolean]
+      # @!attribute [r] auto_create_slot
+      #   Whether the client should create the slot before streaming.
+      #   @return [Boolean]
+      # @!attribute [r] temporary_slot
+      #   Whether a newly created slot should be temporary.
+      #   @return [Boolean]
+      # @!attribute [r] feedback_interval
+      #   Standby feedback interval in seconds.
+      #   @return [Float]
+      attr_reader :database_url,
+                  :slot_name,
+                  :publication_names,
+                  :start_lsn,
+                  :plugin,
+                  :proto_version,
+                  :binary,
+                  :messages,
+                  :auto_create_slot,
+                  :temporary_slot,
+                  :feedback_interval
+
+      # Build and validate a logical replication stream configuration.
+      #
+      # `slot_name` and every publication name are intentionally limited to
+      # simple PostgreSQL identifier-like strings. This keeps command rendering
+      # small and predictable while avoiding quoting rules in this transport
+      # layer.
+      #
+      # Boolean options are normalized with Ruby truthiness. `nil` and `false`
+      # become `false`; all other values become `true`.
+      #
+      # @param database_url [#to_s] PostgreSQL connection URL
+      # @param slot_name [#to_s] logical replication slot name
+      # @param publication_names [Array<#to_s>, #to_s] one or more publication
+      #   names to pass to pgoutput
+      # @param start_lsn [String, Integer, nil] starting LSN as a PostgreSQL LSN
+      #   string, an integer WAL position, or `nil` for `0/0`
+      # @param plugin [#to_s] logical decoding plugin name
+      # @param proto_version [#to_int, #to_s] pgoutput protocol version
+      # @param binary [Object] truthy to request binary column values
+      # @param messages [Object] truthy to request logical decoding messages
+      # @param auto_create_slot [Object] truthy to create the slot before
+      #   starting replication
+      # @param temporary_slot [Object] truthy to create a temporary replication
+      #   slot when `auto_create_slot` is enabled
+      # @param feedback_interval [#to_f, #to_s] seconds between periodic standby
+      #   feedback messages
+      # @return [void]
+      # @raise [ConfigurationError] if publication names are empty or numeric
+      #   settings are invalid
+      # @raise [ArgumentError] if `start_lsn`, `proto_version`, or
+      #   `feedback_interval` cannot be coerced
+      def initialize(database_url:,
+                     slot_name:,
+                     publication_names:,
+                     start_lsn: nil,
+                     plugin: DEFAULT_PLUGIN,
+                     proto_version: DEFAULT_PROTO_VERSION,
+                     binary: false,
+                     messages: false,
+                     auto_create_slot: false,
+                     temporary_slot: false,
+                     feedback_interval: DEFAULT_FEEDBACK_INTERVAL)
+        @database_url = String(database_url).freeze
+        @slot_name = validate_identifier(slot_name, "slot_name").freeze
+        @publication_names = Array(publication_names).map do |name|
+          validate_identifier(name, "publication_name").freeze
+        end.freeze
+        @start_lsn = normalize_lsn(start_lsn).freeze
+        @plugin = String(plugin).freeze
+        @proto_version = Integer(proto_version)
+        @binary = boolean(binary, "binary")
+        @messages = boolean(messages, "messages")
+        @auto_create_slot = boolean(auto_create_slot, "auto_create_slot")
+        @temporary_slot = boolean(temporary_slot, "temporary_slot")
+        @feedback_interval = Float(feedback_interval)
+
+        validate!
+        freeze
+      end
+
+      # Starting LSN to render in `START_REPLICATION`.
+      #
+      # @return [String] normalized LSN string, defaulting to `"0/0"`
+      def start_lsn_string
+        start_lsn || "0/0"
+      end
+
+      private
+
+      def validate!
+        raise ConfigurationError, "publication_names must not be empty" if publication_names.empty?
+        raise ConfigurationError, "proto_version must be positive" unless proto_version.positive?
+        raise ConfigurationError, "feedback_interval must be positive" unless feedback_interval.positive?
+      end
+
+      def normalize_lsn(value)
+        return nil if value.nil?
+        return LSN.format(value) if value.is_a?(Integer)
+
+        LSN.format(LSN.parse(String(value)))
+      end
+
+      def validate_identifier(value, field)
+        string = String(value)
+        unless string.match?(/\A[a-zA-Z_][a-zA-Z0-9_]*\z/)
+          raise ConfigurationError, "#{field} must be a PostgreSQL identifier-like string"
+        end
+
+        string
+      end
+
+      # Boolean type checking helper
+      def boolean(value, name)
+        return true if value == true
+        return false if value == false
+
+        raise ArgumentError, "#{name} must be true or false"
+      end
+    end
+  end
+end