dri 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8718d907e41f0cfb472a255898ed513af0fe81ae4cfe782c7aa7d270cb0c2b9f
-  data.tar.gz: 718f976b309b6eb0cab9f65b32e58de5876edd5507aafcc20a2f098068bb5929
+  metadata.gz: 879c4292254a2a17a0ebcd8e2c0a3f8bbc6e654a69c153ad66423c71eb750fc4
+  data.tar.gz: 51f8e1acec1894ce4a6ab264ef690cf063259f46512d743609bf2f5a6529132f
 SHA512:
-  metadata.gz: 643631388b378a127bca182911c9dfb304a1134b568fb71c716976f637f31f2a8d5056c2e30f0f9e2a72e7528e9e7f58a0bda4c0cbc1066efab02c3159353777
-  data.tar.gz: 46514571671417008fe79dadc26cee33b97ad642e61822e2a2097f4e83d774290d1389f3d7d5c6a8ddf7be7a1974d733b4f5cacef3e7c0084af16a37db30ee0d
+  metadata.gz: ad020b17eb8d05322800332e59b5d286dcb8712df055dab50be7f234df2864a5ba719f900d61b0ba25308a1ea130fa2b586b7f01215beec90eafb614cc8c6da1
+  data.tar.gz: c0ef20575dcc1f9fa3312df5970b79a8b6fa11b8401a1a80d30561c8a764c7bcd140d4e649c619fbce1be6b9f71c943fb51aa5a48c20b18c5f480af4a821bc07

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dri (0.3.1)
+    dri (0.4.0)
       gitlab (~> 4.18)
       httparty (~> 0.20.0)
       json (~> 2.6.1)

data/README.md

@@ -145,6 +145,7 @@ $ dri publish report --format=list # formats the report in a list
 $ dri publish report --format=table # formats the report in a table (default)
 $ dri publish report --dry-run # the report is only generated locally
 $ dri publish report --actions # activate the actions prompt for each failure
+$ dri publish report --feature-flags # includes a summary of the feature flag changes on each environment
 ```
 
 **Note:** These options above can be combined like:

data/lib/dri/command.rb

@@ -26,8 +26,8 @@ module Dri
         config = TTY::Config.new
         config.filename = ".dri_profile"
         config.extname = ".yml"
-        config.append_path Dir.pwd
         config.append_path Dir.home
+        config.append_path Dir.pwd
         config
       end
     end

data/lib/dri/commands/fetch/featureflags.rb

@@ -2,34 +2,29 @@
 
 require_relative '../../command'
 require_relative '../../utils/table'
+require_relative '../../utils/feature_flag_consts'
+require_relative '../../feature_flag_report'
 
 module Dri
   module Commands
     class Fetch
       class FeatureFlags < Dri::Command
         include Dri::Utils::Table
-
-        PRODUCTION  = 'host::gitlab.com'
-        STAGING     = 'host::staging.gitlab.com'
-        STAGING_REF = 'host::staging-ref.gitlab.com'
-        PREPROD     = 'host::pre.gitlab.com'
+        include Dri::Utils::FeatureFlagConsts
 
         def initialize(options)
           @options = options
           @today_iso_format = Time.now.strftime('%Y-%m-%dT00:00:00Z')
         end
 
-        def execute(input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
+        def execute(input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
           verify_config_exists
 
           summary = add_color('Summary', :bright_yellow)
           changed_on = add_color('Changed(UTC)', :bright_yellow)
           url = add_color('URL', :bright_yellow)
 
-          prod_feature_flags = []
-          staging_feature_flags = []
-          staging_ref_feature_flags = []
-          preprod_feature_flags = []
+          report = Dri::FeatureFlagReport.new
 
           headers = [summary, changed_on, url]
 
@@ -37,42 +32,23 @@ module Dri
 
           spinner.run do
             response = api_client.fetch_feature_flag_logs(@today_iso_format)
+
             if response.empty?
               logger.info 'It\'s been quiet...no feature flag changes for today 👀'
               break
             end
 
             response.each do |feature_flag|
-              summary = feature_flag.title
-
-              substrings = ["set to \"true\"", "set to \"false\""]
-              next unless substrings.any? { |substr| summary.include?(substr) }
-
-              changed_on = feature_flag.description[/(?<=Changed on \(in UTC\): ).+?(?=\n)/].delete('`')
-              url = feature_flag.web_url
-
-              feature_flag_data = [summary, changed_on, url]
-
-              labels = feature_flag.labels
-              host_label = labels.select { |label| /^host::/.match(label) }.join('')
+              next unless TITLE_SUBSTRINGS.any? { |substr| feature_flag.title.include?(substr) }
 
