summaryrefslogtreecommitdiff
path: root/lib/gitlab/metrics/dashboard/project_dashboard_service.rb
blob: 5a1c4ecf886428a594751e88b356d8aebe487b08 (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
# frozen_string_literal: true

# Searches a projects repository for a metrics dashboard and formats the output.
# Expects any custom dashboards will be located in `.gitlab/dashboards`
# Use Gitlab::Metrics::Dashboard::Finder to retrive dashboards.
module Gitlab
  module Metrics
    module Dashboard
      class ProjectDashboardService < Gitlab::Metrics::Dashboard::BaseService
        DASHBOARD_ROOT = ".gitlab/dashboards"

        class << self
          def all_dashboard_paths(project)
            file_finder(project)
              .list_files_for(DASHBOARD_ROOT)
              .map do |filepath|
                {
                  path: filepath,
                  display_name: name_for_path(filepath),
                  default: false
                }
              end
          end

          def file_finder(project)
            Gitlab::Template::Finders::RepoTemplateFinder.new(project, DASHBOARD_ROOT, '.yml')
          end

          # Grabs the filepath after the base directory.
          def name_for_path(filepath)
            filepath.delete_prefix("#{DASHBOARD_ROOT}/")
          end
        end

        private

        # Searches the project repo for a custom-defined dashboard.
        def get_raw_dashboard
          yml = self.class.file_finder(project).read(dashboard_path)

          YAML.safe_load(yml)
        end

        def cache_key
          "project_#{project.id}_metrics_dashboard_#{dashboard_path}"
        end
      end
    end
  end
end