pg_easy_replicate 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63ce4d3c583c90660cde52a6f0f138891af2b3eb6a2ccee039cbb57931a9a9aa
-  data.tar.gz: f2d8914e131a7eeaa0799c82f6d96ff4c4d765902fc0eed773927d58f8eae38d
+  metadata.gz: 15886c32380f5cc412bc1d577795d9650381703050445523966533a8f11f6b30
+  data.tar.gz: dbe671357959ec3b75e2b56f09e55ef48d9f316028c9d7cd96909a0bdde65916
 SHA512:
-  metadata.gz: ec486fbc867215ea81e25f0fd001f0036d74d222a8782ea7525cd938e76cc782288ad42f90b878d9ddb95b00c20887d7e5ef29fb20b04f04451a6a0b59d495d7
-  data.tar.gz: d8704fef89664ce130801ccc4e9c8974fcc922e56e7570fc9260702c54da1fe366cbbede1b9c9f1da5aeb3d5ce5a27e1d991fdab1454f4ee7cf4d24af8684825
+  metadata.gz: 650cd861e5e69039024753fb02d87957faa9bfc0ffe1fc965eea29f5fd5eb5a60c54a4e94793949dcaf5d44a1387adac9585a8ebb43457a179ebe3f4f843e2d7
+  data.tar.gz: be238ebb8857e2cd83ea944ab3e0cac15e5fe5e0d85fc84b745dfbdc16548c2e2c9f569ea559b3ca813d8314d6f7d2e0f1558f9310b5bc68a202957f293d4d2c

data/.rubocop.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-rspec
   - rubocop-rake
   - rubocop-performance
@@ -211,8 +211,9 @@ RSpec/DescribeClass:
 RSpec/DescribedClass:
   Enabled: false
 
-RSpec/FilePath:
-  Enabled: false
+# RSpec/FilePath is replaced by RSpec/SpecFilePathFormat and RSpec/SpecFilePathSuffix
+# RSpec/FilePath:
+#   Enabled: false
 
 RSpec/IdenticalEqualityAssertion:
   Enabled: false
@@ -232,9 +233,6 @@ RSpec/NestedGroups:
 RSpec/PredicateMatcher:
   Enabled: false
 
-RSpec/Rails/HttpStatus:
-  Enabled: false
-
 RSpec/RepeatedExampleGroupDescription:
   Enabled: false
 

data/.ruby-version

@@ -1 +1 @@
-3.1.4
+3.4.4

data/Dockerfile

@@ -1,7 +1,22 @@
-FROM ruby:3.1.4
+FROM ruby:3.4.4-slim
 
 ARG VERSION
 
-RUN apt-get update && apt-get install postgresql-client -y
+RUN apt-get update && \
+  apt-get install -y --no-install-recommends \
+  wget \
+  gnupg2 \
+  lsb-release \
+  build-essential \
+  libpq-dev \
+  && wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | gpg --dearmor -o /usr/share/keyrings/postgresql-keyring.gpg && \
+  echo "deb [signed-by=/usr/share/keyrings/postgresql-keyring.gpg] http://apt.postgresql.org/pub/repos/apt/ $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list && \
+  apt-get update && \
+  apt-get install -y --no-install-recommends postgresql-client && \
+  gem install pg_easy_replicate -v $VERSION && \
+  apt-get remove -y wget gnupg2 lsb-release && \
+  apt-get autoremove -y && \
+  apt-get clean && \
+  rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
 RUN pg_dump --version
-RUN gem install pg_easy_replicate -v $VERSION

data/Gemfile.lock

@@ -1,101 +1,104 @@
 PATH
   remote: .
   specs:
-    pg_easy_replicate (0.3.7)
+    pg_easy_replicate (0.4.0)
       ougai (~> 2.0.0)