-              case host_label
-              when PRODUCTION
-                prod_feature_flags << feature_flag_data
-              when STAGING
-                staging_feature_flags << feature_flag_data
-              when STAGING_REF
-                staging_ref_feature_flags << feature_flag_data
-              when PREPROD
-                preprod_feature_flags << feature_flag_data
-              end
+              report.add_change(feature_flag)
             end
           end
 
-          print_results('Production', headers, prod_feature_flags, output) unless prod_feature_flags.empty?
-          print_results('Staging', headers, staging_feature_flags, output) unless staging_feature_flags.empty?
-          print_results('Staging Ref', headers, staging_ref_feature_flags, output) unless staging_ref_feature_flags.empty? # rubocop:disable Layout/LineLength
-          print_results('Preprod', headers, preprod_feature_flags, output) unless preprod_feature_flags.empty?
+          print_results('Production', headers, report.prod, output) unless report.prod.empty?
+          print_results('Staging', headers, report.staging, output) unless report.staging.empty?
+          print_results('Staging Ref', headers, report.staging_ref, output) unless report.staging_ref.empty?
+          print_results('Preprod', headers, report.preprod, output) unless report.preprod.empty?
         end
 
         private

data/lib/dri/commands/publish/report.rb

@@ -2,21 +2,26 @@
 
 require_relative '../../command'
 require_relative '../../utils/markdown_lists'
-require_relative "../../report"
+require_relative '../../utils/feature_flag_consts'
+require_relative '../../report'
+require_relative '../../feature_flag_report'
 
 require 'markdown-tables'
 require 'fileutils'
-require "uri"
+require 'uri'
 
 module Dri
   module Commands
     class Publish
-      class Report < Dri::Command
+      class Report < Dri::Command # rubocop:disable Metrics/ClassLength
+        include Dri::Utils::FeatureFlagConsts
+
         def initialize(options)
           @options = options
 
           @date = Date.today
           @time = Time.now.to_i
