Add specs for name_suggestion

lib/gitlab/usage/metrics/instrumentations/generic_metric.rb

@@ -25,6 +25,14 @@ module Gitlab
               self.class.metric_value.call
             end
           end
+
+          def suggested_name
+            Gitlab::Usage::Metrics::NameSuggestion.for(
+              :alt,
+              relation: nil,
+              column: nil
+            )
+          end
         end
       end
     end

lib/gitlab/usage/metrics/instrumentations/redis_hll_metric.rb

@@ -30,6 +30,14 @@ module Gitlab
             end
           end
 
+          def suggested_name
+            Gitlab::Usage::Metrics::NameSuggestion.for(
+              :redis,
+              relation: nil,
+              column: nil
+            )
+          end
+
           private
 
           def time_constraints

lib/gitlab/usage/metrics/name_suggestion.rb

@@ -17,8 +17,6 @@ module Gitlab
               name_suggestion(column: column, relation: relation, prefix: 'count_distinct', distinct: :distinct)
             when :estimate_batch_distinct_count
               name_suggestion(column: column, relation: relation, prefix: 'estimate_distinct_count')
-            when :add
-              "add_#{relation.join('_and_')}"
             when :sum
               name_suggestion(column: column, relation: relation, prefix: 'sum')
             when :redis

lib/gitlab/usage/metrics/names_suggestions/generator.rb

@@ -41,7 +41,7 @@ module Gitlab
             end
 
             def add(*args)
-              Gitlab::Usage::Metrics::NameSuggestion.for(:add, relation: args)
+              "add_#{args.join('_and_')}"
             end
           end
         end

spec/lib/gitlab/usage/metrics/name_suggestion_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gitlab::Usage::Metrics::NameSuggestion do
+  describe '#for' do
+    shared_examples 'name suggestion' do
+      it 'return correct name' do
+        expect(described_class.for(operation, relation: relation, column: column)).to match name_suggestion
+      end
+    end
+
+    context 'for count with nil column' do
+      it_behaves_like 'name suggestion' do
+        let(:operation) { :count }
+        let(:relation) { Board }
+        let(:column) { nil }
+        let(:name_suggestion) { /count_boards/ }
+      end
+    end
+
+    context 'for count with column :id' do
+      it_behaves_like 'name suggestion' do
+        let(:operation) { :count }
+        let(:relation) { Board }
+        let(:column) { :id }
+        let(:name_suggestion) { /count_boards/ }
+      end
+    end
+
+    context 'for count distinct with column defined metrics' do
+      it_behaves_like 'name suggestion' do
+        let(:operation) { :distinct_count }
+        let(:relation) { ZoomMeeting }
+        let(:column) { :issue_id }
+        let(:name_suggestion) { /count_distinct_issue_id_from_zoom_meetings/ }
+      end
+    end
+
+    context 'joined relations' do
+      context 'counted attribute comes from joined relation' do
+        it_behaves_like 'name suggestion' do
+          let(:operation) { :distinct_count }
+          let(:column) { ::Deployment.arel_table[:environment_id] }
+          let(:relation) do
+            ::Clusters::Applications::Ingress.modsecurity_enabled.logging
+              .joins(cluster: :deployments)
+              .merge(::Clusters::Cluster.enabled)
+              .merge(Deployment.success)
+          end
+
+          let(:constraints) { /'\(clusters_applications_ingress\.modsecurity_enabled = TRUE AND clusters_applications_ingress\.modsecurity_mode = \d+ AND clusters.enabled = TRUE AND deployments.status = \d+\)'/ }
+          let(:name_suggestion) { /count_distinct_environment_id_from_<adjective describing\: #{constraints}>_deployments_<with>_<adjective describing\: #{constraints}>_clusters_<having>_<adjective describing\: #{constraints}>_clusters_applications_ingress/ }
+        end
+      end
+
+      context 'counted attribute comes from source relation' do
+        it_behaves_like 'name suggestion' do
+          # corresponding metric is collected with count(Issue.with_alert_management_alerts.not_authored_by(::User.alert_bot), start: issue_minimum_id, finish: issue_maximum_id)
+          let(:operation) { :count }
+          let(:relation) { Issue.with_alert_management_alerts.not_authored_by(::User.alert_bot) }
+          let(:column) { nil }
+          let(:name_suggestion) { /count_<adjective describing\: '\(issues\.author_id != \d+\)'>_issues_<with>_alert_management_alerts/ }
+        end
+      end
+    end
+
+    context 'strips off time period constraint' do
+      it_behaves_like 'name suggestion' do
+        # corresponding metric is collected with distinct_count(::Clusters::Cluster.aws_installed.enabled.where(time_period), :user_id)
+        let(:operation) { :distinct_count }
+        let(:relation) { ::Clusters::Cluster.aws_installed.enabled.where(created_at: 30.days.ago..2.days.ago ) }
+        let(:column) { :user_id }
+        let(:constraints) { /<adjective describing\: '\(clusters.provider_type = \d+ AND \(cluster_providers_aws\.status IN \(\d+\)\) AND clusters\.enabled = TRUE\)'>/ }
+        let(:name_suggestion) { /count_distinct_user_id_from_#{constraints}_clusters_<with>_#{constraints}_cluster_providers_aws/ }
+      end
+    end
+
+    context 'for sum metrics' do
+      it_behaves_like 'name suggestion' do
+        # corresponding metric is collected with sum(JiraImportState.finished, :imported_issues_count)
+        let(:key_path) { 'counts.jira_imports_total_imported_issues_count' }
+        let(:operation) { :sum }
+        let(:relation) { JiraImportState.finished }
+        let(:column) { :imported_issues_count}
+        let(:name_suggestion) { /sum_imported_issues_count_from_<adjective describing\: '\(jira_imports\.status = \d+\)'>_jira_imports/ }
+      end
+    end
+
+    context 'for redis metrics' do
+      it_behaves_like 'name suggestion' do
+        # corresponding metric is collected with redis_usage_data { unique_visit_service.unique_visits_for(targets: :analytics) }
+        let(:operation) { :redis }
+        let(:column) { nil }
+        let(:relation) { nil }
+        let(:name_suggestion) { /<please fill metric name, suggested format is: {subject}_{verb}{ing|ed}_{object} eg: users_creating_epics or merge_requests_viewed_in_single_file_mode>/ }
+      end
+    end
+
+    context 'for alt_usage_data metrics' do
+      it_behaves_like 'name suggestion' do
+        # corresponding metric is collected with alt_usage_data(fallback: nil) { operating_system }
+        let(:operation) { :alt }
+        let(:column) { nil }
+        let(:relation) { nil }
+        let(:name_suggestion) { /<please fill metric name>/ }
+      end
+    end
+  end
+end