mirror of
https://github.com/postalserver/postal.git
synced 2026-10-18 18:26:06 +00:00
Adam Cooke
5eeed7c023
Upgrades Rails from 7.1.6 to 7.2.3.2, Ruby from 3.4.6 to 3.4.10, and brings the rest of the bundle up to date. Two things were broken by Rails 7.2 and are fixed here: * MigrationWaiter called `ActiveRecord::Base.connection.migration_context`, which moved to the connection pool in 7.2. This raised NoMethodError on boot for any deployment with `migration_waiter.enabled` set, and had no test covering it. * `config.action_dispatch.show_exceptions = false` was deprecated in 7.1 and removed in 7.2. Now `:none`. `json` is pinned to < 3. Active Support 7.2 passes `quirks_mode:` to both `JSON.generate` and `JSON.parse`, and json 3.0 removed that option, so an unpinned json resolves to 3.x and makes every `to_json` raise - webhook payloads included. Nothing else in the bundle constrains it. The pin can go when we reach Rails 8.1, which no longer passes the option. `dynamic_form` is dropped. It is unmaintained and from 1.3.1 requires Ruby < 3.4, so it could never be updated again. Ten views used it, so `error_messages_for` now lives in ErrorMessagesHelper and `f.error_messages` in a form builder extension. The rendered markup is unchanged apart from a heading and description the stylesheet had always hidden; the rules that hid them are removed too. `execjs` is unpinned. The `< 2.8` constraint dated from the Rails 6.0 upgrade and asset output is byte-identical without it. Notable gem majors: puma 8, haml 7, secure_headers 7, sentry 7, jwt 3, prometheus-client 5, highline 3, omniauth-rails_csrf_protection 2, rspec-rails 8, shoulda-matchers 8, rubocop 1.91. secure_headers 7 changes X-XSS-Protection from "1; mode=block" to "0", which is the correct modern default and matches Rails' own. `config.load_defaults` deliberately stays at 7.0. The pending 7.1 and 7.2 options are listed, commented out, in new_framework_defaults_7_1.rb and _7_2.rb so they can be adopted in stages - several change the signed cookie and cache formats and need a staged deploy. The vestigial new_framework_defaults_7_0.rb is removed, as `load_defaults 7.0` already applies all of it. Adds tests for the areas this touched, which were mostly uncovered: MigrationWaiter, the serialized columns that gate a defaults bump, JSON encoding, HAML template compilation for all 103 templates, page rendering, form error rendering and security headers. The assets Gemfile group now includes :test so the view layer can be exercised at all.
67 lines
1.8 KiB
Ruby
67 lines
1.8 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
# This initializer will wait for all pending migrations to be applied before
|
|
# continuing to start the application. This is useful when running the application
|
|
# in a cluster where migrations are run in a separate job which runs at the same
|
|
# time as the other processes.
|
|
|
|
class MigrationWaiter
|
|
|
|
ATTEMPTS = Postal::Config.migration_waiter.attempts
|
|
SLEEP_TIME = Postal::Config.migration_waiter.sleep_time
|
|
|
|
class << self
|
|
|
|
def wait
|
|
attempts_remaining = ATTEMPTS
|
|
loop do
|
|
pending_migrations = pending_migration_count
|
|
if pending_migrations.zero?
|
|
Postal.logger.info "no pending migrations, continuing"
|
|
return
|
|
end
|
|
|
|
attempts_remaining -= 1
|
|
|
|
if attempts_remaining.zero?
|
|
Postal.logger.info "#{pending_migrations} migration(s) are still pending after #{ATTEMPTS} attempts, exiting"
|
|
Process.exit(1)
|
|
else
|
|
Postal.logger.info "waiting for #{pending_migrations} migration(s) to be applied (#{attempts_remaining} remaining)"
|
|
sleep SLEEP_TIME
|
|
end
|
|
end
|
|
end
|
|
|
|
# Returns the number of migrations which exist in the application but have
|
|
# not yet been applied to the database.
|
|
def pending_migration_count
|
|
ActiveRecord::Base.connection_pool.migration_context.open.pending_migrations.size
|
|
end
|
|
|
|
def wait_if_appropriate
|
|
# Don't wait if not configured
|
|
return unless Postal::Config.migration_waiter.enabled?
|
|
|
|
# Don't wait in the console, rake tasks or rails commands
|
|
return if console? || rake_task? || rails_command?
|
|
|
|
wait
|
|
end
|
|
|
|
def console?
|
|
Rails.const_defined?("Console")
|
|
end
|
|
|
|
def rake_task?
|
|
Rake.application.top_level_tasks.any?
|
|
end
|
|
|
|
def rails_command?
|
|
caller.any? { |c| c =~ /rails\/commands/ }
|
|
end
|
|
|
|
end
|
|
|
|
end
|