pg_ha_migrations 1.2.0 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36546429641ce670fa116d251f17993538b3ab60b5014c1917103e45b1fa0f45
-  data.tar.gz: 969078be676bc767aa8f325328da8aeda95b6120e620c5d8556bda639c94a3f4
+  metadata.gz: aa56359f3f0d8d56cc060ffbda09e40a234bbd80581de50d637caf8fc5ffb94b
+  data.tar.gz: e53c77e2a38349e16e8dd977747b0bb1691ed7a4643a7ae5dda26d05ef3cf71e
 SHA512:
-  metadata.gz: d2ee13eed929c6278cf745b6b4e4ecff210858e930f97be67d0db2ff4bd2efc65288cc2c80090343cb6cc3e2097c8e1fcf62955fddf442eced723660793706df
-  data.tar.gz: d1f0853d0d47774e889835716f6619097f3e56016e8997a7115e31c34e87dfc80b0871eee128161f4583247265afbfd9aeae752312dad4bb11a5dd5bf0946184
+  metadata.gz: ffca13e9164a6d1a82b03fcb521707aef486d78385db1e48f5c43d7702399316d1616a166e89e917f28c18f7aba06b3eec89316c34218ecab851599132b688c6
+  data.tar.gz: 657e725471a0caad6e100e0cb009f242b2af4d2eaf4385d65c02623e0366d57ff4d24a6dcc71ba1457e34f80f972d9c0a0704bf238f0442fa902df119440146c

data/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      matrix:
+        pg:
+          - 9.6
+          - 10
+          - 11
+          - 12
+        gemfile:
+          - rails_5.0
+          - rails_5.1
+          - rails_5.2
+          - rails_6.0
+    name: PostgreSQL ${{ matrix.pg }}
+    runs-on: ubuntu-latest
+    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+      ImageOS: ubuntu20
+    services:
+      postgresql:
+        image: postgres:${{ matrix.pg }}
+        env:
+          POSTGRES_PASSWORD: postgres
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Ruby using .ruby-version file
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - run: bundle exec rake spec

data/.ruby-version

@@ -1 +1 @@
-ruby-2.4.3
+ruby-2.7

data/.travis.yml

@@ -1,16 +1,27 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4
+  - 2.5
+env:
+  jobs:
+    - PGVERSION: "9.6"
+    - PGVERSION: "10"
+    - PGVERSION: "11"
+    - PGVERSION: "12"
 services:
   - postgresql
-addons:
-  postgresql: "9.6"
 before_install:
+  - "for CLUSTER_VERSION in $(pg_lsclusters -h | cut -d' ' -f1); do sudo pg_dropcluster $CLUSTER_VERSION main --stop || true; done"
+  - sudo apt-get update
+  - sudo apt-get -y install postgresql-$PGVERSION postgresql-client-$PGVERSION postgresql-server-dev-$PGVERSION postgresql-client-common postgresql-common
+  - sudo pg_dropcluster $PGVERSION main --stop || true
+  - sudo pg_createcluster $PGVERSION main -D /var/ramfs/postgresql/11/main -- --auth=trust
+  - sudo pg_ctlcluster start $PGVERSION main
   - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
   - gem install bundler -v 1.15.4
 gemfile:
   - gemfiles/rails_5.0.gemfile
   - gemfiles/rails_5.1.gemfile
   - gemfiles/rails_5.2.gemfile
+  - gemfiles/rails_6.0.gemfile
 script: "bundle exec rake spec"

data/Appraisals

@@ -10,3 +10,7 @@ appraise "rails-5.2" do
   gem "rails", "5.2.3"
 end
 
+appraise "rails-6.0" do
+  gem "rails", "6.0.0"
+end
+

data/README.md

@@ -55,7 +55,7 @@ There are two major classes of concerns we try to handle in the API:
 
 We rename migration methods with prefixes denoting their safety level:
 
-- `safe_*`: These methods check for both application and database safety concerns prefer concurrent operations where available, set low lock timeouts where appropriate, and decompose operations into multiple safe steps.
+- `safe_*`: These methods check for both application and database safety concerns, prefer concurrent operations where available, set low lock timeouts where appropriate, and decompose operations into multiple safe steps.
 - `unsafe_*`: These methods are generally a direct dispatch to the native ActiveRecord migration method.
 
 Calling the original migration methods without a prefix will raise an error.
