Read about our upcoming Code of Conduct on this issue

This instance will be upgraded to Heptapod 0.28.1 on 2022-01-26 at 16:00 UTC+1 (a few minutes of down time)

project_error_tracking_setting.rb 4.88 KB
Newer Older
1
2
3
# frozen_string_literal: true

module ErrorTracking
4
  class ProjectErrorTrackingSetting < ApplicationRecord
Reuben Pereira's avatar
Reuben Pereira committed
5
    include Gitlab::Utils::StrongMemoize
6
7
    include ReactiveCaching

8
    SENTRY_API_ERROR_TYPE_BAD_REQUEST = 'bad_request_for_sentry_api'
9
10
    SENTRY_API_ERROR_TYPE_MISSING_KEYS = 'missing_keys_in_sentry_response'
    SENTRY_API_ERROR_TYPE_NON_20X_RESPONSE = 'non_20x_response_from_sentry'
11
    SENTRY_API_ERROR_INVALID_SIZE = 'invalid_size_of_sentry_response'
12

Reuben Pereira's avatar
Reuben Pereira committed
13
14
15
16
17
18
19
20
    API_URL_PATH_REGEXP = %r{
      \A
        (?<prefix>/api/0/projects/+)
        (?:
          (?<organization>[^/]+)/+
          (?<project>[^/]+)/*
        )?
      \z
Stan Hu's avatar
Stan Hu committed
21
    }x.freeze
Reuben Pereira's avatar
Reuben Pereira committed
22

23
24
    self.reactive_cache_key = ->(setting) { [setting.class.model_name.singular, setting.project_id] }

25
26
    belongs_to :project

27
    validates :api_url, length: { maximum: 255 }, public_url: { enforce_sanitization: true, ascii_only: true }, allow_nil: true
28

Reuben Pereira's avatar
Reuben Pereira committed
29
    validates :api_url, presence: { message: 'is a required field' }, if: :enabled
30
31
32

    validate :validate_api_url_path, if: :enabled

Reuben Pereira's avatar
Reuben Pereira committed
33
    validates :token, presence: { message: 'is a required field' }, if: :enabled
34

35
36
37
38
    attr_encrypted :token,
      mode: :per_attribute_iv,
      key: Settings.attr_encrypted_db_key_base_truncated,
      algorithm: 'aes-256-gcm'
39
40
41

    after_save :clear_reactive_cache!

Reuben Pereira's avatar
Reuben Pereira committed
42
43
44
45
46
    def api_url=(value)
      super
      clear_memoization(:api_url_slugs)
    end

47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
    def project_name
      super || project_name_from_slug
    end

    def organization_name
      super || organization_name_from_slug
    end

    def project_slug
      project_slug_from_api_url
    end

    def organization_slug
      organization_slug_from_api_url
    end

    def self.build_api_url_from(api_host:, project_slug:, organization_slug:)
Reuben Pereira's avatar
Reuben Pereira committed
64
65
      return if api_host.blank?

66
67
68
69
70
71
72
73
      uri = Addressable::URI.parse("#{api_host}/api/0/projects/#{organization_slug}/#{project_slug}/")
      uri.path = uri.path.squeeze('/')

      uri.to_s
    rescue Addressable::URI::InvalidURIError
      api_host
    end

74
75
76
77
78
79
80
81
82
83
    def sentry_client
      Sentry::Client.new(api_url, token)
    end

    def sentry_external_url
      self.class.extract_sentry_external_url(api_url)
    end

    def list_sentry_issues(opts = {})
      with_reactive_cache('list_issues', opts.stringify_keys) do |result|
84
        result
85
86
87
      end
    end

88
89
90
91
    def list_sentry_projects
      { projects: sentry_client.list_projects }
    end

92
93
94
95
96
97
98
99
100
101
102
103
    def issue_details(opts = {})
      with_reactive_cache('issue_details', opts.stringify_keys) do |result|
        result
      end
    end

    def issue_latest_event(opts = {})
      with_reactive_cache('issue_latest_event', opts.stringify_keys) do |result|
        result
      end
    end

104
105
106
    def calculate_reactive_cache(request, opts)
      case request
      when 'list_issues'
107
        sentry_client.list_issues(**opts.symbolize_keys)
108
109
110
111
112
113
114
115
      when 'issue_details'
        {
          issue: sentry_client.issue_details(**opts.symbolize_keys)
        }
      when 'issue_latest_event'
        {
          latest_event: sentry_client.issue_latest_event(**opts.symbolize_keys)
        }
116
      end
117
    rescue Sentry::Client::Error => e
118
119
120
      { error: e.message, error_type: SENTRY_API_ERROR_TYPE_NON_20X_RESPONSE }
    rescue Sentry::Client::MissingKeysError => e
      { error: e.message, error_type: SENTRY_API_ERROR_TYPE_MISSING_KEYS }
121
122
    rescue Sentry::Client::ResponseInvalidSizeError => e
      { error: e.message, error_type: SENTRY_API_ERROR_INVALID_SIZE }
123
124
    rescue Sentry::Client::BadRequestError => e
      { error: e.message, error_type: SENTRY_API_ERROR_TYPE_BAD_REQUEST }
125
126
127
128
129
130
131
132
133
    end

    # http://HOST/api/0/projects/ORG/PROJECT
    # ->
    # http://HOST/ORG/PROJECT
    def self.extract_sentry_external_url(url)
      url.sub('api/0/projects/', '')
    end

134
135
136
137
138
139
140
    def api_host
      return if api_url.blank?

      # This returns http://example.com/
      Addressable::URI.join(api_url, '/').to_s
    end

141
142
    private

143
144
145
146
147
148
149
150
151
    def project_name_from_slug
      @project_name_from_slug ||= project_slug_from_api_url&.titleize
    end

    def organization_name_from_slug
      @organization_name_from_slug ||= organization_slug_from_api_url&.titleize
    end

    def project_slug_from_api_url
Reuben Pereira's avatar
Reuben Pereira committed
152
      api_url_slug(:project)
153
154
155
    end

    def organization_slug_from_api_url
Reuben Pereira's avatar
Reuben Pereira committed
156
157
158
159
160
161
      api_url_slug(:organization)
    end

    def api_url_slug(capture)
      slugs = strong_memoize(:api_url_slugs) { extract_api_url_slugs || {} }
      slugs[capture]
162
163
    end

Reuben Pereira's avatar
Reuben Pereira committed
164
    def extract_api_url_slugs
165
166
167
168
169
      return if api_url.blank?

      begin
        url = Addressable::URI.parse(api_url)
      rescue Addressable::URI::InvalidURIError
Reuben Pereira's avatar
Reuben Pereira committed
170
        return
171
172
      end

Reuben Pereira's avatar
Reuben Pereira committed
173
      url.path.match(API_URL_PATH_REGEXP)
174
175
    end

176
    def validate_api_url_path
177
178
      return if api_url.blank?

Reuben Pereira's avatar
Reuben Pereira committed
179
180
181
182
183
184
      unless api_url_slug(:prefix)
        return errors.add(:api_url, 'is invalid')
      end

      unless api_url_slug(:organization)
        errors.add(:project, 'is a required field')
185
186
      end
    end
187
188
  end
end