305 lines
11 KiB
Ruby
305 lines
11 KiB
Ruby
# frozen_string_literal: true
|
||
|
||
module Gitlab
|
||
module Database
|
||
DATABASE_NAMES = %w[main ci].freeze
|
||
|
||
MAIN_DATABASE_NAME = 'main'
|
||
CI_DATABASE_NAME = 'ci'
|
||
DEFAULT_POOL_HEADROOM = 10
|
||
|
||
# This constant is used when renaming tables concurrently.
|
||
# If you plan to rename a table using the `rename_table_safely` method, add your table here one milestone before the rename.
|
||
# Example:
|
||
# TABLES_TO_BE_RENAMED = {
|
||
# 'old_name' => 'new_name'
|
||
# }.freeze
|
||
TABLES_TO_BE_RENAMED = {}.freeze
|
||
|
||
# Minimum PostgreSQL version requirement per documentation:
|
||
# https://docs.gitlab.com/ee/install/requirements.html#postgresql-requirements
|
||
MINIMUM_POSTGRES_VERSION = 12
|
||
|
||
# https://www.postgresql.org/docs/9.2/static/datatype-numeric.html
|
||
MAX_INT_VALUE = 2147483647
|
||
MIN_INT_VALUE = -2147483648
|
||
|
||
# The max value between MySQL's TIMESTAMP and PostgreSQL's timestampz:
|
||
# https://www.postgresql.org/docs/9.1/static/datatype-datetime.html
|
||
# https://dev.mysql.com/doc/refman/5.7/en/datetime.html
|
||
# FIXME: this should just be the max value of timestampz
|
||
MAX_TIMESTAMP_VALUE = Time.at((1 << 31) - 1).freeze
|
||
|
||
# The maximum number of characters for text fields, to avoid DoS attacks via parsing huge text fields
|
||
# https://gitlab.com/gitlab-org/gitlab-foss/issues/61974
|
||
MAX_TEXT_SIZE_LIMIT = 1_000_000
|
||
|
||
# Minimum schema version from which migrations are supported
|
||
# Migrations before this version may have been removed
|
||
MIN_SCHEMA_VERSION = 20190506135400
|
||
MIN_SCHEMA_GITLAB_VERSION = '11.11.0'
|
||
|
||
# Schema we store dynamically managed partitions in (e.g. for time partitioning)
|
||
DYNAMIC_PARTITIONS_SCHEMA = :gitlab_partitions_dynamic
|
||
|
||
# Schema we store static partitions in (e.g. for hash partitioning)
|
||
STATIC_PARTITIONS_SCHEMA = :gitlab_partitions_static
|
||
|
||
# This is an extensive list of postgres schemas owned by GitLab
|
||
# It does not include the default public schema
|
||
EXTRA_SCHEMAS = [DYNAMIC_PARTITIONS_SCHEMA, STATIC_PARTITIONS_SCHEMA].freeze
|
||
|
||
PRIMARY_DATABASE_NAME = ActiveRecord::Base.connection_db_config.name.to_sym
|
||
|
||
def self.database_base_models
|
||
@database_base_models ||= {
|
||
# Note that we use ActiveRecord::Base here and not ApplicationRecord.
|
||
# This is deliberate, as we also use these classes to apply load
|
||
# balancing to, and the load balancer must be enabled for _all_ models
|
||
# that inher from ActiveRecord::Base; not just our own models that
|
||
# inherit from ApplicationRecord.
|
||
main: ::ActiveRecord::Base,
|
||
ci: ::Ci::CiDatabaseRecord.connection_class? ? ::Ci::CiDatabaseRecord : nil
|
||
}.compact.freeze
|
||
end
|
||
|
||
def self.databases
|
||
@databases ||= database_base_models
|
||
.transform_values { |connection_class| Connection.new(connection_class) }
|
||
.with_indifferent_access
|
||
.freeze
|
||
end
|
||
|
||
def self.main
|
||
databases[PRIMARY_DATABASE_NAME]
|
||
end
|
||
|
||
# We configure the database connection pool size automatically based on the
|
||
# configured concurrency. We also add some headroom, to make sure we don't
|
||
# run out of connections when more threads besides the 'user-facing' ones
|
||
# are running.
|
||
#
|
||
# Read more about this in
|
||
# doc/development/database/client_side_connection_pool.md
|
||
def self.default_pool_size
|
||
headroom =
|
||
(ENV["DB_POOL_HEADROOM"].presence || DEFAULT_POOL_HEADROOM).to_i
|
||
|
||
Gitlab::Runtime.max_threads + headroom
|
||
end
|
||
|
||
def self.has_config?(database_name)
|
||
Gitlab::Application.config.database_configuration[Rails.env].include?(database_name.to_s)
|
||
end
|
||
|
||
def self.main_database?(name)
|
||
# The database is `main` if it is a first entry in `database.yml`
|
||
# Rails internally names them `primary` to avoid confusion
|
||
# with broad `primary` usage we use `main` instead
|
||
#
|
||
# TODO: The explicit `== 'main'` is needed in a transition period till
|
||
# the `database.yml` is not migrated into `main:` syntax
|
||
# https://gitlab.com/gitlab-org/gitlab/-/merge_requests/65243
|
||
ActiveRecord::Base.configurations.primary?(name.to_s) || name.to_s == 'main'
|
||
end
|
||
|
||
def self.ci_database?(name)
|
||
name.to_s == CI_DATABASE_NAME
|
||
end
|
||
|
||
def self.check_postgres_version_and_print_warning
|
||
return if Gitlab::Runtime.rails_runner?
|
||
|
||
databases.each do |name, connection|
|
||
next if connection.postgresql_minimum_supported_version?
|
||
|
||
Kernel.warn ERB.new(Rainbow.new.wrap(<<~EOS).red).result
|
||
|
||
██ ██ █████ ██████ ███ ██ ██ ███ ██ ██████
|
||
██ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██ ██
|
||
██ █ ██ ███████ ██████ ██ ██ ██ ██ ██ ██ ██ ██ ███
|
||
██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
|
||
███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████
|
||
|
||
******************************************************************************
|
||
You are using PostgreSQL #{connection.version} for the #{name} database, but PostgreSQL >= <%= Gitlab::Database::MINIMUM_POSTGRES_VERSION %>
|
||
is required for this version of GitLab.
|
||
<% if Rails.env.development? || Rails.env.test? %>
|
||
If using gitlab-development-kit, please find the relevant steps here:
|
||
https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/doc/howto/postgresql.md#upgrade-postgresql
|
||
<% end %>
|
||
Please upgrade your environment to a supported PostgreSQL version, see
|
||
https://docs.gitlab.com/ee/install/requirements.html#database for details.
|
||
******************************************************************************
|
||
EOS
|
||
rescue ActiveRecord::ActiveRecordError, PG::Error
|
||
# ignore - happens when Rake tasks yet have to create a database, e.g. for testing
|
||
end
|
||
end
|
||
|
||
def self.nulls_order(field, direction = :asc, nulls_order = :nulls_last)
|
||
raise ArgumentError unless [:nulls_last, :nulls_first].include?(nulls_order)
|
||
raise ArgumentError unless [:asc, :desc].include?(direction)
|
||
|
||
case nulls_order
|
||
when :nulls_last then nulls_last_order(field, direction)
|
||
when :nulls_first then nulls_first_order(field, direction)
|
||
end
|
||
end
|
||
|
||
def self.nulls_last_order(field, direction = 'ASC')
|
||
Arel.sql("#{field} #{direction} NULLS LAST")
|
||
end
|
||
|
||
def self.nulls_first_order(field, direction = 'ASC')
|
||
Arel.sql("#{field} #{direction} NULLS FIRST")
|
||
end
|
||
|
||
def self.random
|
||
"RANDOM()"
|
||
end
|
||
|
||
def self.true_value
|
||
"'t'"
|
||
end
|
||
|
||
def self.false_value
|
||
"'f'"
|
||
end
|
||
|
||
def self.sanitize_timestamp(timestamp)
|
||
MAX_TIMESTAMP_VALUE > timestamp ? timestamp : MAX_TIMESTAMP_VALUE.dup
|
||
end
|
||
|
||
def self.allow_cross_joins_across_databases(url:)
|
||
# this method is implemented in:
|
||
# spec/support/database/prevent_cross_joins.rb
|
||
yield
|
||
end
|
||
|
||
# This method will allow cross database modifications within the block
|
||
# Example:
|
||
#
|
||
# allow_cross_database_modification_within_transaction(url: 'url-to-an-issue') do
|
||
# create(:build) # inserts ci_build and project record in one transaction
|
||
# end
|
||
def self.allow_cross_database_modification_within_transaction(url:)
|
||
# this method will be overridden in:
|
||
# spec/support/database/cross_database_modification_check.rb
|
||
yield
|
||
end
|
||
|
||
def self.add_post_migrate_path_to_rails(force: false)
|
||
return if ENV['SKIP_POST_DEPLOYMENT_MIGRATIONS'] && !force
|
||
|
||
Rails.application.config.paths['db'].each do |db_path|
|
||
path = Rails.root.join(db_path, 'post_migrate').to_s
|
||
|
||
unless Rails.application.config.paths['db/migrate'].include? path
|
||
Rails.application.config.paths['db/migrate'] << path
|
||
|
||
# Rails memoizes migrations at certain points where it won't read the above
|
||
# path just yet. As such we must also update the following list of paths.
|
||
ActiveRecord::Migrator.migrations_paths << path
|
||
end
|
||
end
|
||
end
|
||
|
||
def self.db_config_names
|
||
::ActiveRecord::Base.configurations.configs_for(env_name: Rails.env).map(&:name)
|
||
end
|
||
|
||
def self.db_config_for_connection(connection)
|
||
return unless connection
|
||
|
||
# The LB connection proxy does not have a direct db_config
|
||
# that can be referenced
|
||
return if connection.is_a?(::Gitlab::Database::LoadBalancing::ConnectionProxy)
|
||
|
||
# During application init we might receive `NullPool`
|
||
return unless connection.respond_to?(:pool) &&
|
||
connection.pool.respond_to?(:db_config)
|
||
|
||
connection.pool.db_config
|
||
end
|
||
|
||
# At the moment, the connection can only be retrieved by
|
||
# Gitlab::Database::LoadBalancer#read or #read_write or from the
|
||
# ActiveRecord directly. Therefore, if the load balancer doesn't
|
||
# recognize the connection, this method returns the primary role
|
||
# directly. In future, we may need to check for other sources.
|
||
# Expected returned names:
|
||
# main, main_replica, ci, ci_replica, unknown
|
||
def self.db_config_name(connection)
|
||
db_config = db_config_for_connection(connection)
|
||
db_config&.name || 'unknown'
|
||
end
|
||
|
||
def self.read_only?
|
||
false
|
||
end
|
||
|
||
def self.read_write?
|
||
!read_only?
|
||
end
|
||
|
||
# Monkeypatch rails with upgraded database observability
|
||
def self.install_transaction_metrics_patches!
|
||
ActiveRecord::Base.prepend(ActiveRecordBaseTransactionMetrics)
|
||
end
|
||
|
||
def self.install_transaction_context_patches!
|
||
ActiveRecord::ConnectionAdapters::TransactionManager
|
||
.prepend(TransactionManagerContext)
|
||
ActiveRecord::ConnectionAdapters::RealTransaction
|
||
.prepend(RealTransactionContext)
|
||
end
|
||
|
||
# MonkeyPatch for ActiveRecord::Base for adding observability
|
||
module ActiveRecordBaseTransactionMetrics
|
||
extend ActiveSupport::Concern
|
||
|
||
class_methods do
|
||
# A patch over ActiveRecord::Base.transaction that provides
|
||
# observability into transactional methods.
|
||
def transaction(**options, &block)
|
||
if options[:requires_new] && connection.transaction_open?
|
||
::Gitlab::Database::Metrics.subtransactions_increment(self.name)
|
||
end
|
||
|
||
ActiveSupport::Notifications.instrument('transaction.active_record', { connection: connection }) do
|
||
super(**options, &block)
|
||
end
|
||
end
|
||
end
|
||
end
|
||
|
||
# rubocop:disable Gitlab/ModuleWithInstanceVariables
|
||
module TransactionManagerContext
|
||
def transaction_context
|
||
@stack.first.try(:gitlab_transaction_context)
|
||
end
|
||
end
|
||
|
||
module RealTransactionContext
|
||
def gitlab_transaction_context
|
||
@gitlab_transaction_context ||= ::Gitlab::Database::Transaction::Context.new
|
||
end
|
||
|
||
def commit
|
||
gitlab_transaction_context.commit
|
||
|
||
super
|
||
end
|
||
|
||
def rollback
|
||
gitlab_transaction_context.rollback
|
||
|
||
super
|
||
end
|
||
end
|
||
# rubocop:enable Gitlab/ModuleWithInstanceVariables
|
||
end
|
||
end
|
||
|
||
Gitlab::Database.prepend_mod_with('Gitlab::Database')
|