+          @today_iso_format = Time.now.strftime('%Y-%m-%dT00:00:00Z')
         end
 
         def execute(input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
@@ -26,7 +31,9 @@ module Dri
           logger.info "Fetching triaged failures with award emoji #{emoji}..."
 
           spinner.start
+
           issues = api_client.fetch_triaged_failures(emoji: emoji, state: 'opened')
+
           spinner.stop
 
           if issues.empty?
@@ -34,27 +41,28 @@ module Dri
             exit 1
           end
 
-          logger.info "Assembling the report... "
+          logger.info 'Assembling the failures report... '
           # sets each failure on the table
           action_options = [
-            "pinged SET",
-            "reproduced",
-            "transient",
-            "quarantined",
-            "active investigation",
-            "blocking pipelines",
-            "awaiting for a fix to merge",
-            "notified the team",
-            "due to feature flag"
+            'pinged SET',
+            'reproduced',
+            'transient',
+            'quarantined',
+            'active investigation',
+            'blocking pipelines',
+            'awaiting for a fix to merge',
+            'notified the team',
+            'due to feature flag'
           ]
 
           spinner.start
+
           issues.each do |issue|
             actions = []
 
             if @options[:actions]
               actions = prompt.multi_select(
-                "Please mark the actions on #{add_color(issue['title'], :yellow)}: ",
+                "Please mark the actions on #{add_color(issue.title, :yellow)}: ",
                 action_options,
                 per_page: 9
               )
@@ -77,14 +85,59 @@ module Dri
             end
           end
 
+          spinner.stop
+
+          if @options[:feature_flags]
+            logger.info 'Fetching today\'s feature flag changes...'
+
+            feature_flag_report = Dri::FeatureFlagReport.new
+
+            spinner.start
+
+            feature_flags = api_client.fetch_feature_flag_logs(@today_iso_format)
+
+            feature_flags.each do |feature_flag|
+              next unless TITLE_SUBSTRINGS.any? { |substr| feature_flag.title.include?(substr) }
+
+              feature_flag_report.add_change(feature_flag)
+            end
+
+            spinner.stop
+
+            logger.info 'Assembling the feature flags report...'
+
+            spinner.start
+
+            feature_flag_note = "\n\n## Feature Flag Changes"
+            feature_flag_changes = ''
+
+            format_type = @options[:format] == 'list' ? :list : :table
+
+            feature_flag_report.get_all_flag_changes.each do |env, changes|
+              next if changes.empty?
+
+              feature_flag_changes += format_feature_flag_changes(
+                env, changes, feature_flag_report.labels, format_type
+              )
+            end
+
+            feature_flag_note += if feature_flag_changes.empty?
+                                   "\n\nNo changes found today"
+                                 else
+                                   "\n\n<details><summary>Click to expand</summary>#{feature_flag_changes}</details>"
+                                 end
+
+            spinner.stop
+          end
+
           report.set_header(timezone, username)
           note = "#{report.header}\n\n#{format_style}"
 
-          spinner.stop
+          note += feature_flag_note if @options[:feature_flags]
 
           # creates an .md file with the report locally in /handover_reports
           if @options[:dry_run]
-            logger.info "Downloading the report... "
+            logger.info 'Downloading the report... '
 
             spinner.start
 
@@ -104,7 +157,7 @@ module Dri
 
           # sends note to the weekly triage report
           issues = api_client.fetch_current_triage_issue
-          current_issue_iid = issues[0]["iid"]
+          current_issue_iid = issues.first.iid
 
           api_client.post_triage_report_note(iid: current_issue_iid, body: note)
 
@@ -113,6 +166,27 @@ module Dri
             Thanks @#{username}, your report was posted at https://gitlab.com/gitlab-org/quality/pipeline-triage/-/issues/#{current_issue_iid} 🎉
           MSG
         end
+
+        private
+
+        def format_feature_flag_changes(env, changes, labels, format_type)
+          unless format_type == :table || format_type == :list
+            raise ArgumentError, 'format_type must be one of type :table or :list'
+          end
+
+          case format_type
+          when :list
+            formatted_changes = Utils::MarkdownLists.make_list(labels, changes)
+          when :table
+            formatted_changes = MarkdownTables.make_table(
+              labels,
+              changes,
+              is_rows: true, align: %w[l l l]
+            )
+          end
+
+          "\n\n### #{env.to_s.capitalize.tr('_', ' ')}\n\n#{formatted_changes}"
+        end
       end
     end
   end

data/lib/dri/commands/publish.rb

@@ -14,6 +14,8 @@ module Dri
                              desc: 'Formats the report'
       method_option :actions, type: :boolean,
                               desc: 'Updates actions on failures'
+      method_option :feature_flags, type: :boolean,
+                                    desc: 'Adds summary of feature flag changes'
       def report(*)
         if options[:help]
           invoke :help, ['report']

data/lib/dri/feature_flag_report.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative './utils/feature_flag_consts'
+
+module Dri
+  class FeatureFlagReport
+    include Dri::Utils::FeatureFlagConsts
+
+    attr_reader :header, :labels, :prod, :staging, :staging_ref, :preprod
+
+    def initialize
+      @header = '## Feature Flag Changes'
+      @labels = %w[Summary Changed(UTC) URL]
+      @prod = []
+      @staging = []
+      @staging_ref = []
+      @preprod = []
+    end
+
+    def add_change(feature_flag)
+      summary = feature_flag.title
+
+      changed_on = feature_flag.description[/(?<=Changed on \(in UTC\): ).+?(?=\n)/].delete('`')
+      url = feature_flag.web_url
+
+      feature_flag_data = [summary, changed_on, url]
+
+      labels = feature_flag.labels
+      host_label = labels.select { |label| /^host::/.match(label) }.join('')
+
+      case host_label
+      when PRODUCTION
+        @prod << feature_flag_data
+      when STAGING
+        @staging << feature_flag_data
+      when STAGING_REF
+        @staging_ref << feature_flag_data
+      when PREPROD
+        @preprod << feature_flag_data
+      end
+    end
+
+    def get_all_flag_changes
+      { production: @prod, staging: @staging, staging_ref: @staging_ref, preprod: @preprod }
+    end
+  end
+end

data/lib/dri/utils/feature_flag_consts.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Dri
+  module Utils
+    module FeatureFlagConsts
+      PRODUCTION  = 'host::gitlab.com'
+      STAGING     = 'host::staging.gitlab.com'
+      STAGING_REF = 'host::staging-ref.gitlab.com'
+      PREPROD     = 'host::pre.gitlab.com'
+      TITLE_SUBSTRINGS = ["set to \"true\"", "set to \"false\""].freeze
+    end
+  end
+end

data/lib/dri/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dri
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dri
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab
@@ -333,10 +333,12 @@ files:
 - lib/dri/commands/rm/emoji.rb
 - lib/dri/commands/rm/profile.rb
 - lib/dri/commands/rm/reports.rb
+- lib/dri/feature_flag_report.rb
 - lib/dri/gitlab/issues.rb
 - lib/dri/refinements/truncate.rb
 - lib/dri/report.rb
 - lib/dri/templates/incidents/.gitkeep
+- lib/dri/utils/feature_flag_consts.rb
 - lib/dri/utils/markdown_lists.rb
 - lib/dri/utils/table.rb
 - lib/dri/version.rb