pg_ha_migrations 1.2.5 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa56359f3f0d8d56cc060ffbda09e40a234bbd80581de50d637caf8fc5ffb94b
-  data.tar.gz: e53c77e2a38349e16e8dd977747b0bb1691ed7a4643a7ae5dda26d05ef3cf71e
+  metadata.gz: a5eb93231a1de0f12819682bfe42606bf0cc49813a50b91670107f01eafe8f18
+  data.tar.gz: adcea5f591af66bb790118c562a0cab80dca009421529437d2586e6c0b957f01
 SHA512:
-  metadata.gz: ffca13e9164a6d1a82b03fcb521707aef486d78385db1e48f5c43d7702399316d1616a166e89e917f28c18f7aba06b3eec89316c34218ecab851599132b688c6
-  data.tar.gz: 657e725471a0caad6e100e0cb009f242b2af4d2eaf4385d65c02623e0366d57ff4d24a6dcc71ba1457e34f80f972d9c0a0704bf238f0442fa902df119440146c
+  metadata.gz: c7c827c5385b13a438a4a2cf1eaa1b7535e54e6d3293f67616849647706ca869a1362db4e102e66802f0930d450a09e3943d365a6b9d7481871c286c3fba1a36
+  data.tar.gz: 334f6c562b0b1288690ff6ec1033beb6676446f4c3a5d708d65de93884e85a65a863d985a37bc02a0c30046d34fbd289f9ac5cca50ada30a9e6d4fcdc0d977ac

data/.github/workflows/ci.yml

@@ -14,6 +14,8 @@ jobs:
           - rails_5.1
           - rails_5.2
           - rails_6.0
+          - rails_6.1
+          - rails_7.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

data/Appraisals

@@ -14,3 +14,10 @@ appraise "rails-6.0" do
   gem "rails", "6.0.0"
 end
 
+appraise "rails-6.1" do
+  gem "rails", "6.1.0"
+end
+
+appraise "rails-7.0" do
+  gem "rails", "7.0.0"
+end

data/README.md

@@ -148,6 +148,8 @@ safe_change_column_default :table, :column, -> { "NOW()" }
 safe_change_column_default :table, :column, -> { "'NOW()'" }
 ```
 
+Note: On Postgres 11+ adding a column with a constant default value does not rewrite or scan the table (under a lock or otherwise). In that case a migration adding a column with a default should do so in a single operation rather than the two-step `safe_add_column` followed by `safe_change_column_default`. We enforce this best practice with the error `PgHaMigrations::BestPracticeError`, but if your prefer otherwise (or are running in a mixed Postgres version environment), you may opt out by setting `config.prefer_single_step_column_addition_with_default = true` [in your configuration initializer](#configuration).
+
 #### safe\_make\_column\_nullable
 
 Safely make the column nullable.
@@ -272,6 +274,8 @@ end
 
 - `disable_default_migration_methods`: If true, the default implementations of DDL changes in `ActiveRecord::Migration` and the PostgreSQL adapter will be overridden by implementations that raise a `PgHaMigrations::UnsafeMigrationError`. Default: `true`
 - `check_for_dependent_objects`: If true, some `unsafe_*` migration methods will raise a `PgHaMigrations::UnsafeMigrationError` if any dependent objects exist. Default: `false`
+- `prefer_single_step_column_addition_with_default`: If `true`, raise an error when adding a column and separately setting a constant default value for that column in the same migration. Default: `false`
+- 'allow_force_create_table`: If false, the `force: true` option to ActiveRecord's `create_table` method is disallowed. Default: `true`
 
 ### Rake Tasks
 
@@ -299,7 +303,11 @@ After checking out the repo, run `bin/setup` to install dependencies and start a
 
 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.
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Note: if while releasing the gem you get the error ``Your rubygems.org credentials aren't set. Run `gem push` to set them.`` you can more simply run `gem signin`.
 
 ## Contributing
 

data/bin/setup

@@ -2,6 +2,9 @@
 set -euo pipefail
 IFS=$'\n\t'
 set -vx
+export PGPASSWORD="${PGPASSWORD:-postgres}"
+PGVERSION="${PGVERSION:-13}"
+
 
 bundle install
 bundle exec appraisal install
@@ -9,4 +12,4 @@ bundle exec appraisal install
 # Do any other automated setup that you need to do here
 
 # Launch a blank postgres image for testing
-docker run -d -p 127.0.0.1:5432:5432 postgres:10
+docker run -d -p 127.0.0.1:5432:5432 -e POSTGRES_PASSWORD="${PGPASSWORD}" postgres:${PGVERSION}

data/gemfiles/rails_6.1.gemfile

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

data/gemfiles/rails_7.0.gemfile

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

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, 6.0].map do |v|
+  ALLOWED_VERSIONS = [4.2, 5.0, 5.1, 5.2, 6.0, 6.1, 7.0].map do |v|
     begin
       ActiveRecord::Migration[v]
     rescue ArgumentError

data/lib/pg_ha_migrations/blocking_database_transactions.rb

@@ -49,10 +49,6 @@ module PgHaMigrations
           LEFT JOIN pg_class c ON ( -- Database wide
             l.locktype = 'relation'
             AND l.relation = c.oid
-            -- Be explicit about this being for a single database -- it's already implicit in
-            -- the relations used, and if we don't restrict this we could get incorrect results
-            -- with oid collisions from pg_namespace and pg_class.
-            AND l.database = (SELECT d.oid FROM pg_database d WHERE d.datname = current_database())
           )
           LEFT JOIN pg_namespace ns ON (c.relnamespace = ns.oid) -- Database wide
         WHERE psa.#{pid_column} != pg_backend_pid()
