debian-mirror-gitlab/config/application.rb

390 lines
17 KiB
Ruby
Raw Normal View History

2021-01-03 14:25:43 +05:30
# frozen_string_literal: true
2019-09-30 21:07:59 +05:30
require_relative 'boot'
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
# Based on https://github.com/rails/rails/blob/v6.0.1/railties/lib/rails/all.rb
2019-09-30 21:07:59 +05:30
# Only load the railties we need instead of loading everything
2020-03-13 15:44:24 +05:30
require 'rails'
2019-09-30 21:07:59 +05:30
require 'active_record/railtie'
require 'action_controller/railtie'
require 'action_view/railtie'
require 'action_mailer/railtie'
2020-04-08 14:13:33 +05:30
require 'action_cable/engine'
2019-09-30 21:07:59 +05:30
require 'rails/test_unit/railtie'
2016-06-02 11:05:42 +05:30
2019-09-30 21:07:59 +05:30
Bundler.require(*Rails.groups)
2014-09-02 18:07:02 +05:30
module Gitlab
class Application < Rails::Application
2019-09-30 21:07:59 +05:30
require_dependency Rails.root.join('lib/gitlab')
2019-12-21 20:55:43 +05:30
require_dependency Rails.root.join('lib/gitlab/utils')
2020-07-28 23:09:34 +05:30
require_dependency Rails.root.join('lib/gitlab/action_cable/config')
2018-03-17 18:26:18 +05:30
require_dependency Rails.root.join('lib/gitlab/redis/wrapper')
2017-09-10 17:25:29 +05:30
require_dependency Rails.root.join('lib/gitlab/redis/cache')
require_dependency Rails.root.join('lib/gitlab/redis/queues')
require_dependency Rails.root.join('lib/gitlab/redis/shared_state')
2018-03-27 19:54:05 +05:30
require_dependency Rails.root.join('lib/gitlab/current_settings')
2018-11-08 19:23:39 +05:30
require_dependency Rails.root.join('lib/gitlab/middleware/read_only')
2018-12-05 23:21:45 +05:30
require_dependency Rails.root.join('lib/gitlab/middleware/basic_health_check')
2020-04-22 19:07:51 +05:30
require_dependency Rails.root.join('lib/gitlab/middleware/same_site_cookies')
2020-06-23 00:09:42 +05:30
require_dependency Rails.root.join('lib/gitlab/middleware/handle_ip_spoof_attack_error')
2021-01-03 14:25:43 +05:30
require_dependency Rails.root.join('lib/gitlab/middleware/handle_null_bytes')
2020-03-13 15:44:24 +05:30
require_dependency Rails.root.join('lib/gitlab/runtime')
2018-11-08 19:23:39 +05:30
2014-09-02 18:07:02 +05:30
# Settings in config/environments/* take precedence over those specified here.
# Application configuration should go into files in config/initializers
# -- all .rb files in that directory are automatically loaded.
2019-09-30 21:07:59 +05:30
config.active_record.sqlite3.represent_boolean_as_integer = true
2016-06-02 11:05:42 +05:30
# Sidekiq uses eager loading, but directories not in the standard Rails
# directories must be added to the eager load paths:
# https://github.com/mperham/sidekiq/wiki/FAQ#why-doesnt-sidekiq-autoload-my-rails-application-code
# Also, there is no need to add `lib` to autoload_paths since autoloading is
# configured to check for eager loaded paths:
# https://github.com/rails/rails/blob/v4.2.6/railties/lib/rails/engine.rb#L687
# This is a nice reference article on autoloading/eager loading:
# http://blog.arkency.com/2014/11/dont-forget-about-eager-load-when-extending-autoload
2017-09-10 17:25:29 +05:30
config.eager_load_paths.push(*%W[#{config.root}/lib
2018-03-27 19:54:05 +05:30
#{config.root}/app/models/badges
2016-06-02 11:05:42 +05:30
#{config.root}/app/models/hooks
#{config.root}/app/models/members
2016-11-03 12:29:30 +05:30
#{config.root}/app/models/project_services
2018-11-18 11:00:15 +05:30
#{config.root}/app/graphql/resolvers/concerns
2020-11-24 15:15:51 +05:30
#{config.root}/app/graphql/mutations/concerns
#{config.root}/app/graphql/types/concerns])
2016-06-02 11:05:42 +05:30
config.generators.templates.push("#{config.root}/generator_templates")
2014-09-02 18:07:02 +05:30
2019-12-21 20:55:43 +05:30
if Gitlab.ee?
ee_paths = config.eager_load_paths.each_with_object([]) do |path, memo|
ee_path = config.root.join('ee', Pathname.new(path).relative_path_from(config.root))
memo << ee_path.to_s
end
2019-09-04 21:01:54 +05:30
2020-03-13 15:44:24 +05:30
ee_paths << "#{config.root}/ee/app/replicators"
2019-12-21 20:55:43 +05:30
# Eager load should load CE first
config.eager_load_paths.push(*ee_paths)
config.helpers_paths.push "#{config.root}/ee/app/helpers"
2019-09-04 21:01:54 +05:30
2019-12-21 20:55:43 +05:30
# Other than Ruby modules we load EE first
config.paths['lib/tasks'].unshift "#{config.root}/ee/lib/tasks"
config.paths['app/views'].unshift "#{config.root}/ee/app/views"
end
2019-09-04 21:01:54 +05:30
2018-03-17 18:26:18 +05:30
# Rake tasks ignore the eager loading settings, so we need to set the
# autoload paths explicitly
config.autoload_paths = config.eager_load_paths.dup
2014-09-02 18:07:02 +05:30
# Only load the plugins named here, in the order given (default is alphabetical).
# :all can be used as a placeholder for all plugins not explicitly named.
# config.plugins = [ :exception_notification, :ssl_requirement, :all ]
# The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
# config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
# config.i18n.default_locale = :de
config.i18n.enforce_available_locales = false
2019-02-15 15:39:39 +05:30
# Enable locale fallbacks for I18n (makes lookups for any locale fall back to
# the I18n.default_locale when a translation can not be found).
# We have to explicitly set default locale since 1.1.0 - see:
# https://github.com/svenfuchs/i18n/pull/415
config.i18n.fallbacks = [:en]
2017-08-17 22:00:37 +05:30
# Translation for AR attrs is not working well for POROs like WikiPage
config.gettext_i18n_rails.use_for_active_record_attributes = false
2014-09-02 18:07:02 +05:30
# Configure the default encoding used in templates for Ruby 1.9.
config.encoding = "utf-8"
# Configure sensitive parameters which will be filtered from the log file.
2016-06-02 11:05:42 +05:30
#
# Parameters filtered:
2018-03-17 18:26:18 +05:30
# - Any parameter ending with `token`
2017-09-10 17:25:29 +05:30
# - Any parameter containing `password`
# - Any parameter containing `secret`
2018-12-05 23:21:45 +05:30
# - Any parameter ending with `key`
2016-06-02 11:05:42 +05:30
# - Two-factor tokens (:otp_attempt)
# - Repo/Project Import URLs (:import_url)
2018-03-17 18:26:18 +05:30
# - Build traces (:trace)
2016-06-02 11:05:42 +05:30
# - Build variables (:variables)
# - GitLab Pages SSL cert/key info (:certificate, :encrypted_key)
# - Webhook URLs (:hook)
# - Sentry DSN (:sentry_dsn)
2018-11-08 19:23:39 +05:30
# - File content from Web Editor (:content)
2019-07-07 11:18:12 +05:30
# - Jira shared secret (:sharedSecret)
2019-10-12 21:52:04 +05:30
# - Titles, bodies, and descriptions for notes, issues, etc.
2018-11-29 20:51:05 +05:30
#
2019-10-12 21:52:04 +05:30
# NOTE: It is **IMPORTANT** to also update labkit's filter when
# adding parameters here to not introduce another security
# vulnerability:
# https://gitlab.com/gitlab-org/labkit/blob/master/mask/matchers.go
config.filter_parameters += [
/token$/,
/password/,
/secret/,
/key$/,
/^body$/,
/^description$/,
/^note$/,
/^text$/,
2021-01-03 14:25:43 +05:30
/^title$/,
/^hook$/
2019-10-12 21:52:04 +05:30
]
2016-06-02 11:05:42 +05:30
config.filter_parameters += %i(
certificate
encrypted_key
import_url
2020-05-24 23:13:21 +05:30
elasticsearch_url
2020-12-08 15:28:05 +05:30
search
2016-06-02 11:05:42 +05:30
otp_attempt
sentry_dsn
2018-03-17 18:26:18 +05:30
trace
2016-06-02 11:05:42 +05:30
variables
2018-11-08 19:23:39 +05:30
content
2019-07-07 11:18:12 +05:30
sharedSecret
2016-06-02 11:05:42 +05:30
)
2014-09-02 18:07:02 +05:30
# Enable escaping HTML in JSON.
config.active_support.escape_html_entities_in_json = true
# Use SQL instead of Active Record's schema dumper when creating the database.
# This is necessary if your schema can't be completely dumped by the schema dumper,
# like if you have constraints or database-specific column types
2020-04-22 19:07:51 +05:30
config.active_record.schema_format = :sql
2014-09-02 18:07:02 +05:30
2020-07-28 23:09:34 +05:30
config.action_mailer.delivery_job = "ActionMailer::MailDeliveryJob"
2014-09-02 18:07:02 +05:30
# Enable the asset pipeline
config.assets.enabled = true
2018-03-17 18:26:18 +05:30
2017-08-17 22:00:37 +05:30
# Support legacy unicode file named img emojis, `1F939.png`
2016-08-24 12:49:21 +05:30
config.assets.paths << Gemojione.images_path
2018-03-17 18:26:18 +05:30
config.assets.paths << "#{config.root}/vendor/assets/fonts"
2021-01-03 14:25:43 +05:30
config.assets.precompile << "application_utilities.css"
config.assets.precompile << "application_utilities_dark.css"
2020-06-23 00:09:42 +05:30
config.assets.precompile << "application_dark.css"
2020-10-24 23:57:45 +05:30
config.assets.precompile << "startup/*.css"
2014-09-02 18:07:02 +05:30
config.assets.precompile << "print.css"
2019-12-26 22:10:19 +05:30
config.assets.precompile << "mailer.css"
config.assets.precompile << "mailer_client_specific.css"
2016-06-02 11:05:42 +05:30
config.assets.precompile << "notify.css"
config.assets.precompile << "mailers/*.css"
2020-11-24 15:15:51 +05:30
config.assets.precompile << "page_bundles/_mixins_and_variables_and_functions.css"
2021-01-03 14:25:43 +05:30
config.assets.precompile << "page_bundles/boards.css"
config.assets.precompile << "page_bundles/cycle_analytics.css"
config.assets.precompile << "page_bundles/dev_ops_report.css"
config.assets.precompile << "page_bundles/environments.css"
config.assets.precompile << "page_bundles/error_tracking_details.css"
config.assets.precompile << "page_bundles/error_tracking_index.css"
config.assets.precompile << "page_bundles/experimental_separate_sign_up.css"
2018-11-18 11:00:15 +05:30
config.assets.precompile << "page_bundles/ide.css"
2021-01-03 14:25:43 +05:30
config.assets.precompile << "page_bundles/issues_list.css"
2020-11-24 15:15:51 +05:30
config.assets.precompile << "page_bundles/jira_connect.css"
2021-01-03 14:25:43 +05:30
config.assets.precompile << "page_bundles/jira_connect_users.css"
config.assets.precompile << "page_bundles/merge_conflicts.css"
config.assets.precompile << "page_bundles/merge_requests.css"
config.assets.precompile << "page_bundles/milestone.css"
config.assets.precompile << "page_bundles/pipeline.css"
config.assets.precompile << "page_bundles/pipelines.css"
config.assets.precompile << "page_bundles/productivity_analytics.css"
config.assets.precompile << "page_bundles/terminal.css"
2020-11-24 15:15:51 +05:30
config.assets.precompile << "page_bundles/todos.css"
2021-01-03 14:25:43 +05:30
config.assets.precompile << "page_bundles/reports.css"
2018-12-05 23:21:45 +05:30
config.assets.precompile << "page_bundles/xterm.css"
2021-01-03 14:25:43 +05:30
config.assets.precompile << "page_bundles/wiki.css"
config.assets.precompile << "lazy_bundles/cropper.css"
2017-09-10 17:25:29 +05:30
config.assets.precompile << "performance_bar.css"
2017-08-17 22:00:37 +05:30
config.assets.precompile << "lib/ace.js"
2020-03-13 15:44:24 +05:30
config.assets.precompile << "disable_animations.css"
2018-10-15 14:42:47 +05:30
config.assets.precompile << "snippets.css"
2018-03-17 18:26:18 +05:30
config.assets.precompile << "locale/**/app.js"
2018-10-15 14:42:47 +05:30
config.assets.precompile << "emoji_sprites.css"
2018-11-08 19:23:39 +05:30
config.assets.precompile << "errors.css"
2020-11-24 15:15:51 +05:30
config.assets.precompile << "jira_connect.js"
config.assets.precompile << "themes/*.css"
2014-09-02 18:07:02 +05:30
2019-07-07 11:18:12 +05:30
config.assets.precompile << "highlight/themes/*.css"
2018-05-09 12:01:36 +05:30
# Import gitlab-svgs directly from vendored directory
2018-12-13 13:39:08 +05:30
config.assets.paths << "#{config.root}/node_modules/@gitlab/svgs/dist"
2018-05-09 12:01:36 +05:30
config.assets.precompile << "icons.svg"
config.assets.precompile << "icons.json"
config.assets.precompile << "illustrations/*.svg"
2020-10-24 23:57:45 +05:30
# Import Fontawesome fonts
config.assets.paths << "#{config.root}/node_modules/font-awesome/fonts"
config.assets.precompile << "fontawesome-webfont.woff2"
config.assets.precompile << "fontawesome-webfont.woff"
2018-11-18 11:00:15 +05:30
# Import css for xterm
config.assets.paths << "#{config.root}/node_modules/xterm/src/"
config.assets.precompile << "xterm.css"
2019-10-12 21:52:04 +05:30
# Import path for EE specific SCSS entry point
# In CE it will import a noop file, in EE a functioning file
# Order is important, so that the ee file takes precedence:
2019-12-21 20:55:43 +05:30
config.assets.paths << "#{config.root}/ee/app/assets/stylesheets/_ee" if Gitlab.ee?
2019-10-12 21:52:04 +05:30
config.assets.paths << "#{config.root}/app/assets/stylesheets/_ee"
2019-09-04 21:01:54 +05:30
config.assets.paths << "#{config.root}/vendor/assets/javascripts/"
config.assets.precompile << "snowplow/sp.js"
2019-09-30 21:07:59 +05:30
# This path must come last to avoid confusing sprockets
2019-12-04 20:38:33 +05:30
# See https://gitlab.com/gitlab-org/gitlab-foss/issues/64091#note_194512508
2019-09-30 21:07:59 +05:30
config.assets.paths << "#{config.root}/node_modules"
2014-09-02 18:07:02 +05:30
# Version of your assets, change this if you want to expire all your assets
config.assets.version = '1.0'
2019-02-15 15:39:39 +05:30
# Nokogiri is significantly faster and uses less memory than REXML
ActiveSupport::XmlMini.backend = 'Nokogiri'
2018-11-18 11:00:15 +05:30
# This middleware needs to precede ActiveRecord::QueryCache and other middlewares that
# connect to the database.
2018-12-05 23:21:45 +05:30
config.middleware.insert_after Rails::Rack::Logger, ::Gitlab::Middleware::BasicHealthCheck
2018-11-18 11:00:15 +05:30
2018-03-17 18:26:18 +05:30
config.middleware.insert_after Warden::Manager, Rack::Attack
2014-09-02 18:07:02 +05:30
2020-04-22 19:07:51 +05:30
config.middleware.insert_before ActionDispatch::Cookies, ::Gitlab::Middleware::SameSiteCookies
2020-06-23 00:09:42 +05:30
config.middleware.insert_before ActionDispatch::RemoteIp, ::Gitlab::Middleware::HandleIpSpoofAttackError
2021-01-03 14:25:43 +05:30
config.middleware.use ::Gitlab::Middleware::HandleNullBytes
2014-09-02 18:07:02 +05:30
# Allow access to GitLab API from other domains
2016-10-01 15:18:49 +05:30
config.middleware.insert_before Warden::Manager, Rack::Cors do
2020-03-13 15:44:24 +05:30
headers_to_expose = %w[Link X-Total X-Total-Pages X-Per-Page X-Page X-Next-Page X-Prev-Page X-Gitlab-Blob-Id X-Gitlab-Commit-Id X-Gitlab-Content-Sha256 X-Gitlab-Encoding X-Gitlab-File-Name X-Gitlab-File-Path X-Gitlab-Last-Commit-Id X-Gitlab-Ref X-Gitlab-Size]
2016-10-01 15:18:49 +05:30
allow do
origins Gitlab.config.gitlab.url
resource '/api/*',
credentials: true,
headers: :any,
methods: :any,
2020-03-13 15:44:24 +05:30
expose: headers_to_expose
2016-10-01 15:18:49 +05:30
end
# Cross-origin requests must not have the session cookie available
2014-09-02 18:07:02 +05:30
allow do
origins '*'
2015-04-26 12:48:37 +05:30
resource '/api/*',
2016-10-01 15:18:49 +05:30
credentials: false,
2015-04-26 12:48:37 +05:30
headers: :any,
2015-10-24 18:46:33 +05:30
methods: :any,
2020-03-13 15:44:24 +05:30
expose: headers_to_expose
2014-09-02 18:07:02 +05:30
end
end
2015-04-26 12:48:37 +05:30
2017-09-10 17:25:29 +05:30
# Use caching across all environments
2019-12-26 22:10:19 +05:30
# Full list of options:
# https://api.rubyonrails.org/classes/ActiveSupport/Cache/RedisCacheStore.html#method-c-new
2020-04-22 19:07:51 +05:30
caching_config_hash = {}
caching_config_hash[:redis] = Gitlab::Redis::Cache.pool
2020-04-08 14:13:33 +05:30
caching_config_hash[:compress] = Gitlab::Utils.to_boolean(ENV.fetch('ENABLE_REDIS_CACHE_COMPRESSION', '1'))
2017-09-10 17:25:29 +05:30
caching_config_hash[:namespace] = Gitlab::Redis::Cache::CACHE_NAMESPACE
caching_config_hash[:expires_in] = 2.weeks # Cache should not grow forever
2020-01-12 00:16:45 +05:30
2019-12-26 22:10:19 +05:30
config.cache_store = :redis_cache_store, caching_config_hash
2015-04-26 12:48:37 +05:30
2015-12-23 02:04:40 +05:30
config.active_job.queue_adapter = :sidekiq
2015-04-26 12:48:37 +05:30
# This is needed for gitlab-shell
ENV['GITLAB_PATH_OUTSIDE_HOOK'] = ENV['PATH']
2017-08-17 22:00:37 +05:30
ENV['GIT_TERMINAL_PROMPT'] = '0'
2016-06-02 11:05:42 +05:30
2018-12-05 23:21:45 +05:30
# GitLab Read-only middleware support
2018-11-08 19:23:39 +05:30
config.middleware.insert_after ActionDispatch::Flash, ::Gitlab::Middleware::ReadOnly
2018-03-17 18:26:18 +05:30
2016-06-02 11:05:42 +05:30
config.generators do |g|
2018-03-17 18:26:18 +05:30
g.factory_bot false
2016-06-02 11:05:42 +05:30
end
2017-09-10 17:25:29 +05:30
2021-01-03 14:25:43 +05:30
# sprocket-rails adds some precompile assets we actually do not need.
#
# It copies all _non_ js and CSS files from the app/assets/ older.
#
# In our case this copies for example: Vue, Markdown and Graphql, which we do not need
# for production.
#
# We remove this default behavior and then reimplement it in order to consider ee/ as well
# and remove those other files we do not need.
#
# For reference: https://github.com/rails/sprockets-rails/blob/v3.2.1/lib/sprockets/railtie.rb#L84-L87
initializer :correct_precompile_targets, after: :set_default_precompile do |app|
app.config.assets.precompile.reject! { |entry| entry == Sprockets::Railtie::LOOSE_APP_ASSETS }
asset_roots = [config.root.join("app/assets").to_s]
if Gitlab.ee?
asset_roots << config.root.join("ee/app/assets").to_s
end
LOOSE_APP_ASSETS = lambda do |logical_path, filename|
filename.start_with?(*asset_roots) &&
!['.js', '.css', '.md', '.vue', '.graphql', ''].include?(File.extname(logical_path))
end
app.config.assets.precompile << LOOSE_APP_ASSETS
end
2020-04-08 14:13:33 +05:30
# This empty initializer forces the :let_zeitwerk_take_over initializer to run before we load
# initializers in config/initializers. This is done because autoloading before Zeitwerk takes
# over is deprecated but our initializers do a lot of autoloading.
# See https://gitlab.com/gitlab-org/gitlab/issues/197346 for more details
initializer :move_initializers, before: :load_config_initializers, after: :let_zeitwerk_take_over do
end
# We need this for initializers that need to be run before Zeitwerk is loaded
initializer :before_zeitwerk, before: :let_zeitwerk_take_over, after: :prepend_helpers_path do
Dir[Rails.root.join('config/initializers_before_autoloader/*.rb')].sort.each do |initializer|
load_config_initializer(initializer)
end
end
2021-01-03 14:25:43 +05:30
# Add EE assets. They should take precedence over CE. This means if two files exist, e.g.:
#
# ee/app/assets/stylesheets/example.scss
# app/assets/stylesheets/example.scss
#
# The ee/ version will be preferred.
initializer :prefer_ee_assets, after: :append_assets_path do |app|
if Gitlab.ee?
%w[images javascripts stylesheets].each do |path|
app.config.assets.paths.unshift("#{config.root}/ee/app/assets/#{path}")
end
end
end
2017-09-10 17:25:29 +05:30
config.after_initialize do
2020-06-23 00:09:42 +05:30
# Devise (see initializers/8_devise.rb) already reloads routes if
# eager loading is enabled, so don't do this twice since it's
# expensive.
Rails.application.reload_routes! unless config.eager_load
2017-09-10 17:25:29 +05:30
project_url_helpers = Module.new do
extend ActiveSupport::Concern
Gitlab::Application.routes.named_routes.helper_names.each do |name|
next unless name.include?('namespace_project')
define_method(name.sub('namespace_project', 'project')) do |project, *args|
2018-11-18 11:00:15 +05:30
send(name, project&.namespace, project, *args)
2017-09-10 17:25:29 +05:30
end
end
end
# We add the MilestonesRoutingHelper because we know that this does not
# conflict with the methods defined in `project_url_helpers`, and we want
# these methods available in the same places.
Gitlab::Routing.add_helpers(project_url_helpers)
2020-06-23 00:09:42 +05:30
Gitlab::Routing.add_helpers(TimeboxesRoutingHelper)
2017-09-10 17:25:29 +05:30
end
2014-09-02 18:07:02 +05:30
end
end