Class: Gitlab::EtagCaching::Router::Rails

Inherits:

Object

• Object
• Gitlab::EtagCaching::Router::Rails

Extended by:

Helpers

Defined in:

lib/gitlab/etag_caching/router/rails.rb

Constant Summary

USED_IN_ROUTES =

We enable an ETag for every request matching the regex. To match a regex the path needs to match the following:

- Don't contain a reserved word (expect for the words used in the
  regex itself)
- Ending in `issues/id`/realtime_changes` for the `issue_title` route

%w[noteable issue issues realtime_changes
commit pipelines merge_requests builds
new environments].freeze

RESERVED_WORDS =

Gitlab::PathRegex::ILLEGAL_PROJECT_PATH_WORDS - USED_IN_ROUTES

RESERVED_WORDS_REGEX =

Regexp.union(*RESERVED_WORDS.map(&Regexp.method(:escape)))

RESERVED_WORDS_PREFIX =

%(^(?!.*\/(#{RESERVED_WORDS_REGEX})\/).*)

ROUTES =

[
  [
    %r{#{RESERVED_WORDS_PREFIX}/issues/\d+/realtime_changes\z},
    'issue_title',
    ::Projects::IssuesController,
    :realtime_changes
  ],
  [
    %r{#{RESERVED_WORDS_PREFIX}/commit/\S+/pipelines\.json\z},
    'commit_pipelines',
    ::Projects::CommitController,
    :pipelines
  ],
  [
    %r{#{RESERVED_WORDS_PREFIX}/merge_requests/new\.json\z},
    'new_merge_request_pipelines',
    ::Projects::MergeRequests::CreationsController,
    :new
  ],
  [
    %r{#{RESERVED_WORDS_PREFIX}/merge_requests/\d+/pipelines\.json\z},
    'merge_request_pipelines',
    ::Projects::MergeRequestsController,
    :pipelines
  ],
  [
    %r{#{RESERVED_WORDS_PREFIX}/pipelines\.json\z},
    'project_pipelines',
    ::Projects::PipelinesController,
    :index
  ],
  [
    %r{#{RESERVED_WORDS_PREFIX}/pipelines/\d+\.json\z},
    'project_pipeline',
    ::Projects::PipelinesController,
    :show
  ],
  [
    %r{#{RESERVED_WORDS_PREFIX}/builds/\d+\.json\z},
    'project_build',
    ::Projects::BuildsController,
    :show
  ],
  [
    %r{#{RESERVED_WORDS_PREFIX}/clusters/\d+/environments\z},
    'cluster_environments',
    ::Groups::ClustersController,
    :environments
  ],
  [
    %r{#{RESERVED_WORDS_PREFIX}/-/environments\.json\z},
    'environments',
    ::Projects::EnvironmentsController,
    :index
  ],
  [
    %r{#{RESERVED_WORDS_PREFIX}/import/github/realtime_changes\.json\z},
    'realtime_changes_import_github',
    ::Import::GithubController,
    :realtime_changes
  ],
  [
    %r{#{RESERVED_WORDS_PREFIX}/import/gitea/realtime_changes\.json\z},
    'realtime_changes_import_gitea',
    ::Import::GiteaController,
    :realtime_changes
  ],
  [
    %r{#{RESERVED_WORDS_PREFIX}/merge_requests/\d+/cached_widget\.json\z},
    'merge_request_widget',
    ::Projects::MergeRequests::ContentController,
    :cached_widget
  ]
].map { |attrs| build_rails_route(*attrs) }.freeze

Class Method Summary

• .all_routes ⇒ Object

  Overridden in EE to add more routes.

• .cache_key(request) ⇒ Object
• .match(request) ⇒ Object

Methods included from Helpers

build_graphql_route, build_rails_route

Class Method Details

.all_routes ⇒ Object

Overridden in EE to add more routes

# File 'lib/gitlab/etag_caching/router/rails.rb', line 97

def self.all_routes
  ROUTES
end

.cache_key(request) ⇒ Object

# File 'lib/gitlab/etag_caching/router/rails.rb', line 105

def self.cache_key(request)
  request.path
end

.match(request) ⇒ Object

# File 'lib/gitlab/etag_caching/router/rails.rb', line 101

def self.match(request)
  all_routes.find { |route| route.match(request.path_info) }
end