@@ -65,6 +61,10 @@ module PgHaMigrations
           )
           AND psa.xact_start < clock_timestamp() - ?::interval
           AND psa.#{query_column} !~ ?
+          -- Be explicit about this being for a single database -- it's already implicit in
+          -- the relations used, and if we don't restrict this we could get incorrect results
+          -- with oid collisions from pg_namespace and pg_class.
+          AND psa.datname = current_database()
           #{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/safe_statements.rb

@@ -1,4 +1,8 @@
 module PgHaMigrations::SafeStatements
+  def safe_added_columns_without_default_value
+    @safe_added_columns_without_default_value ||= []
+  end
+
   def safe_create_table(table, options={}, &block)
     if options[:force]
       raise PgHaMigrations::UnsafeMigrationError.new(":force is NOT SAFE! Explicitly call unsafe_drop_table first if you want to recreate an existing table")
@@ -34,17 +38,28 @@ module PgHaMigrations::SafeStatements
   end
 
   def safe_add_column(table, column, type, options = {})
+    # Note: we don't believe we need to consider the odd case where
+    # `:default => nil` or `:default => -> { null }` (or similar) is
+    # passed because:
+    # - It's OK to exclude that case with an "unnecessary" `raise`
+    #   below as it doesn't make semantic sense anyway.
+    # - If `:null => false` is also passed we are assuming Postgres's
+    #   seq scan of the table (to verify the NOT NULL constraint) will
+    #   short-circuit (though we have not confirmed that).
     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
+    elsif 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")
     end
 
+    unless options.has_key?(:default)
+      self.safe_added_columns_without_default_value << [table.to_s, column.to_s]
+    end
+
     unsafe_add_column(table, column, type, options)
   end
 
@@ -55,6 +70,12 @@ module PgHaMigrations::SafeStatements
   end
 
   def safe_change_column_default(table_name, column_name, default_value)
+    if PgHaMigrations.config.prefer_single_step_column_addition_with_default &&
+        ActiveRecord::Base.connection.postgresql_version >= 11_00_00 &&
+        self.safe_added_columns_without_default_value.include?([table_name.to_s, column_name.to_s])
+      raise PgHaMigrations::BestPracticeError, "On Postgres 11+ it's safe to set a constant default value when adding a new column; please set the default value as part of the column addition"
+    end
+
     column = connection.send(:column_for, table_name, column_name)
 
     # In 5.2 we have an edge whereby passing in a string literal with an expression

data/lib/pg_ha_migrations/version.rb

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

data/lib/pg_ha_migrations.rb

@@ -8,14 +8,16 @@ module PgHaMigrations
   Config = Struct.new(
     :disable_default_migration_methods,
     :check_for_dependent_objects,
-    :allow_force_create_table
+    :allow_force_create_table,
+    :prefer_single_step_column_addition_with_default
   )
 
   def self.config
     @config ||= Config.new(
       true,
       false,
-      true
+      true,
+      false
     )
   end
 
@@ -29,18 +31,24 @@ module PgHaMigrations
   # Safe versus unsafe in this context specifically means the following:
   # - Safe operations will not block for long periods of time.
   # - Unsafe operations _may_ block for long periods of time.
-  UnsafeMigrationError = Class.new(Exception)
+  UnsafeMigrationError = Class.new(StandardError)
 
   # Invalid migrations are operations which we expect to not function
   # as expected or get the schema into an inconsistent state
-  InvalidMigrationError = Class.new(Exception)
+  InvalidMigrationError = Class.new(StandardError)
+
+  # Operations violating a best practice, but not actually unsafe will
+  # raise this error. For example, adding a column without a default and
+  # then setting its default in a second action in a single migration
+  # isn't our documented best practice and will raise this error.
+  BestPracticeError = Class.new(Exception)
 
   # Unsupported migrations use ActiveRecord::Migration features that
   # we don't support, and therefore will likely have unexpected behavior.
-  UnsupportedMigrationError = Class.new(Exception)
+  UnsupportedMigrationError = Class.new(StandardError)
 
   # This gem only supports the PostgreSQL adapter at this time.
-  UnsupportedAdapter = Class.new(Exception)
+  UnsupportedAdapter = Class.new(StandardError)
 end
 
 require "pg_ha_migrations/blocking_database_transactions"

data/pg_ha_migrations.gemspec

@@ -29,14 +29,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pg"
-  spec.add_development_dependency "db-query-matchers", "~> 0.9.0"
+  spec.add_development_dependency "db-query-matchers", "~> 0.11.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "appraisal", "~> 2.2.0"
 
-  spec.add_dependency "rails", ">= 5.0", "< 6.1"
+  spec.add_dependency "rails", ">= 5.0", "< 7.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.5
+  version: 1.5.0
 platform: ruby
 authors:
 - celeen
@@ -14,22 +14,22 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-05 00:00:00.000000000 Z
+date: 2022-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +123,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -133,7 +133,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: relation_to_struct
   requirement: !ruby/object:Gem::Requirement
@@ -161,7 +161,6 @@ files:
 - ".pryrc"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
 - Appraisals
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -175,6 +174,8 @@ files:
 - gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
+- gemfiles/rails_6.1.gemfile
+- gemfiles/rails_7.0.gemfile
 - lib/pg_ha_migrations.rb
 - lib/pg_ha_migrations/allowed_versions.rb
 - lib/pg_ha_migrations/blocking_database_transactions.rb

data/.travis.yml

@@ -1,27 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5
-env:
-  jobs:
-    - PGVERSION: "9.6"
-    - PGVERSION: "10"
-    - PGVERSION: "11"
-    - PGVERSION: "12"
-services:
-  - postgresql
-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"