-      pg (~> 1.5.3)
-      pg_query (~> 5.1.0)
-      sequel (>= 5.69, < 5.87)
-      thor (>= 1.2.2, < 1.4.0)
+      pg (>= 1.5.3, < 1.7.0)
+      pg_query (>= 5.1, < 6.2)
+      sequel (>= 5.69, < 5.98)
+      thor (>= 1.2.2, < 1.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    bigdecimal (3.1.8)
+    ast (2.4.3)
+    bigdecimal (3.3.1)
     coderay (1.1.3)
-    diff-lcs (1.5.1)
-    google-protobuf (4.28.2-arm64-darwin)
+    diff-lcs (1.6.2)
+    google-protobuf (4.33.0-arm64-darwin)
       bigdecimal
       rake (>= 13)
-    google-protobuf (4.28.2-x86_64-linux)
+    google-protobuf (4.33.0-x86_64-linux-gnu)
       bigdecimal
       rake (>= 13)
-    haml (6.1.1)
+    haml (6.3.0)
       temple (>= 0.8.2)
       thor
       tilt
-    json (2.8.2)
-    language_server-protocol (3.17.0.3)
+    json (2.15.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
     method_source (1.1.0)
-    oj (3.14.3)
+    oj (3.16.11)
+      bigdecimal (>= 3.0)
+      ostruct (>= 0.2)
+    ostruct (0.6.3)
     ougai (2.0.0)
       oj (~> 3.10)
-    parallel (1.26.3)
-    parser (3.3.6.0)
+    parallel (1.27.0)
+    parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
-    pg (1.5.9)
-    pg_query (5.1.0)
-      google-protobuf (>= 3.22.3)
+    pg (1.6.2-arm64-darwin)
+    pg (1.6.2-x86_64-linux)
+    pg_query (6.1.0)
+      google-protobuf (>= 3.25.3)
     prettier_print (1.2.1)
-    pry (0.15.0)
+    prism (1.6.0)
+    pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.2.1)
-    rbs (3.1.0)
-    regexp_parser (2.9.2)
-    rexml (3.3.9)
-    rspec (3.13.0)
+    rake (13.3.0)
+    rbs (3.9.5)
+      logger
+    regexp_parser (2.11.3)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
+    rspec-mocks (3.13.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.0)
-    rubocop (1.64.1)
+    rspec-support (3.13.6)
+    rubocop (1.81.6)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.36.1)
-      parser (>= 3.3.1.0)
-    rubocop-capybara (2.20.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
-      rubocop (~> 1.41)
-    rubocop-packaging (0.5.2)
-      rubocop (>= 1.33, < 2.0)
-    rubocop-performance (1.23.0)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rake (0.6.0)
-      rubocop (~> 1.0)
-    rubocop-rspec (2.29.1)
-      rubocop (~> 1.40)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
-      rubocop-rspec_rails (~> 2.28)
-    rubocop-rspec_rails (2.28.2)
-      rubocop (~> 1.40)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.47.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-packaging (0.6.0)
+      lint_roller (~> 1.1.0)
+      rubocop (>= 1.72.1, < 2.0)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.7.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
     ruby-progressbar (1.13.0)
-    sequel (5.86.0)
+    sequel (5.97.0)
       bigdecimal
-    syntax_tree (6.2.0)
+    syntax_tree (6.3.0)
       prettier_print (>= 1.2.0)
     syntax_tree-haml (4.0.3)
       haml (>= 5.2)
@@ -105,14 +108,18 @@ GEM
       prettier_print
       rbs
       syntax_tree (>= 2.0.1)
-    temple (0.10.1)
-    thor (1.3.2)
-    tilt (2.1.0)
-    unicode-display_width (2.6.0)
+    temple (0.10.4)
+    thor (1.4.0)
+    tilt (2.6.1)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-24
   x86_64-linux
+  x86_64-linux-gnu
 
 DEPENDENCIES
   pg_easy_replicate!

data/README.md

@@ -159,6 +159,11 @@ For AWS the special user role is `rds_superuser`, and for GCP it is `cloudsqlsup
 
 **Note**: The user in the connection url must be part of the special user role being supplied.
 
+**PostgreSQL 16+ Requirement**: Starting with PostgreSQL 16, if you're using `--special-user-role`, the user in your connection URL must have the `ADMIN OPTION` on that role. You can grant this with:
+```sql
+GRANT rds_superuser TO your_user WITH ADMIN OPTION;
+```
+
 #### Config Check
 
 ```bash
@@ -374,5 +379,5 @@ Next, you can set up a program that watches the `stats` and waits until `switcho
 PRs most welcome. You can get started locally by
 
 - `docker compose down -v && docker compose up --remove-orphans --build`
-- Install ruby `3.1.4` using RVM ([instruction](https://rvm.io/rvm/install#any-other-system))
+- Install ruby `3.4.4` using RVM ([instruction](https://rvm.io/rvm/install#any-other-system))
 - `bundle exec rspec` for specs

data/lib/pg_easy_replicate/ddl_audit.rb

@@ -171,18 +171,22 @@ module PgEasyReplicate
 
       def create_event_triggers(conn, group_name)
         sanitized_group_name = sanitize_identifier(group_name)
+
+        pg_version = conn.fetch("SHOW server_version_num").first[:server_version_num].to_i
+        execute_keyword = pg_version >= 110000 ? "FUNCTION" : "PROCEDURE"
+
         conn.run(<<~SQL)
           DROP EVENT TRIGGER IF EXISTS pger_ddl_trigger_#{sanitized_group_name};
           CREATE EVENT TRIGGER pger_ddl_trigger_#{sanitized_group_name} ON ddl_command_end
-          EXECUTE FUNCTION #{internal_schema_name}.pger_ddl_trigger_#{sanitized_group_name}();
+          EXECUTE #{execute_keyword} #{internal_schema_name}.pger_ddl_trigger_#{sanitized_group_name}();
 
           DROP EVENT TRIGGER IF EXISTS pger_drop_trigger_#{sanitized_group_name};
           CREATE EVENT TRIGGER pger_drop_trigger_#{sanitized_group_name} ON sql_drop
-          EXECUTE FUNCTION #{internal_schema_name}.pger_ddl_trigger_#{sanitized_group_name}();
+          EXECUTE #{execute_keyword} #{internal_schema_name}.pger_ddl_trigger_#{sanitized_group_name}();
 
           DROP EVENT TRIGGER IF EXISTS pger_table_rewrite_trigger_#{sanitized_group_name};
           CREATE EVENT TRIGGER pger_table_rewrite_trigger_#{sanitized_group_name} ON table_rewrite
-          EXECUTE FUNCTION #{internal_schema_name}.pger_ddl_trigger_#{sanitized_group_name}();
+          EXECUTE #{execute_keyword} #{internal_schema_name}.pger_ddl_trigger_#{sanitized_group_name}();
         SQL
       rescue => e
         abort_with("Creating event triggers failed: #{e.message}")

data/lib/pg_easy_replicate/stats.rb

@@ -122,7 +122,7 @@ module PgEasyReplicate
             .with_object(Hash.new(0)) do |state, counts|
               counts[state[:replication_state]] += 1
             end
-        result.keys.uniq.count == 1 &&
+        result.keys.uniq.one? &&
           result.keys.first == REPLICATION_STATE_MAP["r"]
       end
 

data/lib/pg_easy_replicate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgEasyReplicate
-  VERSION = "0.3.7"
+  VERSION = "0.4.0"
 end

data/lib/pg_easy_replicate.rb

@@ -166,8 +166,13 @@ module PgEasyReplicate
     def cleanup(options)
       cleanup_steps = [
         -> do
-          logger.info("Dropping groups table")
-          Group.drop
+          if options[:everything]
+            logger.info("Dropping groups table")
+            Group.drop
+          else
+            logger.info("Deleting group entry for #{options[:group_name]}")
+            Group.delete(options[:group_name])
+          end
         end,
         -> do
           if options[:restore_connection_on_source_db]
@@ -343,6 +348,18 @@ module PgEasyReplicate
       raise "Unable to check superuser conditions: #{e.message}"
     end
 
+    def get_pg_version(conn_string:)
+      sql = "SELECT version()"
+      result = Query.run(query: sql, connection_url: conn_string, user: db_user(conn_string))
+      version_string = result.first[:version]
+      # Extract major version number (e.g., "PostgreSQL 16.1..." -> 16)
+      version_match = version_string.match(/PostgreSQL (\d+)\./)
+      version_match ? version_match[1].to_i : nil
+    rescue => e
+      logger.warn("Unable to determine PostgreSQL version: #{e.message}")
+      nil
+    end
+
     def create_user(
       conn_string:,
       special_user_role: nil,
@@ -364,12 +381,11 @@ module PgEasyReplicate
         transaction: false,
       )
 
-      sql =
-        if special_user_role
-          "grant #{quote_ident(special_user_role)} to #{quote_ident(internal_user_name)};"
-        else
-          "alter user #{quote_ident(internal_user_name)} with superuser;"
-        end
+      sql = if special_user_role
+        "grant #{quote_ident(special_user_role)} to #{quote_ident(internal_user_name)};"
+      else
+        "alter user #{quote_ident(internal_user_name)} with superuser;"
+      end
 
       Query.run(
         query: sql,
@@ -378,16 +394,29 @@ module PgEasyReplicate
         transaction: false,
       )
 
-      return unless grant_permissions_on_schema
-      Query.run(
-        query:
-          "grant all on schema #{quote_ident(internal_schema_name)} to #{quote_ident(internal_user_name)}",
-        connection_url: conn_string,
-        user: db_user(conn_string),
-        transaction: false,
-      )
+      if grant_permissions_on_schema
+        Query.run(
+          query:
+            "grant all on schema #{quote_ident(internal_schema_name)} to #{quote_ident(internal_user_name)}",
+          connection_url: conn_string,
+          user: db_user(conn_string),
+          transaction: false,
+        )
+      end
     rescue => e
-      raise "Unable to create user: #{e.message}"
+      raise "Unable to create user: #{e.message}" unless special_user_role && e.message.include?("permission denied to grant role")
+
+      pg_version = get_pg_version(conn_string: conn_string)
+      version_info = if pg_version && pg_version >= 16
+        "PostgreSQL #{pg_version} requires"
+      else
+        "PostgreSQL 16+ requires"
+      end
+
+      raise "Unable to create user: #{e.message}. " \
+            "#{version_info} the user '#{db_user(conn_string)}' to have the ADMIN option on role '#{special_user_role}' to grant it to other users. " \
+            "Please ensure the user has been granted the role with ADMIN option: " \
+            "GRANT #{special_user_role} TO #{db_user(conn_string)} WITH ADMIN OPTION;"
     end
 
     def drop_user(conn_string:, user: internal_user_name)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pg_easy_replicate
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.0
 platform: ruby
 authors:
 - Shayon Mukherjee
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ougai
@@ -28,30 +27,42 @@ dependencies:
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: pg_query
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
@@ -61,7 +72,7 @@ dependencies:
         version: '5.69'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.87'
+        version: '5.98'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -71,7 +82,7 @@ dependencies:
         version: '5.69'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.87'
+        version: '5.98'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +92,7 @@ dependencies:
         version: 1.2.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -91,7 +102,7 @@ dependencies:
         version: 1.2.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: prettier_print
   requirement: !ruby/object:Gem::Requirement
@@ -305,8 +316,10 @@ homepage: https://github.com/shayonj/pg_easy_replicate
 licenses:
 - MIT
 metadata:
+  homepage_uri: https://github.com/shayonj/pg_easy_replicate
+  source_code_uri: https://github.com/shayonj/pg_easy_replicate
+  changelog_uri: https://github.com/shayonj/pg_easy_replicate/blob/main/CODE_OF_CONDUCT.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -321,8 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Easily setup logical replication and switchover to new database with minimal
   downtime