summaryrefslogtreecommitdiff
path: root/lib/gitlab/gitaly_client/storage_settings.rb
blob: 8e8d6c18519e6adc1b8ee9ebcb31e5ec340fba28 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
module Gitlab
  module GitalyClient
    # This is a chokepoint that is meant to help us stop remove all places
    # where production code (app, config, db, lib) touches Git repositories
    # directly.
    class StorageSettings
      DirectPathAccessError = Class.new(StandardError)
      InvalidConfigurationError = Class.new(StandardError)

      INVALID_STORAGE_MESSAGE = <<~MSG.freeze
        Storage is invalid because it has no `path` key.

        For source installations, update your config/gitlab.yml Refer to gitlab.yml.example for an updated example.
        If you're using the Gitlab Development Kit, you can update your configuration running `gdk reconfigure`.
      MSG

      # This class will give easily recognizable NoMethodErrors
      Deprecated = Class.new

      MUTEX = Mutex.new

      DISK_ACCESS_DENIED_FLAG = :deny_disk_access

      # If your code needs this method then your code needs to be fixed.
      def self.allow_disk_access
        self.disk_access_override_add(1)
        yield
      ensure
        self.disk_access_override_add(-1)
      end

      def self.disk_access_override?
        if RequestStore.active?
          RequestStore.fetch(:gitaly_disk_access_override, 0) > 0
        else
          MUTEX.synchronize { @disk_access_override && @disk_access_override > 0 }
        end
      end

      def self.disk_access_override_add(value)
        if RequestStore.active?
          RequestStore[:gitaly_disk_access_override] ||= 0
          RequestStore[:gitaly_disk_access_override] += value
        else
          MUTEX.synchronize do
            @disk_access_override ||= 0
            @disk_access_override += value
          end
        end
      end

      def self.disk_access_denied?
        !disk_access_override? && GitalyClient.feature_enabled?(DISK_ACCESS_DENIED_FLAG)
      rescue
        false # Err on the side of caution, don't break gitlab for people
      end

      def initialize(storage)
        raise InvalidConfigurationError, "expected a Hash, got a #{storage.class.name}" unless storage.is_a?(Hash)
        raise InvalidConfigurationError, INVALID_STORAGE_MESSAGE unless storage.has_key?('path')

        # Support a nil 'path' field because some of the circuit breaker tests use it.
        @legacy_disk_path = File.expand_path(storage['path'], Rails.root) if storage['path']

        storage['path'] = Deprecated
        @hash = storage
      end

      def gitaly_address
        @hash.fetch(:gitaly_address)
      end

      def legacy_disk_path
        if self.class.disk_access_denied?
          raise DirectPathAccessError, "git disk access denied via the gitaly_#{DISK_ACCESS_DENIED_FLAG} feature"
        end

        @legacy_disk_path
      end

      private

      def method_missing(m, *args, &block)
        @hash.public_send(m, *args, &block) # rubocop:disable GitlabSecurity/PublicSend
      end
    end
  end
end