Commit 364fdbb3 authored by Douwe Maan's avatar Douwe Maan

Merge branch 'tc-geo-read-only-to-ce' into 'master'

Create idea of read-only database

Closes #2855, #3398, #3399, and #3505

See merge request gitlab-org/gitlab-ee!2954
parents abebc2e8 e44821cd
...@@ -3,18 +3,23 @@ ...@@ -3,18 +3,23 @@
# Automatically sets the layout and ensures an administrator is logged in # Automatically sets the layout and ensures an administrator is logged in
class Admin::ApplicationController < ApplicationController class Admin::ApplicationController < ApplicationController
before_action :authenticate_admin! before_action :authenticate_admin!
before_action :display_geo_information before_action :display_read_only_information
layout 'admin' layout 'admin'
def authenticate_admin! def authenticate_admin!
render_404 unless current_user.admin? render_404 unless current_user.admin?
end end
def display_geo_information def display_read_only_information
return unless Gitlab::Geo.secondary? return unless Gitlab::Database.read_only?
return unless Gitlab::Geo.primary_node_configured?
primary_node = view_context.link_to('primary node', Gitlab::Geo.primary_node.url) flash.now[:notice] = read_only_message
flash.now[:notice] = "You are on a secondary (read-only) Geo node. If you want to make any changes, you must visit the #{primary_node}.".html_safe end
private
# Overridden in EE
def read_only_message
_('You are on a read-only GitLab instance.')
end end
end end
...@@ -12,7 +12,7 @@ module Boards ...@@ -12,7 +12,7 @@ module Boards
def index def index
issues = Boards::Issues::ListService.new(board_parent, current_user, filter_params).execute issues = Boards::Issues::ListService.new(board_parent, current_user, filter_params).execute
issues = issues.page(params[:page]).per(params[:per] || 20) issues = issues.page(params[:page]).per(params[:per] || 20)
make_sure_position_is_set(issues) unless Gitlab::Geo.secondary? make_sure_position_is_set(issues) if Gitlab::Database.read_write?
issues = issues.preload(:project, issues = issues.preload(:project,
:milestone, :milestone,
:assignees, :assignees,
......
...@@ -4,6 +4,8 @@ class Projects::LfsApiController < Projects::GitHttpClientController ...@@ -4,6 +4,8 @@ class Projects::LfsApiController < Projects::GitHttpClientController
include GitlabRoutingHelper include GitlabRoutingHelper
include LfsRequest include LfsRequest
prepend ::EE::Projects::LfsApiController
skip_before_action :lfs_check_access!, only: [:deprecated] skip_before_action :lfs_check_access!, only: [:deprecated]
before_action :lfs_check_batch_operation!, only: [:batch] before_action :lfs_check_batch_operation!, only: [:batch]
...@@ -96,14 +98,19 @@ class Projects::LfsApiController < Projects::GitHttpClientController ...@@ -96,14 +98,19 @@ class Projects::LfsApiController < Projects::GitHttpClientController
end end
def lfs_check_batch_operation! def lfs_check_batch_operation!
if upload_request? && Gitlab::Geo.secondary? if upload_request? && Gitlab::Database.read_only?
render( render(
json: { json: {
message: "You cannot write to a secondary GitLab Geo instance. Please use #{geo_primary_default_url_to_repo(project)} instead." message: lfs_read_only_message
}, },
content_type: "application/vnd.git-lfs+json", content_type: 'application/vnd.git-lfs+json',
status: 403 status: 403
) )
end end
end end
# Overridden in EE
def lfs_read_only_message
_('You cannot write to this read-only GitLab instance.')
end
end end
...@@ -15,7 +15,7 @@ class Projects::MergeRequests::ApplicationController < Projects::ApplicationCont ...@@ -15,7 +15,7 @@ class Projects::MergeRequests::ApplicationController < Projects::ApplicationCont
# Make sure merge requests created before 8.0 # Make sure merge requests created before 8.0
# have head file in refs/merge-requests/ # have head file in refs/merge-requests/
def ensure_ref_fetched def ensure_ref_fetched
@merge_request.ensure_ref_fetched @merge_request.ensure_ref_fetched if Gitlab::Database.read_write?
end end
def merge_request_params def merge_request_params
......
...@@ -9,9 +9,7 @@ class SessionsController < Devise::SessionsController ...@@ -9,9 +9,7 @@ class SessionsController < Devise::SessionsController
prepend_before_action :check_initial_setup, only: [:new] prepend_before_action :check_initial_setup, only: [:new]
prepend_before_action :authenticate_with_two_factor, prepend_before_action :authenticate_with_two_factor,
if: :two_factor_enabled?, only: [:create] if: :two_factor_enabled?, only: [:create]
prepend_before_action :store_redirect_path, only: [:new] prepend_before_action :store_redirect_uri, only: [:new]
before_action :gitlab_geo_login, only: [:new]
before_action :gitlab_geo_logout, only: [:destroy]
before_action :auto_sign_in_with_provider, only: [:new] before_action :auto_sign_in_with_provider, only: [:new]
before_action :load_recaptcha before_action :load_recaptcha
...@@ -88,7 +86,11 @@ class SessionsController < Devise::SessionsController ...@@ -88,7 +86,11 @@ class SessionsController < Devise::SessionsController
end end
end end
def store_redirect_path def stored_redirect_uri
@redirect_to ||= stored_location_for(:redirect)
end
def store_redirect_uri
redirect_uri = redirect_uri =
if request.referer.present? && (params['redirect_to_referer'] == 'yes') if request.referer.present? && (params['redirect_to_referer'] == 'yes')
URI(request.referer) URI(request.referer)
...@@ -98,40 +100,22 @@ class SessionsController < Devise::SessionsController ...@@ -98,40 +100,22 @@ class SessionsController < Devise::SessionsController
# Prevent a 'you are already signed in' message directly after signing: # Prevent a 'you are already signed in' message directly after signing:
# we should never redirect to '/users/sign_in' after signing in successfully. # we should never redirect to '/users/sign_in' after signing in successfully.
if redirect_uri.path == new_user_session_path return true if redirect_uri.path == new_user_session_path
return true
elsif redirect_uri.host == Gitlab.config.gitlab.host && redirect_uri.port == Gitlab.config.gitlab.port redirect_to = redirect_uri.to_s if redirect_allowed_to?(redirect_uri)
redirect_to = redirect_uri.to_s
elsif Gitlab::Geo.geo_node?(host: redirect_uri.host, port: redirect_uri.port)
redirect_to = redirect_uri.to_s
end
@redirect_to = redirect_to @redirect_to = redirect_to
store_location_for(:redirect, redirect_to) store_location_for(:redirect, redirect_to)
end end
def two_factor_enabled? # Overridden in EE
find_user.try(:two_factor_enabled?) def redirect_allowed_to?(uri)
end uri.host == Gitlab.config.gitlab.host &&
uri.port == Gitlab.config.gitlab.port
def gitlab_geo_login
return unless Gitlab::Geo.secondary?
return if signed_in?
oauth = Gitlab::Geo::OauthSession.new
# share full url with primary node by oauth state
user_return_to = URI.join(root_url, session[:user_return_to].to_s).to_s
oauth.return_to = @redirect_to || user_return_to
redirect_to oauth_geo_auth_url(state: oauth.generate_oauth_state)
end end
def gitlab_geo_logout def two_factor_enabled?
return unless Gitlab::Geo.secondary? find_user&.two_factor_enabled?
oauth = Gitlab::Geo::OauthSession.new(access_token: session[:access_token])
@geo_logout_state = oauth.generate_logout_state
end end
def auto_sign_in_with_provider def auto_sign_in_with_provider
......
...@@ -59,7 +59,7 @@ module CacheMarkdownField ...@@ -59,7 +59,7 @@ module CacheMarkdownField
# Update every column in a row if any one is invalidated, as we only store # Update every column in a row if any one is invalidated, as we only store
# one version per row # one version per row
def refresh_markdown_cache!(do_update: false) def refresh_markdown_cache
options = { skip_project_check: skip_project_check? } options = { skip_project_check: skip_project_check? }
updates = cached_markdown_fields.markdown_fields.map do |markdown_field| updates = cached_markdown_fields.markdown_fields.map do |markdown_field|
...@@ -71,8 +71,14 @@ module CacheMarkdownField ...@@ -71,8 +71,14 @@ module CacheMarkdownField
updates['cached_markdown_version'] = CacheMarkdownField::CACHE_VERSION updates['cached_markdown_version'] = CacheMarkdownField::CACHE_VERSION
updates.each {|html_field, data| write_attribute(html_field, data) } updates.each {|html_field, data| write_attribute(html_field, data) }
end
def refresh_markdown_cache!
updates = refresh_markdown_cache
return unless persisted? && Gitlab::Database.read_write?
update_columns(updates) if persisted? && do_update update_columns(updates)
end end
def cached_html_up_to_date?(markdown_field) def cached_html_up_to_date?(markdown_field)
...@@ -124,8 +130,8 @@ module CacheMarkdownField ...@@ -124,8 +130,8 @@ module CacheMarkdownField
end end
# Using before_update here conflicts with elasticsearch-model somehow # Using before_update here conflicts with elasticsearch-model somehow
before_create :refresh_markdown_cache!, if: :invalidated_markdown_cache? before_create :refresh_markdown_cache, if: :invalidated_markdown_cache?
before_update :refresh_markdown_cache!, if: :invalidated_markdown_cache? before_update :refresh_markdown_cache, if: :invalidated_markdown_cache?
end end
class_methods do class_methods do
......
...@@ -156,7 +156,7 @@ module Routable ...@@ -156,7 +156,7 @@ module Routable
end end
def update_route def update_route
return if Gitlab::Geo.secondary? return if Gitlab::Database.read_only?
prepare_route prepare_route
route.save route.save
......
...@@ -43,15 +43,17 @@ module TokenAuthenticatable ...@@ -43,15 +43,17 @@ module TokenAuthenticatable
write_attribute(token_field, token) if token write_attribute(token_field, token) if token
end end
# Returns a token, but only saves when the database is in read & write mode
define_method("ensure_#{token_field}!") do define_method("ensure_#{token_field}!") do
send("reset_#{token_field}!") if read_attribute(token_field).blank? # rubocop:disable GitlabSecurity/PublicSend send("reset_#{token_field}!") if read_attribute(token_field).blank? # rubocop:disable GitlabSecurity/PublicSend
read_attribute(token_field) read_attribute(token_field)
end end
# Resets the token, but only saves when the database is in read & write mode
define_method("reset_#{token_field}!") do define_method("reset_#{token_field}!") do
write_new_token(token_field) write_new_token(token_field)
save! save! if Gitlab::Database.read_write?
end end
end end
end end
......
...@@ -498,7 +498,7 @@ class MergeRequest < ActiveRecord::Base ...@@ -498,7 +498,7 @@ class MergeRequest < ActiveRecord::Base
end end
def check_if_can_be_merged def check_if_can_be_merged
return unless unchecked? && !Gitlab::Geo.secondary? return unless unchecked? && Gitlab::Database.read_write?
can_be_merged = can_be_merged =
!broken? && project.repository.can_be_merged?(diff_head_sha, target_branch) !broken? && project.repository.can_be_merged?(diff_head_sha, target_branch)
......
...@@ -811,7 +811,7 @@ class Project < ActiveRecord::Base ...@@ -811,7 +811,7 @@ class Project < ActiveRecord::Base
end end
def cache_has_external_issue_tracker def cache_has_external_issue_tracker
update_column(:has_external_issue_tracker, services.external_issue_trackers.any?) update_column(:has_external_issue_tracker, services.external_issue_trackers.any?) if Gitlab::Database.read_write?
end end
def has_wiki? def has_wiki?
...@@ -831,7 +831,7 @@ class Project < ActiveRecord::Base ...@@ -831,7 +831,7 @@ class Project < ActiveRecord::Base
end end
def cache_has_external_wiki def cache_has_external_wiki
update_column(:has_external_wiki, services.external_wikis.any?) update_column(:has_external_wiki, services.external_wikis.any?) if Gitlab::Database.read_write?
end end
def find_or_initialize_services(exceptions: []) def find_or_initialize_services(exceptions: [])
......
...@@ -477,6 +477,14 @@ class User < ActiveRecord::Base ...@@ -477,6 +477,14 @@ class User < ActiveRecord::Base
reset_password_sent_at.present? && reset_password_sent_at >= 1.minute.ago reset_password_sent_at.present? && reset_password_sent_at >= 1.minute.ago
end end
def remember_me!
super if ::Gitlab::Database.read_write?
end
def forget_me!
super if ::Gitlab::Database.read_write?
end
def disable_two_factor! def disable_two_factor!
transaction do transaction do
update_attributes( update_attributes(
......
module Keys module Keys
class LastUsedService class LastUsedService
prepend ::EE::Keys::LastUsedService
TIMEOUT = 1.day.to_i TIMEOUT = 1.day.to_i
attr_reader :key attr_reader :key
...@@ -18,6 +16,8 @@ module Keys ...@@ -18,6 +16,8 @@ module Keys
end end
def update? def update?
return false if ::Gitlab::Database.read_only?
last_used = key.last_used_at last_used = key.last_used_at
return false if last_used && (Time.zone.now - last_used) <= TIMEOUT return false if last_used && (Time.zone.now - last_used) <= TIMEOUT
......
...@@ -14,7 +14,7 @@ module Users ...@@ -14,7 +14,7 @@ module Users
private private
def record_activity def record_activity
Gitlab::UserActivities.record(@author.id) unless Gitlab::Geo.secondary? Gitlab::UserActivities.record(@author.id) if Gitlab::Database.read_write?
Rails.logger.debug("Recorded activity: #{@activity} for User ID: #{@author.id} (username: #{@author.username})") Rails.logger.debug("Recorded activity: #{@activity} for User ID: #{@author.id} (username: #{@author.username})")
end end
......
...@@ -84,7 +84,7 @@ ...@@ -84,7 +84,7 @@
%p %p
.js-health .js-health
- unless Gitlab::Geo.secondary? - if Gitlab::Database.read_write?
.node-actions .node-actions
- if Gitlab::Geo.license_allows? - if Gitlab::Geo.license_allows?
- if node.missing_oauth_application? - if node.missing_oauth_application?
......
---
title: Create idea of read-only database and add method to check for it
merge_request: 2954
author:
type: changed
...@@ -174,8 +174,8 @@ module Gitlab ...@@ -174,8 +174,8 @@ module Gitlab
ENV['GITLAB_PATH_OUTSIDE_HOOK'] = ENV['PATH'] ENV['GITLAB_PATH_OUTSIDE_HOOK'] = ENV['PATH']
ENV['GIT_TERMINAL_PROMPT'] = '0' ENV['GIT_TERMINAL_PROMPT'] = '0'
# Gitlab Geo Middleware support # Gitlab Read-only middleware support
config.middleware.insert_after ActionDispatch::Flash, 'Gitlab::Middleware::ReadonlyGeo' config.middleware.insert_after ActionDispatch::Flash, 'Gitlab::Middleware::ReadOnly'
config.generators do |g| config.generators do |g|
g.factory_girl false g.factory_girl false
......
...@@ -78,19 +78,20 @@ to see if there are changes since the last time the log was checked ...@@ -78,19 +78,20 @@ to see if there are changes since the last time the log was checked
and will handle repository updates, deletes, changes & renames. and will handle repository updates, deletes, changes & renames.
## Readonly ## Read-only
All **Secondary** nodes are read-only. All **Secondary** nodes are read-only.
We have a Rails Middleware that filters any potentially writing operations The general principle of a [read-only database](verifying_database_capabilities.md#read-only-database)
and prevent user from trying to update the database and getting a 500 error applies to all Geo secondary nodes. So `Gitlab::Database.read_only?`
(see `Gitlab::Middleware::ReadonlyGeo`). will always return `true` on a secondary node.
Database will already be read-only in a replicated setup, so we don't need to When some write actions are not allowed, because the node is a
take any extra step for that. secondary, consider the `Gitlab::Database.read_only?` or `Gitlab::Database.read_write?`
guard, instead of `Gitlab::Geo.secondary?`.
We do use our feature toggle `.secondary?` to coordinate Git operations and do Database itself will already be read-only in a replicated setup, so we
the correct authorization (denying writing on any secondary node). don't need to take any extra step for that.
## File Transfers ## File Transfers
......
...@@ -24,3 +24,15 @@ else ...@@ -24,3 +24,15 @@ else
run_query run_query
end end
``` ```
# Read-only database
The database can be used in read-only mode. In this case we have to
make sure all GET requests don't attempt any write operations to the
database. If one of those requests wants to write to the database, it needs
to be wrapped in a `Gitlab::Database.read_only?` or `Gitlab::Database.read_write?`
guard, to make sure it doesn't for read-only databases.
We have a Rails Middleware that filters any potentially writing
operations (the CUD operations of CRUD) and prevent the user from trying
to update the database and getting a 500 error (see `Gitlab::Middleware::ReadOnly`).
module EE
module Admin
module ApplicationController
def read_only_message
raise NotImplementedError unless defined?(super)
return super unless Gitlab::Geo.secondary_with_primary?
link_to_primary_node = view_context.link_to('primary node', Gitlab::Geo.primary_node.url)
(_('You are on a read-only GitLab instance. If you want to make any changes, you must visit the %{link_to_primary_node}.') % { link_to_primary_node: link_to_primary_node }).html_safe
end
end
end
end
module EE
module Projects
module LfsApiController
def lfs_read_only_message
raise NotImplementedError unless defined?(super)
return super unless ::Gitlab::Geo.secondary_with_primary?
(_('You cannot write to a read-only secondary GitLab Geo instance. Please use %{link_to_primary_node} instead.') % { link_to_primary_node: geo_primary_default_url_to_repo(project) }).html_safe
end
end
end
end
...@@ -2,13 +2,45 @@ module EE ...@@ -2,13 +2,45 @@ module EE
module SessionsController module SessionsController
extend ActiveSupport::Concern extend ActiveSupport::Concern
prepended do
before_action :gitlab_geo_login, only: [:new]
before_action :gitlab_geo_logout, only: [:destroy]
end
private private
def gitlab_geo_login
return unless ::Gitlab::Geo.secondary?
return if signed_in?
oauth = ::Gitlab::Geo::OauthSession.new
# share full url with primary node by oauth state
user_return_to = URI.join(root_url, session[:user_return_to].to_s).to_s
oauth.return_to = stored_redirect_uri || user_return_to
redirect_to oauth_geo_auth_url(state: oauth.generate_oauth_state)
end
def gitlab_geo_logout
return unless ::Gitlab::Geo.secondary?
oauth = ::Gitlab::Geo::OauthSession.new(access_token: session[:access_token])
@geo_logout_state = oauth.generate_logout_state
end
def log_failed_login def log_failed_login
::AuditEventService.new(request.filtered_parameters['user']['login'], nil, ip_address: request.remote_ip) ::AuditEventService.new(request.filtered_parameters['user']['login'], nil, ip_address: request.remote_ip)
.for_failed_login.unauth_security_event .for_failed_login.unauth_security_event
super super
end end
def redirect_allowed_to?(uri)
raise NotImplementedError unless defined?(super)
# Redirect is not only allowed to current host, but also to other Geo nodes
super || ::Gitlab::Geo.geo_node?(host: uri.host, port: uri.port)
end
end end
end end
...@@ -273,14 +273,6 @@ module EE ...@@ -273,14 +273,6 @@ module EE
.order(order % quoted_values) # `order` cannot escape for us! .order(order % quoted_values) # `order` cannot escape for us!
end end
def cache_has_external_issue_tracker
super unless ::Gitlab::Geo.secondary?
end
def cache_has_external_wiki
super unless ::Gitlab::Geo.secondary?
end
def execute_hooks(data, hooks_scope = :push_hooks) def execute_hooks(data, hooks_scope = :push_hooks)
super super
......
...@@ -84,16 +84,6 @@ module EE ...@@ -84,16 +84,6 @@ module EE
super || auditor? super || auditor?
end end
def remember_me!
return if ::Gitlab::Geo.secondary?
super
end
def forget_me!
return if ::Gitlab::Geo.secondary?
super
end
def email_opted_in_source def email_opted_in_source
email_opted_in_source_id == EMAIL_OPT_IN_SOURCE_ID_GITLAB_COM ? 'GitLab.com' : '' email_opted_in_source_id == EMAIL_OPT_IN_SOURCE_ID_GITLAB_COM ? 'GitLab.com' : ''
end end
......
module EE module EE
module Keys module Gitlab
module LastUsedService module Database
def update? def self.read_only?
raise NotImplementedError unless defined?(super) raise NotImplementedError unless defined?(super)
!::Gitlab::Geo.secondary? && super Gitlab::Geo.secondary? || super
end end
end end
end end
......
...@@ -40,7 +40,7 @@ module Banzai ...@@ -40,7 +40,7 @@ module Banzai
return cacheless_render_field(object, field) return cacheless_render_field(object, field)
end end
object.refresh_markdown_cache!(do_update: update_object?(object)) unless object.cached_html_up_to_date?(field) object.refresh_markdown_cache! unless object.cached_html_up_to_date?(field)
object.cached_html_for(field) object.cached_html_for(field)
end end
...@@ -162,10 +162,5 @@ module Banzai ...@@ -162,10 +162,5 @@ module Banzai
return unless cache_key return unless cache_key
Rails.cache.__send__(:expanded_key, full_cache_key(cache_key, pipeline_name)) # rubocop:disable GitlabSecurity/PublicSend Rails.cache.__send__(:expanded_key, full_cache_key(cache_key, pipeline_name)) # rubocop:disable GitlabSecurity/PublicSend
end end
# GitLab EE needs to disable updates on GET requests in Geo
def self.update_object?(object)
!Gitlab::Geo.secondary?
end
end end
end end
module Gitlab module Gitlab
module Database module Database
extend ::EE::Gitlab::Database
# The max value of INTEGER type is the same between MySQL and PostgreSQL: # The max value of INTEGER type is the same between MySQL and PostgreSQL:
# https://www.postgresql.org/docs/9.2/static/datatype-numeric.html # https://www.postgresql.org/docs/9.2/static/datatype-numeric.html
# http://dev.mysql.com/doc/refman/5.7/en/integer-types.html # http://dev.mysql.com/doc/refman/5.7/en/integer-types.html
...@@ -29,6 +31,15 @@ module Gitlab ...@@ -29,6 +31,15 @@ module Gitlab
adapter_name.casecmp('postgresql').zero? adapter_name.casecmp('postgresql').zero?
end end
# Overridden in EE
def self.read_only?
false
end
def self.read_write?
!self.read_only?
end
def self.version def self.version
database_version.match(/\A(?:PostgreSQL |)([^\s]+).*\z/)[1] database_version.match(/\A(?:PostgreSQL |)([^\s]+).*\z/)[1]
end end
......
...@@ -54,6 +54,10 @@ module Gitlab ...@@ -54,6 +54,10 @@ module Gitlab
Gitlab::Geo.primary_node.present? Gitlab::Geo.primary_node.present?
end end
def self.secondary_with_primary?
self.secondary? && self.primary_node_configured?
end
def self.license_allows? def self.license_allows?
::License.feature_available?(:geo) ::License.feature_available?(:geo)
end end
......
...@@ -19,8 +19,8 @@ module Gitlab ...@@ -19,8 +19,8 @@ module Gitlab
command_not_allowed: "The command you're trying to execute is not allowed.", command_not_allowed: "The command you're trying to execute is not allowed.",
upload_pack_disabled_over_http: 'Pulling over HTTP is not allowed.', upload_pack_disabled_over_http: 'Pulling over HTTP is not allowed.',
receive_pack_disabled_over_http: 'Pushing over HTTP is not allowed.', receive_pack_disabled_over_http: 'Pushing over HTTP is not allowed.',
readonly: 'The repository is temporarily read-only. Please try again later.', read_only: 'The repository is temporarily read-only. Please try again later.',
cannot_push_to_secondary_geo: "You can't push code to a secondary GitLab Geo node." cannot_push_to_read_only: "You can't push code to a read-only GitLab instance."
}.freeze }.freeze
DOWNLOAD_COMMANDS = %w{ git-upload-pack git-upload-archive }.freeze DOWNLOAD_COMMANDS = %w{ git-upload-pack git-upload-archive }.freeze
...@@ -173,11 +173,11 @@ module Gitlab ...@@ -173,11 +173,11 @@ module Gitlab
# TODO: please clean this up # TODO: please clean this up
def check_push_access!(changes) def check_push_access!(changes)
if project.repository_read_only? if project.repository_read_only?
raise UnauthorizedError, ERROR_MESSAGES[:readonly] raise UnauthorizedError, ERROR_MESSAGES[:read_only]
end end
if Gitlab::Geo.secondary? if Gitlab::Database.read_only?
raise UnauthorizedError, ERROR_MESSAGES[:cannot_push_to_secondary_geo] raise UnauthorizedError, ERROR_MESSAGES[:cannot_push_to_read_only]
end end
if deploy_key if deploy_key
......
module Gitlab module Gitlab
class GitAccessWiki < GitAccess class GitAccessWiki < GitAccess
ERROR_MESSAGES = { ERROR_MESSAGES = {
geo: "You can't push code to a secondary GitLab Geo node.", read_only: "You can't push code to a read-only GitLab instance.",
write_to_wiki: "You are not allowed to write to this project's wiki." write_to_wiki: "You are not allowed to write to this project's wiki."
}.freeze }.freeze
...@@ -18,8 +18,8 @@ module Gitlab ...@@ -18,8 +18,8 @@ module Gitlab
raise UnauthorizedError, ERROR_MESSAGES[:write_to_wiki] raise UnauthorizedError, ERROR_MESSAGES[:write_to_wiki]
end end
if Gitlab::Geo.enabled? && Gitlab::Geo.secondary? if Gitlab::Database.read_only?
raise UnauthorizedError, ERROR_MESSAGES[:geo] raise UnauthorizedError, ERROR_MESSAGES[:read_only]
end end
true true
......
module Gitlab module Gitlab
module Middleware module Middleware
class ReadonlyGeo class ReadOnly
DISALLOWED_METHODS = %w(POST PATCH PUT DELETE).freeze DISALLOWED_METHODS = %w(POST PATCH PUT DELETE).freeze
APPLICATION_JSON = 'application/json'.freeze APPLICATION_JSON = 'application/json'.freeze
API_VERSIONS = (3..4) API_VERSIONS = (3..4)
...@@ -13,9 +13,9 @@ module Gitlab ...@@ -13,9 +13,9 @@ module Gitlab
def call(env) def call(env)
@env = env @env = env
if disallowed_request? && Gitlab::Geo.secondary? if disallowed_request? && Gitlab::Database.read_only?
Rails.logger.debug('GitLab Geo: preventing possible non readonly operation') Rails.logger.debug('GitLab ReadOnly: preventing possible non read-only operation')
error_message = 'You cannot do writing operations on a secondary GitLab Geo instance' error_message = 'You cannot do writing operations on a read-only GitLab instance'
if json_request? if json_request?
return [403, { 'Content-Type' => 'application/json' }, [{ 'message' => error_message }.to_json]] return [403, { 'Content-Type' => 'application/json' }, [{ 'message' => error_message }.to_json]]
......
require Rails.root.join('ee/lib/ee/gitlab/database')
require Rails.root.join('lib/gitlab/database') require Rails.root.join('lib/gitlab/database')
require Rails.root.join('lib/gitlab/database/migration_helpers') require Rails.root.join('lib/gitlab/database/migration_helpers')
require Rails.root.join('db/migrate/20151007120511_namespaces_projects_path_lower_indexes') require Rails.root.join('db/migrate/20151007120511_namespaces_projects_path_lower_indexes')
......
...@@ -83,8 +83,8 @@ describe EE::User do ...@@ -83,8 +83,8 @@ describe EE::User do
expect(subject.reload.remember_created_at).to be_nil expect(subject.reload.remember_created_at).to be_nil
end end
it 'does not clear remember_created_at when in a Geo secondary node' do it 'does not clear remember_created_at when in a GitLab read-only instance' do
allow(Gitlab::Geo).to receive(:secondary?) { true } allow(Gitlab::Database).to receive(:read_only?) { true }
expect { subject.forget_me! }.not_to change(subject, :remember_created_at) expect { subject.forget_me! }.not_to change(subject, :remember_created_at)
end end
...@@ -99,8 +99,8 @@ describe EE::User do ...@@ -99,8 +99,8 @@ describe EE::User do
expect(subject.reload.remember_created_at).not_to be_nil expect(subject.reload.remember_created_at).not_to be_nil
end end
it 'does not update remember_created_at when in a Geo secondary node' do it 'does not update remember_created_at when in a Geo read-only instance' do
allow(Gitlab::Geo).to receive(:secondary?) { true } allow(Gitlab::Database).to receive(:read_only?) { true }
expect { subject.remember_me! }.not_to change(subject, :remember_created_at) expect { subject.remember_me! }.not_to change(subject, :remember_created_at)
end end
......
require 'spec_helper' require 'spec_helper'
describe Keys::LastUsedService do describe Keys::LastUsedService do
it 'does not run on Geo secondaries', :clean_gitlab_redis_shared_state do it 'does not run on read-only GitLab instances', :clean_gitlab_redis_shared_state do
key = create(:key, last_used_at: 1.year.ago) key = create(:key, last_used_at: 1.year.ago)
original_time = key.last_used_at original_time = key.last_used_at
allow(::Gitlab::Geo).to receive(:secondary?).and_return(true) allow(::Gitlab::Database).to receive(:read_only?).and_return(true)
described_class.new(key).execute described_class.new(key).execute
expect(key.reload.last_used_at).to be_like_time(original_time) expect(key.reload.last_used_at).to be_like_time(original_time)
......
...@@ -174,7 +174,7 @@ FactoryGirl.define do ...@@ -174,7 +174,7 @@ FactoryGirl.define do
end end
end end
trait :readonly do trait :read_only do
repository_read_only true repository_read_only true
end end
......
...@@ -31,14 +31,14 @@ describe Banzai::Renderer do ...@@ -31,14 +31,14 @@ describe Banzai::Renderer do
let(:object) { fake_object(fresh: false) } let(:object) { fake_object(fresh: false) }
it 'caches and returns the result' do it 'caches and returns the result' do
expect(object).to receive(:refresh_markdown_cache!).with(do_update: true) expect(object).to receive(:refresh_markdown_cache!)
is_expected.to eq('field_html') is_expected.to eq('field_html')
end end
it "skips database caching on a Geo secondary" do it "skips database caching on a GitLab read-only instance" do
allow(Gitlab::Geo).to receive(:secondary?).and_return(true) allow(Gitlab::Database).to receive(:read_only?).and_return(true)
expect(object).to receive(:refresh_markdown_cache!).with(do_update: false) expect(object).to receive(:refresh_markdown_cache!)
is_expected.to eq('field_html') is_expected.to eq('field_html')
end end
......
...@@ -110,7 +110,7 @@ describe Gitlab::Geo do ...@@ -110,7 +110,7 @@ describe Gitlab::Geo do
end end
end end
describe 'readonly?' do describe 'secondary?' do
context 'when current node is secondary' do context 'when current node is secondary' do
it 'returns true' do it 'returns true' do
stub_current_geo_node(secondary_node) stub_current_geo_node(secondary_node)
......
...@@ -744,11 +744,10 @@ describe Gitlab::GitAccess do ...@@ -744,11 +744,10 @@ describe Gitlab::GitAccess do
run_permission_checks(admin: matrix) run_permission_checks(admin: matrix)
end end
context "when in a secondary gitlab geo node" do context "when in a read-only GitLab instance" do
before do before do
create(:protected_branch, name: 'feature', project: project) create(:protected_branch, name: 'feature', project: project)
allow(Gitlab::Geo).to receive(:enabled?) { true } allow(Gitlab::Database).to receive(:read_only?) { true }
allow(Gitlab::Geo).to receive(:secondary?) { true }
end end
# Only check admin; if an admin can't do it, other roles can't either # Only check admin; if an admin can't do it, other roles can't either
...@@ -944,7 +943,7 @@ describe Gitlab::GitAccess do ...@@ -944,7 +943,7 @@ describe Gitlab::GitAccess do
end end
context 'when the repository is read only' do context 'when the repository is read only' do
let(:project) { create(:project, :repository, :readonly) } let(:project) { create(:project, :repository, :read_only) }
it 'denies push access' do it 'denies push access' do
project.add_master(user) project.add_master(user)
......
...@@ -25,15 +25,13 @@ describe Gitlab::GitAccessWiki do ...@@ -25,15 +25,13 @@ describe Gitlab::GitAccessWiki do
it { expect { subject }.not_to raise_error } it { expect { subject }.not_to raise_error }
context 'when in a secondary gitlab geo node' do context 'when in a read-only GitLab instance' do
before do before do
allow(Gitlab::Geo).to receive(:enabled?) { true } allow(Gitlab::Database).to receive(:read_only?) { true }
allow(Gitlab::Geo).to receive(:secondary?) { true }
allow(Gitlab::Geo).to receive(:license_allows?) { true }
end end
it 'does not give access to upload wiki code' do it 'does not give access to upload wiki code' do
expect { subject }.to raise_error(Gitlab::GitAccess::UnauthorizedError, "You can't push code to a secondary GitLab Geo node.") expect { subject }.to raise_error(Gitlab::GitAccess::UnauthorizedError, "You can't push code to a read-only GitLab instance.")
end end
end end
end end
......
require 'spec_helper' require 'spec_helper'
describe Gitlab::Middleware::ReadonlyGeo do describe Gitlab::Middleware::ReadOnly do
include Rack::Test::Methods include Rack::Test::Methods
RSpec::Matchers.define :be_a_redirect do RSpec::Matchers.define :be_a_redirect do
...@@ -38,11 +38,11 @@ describe Gitlab::Middleware::ReadonlyGeo do ...@@ -38,11 +38,11 @@ describe Gitlab::Middleware::ReadonlyGeo do
let(:request) { Rack::MockRequest.new(rack_stack) } let(:request) { Rack::MockRequest.new(rack_stack) }
context 'normal requests to a secondary Gitlab Geo' do context 'normal requests to a read-only Gitlab instance' do
let(:fake_app) { lambda { |env| [200, { 'Content-Type' => 'text/plain' }, ['OK']] } } let(:fake_app) { lambda { |env| [200, { 'Content-Type' => 'text/plain' }, ['OK']] } }
before do before do
allow(Gitlab::Geo).to receive(:secondary?) { true } allow(Gitlab::Database).to receive(:read_only?) { true }
end end
it 'expects PATCH requests to be disallowed' do it 'expects PATCH requests to be disallowed' do
...@@ -98,13 +98,6 @@ describe Gitlab::Middleware::ReadonlyGeo do ...@@ -98,13 +98,6 @@ describe Gitlab::Middleware::ReadonlyGeo do
expect(subject).not_to disallow_request expect(subject).not_to disallow_request
end end
it 'expects a GET status request to be allowed' do
response = request.get("/api/#{API::API.version}/geo/status")
expect(response).not_to be_a_redirect
expect(subject).not_to disallow_request
end
it 'expects a POST LFS request to batch URL to be allowed' do it 'expects a POST LFS request to batch URL to be allowed' do
response = request.post('/root/rouge.git/info/lfs/objects/batch') response = request.post('/root/rouge.git/info/lfs/objects/batch')
...@@ -114,12 +107,12 @@ describe Gitlab::Middleware::ReadonlyGeo do ...@@ -114,12 +107,12 @@ describe Gitlab::Middleware::ReadonlyGeo do
end end
end end
context 'json requests to a secondary Geo node' do context 'json requests to a read-only GitLab instance' do
let(:fake_app) { lambda { |env| [200, { 'Content-Type' => 'application/json' }, ['OK']] } } let(:fake_app) { lambda { |env| [200, { 'Content-Type' => 'application/json' }, ['OK']] } }
let(:content_json) { { 'CONTENT_TYPE' => 'application/json' } } let(:content_json) { { 'CONTENT_TYPE' => 'application/json' } }
before do before do
allow(Gitlab::Geo).to receive(:secondary?) { true } allow(Gitlab::Database).to receive(:read_only?) { true }
end end
it 'expects PATCH requests to be disallowed' do it 'expects PATCH requests to be disallowed' do
......
...@@ -178,14 +178,13 @@ describe CacheMarkdownField do ...@@ -178,14 +178,13 @@ describe CacheMarkdownField do
end end
end end
describe '#refresh_markdown_cache!' do describe '#refresh_markdown_cache' do
before do before do
thing.foo = updated_markdown thing.foo = updated_markdown
end end
context 'do_update: false' do
it 'fills all html fields' do it 'fills all html fields' do
thing.refresh_markdown_cache! thing.refresh_markdown_cache
expect(thing.foo_html).to eq(updated_html) expect(thing.foo_html).to eq(updated_html)
expect(thing.foo_html_changed?).to be_truthy expect(thing.foo_html_changed?).to be_truthy
...@@ -195,20 +194,24 @@ describe CacheMarkdownField do ...@@ -195,20 +194,24 @@ describe CacheMarkdownField do
it 'does not save the result' do it 'does not save the result' do
expect(thing).not_to receive(:update_columns) expect(thing).not_to receive(:update_columns)
thing.refresh_markdown_cache! thing.refresh_markdown_cache
end end
it 'updates the markdown cache version' do it 'updates the markdown cache version' do
thing.cached_markdown_version = nil thing.cached_markdown_version = nil
thing.refresh_markdown_cache! thing.refresh_markdown_cache
expect(thing.cached_markdown_version).to eq(CacheMarkdownField::CACHE_VERSION) expect(thing.cached_markdown_version).to eq(CacheMarkdownField::CACHE_VERSION)
end end
end end
context 'do_update: true' do describe '#refresh_markdown_cache!' do
before do
thing.foo = updated_markdown
end
it 'fills all html fields' do it 'fills all html fields' do
thing.refresh_markdown_cache!(do_update: true) thing.refresh_markdown_cache!
expect(thing.foo_html).to eq(updated_html) expect(thing.foo_html).to eq(updated_html)
expect(thing.foo_html_changed?).to be_truthy expect(thing.foo_html_changed?).to be_truthy
...@@ -219,7 +222,7 @@ describe CacheMarkdownField do ...@@ -219,7 +222,7 @@ describe CacheMarkdownField do
expect(thing).to receive(:persisted?).and_return(false) expect(thing).to receive(:persisted?).and_return(false)
expect(thing).not_to receive(:update_columns) expect(thing).not_to receive(:update_columns)
thing.refresh_markdown_cache!(do_update: true) thing.refresh_markdown_cache!
end end
it 'saves the changes using #update_columns' do it 'saves the changes using #update_columns' do
...@@ -227,8 +230,7 @@ describe CacheMarkdownField do ...@@ -227,8 +230,7 @@ describe CacheMarkdownField do
expect(thing).to receive(:update_columns) expect(thing).to receive(:update_columns)
.with("foo_html" => updated_html, "baz_html" => "", "cached_markdown_version" => CacheMarkdownField::CACHE_VERSION) .with("foo_html" => updated_html, "baz_html" => "", "cached_markdown_version" => CacheMarkdownField::CACHE_VERSION)
thing.refresh_markdown_cache!(do_update: true) thing.refresh_markdown_cache!
end
end end
end end
......
...@@ -12,10 +12,10 @@ describe Group, 'Routable' do ...@@ -12,10 +12,10 @@ describe Group, 'Routable' do
it { is_expected.to have_many(:redirect_routes).dependent(:destroy) } it { is_expected.to have_many(:redirect_routes).dependent(:destroy) }
end end
describe 'Geo secondary' do describe 'GitLab read-only instance' do
it 'does not save route if route is not present' do it 'does not save route if route is not present' do
group.route.path = '' group.route.path = ''
allow(Gitlab::Geo).to receive(:secondary?).and_return(true) allow(Gitlab::Database).to receive(:read_only?).and_return(true)
expect(group).to receive(:update_route).and_call_original expect(group).to receive(:update_route).and_call_original
expect { group.full_path }.to change { Route.count }.by(0) expect { group.full_path }.to change { Route.count }.by(0)
......
...@@ -822,8 +822,8 @@ describe Project do ...@@ -822,8 +822,8 @@ describe Project do
end.to change { project.has_external_issue_tracker}.to(false) end.to change { project.has_external_issue_tracker}.to(false)
end end
it 'does not cache data when in a secondary gitlab geo node' do it 'does not cache data when in a read-only GitLab instance' do
allow(Gitlab::Geo).to receive(:secondary?) { true } allow(Gitlab::Database).to receive(:read_only?) { true }
expect do expect do
project.cache_has_external_issue_tracker project.cache_has_external_issue_tracker
...@@ -852,8 +852,8 @@ describe Project do ...@@ -852,8 +852,8 @@ describe Project do
end.to change { project.has_external_wiki}.to(false) end.to change { project.has_external_wiki}.to(false)
end end
it 'does not cache data when in a secondary gitlab geo node' do it 'does not cache data when in a read-only GitLab instance' do
allow(Gitlab::Geo).to receive(:secondary?) { true } allow(Gitlab::Database).to receive(:read_only?) { true }
expect do expect do
project.cache_has_external_wiki project.cache_has_external_wiki
...@@ -2928,7 +2928,7 @@ describe Project do ...@@ -2928,7 +2928,7 @@ describe Project do
expect(project.migrate_to_hashed_storage!).to be_truthy expect(project.migrate_to_hashed_storage!).to be_truthy
end end
it 'flags as readonly' do it 'flags as read-only' do
expect { project.migrate_to_hashed_storage! }.to change { project.repository_read_only }.to(true) expect { project.migrate_to_hashed_storage! }.to change { project.repository_read_only }.to(true)
end end
...@@ -3055,7 +3055,7 @@ describe Project do ...@@ -3055,7 +3055,7 @@ describe Project do
expect(project.migrate_to_hashed_storage!).to be_nil expect(project.migrate_to_hashed_storage!).to be_nil
end end
it 'does not flag as readonly' do it 'does not flag as read-only' do
expect { project.migrate_to_hashed_storage! }.not_to change { project.repository_read_only } expect { project.migrate_to_hashed_storage! }.not_to change { project.repository_read_only }
end end
end end
......
...@@ -877,8 +877,7 @@ describe 'Git LFS API and storage' do ...@@ -877,8 +877,7 @@ describe 'Git LFS API and storage' do
end end
end end
describe 'when handling lfs batch request on a secondary Geo node' do describe 'when handling lfs batch request on a read-only GitLab instance' do
let!(:primary) { create(:geo_node, :primary) }
let(:authorization) { authorize_user } let(:authorization) { authorize_user }
let(:project) { create(:project) } let(:project) { create(:project) }
let(:path) { "#{project.http_url_to_repo}/info/lfs/objects/batch" } let(:path) { "#{project.http_url_to_repo}/info/lfs/objects/batch" }
...@@ -887,7 +886,7 @@ describe 'Git LFS API and storage' do ...@@ -887,7 +886,7 @@ describe 'Git LFS API and storage' do
end end
before do before do
allow(Gitlab::Geo).to receive(:secondary?) { true } allow(Gitlab::Database).to receive(:read_only?) { true }
project.team << [user, :master] project.team << [user, :master]
enable_lfs enable_lfs
end end
...@@ -902,7 +901,7 @@ describe 'Git LFS API and storage' do ...@@ -902,7 +901,7 @@ describe 'Git LFS API and storage' do
post_lfs_json path, body.merge('operation' => 'upload'), headers post_lfs_json path, body.merge('operation' => 'upload'), headers
expect(response).to have_gitlab_http_status(403) expect(response).to have_gitlab_http_status(403)
expect(json_response).to include('message' => "You cannot write to a secondary GitLab Geo instance. Please use #{project.http_url_to_repo} instead.") expect(json_response).to include('message' => 'You cannot write to this read-only GitLab instance.')
end end
end end
......
...@@ -20,7 +20,7 @@ describe Projects::HashedStorageMigrationService do ...@@ -20,7 +20,7 @@ describe Projects::HashedStorageMigrationService do
expect(gitlab_shell.exists?(project.repository_storage_path, "#{hashed_storage.disk_path}.wiki.git")).to be_truthy expect(gitlab_shell.exists?(project.repository_storage_path, "#{hashed_storage.disk_path}.wiki.git")).to be_truthy
end end
it 'updates project to be hashed and not readonly' do it 'updates project to be hashed and not read-only' do
service.execute service.execute
expect(project.hashed_storage?).to be_truthy expect(project.hashed_storage?).to be_truthy
......
...@@ -39,9 +39,9 @@ describe Users::ActivityService do ...@@ -39,9 +39,9 @@ describe Users::ActivityService do
end end
end end
context 'when in Geo secondary node' do context 'when in GitLab read-only instance' do
before do before do
allow(Gitlab::Geo).to receive(:secondary?).and_return(true) allow(Gitlab::Database).to receive(:read_only?).and_return(true)
end end
it 'does not update last_activity_at' do it 'does not update last_activity_at' do
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment