summaryrefslogtreecommitdiff
path: root/lib/gitlab/etag_caching/middleware.rb
blob: 9c98f0d1a306e4cafac16d3ba6c041186c238639 (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
module Gitlab
  module EtagCaching
    class Middleware
      RESERVED_WORDS = ProjectPathValidator::RESERVED.map { |word| "/#{word}/" }.join('|')
      ROUTE_REGEXP = Regexp.union(
        %r(^(?!.*(#{RESERVED_WORDS})).*/noteable/issue/\d+/notes\z)
      )

      def initialize(app)
        @app = app
      end

      def call(env)
        return @app.call(env) unless enabled_for_current_route?(env)
        Gitlab::Metrics.add_event(:etag_caching_middleware_used)

        etag, cached_value_present = get_etag(env)
        if_none_match = env['HTTP_IF_NONE_MATCH']

        if if_none_match == etag
          handle_cache_hit(etag)
        else
          track_cache_miss(if_none_match, cached_value_present)

          status, headers, body = @app.call(env)
          headers['ETag'] = etag
          [status, headers, body]
        end
      end

      private

      def enabled_for_current_route?(env)
        ROUTE_REGEXP.match(env['PATH_INFO'])
      end

      def get_etag(env)
        cache_key = env['PATH_INFO']
        store = Gitlab::EtagCaching::Store.new
        current_value = store.get(cache_key)
        cached_value_present = current_value.present?

        unless cached_value_present
          current_value = store.touch(cache_key, only_if_missing: true)
        end

        [weak_etag_format(current_value), cached_value_present]
      end

      def weak_etag_format(value)
        %Q{W/"#{value}"}
      end

      def handle_cache_hit(etag)
        Gitlab::Metrics.add_event(:etag_caching_cache_hit)

        status_code = Gitlab::PollingInterval.polling_enabled? ? 304 : 429

        [status_code, { 'ETag' => etag }, ['']]
      end

      def track_cache_miss(if_none_match, cached_value_present)
        if if_none_match.blank?
          Gitlab::Metrics.add_event(:etag_caching_header_missing)
        elsif !cached_value_present
          Gitlab::Metrics.add_event(:etag_caching_key_not_found)
        else
          Gitlab::Metrics.add_event(:etag_caching_resource_changed)
        end
      end
    end
  end
end