@@ -106,6 +106,18 @@ Safely add a new enum value.
 safe_add_enum_value :enum, "value"
 ```
 
+#### unsafe\_rename\_enum\_value
+
+Unsafely change the value of an enum type entry.
+
+```ruby
+unsafe_rename_enum_value(:enum, "old_value", "new_value")
+```
+
+Note:
+
+Changing an enum value does not issue any long-running scans or acquire locks on usages of the enum type. Therefore multiple queries within a transaction concurrent with the change may see both the old and new values. To highlight these potential pitfalls no `safe_rename_enum_value` equivalent exists. Before modifying an enum type entry you should verify that no concurrently executing queries will attempt to write the old value and that read queries understand the new value.
+
 #### safe\_add\_column
 
 Safely add a column.
@@ -283,7 +295,7 @@ Rake::Task["pg_ha_migrations:check_blocking_database_transactions"].enhance ["db
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies and start a postgres docker container. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies and start a postgres docker container. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. This project uses Appraisal to test against multiple versions of ActiveRecord; you can run the tests against all supported version with `bundle exec appraisal rspec`.
 
 Running tests will automatically create a test database in the locally running Postgres server. You can find the connection parameters in `spec/spec_helper.rb`, but setting the environment variables `PGHOST`, `PGPORT`, `PGUSER`, and `PGPASSWORD` will override the defaults.
 

data/bin/setup

@@ -4,6 +4,7 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
+bundle exec appraisal install
 
 # Do any other automated setup that you need to do here
 

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "6.0.0"
+
+gemspec path: "../"

data/lib/pg_ha_migrations.rb

@@ -57,8 +57,8 @@ module PgHaMigrations::AutoIncluder
   def inherited(klass)
     super(klass) if defined?(super)
 
-    klass.prepend(PgHaMigrations::SafeStatements)
     klass.prepend(PgHaMigrations::UnsafeStatements)
+    klass.prepend(PgHaMigrations::SafeStatements)
   end
 end
 

data/lib/pg_ha_migrations/allowed_versions.rb

@@ -1,7 +1,7 @@
 require "active_record/migration/compatibility"
 
 module PgHaMigrations::AllowedVersions
-  ALLOWED_VERSIONS = [4.2, 5.0, 5.1, 5.2].map do |v|
+  ALLOWED_VERSIONS = [4.2, 5.0, 5.1, 5.2, 6.0].map do |v|
     begin
       ActiveRecord::Migration[v]
     rescue ArgumentError

data/lib/pg_ha_migrations/blocking_database_transactions.rb

@@ -25,13 +25,19 @@ module PgHaMigrations
     end
 
     def self.find_blocking_transactions(minimum_transaction_age = "0 seconds")
-      pid_column, query_column = if ActiveRecord::Base.connection.select_value("SHOW server_version") =~ /9\.1/
+      postgres_version = ActiveRecord::Base.connection.postgresql_version
+      pid_column, query_column = if postgres_version < 9_02_00
         ["procpid", "current_query"]
       else
         ["pid", "query"]
       end
 
-      raw_query = <<-SQL
+      # In some versions of Postgres, walsenders show up here with a non-null xact_start.
+      # That's been patched, so hard to test, but we should exclude them anyway.
+      # https://www.postgresql.org/message-id/flat/20191209234409.exe7osmyalwkt5j4%40development
+      ignore_sqlsender_sql = "psa.backend_type != 'walsender'"
+
+      raw_query = <<~SQL
         SELECT
           psa.datname as database, -- Will only ever be one database
           psa.#{query_column} as current_query,
@@ -59,6 +65,7 @@ module PgHaMigrations
           )
           AND psa.xact_start < clock_timestamp() - ?::interval
           AND psa.#{query_column} !~ ?
+          #{postgres_version >= 10_00_00 ? "AND #{ignore_sqlsender_sql}" : ""}
         GROUP BY psa.datname, psa.#{query_column}, psa.state, psa.xact_start
       SQL
 

data/lib/pg_ha_migrations/blocking_database_transactions_reporter.rb

@@ -24,7 +24,7 @@ module PgHaMigrations
         end
 
         if blocking_transactions.any?(&:concurrent_index_creation?)
-          report << <<-eos.strip_heredoc.lines.map { |line| "\t#{line}" }.join
+          report << <<~eos.lines.map { |line| "\t#{line}" }.join
             Warning: concurrent indexes are currently being built. If you have any other
                      migrations in this deploy that will attempt to create additional
                      concurrent indexes on the same physical database (even if the table

data/lib/pg_ha_migrations/safe_statements.rb

@@ -25,9 +25,21 @@ module PgHaMigrations::SafeStatements
     unsafe_execute("ALTER TYPE #{PG::Connection.quote_ident(name.to_s)} ADD VALUE '#{PG::Connection.escape_string(value)}'")
   end
 
+  def unsafe_rename_enum_value(name, old_value, new_value)
+    if ActiveRecord::Base.connection.postgresql_version < 10_00_00
+      raise PgHaMigrations::InvalidMigrationError, "Renaming an enum value is not supported on Postgres databases before version 10"
+    end
+
+    unsafe_execute("ALTER TYPE #{PG::Connection.quote_ident(name.to_s)} RENAME VALUE '#{PG::Connection.escape_string(old_value)}' TO '#{PG::Connection.escape_string(new_value)}'")
+  end
+
   def safe_add_column(table, column, type, options = {})
-    if options.has_key? :default
-      raise PgHaMigrations::UnsafeMigrationError.new(":default is NOT SAFE! Use safe_change_column_default afterwards then backfill the data to prevent locking the table")
+    if options.has_key?(:default)
+      if ActiveRecord::Base.connection.postgresql_version < 11_00_00
+        raise PgHaMigrations::UnsafeMigrationError.new(":default is NOT SAFE! Use safe_change_column_default afterwards then backfill the data to prevent locking the table")
+      elsif options[:default].is_a?(Proc) || (options[:default].is_a?(String) && !([:string, :text, :binary].include?(type.to_sym) || _type_is_enum(type)))
+        raise PgHaMigrations::UnsafeMigrationError.new(":default is not safe if the default value is volatile. Use safe_change_column_default afterwards then backfill the data to prevent locking the table")
+      end
     end
     if options[:null] == false
       raise PgHaMigrations::UnsafeMigrationError.new(":null => false is NOT SAFE if the table has data! If you _really_ want to do this, use unsafe_make_column_not_nullable")
@@ -66,6 +78,8 @@ module PgHaMigrations::SafeStatements
     # - If the column is text-like or binary, then we can allow anything in the default
     #   value since a Ruby string there will always coerce directly to the equivalent
     #   text/binary value rather than being interpreted as a DDL-time expression.
+    # - Custom enum types are a special case: they also are treated like strings by
+    #   Rails, so we want to allow those as-is.
     # - Otherwise, disallow any Ruby string values and instead require the Ruby object
     #   type that maps to the column type.
     #
@@ -78,7 +92,7 @@ module PgHaMigrations::SafeStatements
        (
          connection.quote_default_expression(default_value, column) == "NULL" ||
          (
-           ![:string, :text, :binary].include?(column.sql_type_metadata.type) &&
+           ![:string, :text, :binary, :enum].include?(column.sql_type_metadata.type) &&
            default_value.is_a?(String)
          )
        )
@@ -199,6 +213,10 @@ module PgHaMigrations::SafeStatements
     raise PgHaMigrations::UnsupportedAdapter, "This gem only works with the #{expected_adapter} adapter, found #{actual_adapter} instead" unless actual_adapter == expected_adapter
   end
 
+  def _type_is_enum(type)
+    ActiveRecord::Base.connection.select_values("SELECT typname FROM pg_type JOIN pg_enum ON pg_type.oid = pg_enum.enumtypid").include?(type.to_s)
+  end
+
   def migrate(direction)
     if respond_to?(:change)
       raise PgHaMigrations::UnsupportedMigrationError, "Tracking changes for automated rollback is not supported; use explicit #up instead."

data/lib/pg_ha_migrations/unsafe_statements.rb

@@ -39,7 +39,6 @@ module PgHaMigrations::UnsafeStatements
   delegate_unsafe_method_to_migration_base_class :change_column
   delegate_unsafe_method_to_migration_base_class :change_column_default
   delegate_unsafe_method_to_migration_base_class :remove_column
-  delegate_unsafe_method_to_migration_base_class :add_index
   delegate_unsafe_method_to_migration_base_class :execute
   delegate_unsafe_method_to_migration_base_class :remove_index
   delegate_unsafe_method_to_migration_base_class :add_foreign_key
@@ -69,6 +68,16 @@ module PgHaMigrations::UnsafeStatements
     execute_ancestor_statement(:create_table, table, options, &block)
   end
 
+  def unsafe_add_index(table, column_names, options = {})
+    if ((ActiveRecord::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR >= 2) || ActiveRecord::VERSION::MAJOR > 5) &&
+        column_names.is_a?(String) && /\W/.match?(column_names) && options.key?(:opclass)
+      raise PgHaMigrations::InvalidMigrationError, "ActiveRecord drops the :opclass option when supplying a string containing an expression or list of columns; instead either supply an array of columns or include the opclass in the string for each column"
+    end
+
+    execute_ancestor_statement(:add_index, table, column_names, options)
+  end
+
+
   def execute_ancestor_statement(method_name, *args, &block)
     # Dispatching here is a bit complicated: we need to execute the method
     # belonging to the first member of the inheritance chain (besides

data/lib/pg_ha_migrations/version.rb

@@ -1,3 +1,3 @@
 module PgHaMigrations
-  VERSION = "1.2.0"
+  VERSION = "1.2.5"
 end

data/pg_ha_migrations.gemspec

@@ -37,6 +37,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "appraisal", "~> 2.2.0"
 
-  spec.add_dependency "rails", ">= 5.0", "< 5.3"
-  spec.add_dependency "relation_to_struct"
+  spec.add_dependency "rails", ">= 5.0", "< 6.1"
+  spec.add_dependency "relation_to_struct", ">= 1.5.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_ha_migrations
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.5
 platform: ruby
 authors:
 - celeen
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-31 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -123,7 +123,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -133,21 +133,21 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: relation_to_struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.1
 description: Enforces DDL/migration safety in Ruby on Rails project with an emphasis
   on explicitly choosing trade-offs and avoiding unnecessary magic.
 email:
@@ -156,6 +156,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".pryrc"
 - ".rspec"
@@ -173,6 +174,7 @@ files:
 - gemfiles/rails_5.0.gemfile
 - gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.2.gemfile
+- gemfiles/rails_6.0.gemfile
 - lib/pg_ha_migrations.rb
 - lib/pg_ha_migrations/allowed_versions.rb
 - lib/pg_ha_migrations/blocking_database_transactions.rb
@@ -205,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Enforces DDL/migration safety in Ruby on Rails project with an emphasis on