gitlab-org--gitlab-foss/danger/product_intelligence/Dangerfile

# frozen_string_literal: true

CHANGED_FILES_MESSAGE = <<~MSG
For the following files, a review from the [Data team and Product Intelligence team](https://gitlab.com/groups/gitlab-org/growth/product-intelligence/engineers/-/group_members?with_inherited_permissions=exclude) is recommended
Please check the ~"product intelligence" [guide](https://docs.gitlab.com/ee/development/product_analytics/usage_ping.html) and reach out to %<engineers_group>s group for a review.


%<changed_files>s

MSG

UPDATE_METRICS_DEFINITIONS_MESSAGE = <<~MSG
  When adding, changing, or updating metrics, please update the [Event dictionary Usage Ping table](https://about.gitlab.com/handbook/product/product-analytics-guide#event-dictionary).

MSG

ENGINEERS_GROUP = '@gitlab-org/growth/product-intelligence/engineers'

tracking_files = [
  'lib/gitlab/tracking.rb',
  'spec/lib/gitlab/tracking_spec.rb',
  'app/helpers/tracking_helper.rb',
  'spec/helpers/tracking_helper_spec.rb',
  'app/assets/javascripts/tracking.js',
  'spec/frontend/tracking_spec.js',
  'generator_templates/usage_metric_definition/metric_definition.yml',
  'lib/generators/rails/usage_metric_definition_generator.rb',
  'spec/lib/generators/usage_metric_definition_generator_spec.rb'
]

usage_data_changed_files = helper.changed_files(%r{(usage_data)|(config/metrics)|(ee/config/metrics)})
snowplow_events_changed_files = git.modified_files & tracking_files

changed_files = (usage_data_changed_files + snowplow_events_changed_files)

if changed_files.any?

  mention = if helper.draft_mr?
              "`#{ENGINEERS_GROUP}`"
            else
              ENGINEERS_GROUP
            end

  warn format(CHANGED_FILES_MESSAGE, changed_files: helper.markdown_list(changed_files), engineers_group: mention)
  warn format(UPDATE_METRICS_DEFINITIONS_MESSAGE) unless helper.changed_files(/usage_ping\.md/).any?

  labels = ['product intelligence']
  labels << 'product intelligence::review pending' unless helper.mr_has_labels?('product intelligence::approved')

  markdown(helper.prepare_labels_for_mr(labels))
end