pgoutput-client 0.0.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a179cfe8d0274992c3f3690f097d47e3b948002dcc30de7aa2b499d6e33a664
-  data.tar.gz: 4fe772473f4926b0586ae819dc47f68c9b9d84cd95de343ceddf43ea6be96052
+  metadata.gz: 1413514b4a4dbe4f3c0f4c59744931ed865ca6faea5662f33844c0786a46e287
+  data.tar.gz: ebb972e2f0dd5a40f46161d6cd5be70df2f42db42e05862edf16f11e0f9a15ef
 SHA512:
-  metadata.gz: 8f3bd156e1bd93334370744f148b719b27a97bee0becca0b10bc45a3eb088e952b0f57bfb2fbaae94d5f3b3d59c26e98a7e39921c176775cc2b1118d16ac253e
-  data.tar.gz: 8fc1960bf9ee93f6558b008dfdf8bf456026d8cf13909639a148a9e7d568ca7b64236d2a895110018deccae6a9213e39f7b0dac1a9b685a087c73eb477174c50
+  metadata.gz: 7cb26f20d9a5a86c231956cb801c98b269aeebcf969dc2408b8ded3dbcae9a1b7995f88179480cbdd59c6f99b9d5df9d7910db78f0d84175d74fcc7e1ac6a0f5
+  data.tar.gz: 93a66bfe718e050fc636c77e78dcc1dd8c8bce064d64794f982944e9dc7a83ed261e3831a88d91ce1a6acb4c2498a5506135d815a8f6d278f5ff1fda168dc868

data/CHANGELOG.md

@@ -1,5 +1,40 @@
-## [Unreleased]
+# Changelog
+
+## Unreleased
+
+## [0.2.0] - 2026-06-16
+
+### Fixed
+
+- Remove the configurable plugin surface; this transport layer is fixed to `pgoutput`.
+- Wire `Pgoutput::Client::Runner#stop` to the active stream for cooperative shutdown.
+- Back off briefly when the replication socket has no `CopyData` ready instead of busy polling.
+- Retry live stream connection loss with backoff and resume from the latest confirmed WAL position.
+- Avoid recreating an existing replication slot during reconnect attempts.
+- Document the Docker-backed E2E workflow in the README and test skip hint.
+- Document that replay, checkpointing, deduplication, and sink ordering belong to downstream layers.
+- Add a live E2E reconnect test that restarts PostgreSQL mid-stream and verifies resume behavior.
+
+---
 
 ## [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,370 @@
-# 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)
+[![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
+- Own replay, checkpointing, deduplication, or sink ordering
+
+Those responsibilities belong to higher layers, especially `cdc-core` and the sink that materializes downstream state.
+
+## Failure Semantics
+
+If the live replication stream loses its connection, `pgoutput-client` retries a small number of times with a backoff and resumes from the latest confirmed WAL position.
+
+It does not decide replay policy, deduplication strategy, checkpoint storage, or exactly-once delivery. Those concerns belong to the downstream CDC runtime and sink layer.
+
+---
+
+## 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:
 
-Install the gem and add to the application's Gemfile by executing:
+```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 exec rake
+```
+
+### Code Linting and Formatting
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle exec rake rubocop
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+### Testing
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle exec rake test
 ```
 
-## Usage
+With coverage:
 
-TODO: Write usage instructions here
+```bash
+COVERAGE=true bundle exec rake test
+```
+---
 
-## Development
+### Type Checking
 
-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
+bundle exec rbs:validate
+```
 
-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).
+---
 
-## Contributing
+### Documentation
 
-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).
+```bash
+bundle exec rake yard
+```
 
-## License
+### End-to-End PostgreSQL
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Run the full Docker-backed E2E flow and clean up afterward:
 
-## Code of Conduct
+```bash
+script/test-e2e
+```
+
+Keep PostgreSQL running after the test for debugging:
+
+```bash
+KEEP_E2E_POSTGRES=1 script/test-e2e
+```
+
+You can also run the steps manually:
+
+```bash
+script/e2e-up
+PGOUTPUT_CLIENT_E2E=1 bundle exec rake test:e2e
+script/e2e-down
+```
+
+Equivalent Rake task:
+
+```bash
+bundle exec rake e2e:run
+```
+
+---
+
+## 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::DEFAULT_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