app/services/metrics/dashboard/custom_dashboard_service.rb


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

# 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 Metrics
  module Dashboard
    class CustomDashboardService < ::Metrics::Dashboard::BaseService
      class << self
        def valid_params?(params)
          params[:dashboard_path].present?
        end

        def all_dashboard_paths(project)
          project.repository.user_defined_metrics_dashboard_paths
            .map do |filepath|
              {
                path: filepath,
                display_name: name_for_path(filepath),
                default: false,
                system_dashboard: false,
                out_of_the_box_dashboard: out_of_the_box_dashboard?
              }
            end
        end

        # Grabs the filepath after the base directory.
        def name_for_path(filepath)
          filepath.delete_prefix("#{Gitlab::Metrics::Dashboard::RepoDashboardFinder::DASHBOARD_ROOT}/")
        end
      end

      private

      # Searches the project repo for a custom-defined dashboard.
      def get_raw_dashboard
        yml = Gitlab::Metrics::Dashboard::RepoDashboardFinder.read_dashboard(project, dashboard_path)

        load_yaml(yml)
      end

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