gitlab_internal_events_cli 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53b38b01e7214b61bb0a8768a926f2a335c7fcdd509c23879aa00627a15b9e6d
+  data.tar.gz: 7a23d46213056876709d6c6c1d77b068c94bf8b54a4887faec103747718d2b0f
+SHA512:
+  metadata.gz: e869509a120eeb35c09557cdc96c7ce6313338a95ef7dc59b7110202e55719460e01abf1e1f497f0eab3cd2df9a860eb3932f0fdd4307cb350d2cfa8976dc460
+  data.tar.gz: 11afd1175a2873484df7af82f9071610811bcd07e69aa0438eab73dc97bb94ac4008478e78af4b6b50234b0f8a943c6a4a71c9ecd17358816c8c826e3fec9e3e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.4.8

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop', '~> 1.21'
+end

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    gitlab_internal_events_cli (0.0.1)
+      json_schemer (~> 2.3.0)
+      pastel (~> 0.8.0)
+      tty-prompt (~> 0.23)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    bigdecimal (4.0.1)
+    diff-lcs (1.6.2)
+    hana (1.3.7)
+    json (2.18.0)
+    json_schemer (2.3.0)
+      bigdecimal
+      hana (~> 1.3)
+      regexp_parser (~> 2.0)
+      simpleidn (~> 0.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    parallel (1.27.0)
+    parser (3.3.10.1)
+      ast (~> 2.4.1)
+      racc
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    prism (1.9.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    regexp_parser (2.11.3)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    rubocop (1.84.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    ruby-progressbar (1.13.0)
+    simpleidn (0.2.3)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.2)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  gitlab_internal_events_cli!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.6.6

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2024 GitLab B.V.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,164 @@
+# GitLab Internal Events CLI
+
+An interactive CLI tool for creating event and metric definition files for GitLab's Internal Events tracking.
+
+This gem extracts the Internal Events CLI from the GitLab monorepo, making it an independent, configurable Ruby gem that can be used in GitLab projects.
+
+## Features
+
+- **Interactive CLI** - Guided flows for creating events and metrics
+- **YAML Generation** - Creates properly formatted event and metric definition files
+- **Code Examples** - Generates code snippets for instrumentation in Rails, RSpec, JavaScript, Vue, and HAML
+- **Configurable** - Adapt paths to work with custom project structures
+- **Metadata Fetching** - Stages and groups fetched directly from GitLab repository
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gitlab_internal_events_cli', path: 'path/to/this/repo'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install gitlab_internal_events_cli
+```
+
+## Usage
+
+### Running the CLI
+
+From the root of a GitLab project (or any project with the expected directory structure):
+
+```bash
+gitlab-internal-events-cli
+```
+
+The CLI provides an interactive menu to:
+- **New Event** - Define a new event to track specific scenarios
+- **New Metric** - Define metrics that count events over time
+- **View Usage** - See code examples for existing events
+- **Help/Flow Advisor** - Get guidance on which tool to use
+
+### Configuration
+
+The CLI can be configured via a `.gitlab_internal_events_cli.yml` file in your project root:
+
+```yaml
+# Optional: Customize paths and URLs
+project_root: .
+
+# Local file paths (relative to project_root)
+event_paths:
+  - config/events/*.yml
+  - ee/config/events/*.yml
+metric_paths:
+  - config/metrics/counts_all/*.yml
+  - config/metrics/counts_7d/*.yml
+  - config/metrics/counts_28d/*.yml
+  - ee/config/metrics/counts_all/*.yml
+  - ee/config/metrics/counts_7d/*.yml
+  - ee/config/metrics/counts_28d/*.yml
+```
+
+## Architecture
+
+### Metadata Fetching
+
+The gem fetches metadata from GitLab repositories:
+- **Stages/Groups**: Fetched from `gitlab-com/www-gitlab-com` master branch for product organization
+
+This ensures the CLI has up-to-date information about product stages and groups without duplicating data.
+
+### Milestone Detection
+
+The milestone is automatically detected from the `VERSION` file in the project root:
+1. **VERSION file**: Extracts `X.Y` from content like `17.8.0-pre`
+1. **Fallback**: Defaults to `"TODO"` if not found
+
+### Directory Structure
+
+The CLI expects the following structure (configurable):
+
+```
+project/
+├── VERSION                          # Milestone detection
+├── config/
+│   ├── events/*.yml                # Event definitions
+│   ├── metrics/
+│   │   ├── counts_all/*.yml       # Total count metrics
+│   │   ├── counts_7d/*.yml        # Weekly metrics
+│   │   └── counts_28d/*.yml       # Monthly metrics
+│   └── feature_categories.yml     # Feature categories
+└── ee/                            # Enterprise Edition
+    ├── config/events/*.yml
+    └── config/metrics/...
+```
+
+## Development
+
+After checking out the repo, run:
+
+```bash
+bundle install
+```
+
+Run the tests:
+
+```bash
+bundle exec rspec
+```
+
+Run rubocop:
+
+```bash
+bundle exec rubocop
+```
+
+### Building and running the gem locally
+
+Build the gem:
+
+```bash
+gem build gitlab_internal_events_cli.gemspec
+```
+
+This produces a `.gem` file in the current directory (e.g. `gitlab_internal_events_cli-0.0.1.gem`).
+
+Install it locally:
+
+```bash
+gem install ./gitlab_internal_events_cli-0.0.1.gem
+```
+
+Then run the CLI from the root of a GitLab project:
+
+```bash
+gitlab-internal-events-cli
+```
+
+Alternatively, run directly from the repo without installing the gem:
+
+```bash
+bundle exec exe/gitlab-internal-events-cli
+```
+
+## Migration from GitLab Monorepo
+
+This gem was extracted from the original CLI at `gitlab/scripts/internal_events/cli.rb`. Key changes:
+
+1. **Configuration System**: All hardcoded paths are now configurable
+2. **Standalone Gem**: Can be used outside the GitLab monorepo with proper configuration
+3. **Module Renamed**: `InternalEventsCli` → `GitlabInternalEventsCli`
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/gitlab-internal-events-cli

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'gitlab_internal_events_cli'
+
+prompt = GitlabInternalEventsCli::GitlabPrompt.new(TTY::Prompt.new)
+GitlabInternalEventsCli::Cli.new(prompt).run

data/gitlab_internal_events_cli.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/gitlab_internal_events_cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'gitlab_internal_events_cli'
+  spec.version = GitlabInternalEventsCli::VERSION
+  spec.authors = ['GitLab']
+  spec.email = ['gitlab@gitlab.com']
+
+  spec.summary = 'GitLab CLI tool for defining internal events and metrics'
+  spec.description = 'An interactive CLI tool for creating event and metric definition files ' \
+                     "for GitLab's internal analytics system."
+  spec.homepage = 'https://gitlab.com/gitlab-org/analytics-section/product-analytics/analytics-cli'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .gitlab-ci.yml .rubocop])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = ['gitlab-internal-events-cli']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'json_schemer', '~> 2.3.0'
+  spec.add_dependency 'pastel', '~> 0.8.0'
+  spec.add_dependency 'tty-prompt', '~> 0.23'
+
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.21'
+end

data/lib/gitlab_internal_events_cli/cli.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module GitlabInternalEventsCli
+  class Cli
+    include Helpers
+
+    attr_reader :cli
+
+    def initialize(cli)
+      @cli = cli
+    end
+
+    def run
+      HttpCache.preload!
+
+      cli.say feedback_notice
+      cli.say instructions
+
+      task = cli.select('What would you like to do?', **select_opts) do |menu|
+        menu.enum '.'
+
+        menu.choice "New Event -- track when a specific scenario occurs on gitlab instances\n     " \
+                    'ex) a user applies a label to an issue', :new_event
+        menu.choice "New Metric -- track the count of existing events over time\n     " \
+                    'ex) count unique users who assign labels to issues per month', :new_metric
+        menu.choice 'View Usage -- look at code and testing examples for existing events & metrics', :view_usage
+        menu.choice '...am I in the right place?', :help_decide
+      end
+
+      case task
+      when :new_event
+        Flows::EventDefiner.new(cli).run
+      when :new_metric
+        Flows::MetricDefiner.new(cli).run
+      when :view_usage
+        Flows::UsageViewer.new(cli).run
+      when :help_decide
+        Flows::FlowAdvisor.new(cli).run
+      end
+    end
+
+    def instructions
+      cli.say <<~TEXT.freeze
+        #{format_info('INSTRUCTIONS:')}
+        To start tracking usage of a feature...
+
+          1) Define event (using CLI)
+          2) Trigger event (from code)
+          3) Define metric (using CLI)
+          4) View data in Tableau (after merge & deploy)
+
+        This CLI will help you create the correct definition files, then provide code examples for instrumentation and testing.
+
+        Learn more: https://docs.gitlab.com/ee/development/internal_analytics/#fundamental-concepts
+
+      TEXT
+    end
+  end
+end

data/lib/gitlab_internal_events_cli/configuration.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'yaml'
+require 'timeout'
+
+module GitlabInternalEventsCli
+  class Configuration
+    DEFAULT_STAGES_URL = 'https://gitlab.com/gitlab-com/www-gitlab-com/-/raw/master/data/stages.yml'
+    DEFAULT_EVENT_SCHEMA_URL = 'https://gitlab.com/gitlab-org/gitlab/-/raw/master/config/events/schema.json'
+    DEFAULT_METRIC_SCHEMA_URL = 'https://gitlab.com/gitlab-org/gitlab/-/raw/master/config/metrics/schema/base.json'
+    DEFAULT_FEATURE_CATEGORIES_URL = 'https://gitlab.com/gitlab-org/gitlab/-/raw/master/config/feature_categories.yml'
+    DEFAULT_VERSION_URL = 'https://gitlab.com/gitlab-org/gitlab/-/raw/master/VERSION'
+
+    attr_accessor :project_root,
+                  :event_paths,
+                  :metric_paths,
+                  :feature_categories_path,
+                  :feature_categories_url,
+                  :event_schema_url,
+                  :metric_schema_url,
+                  :stages_url
+    attr_writer :milestone
+
+    def initialize
+      @project_root = Dir.pwd
+      @event_paths = [
+        'config/events/*.yml',
+        'ee/config/events/*.yml'
+      ]
+      @metric_paths = [
+        'config/metrics/counts_all/*.yml',
+        'config/metrics/counts_7d/*.yml',
+        'config/metrics/counts_28d/*.yml',
+        'ee/config/metrics/counts_all/*.yml',
+        'ee/config/metrics/counts_7d/*.yml',
+        'ee/config/metrics/counts_28d/*.yml'
+      ]
+      @feature_categories_path = 'config/feature_categories.yml'
+      @feature_categories_url = DEFAULT_FEATURE_CATEGORIES_URL
+      @event_schema_url = DEFAULT_EVENT_SCHEMA_URL
+      @metric_schema_url = DEFAULT_METRIC_SCHEMA_URL
+      @stages_url = DEFAULT_STAGES_URL
+    end
+
+    def milestone
+      @milestone ||= milestone_from_version_file || milestone_from_remote || 'TODO'
+    end
+
+    def resolve_event_paths
+      event_paths.flat_map { |pattern| Dir[File.join(project_root, pattern)] }
+    end
+
+    def resolve_metric_paths
+      metric_paths.flat_map { |pattern| Dir[File.join(project_root, pattern)] }
+    end
+
+    def absolute_path(relative_path)
+      File.join(project_root, relative_path)
+    end
+
+    def load_from_file(config_path = nil)
+      config_path ||= File.join(project_root, '.gitlab_internal_events_cli.yml')
+      return unless File.exist?(config_path)
+
+      config = YAML.safe_load_file(config_path, symbolize_names: true)
+      apply_config(config)
+    end
+
+    private
+
+    def apply_config(config)
+      config.each do |key, value|
+        setter = "#{key}="
+        send(setter, value) if respond_to?(setter)
+      end
+    end
+
+    def milestone_from_version_file
+      version_file = File.join(project_root, 'VERSION')
+      return unless File.exist?(version_file)
+
+      extract_milestone(File.read(version_file))
+    end
+
+    def milestone_from_remote
+      content = HttpCache.get(DEFAULT_VERSION_URL)
+      return unless content
+
+      extract_milestone(content)
+    end
+
+    def extract_milestone(content)
+      match = content.strip.match(/(\d+\.\d+)/)
+      match&.captures&.first
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

data/lib/gitlab_internal_events_cli/event.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module GitlabInternalEventsCli
+  NEW_EVENT_FIELDS = %i[
+    description
+    internal_events
+    status
+    category
+    action
+    value_type
+    extra_properties
+    identifiers
+    additional_properties
+    product_group
+    product_categories
+    milestone
+    introduced_by_url
+    tiers
+    classification
+  ].freeze
+
+  EVENT_DEFAULTS = {
+    internal_events: true,
+    status: 'active',
+    product_group: nil,
+    introduced_by_url: 'TODO'
+  }.freeze
+
+  ExistingEvent = Struct.new(*NEW_EVENT_FIELDS, :file_path, keyword_init: true) do
+    def identifiers
+      self[:identifiers] || []
+    end
+
+    def available_filters
+      additional_properties&.keys || []
+    end
+  end
+
+  NewEvent = Struct.new(*NEW_EVENT_FIELDS, keyword_init: true) do
+    def formatted_output
+      EVENT_DEFAULTS
+        .merge(to_h.compact)
+        .slice(*NEW_EVENT_FIELDS)
+        .transform_keys(&:to_s)
+        .to_yaml(line_width: 150)
+    end
+
+    def file_path
+      File.join(
+        *[
+          ('ee' unless tiers.include?('free')),
+          'config',
+          'events',
+          "#{action}.yml"
+        ].compact
+      )
+    end
+
+    def bulk_assign(key_value_pairs)
+      key_value_pairs.each { |key, value| self[key] = value }
+    end
+  end
+
+  class Event
+    def self.parse(**args)
+      ExistingEvent.new(**args)
+    end
+
+    def self.new(**args)
+      NewEvent.new(**args)
+    end
+  end
+end