Deprecate `option` key for internal_events yaml

Deprecate `option` key for internal_events yaml

config/metrics/schema/internal_events.json

@@ -9,21 +9,6 @@
   "then": {
     "properties": {
       "instrumentation_class": false,
-      "options": {
-        "type": "object",
-        "properties": {
-          "events": {
-            "type": "array",
-            "items": {
-              "type": "string"
-            }
-          }
-        },
-        "required": [
-          "events"
-        ],
-        "additionalProperties": false
-      },
       "events": {
         "type": "array",
         "items": {
@@ -49,8 +34,7 @@
       }
     },
     "required": [
-      "events",
-      "options"
+      "events"
     ]
   }
 }

doc/development/internal_analytics/internal_event_instrumentation/migration.md

@@ -137,7 +137,8 @@ To start using Internal Events Tracking, follow these steps:
     ```
 
    Use `project.id` or `namespace.id` instead of `user.id` if your metric is counting something other than unique users.
-1. Call `InternalEvents.tract_event` instead of `HLLRedisCounter.track_event`:
+1. Remove the `options` section from both metric definition files.
+1. Call `InternalEvents.track_event` instead of `HLLRedisCounter.track_event`:
 
     ```diff
     - Gitlab::UsageDataCounters::HLLRedisCounter.track_event(:git_write_action, values: current_user.id)

scripts/internal_events/cli/helpers/metric_options.rb

@@ -71,9 +71,11 @@ def get_existing_metrics_for_events(events)
           fields = InternalEventsCli::NEW_METRIC_FIELDS.map(&:to_s)
 
           metric = Metric.new(**details.slice(*fields))
-          next unless metric.actions
 
-          metric if (metric.actions & actions).any?
+          metric_actions = metric.events&.map { |event| event['name'] }
+          next unless metric_actions
+
+          metric if (metric_actions & actions).any?
         end
       end
 

scripts/internal_events/cli/metric.rb

@@ -18,7 +18,6 @@ module InternalEventsCli
     :product_category,
     :distribution,
     :tier,
-    :options,
     :events
   ].freeze
 
@@ -43,7 +42,7 @@ module InternalEventsCli
     performance_indicator_type: []
   }.freeze
 
-  Metric = Struct.new(*NEW_METRIC_FIELDS, *ADDITIONAL_METRIC_FIELDS, :identifier, keyword_init: true) do
+  Metric = Struct.new(*NEW_METRIC_FIELDS, *ADDITIONAL_METRIC_FIELDS, :identifier, :actions, keyword_init: true) do
     def formatted_output
       METRIC_DEFAULTS
         .merge(to_h.compact)
@@ -102,7 +101,7 @@ def key_path_prefix
     end
 
     def actions
-      options&.dig('events')&.sort || []
+      self[:actions] || []
     end
 
     def identifier_prefix

scripts/internal_events/cli/metric_definer.rb

@@ -114,9 +114,9 @@ def prompt_for_metrics
 
       @metrics = cli.select('Which metrics do you want to add?', eligible_metrics, **select_opts)
 
-      assign_shared_attrs(:options, :milestone) do
+      assign_shared_attrs(:actions, :milestone) do
         {
-          options: { 'events' => selected_events.map(&:action) },
+          actions: selected_events.map(&:action).sort,
           milestone: MILESTONE
         }
       end

spec/fixtures/scripts/internal_events/metrics/ee_total_28d_single_event.yml

@@ -17,8 +17,5 @@ distribution:
 tier:
 - premium
 - ultimate
-options:
-  events:
-  - internal_events_cli_used
 events:
 - name: internal_events_cli_used

spec/fixtures/scripts/internal_events/metrics/ee_total_7d_single_event.yml

@@ -17,8 +17,5 @@ distribution:
 tier:
 - premium
 - ultimate
-options:
-  events:
-  - internal_events_cli_used
 events:
 - name: internal_events_cli_used

spec/fixtures/scripts/internal_events/metrics/ee_total_single_event.yml

@@ -17,8 +17,5 @@ distribution:
 tier:
 - premium
 - ultimate
-options:
-  events:
-  - internal_events_cli_used
 events:
 - name: internal_events_cli_used

spec/fixtures/scripts/internal_events/metrics/keyboard_smashed_metric_28d.yml

@@ -19,9 +19,6 @@ tier:
 - free
 - premium
 - ultimate
-options:
-  events:
-  - random_name
 events:
 - name: random_name
   unique: user.id

spec/fixtures/scripts/internal_events/metrics/keyboard_smashed_metric_7d.yml

@@ -19,9 +19,6 @@ tier:
 - free
 - premium
 - ultimate
-options:
-  events:
-  - random_name
 events:
 - name: random_name
   unique: user.id

spec/fixtures/scripts/internal_events/metrics/project_id_28d_multiple_events.yml

@@ -19,10 +19,6 @@ tier:
 - free
 - premium
 - ultimate
-options:
-  events:
-  - internal_events_cli_closed
-  - internal_events_cli_used
 events:
 - name: internal_events_cli_closed
   unique: project.id

spec/fixtures/scripts/internal_events/metrics/project_id_7d_multiple_events.yml

@@ -19,10 +19,6 @@ tier:
 - free
 - premium
 - ultimate
-options:
-  events:
-  - internal_events_cli_closed
-  - internal_events_cli_used
 events:
 - name: internal_events_cli_closed
   unique: project.id

spec/fixtures/scripts/internal_events/metrics/total_single_event.yml

@@ -19,8 +19,5 @@ tier:
 - free
 - premium
 - ultimate
-options:
-  events:
-  - internal_events_cli_used
 events:
 - name: internal_events_cli_used

spec/fixtures/scripts/internal_events/metrics/user_id_28d_single_event.yml

@@ -19,9 +19,6 @@ tier:
 - free
 - premium
 - ultimate
-options:
-  events:
-  - internal_events_cli_used
 events:
 - name: internal_events_cli_used
   unique: user.id

spec/fixtures/scripts/internal_events/metrics/user_id_7d_single_event.yml

@@ -19,9 +19,6 @@ tier:
 - free
 - premium
 - ultimate
-options:
-  events:
-  - internal_events_cli_used
 events:
 - name: internal_events_cli_used
   unique: user.id

spec/scripts/internal_events/cli_spec.rb

 # frozen_string_literal: true
 
-require 'fast_spec_helper'
+require 'spec_helper'
 require 'tty/prompt/test'
 require_relative '../../../scripts/internal_events/cli'
-require_relative '../../support/helpers/wait_helpers'
 
 RSpec.describe Cli, feature_category: :service_ping do
   include WaitHelpers