jirametrics 2.12.1 → 2.30

data/lib/jirametrics/data_quality_report.rb

@@ -45,6 +45,7 @@ class DataQualityReport < ChartBase
       scan_for_completed_issues_without_a_start_time entry: entry
       scan_for_status_change_after_done entry: entry
       scan_for_backwards_movement entry: entry, backlog_statuses: backlog_statuses
+      scan_for_issue_not_in_active_sprint entry: entry
       scan_for_issues_not_created_in_a_backlog_status entry: entry, backlog_statuses: backlog_statuses
       scan_for_stopped_before_started entry: entry
       scan_for_issues_not_started_with_subtasks_that_have entry: entry
@@ -68,7 +69,7 @@ class DataQualityReport < ChartBase
     result << render_problem_type(:status_changes_after_done)
     result << render_problem_type(:backwards_through_status_categories)
     result << render_problem_type(:backwords_through_statuses)
-    result << render_problem_type(:status_not_on_board)
+    result << render_problem_type(:issue_not_visible_on_board)
     result << render_problem_type(:created_in_wrong_status)
     result << render_problem_type(:stopped_before_started)
     result << render_problem_type(:issue_not_started_but_subtasks_have)
@@ -120,7 +121,7 @@ class DataQualityReport < ChartBase
 
   def initialize_entries
     @entries = @issues.filter_map do |issue|
-      started, stopped = issue.board.cycletime.started_stopped_times(issue)
+      started, stopped = issue.started_stopped_times
       next if stopped && stopped < time_range.begin
       next if started && started > time_range.end
 
@@ -194,7 +195,7 @@ class DataQualityReport < ChartBase
         # If it's been moved back to backlog then it's on a different report. Ignore it here.
         detail = nil if backlog_statuses.any? { |s| s.name == change.value }
 
-        entry.report(problem_key: :status_not_on_board, detail: detail) unless detail.nil?
+        entry.report(problem_key: :issue_not_visible_on_board, detail: detail) unless detail.nil?
       elsif change.old_value.nil?
         # Do nothing
       elsif index < last_index
@@ -223,6 +224,29 @@ class DataQualityReport < ChartBase
     end
   end
 
+  def scan_for_issue_not_in_active_sprint entry:
+    issue = entry.issue
+    return unless issue.board.scrum?
+    return if issue.sprints.any?(&:active?)
+
+    entry.report(problem_key: :issue_not_visible_on_board, detail: 'Issue is not in an active sprint')
+  end
+
+  def scan_for_issue_never_visible_on_board entry:
+    issue = entry.issue
+    ever_visible = issue.changes.any? do |change|
+      next unless change.status?
+
+      issue.board.visible_columns.any? { |col| col.status_ids.include?(change.value_id) }
+    end
+    return if ever_visible
+
+    entry.report(
+      problem_key: :issue_not_visible_on_board,
+      detail: 'Issue has never been in a status mapped to a visible column on the board'
+    )
+  end
+
   def scan_for_issues_not_created_in_a_backlog_status entry:, backlog_statuses:
     creation_change = entry.issue.changes.find { |issue| issue.status? }
 
@@ -250,7 +274,7 @@ class DataQualityReport < ChartBase
 
     started_subtasks = []
     entry.issue.subtasks.each do |subtask|
-      started_subtasks << subtask if subtask.board.cycletime.started_stopped_times(subtask).first
+      started_subtasks << subtask if subtask.started_stopped_times.first
     end
 
     return if started_subtasks.empty?
@@ -266,8 +290,10 @@ class DataQualityReport < ChartBase
 
   def scan_for_items_blocked_on_closed_tickets entry:
     entry.issue.issue_links.each do |link|
+      next unless settings['blocked_link_text'].include?(link.label)
+
       this_active = !entry.stopped
-      other_active = !link.other_issue.board.cycletime.started_stopped_times(link.other_issue).last
+      other_active = !link.other_issue.started_stopped_times.last
       next unless this_active && !other_active
 
       entry.report(
@@ -293,14 +319,14 @@ class DataQualityReport < ChartBase
     return "#{delta} hours" if delta < 24
 
     delta /= 24
-    "#{delta} days"
+    label_days delta
   end
 
   def scan_for_incomplete_subtasks_when_issue_done entry:
     return unless entry.stopped
 
     subtask_labels = entry.issue.subtasks.filter_map do |subtask|
-      subtask_started, subtask_stopped = subtask.board.cycletime.started_stopped_times(subtask)
+      subtask_started, subtask_stopped = subtask.started_stopped_times
 
       if !subtask_started && !subtask_stopped
         "#{subtask_label subtask} (Not even started)"
@@ -407,17 +433,22 @@ class DataQualityReport < ChartBase
     HTML
   end
 
-  def render_status_not_on_board problems
+  def render_issue_not_visible_on_board problems
+    unique_issue_count = problems.map(&:first).uniq.size
     <<-HTML
-      #{label_issues problems.size} were not visible on the board for some period of time. This may impact
-      timings as the work was likely to have been forgotten if it wasn't visible.
+      #{problems.size} #{'time'.then { |w| problems.size == 1 ? w : "#{w}s" }} across #{label_issues unique_issue_count},
+      an item was not visible on the board. This may impact
+      timings as the work was likely to have been forgotten if it wasn't visible. An issue can be not visible
+      for two reasons: the issue was in a status that is not mapped to any visible column on the board
+      (look in "unmapped statuses" on your board), or for scrum boards, the issue was not in an active sprint.
     HTML
   end
 
   def render_created_in_wrong_status problems
     <<-HTML
-      #{label_issues problems.size} were created in a status not designated as Backlog. This will impact
-      the measurement of start times and will therefore impact whether it's shown as in progress or not.
+      #{label_issues problems.size} were created in a status that is not considered to be some varient
+      of To Do. Most likely this means that the issue was created from one of the columns on the board,
+      rather than in the backlog. Why Jira allows this is still a mystery.
     HTML
   end
 

data/lib/jirametrics/dependency_chart.rb

@@ -51,10 +51,13 @@ class DependencyChart < ChartBase
     instance_eval(&@rules_block) if @rules_block
 
     dot_graph = build_dot_graph
-    return "<h1>#{@header_text}</h1>No data matched the selected criteria. Nothing to show." if dot_graph.nil?
+    if dot_graph.nil?
+      return "<h1 class='foldable'>#{@header_text}</h1>" \
+        '<div>No data matched the selected criteria. Nothing to show.</div>'
+    end
 
     svg = execute_graphviz(dot_graph.join("\n"))
-    "<h1>#{@header_text}</h1><div>#{@description_text}</div>#{shrink_svg svg}"
+    "<h1 class='foldable'>#{@header_text}</h1><div>#{@description_text}#{shrink_svg svg}</div>"
   end
 
   def link_rules &block
@@ -228,7 +231,7 @@ class DependencyChart < ChartBase
       elsif is_done
         line2 << 'Done'
       else
-        started_at = issue.board.cycletime.started_stopped_times(issue).first
+        started_at = issue.started_stopped_times.first
         if started_at.nil?
           line2 << 'Not started'
         else

data/lib/jirametrics/download_config.rb

@@ -25,10 +25,25 @@ class DownloadConfig
     @no_earlier_than
   end
 
+  def github_repos
+    @github_repos ||= []
+  end
+
+  def github_repo *repos
+    github_repos.concat(repos.map { |r| normalize_github_repo(r) })
+  end
+
   def start_date today:
     date = today.to_date - @rolling_date_count if @rolling_date_count
     date = [date, @no_earlier_than].max if date && @no_earlier_than
     date = @no_earlier_than if date.nil? && @no_earlier_than
     date
   end
+
+  private
+
+  def normalize_github_repo repo
+    match = repo.match(%r{github\.com/([^/]+/[^/]+?)/?$})
+    match ? match[1] : repo
+  end
 end

data/lib/jirametrics/downloader.rb

@@ -3,8 +3,29 @@
 require 'cgi'
 require 'json'
 
+class DownloadIssueData
+  attr_accessor :key, :found_in_primary_query, :last_modified,
+    :up_to_date, :cache_path, :issue
+
+  def initialize(
+    key:,
+    found_in_primary_query: true,
+    last_modified: nil,
+    up_to_date: true,
+    cache_path: nil,
+    issue: nil
+  )
+    @key = key
+    @found_in_primary_query = found_in_primary_query
+    @last_modified = last_modified
+    @up_to_date = up_to_date
+    @cache_path = cache_path
+    @issue = issue
+  end
+end
+
 class Downloader
-  CURRENT_METADATA_VERSION = 4
+  CURRENT_METADATA_VERSION = 5
 
   attr_accessor :metadata
   attr_reader :file_system
@@ -12,12 +33,23 @@ class Downloader
   # For testing only
   attr_reader :start_date_in_query, :board_id_to_filter_id
 
-  def initialize download_config:, file_system:, jira_gateway:
+  def self.create download_config:, file_system:, jira_gateway:, github_pr_cache: {}
+    is_cloud = jira_gateway.settings['jira_cloud'] || jira_gateway.cloud?
+    (is_cloud ? DownloaderForCloud : DownloaderForDataCenter).new(
+      download_config: download_config,
+      file_system: file_system,
+      jira_gateway: jira_gateway,
+      github_pr_cache: github_pr_cache
+    )
+  end
+
+  def initialize download_config:, file_system:, jira_gateway:, github_pr_cache: {}
     @metadata = {}
     @download_config = download_config
     @target_path = @download_config.project_config.target_path
     @file_system = file_system
     @jira_gateway = jira_gateway
+    @github_pr_cache = github_pr_cache
     @board_id_to_filter_id = {}
 
     @issue_keys_downloaded_in_current_run = []
@@ -28,7 +60,6 @@ class Downloader
     log '', both: true
     log @download_config.project_config.name, both: true
 
-    init_gateway
     load_metadata
 
     if @metadata['no-download']
@@ -43,85 +74,41 @@ class Downloader
     download_statuses
     find_board_ids.each do |id|
       board = download_board_configuration board_id: id
+      board.project_config = @download_config.project_config
       download_issues board: board
     end
     download_users
 
     save_metadata
-  end
-
-  def init_gateway
-    @jira_gateway.load_jira_config(@download_config.project_config.jira_config)
-    @jira_gateway.ignore_ssl_errors = @download_config.project_config.settings['ignore_ssl_errors']
+    download_github_prs if @download_config.github_repos.any?
   end
 
   def log text, both: false
     @file_system.log text, also_write_to_stderr: both
   end
 
-  def find_board_ids
-    ids = @download_config.project_config.board_configs.collect(&:id)
-    raise 'Board ids must be specified' if ids.empty?
-
-    ids
+  def log_start text
+    @file_system.log_start text
   end
 
-  def download_issues board:
-    log "  Downloading primary issues for board #{board.id}", both: true
-    path = File.join(@target_path, "#{file_prefix}_issues/")
-    unless Dir.exist?(path)
-      log "  Creating path #{path}"
-      Dir.mkdir(path)
-    end
-
-    filter_id = @board_id_to_filter_id[board.id]
-    jql = make_jql(filter_id: filter_id)
-    jira_search_by_jql(jql: jql, initial_query: true, board: board, path: path)
-
-    log "  Downloading linked issues for board #{board.id}", both: true
-    loop do
-      @issue_keys_pending_download.reject! { |key| @issue_keys_downloaded_in_current_run.include? key }
-      break if @issue_keys_pending_download.empty?
-
-      keys_to_request = @issue_keys_pending_download[0..99]
-      @issue_keys_pending_download.reject! { |key| keys_to_request.include? key }
-      jql = "key in (#{keys_to_request.join(', ')})"
-      jira_search_by_jql(jql: jql, initial_query: false, board: board, path: path)
-    end
+  def start_progress
+    @file_system.start_progress
   end
 
-  def jira_search_by_jql jql:, initial_query:, board:, path:
-    intercept_jql = @download_config.project_config.settings['intercept_jql']
-    jql = intercept_jql.call jql if intercept_jql
-
-    log "  JQL: #{jql}"
-    escaped_jql = CGI.escape jql
-
-    max_results = 100
-    start_at = 0
-    total = 1
-    while start_at < total
-      json = @jira_gateway.call_url relative_url: '/rest/api/2/search' \
-        "?jql=#{escaped_jql}&maxResults=#{max_results}&startAt=#{start_at}&expand=changelog&fields=*all"
-
-      json['issues'].each do |issue_json|
-        issue_json['exporter'] = {
-          'in_initial_query' => initial_query
-        }
-        identify_other_issues_to_be_downloaded raw_issue: issue_json, board: board
-        file = "#{issue_json['key']}-#{board.id}.json"
-
-        @file_system.save_json(json: issue_json, filename: File.join(path, file))
-      end
+  def progress_dot message = nil
+    @file_system.log message if message
+    @file_system.progress_dot
+  end
 
-      total = json['total'].to_i
-      max_results = json['maxResults']
+  def end_progress
+    @file_system.end_progress
+  end
 
-      message = "    Downloaded #{start_at + 1}-#{[start_at + max_results, total].min} of #{total} issues to #{path} "
-      log message, both: true
+  def find_board_ids
+    ids = @download_config.project_config.board_configs.collect(&:id)
+    raise 'Board ids must be specified' if ids.empty?
 
-      start_at += json['issues'].size
-    end
+    ids
   end
 
   def identify_other_issues_to_be_downloaded raw_issue:, board:
@@ -149,6 +136,8 @@ class Downloader
   end
 
   def download_users
+    return unless @jira_gateway.cloud?
+
     log '  Downloading all users', both: true
     json = @jira_gateway.call_url relative_url: '/rest/api/2/users'
 
@@ -197,11 +186,28 @@ class Downloader
     # actually look at the returned json.
     @board_id_to_filter_id[board_id] = json['filter']['id'].to_i
 
+    if json['type'] == 'simple'
+      features_json = download_features board_id: board_id
+      if BoardFeature.from_raw(features_json).any? { |f| f.name == 'jsw.agility.sprints' && f.enabled? }
+        download_sprints board_id: board_id
+      end
+    end
     download_sprints board_id: board_id if json['type'] == 'scrum'
     # TODO: Should be passing actual statuses, not empty list
     Board.new raw: json, possible_statuses: StatusCollection.new
   end
 
+  def download_features board_id:
+    log "  Downloading features for board #{board_id}", both: true
+    json = @jira_gateway.call_url relative_url: "/rest/agile/1.0/board/#{board_id}/features"
+
+    @file_system.save_json(
+      json: json,
+      filename: File.join(@target_path, "#{file_prefix}_board_#{board_id}_features.json")
+    )
+    json
+  end
+
   def download_sprints board_id:
     log "  Downloading sprints for board #{board_id}", both: true
     max_results = 100
@@ -243,19 +249,29 @@ class Downloader
         value = Date.parse(value) if value.is_a?(String) && value =~ /^\d{4}-\d{2}-\d{2}$/
         @metadata[key] = value
       end
+
     end
 
     # Even if this is the old format, we want to obey this one tag
     @metadata['no-download'] = hash['no-download'] if hash['no-download']
   end
 
+  def timezone_offset
+    @download_config.project_config.exporter.timezone_offset
+  end
+
+  def today_in_project_timezone
+    Time.now.getlocal(timezone_offset).to_date
+  end
+
   def save_metadata
     @metadata['version'] = CURRENT_METADATA_VERSION
+    @metadata['rolling_date_count'] = @download_config.rolling_date_count
     @metadata['date_start_from_last_query'] = @start_date_in_query if @start_date_in_query
 
     if @download_date_range.nil?
       log "Making up a date range in meta since one wasn't specified. You'll want to change that.", both: true
-      today = Date.today
+      today = today_in_project_timezone
       @download_date_range = (today - 7)..today
     end
 
@@ -290,7 +306,8 @@ class Downloader
     end
   end
 
-  def make_jql filter_id:, today: Date.today
+  def make_jql filter_id:, today: nil
+    today ||= today_in_project_timezone
     segments = []
     segments << "filter=#{filter_id}"
 
@@ -298,11 +315,7 @@ class Downloader
 
     if start_date
       @download_date_range = start_date..today.to_date
-
-      # For an incremental download, we want to query from the end of the previous one, not from the
-      # beginning of the full range.
-      @start_date_in_query = metadata['date_end'] || @download_date_range.begin
-      log "    Incremental download only. Pulling from #{@start_date_in_query}", both: true if metadata['date_end']
+      @start_date_in_query = @download_date_range.begin
 
       # Catch-all to pick up anything that's been around since before the range started but hasn't
       # had an update during the range.
@@ -319,6 +332,39 @@ class Downloader
     segments.join ' AND '
   end
 
+  def download_github_prs
+    project_keys = extract_project_keys_from_downloaded_issues
+    if project_keys.empty?
+      log '  No project keys found in downloaded issues, skipping GitHub PR download', both: true
+      return
+    end
+
+    prs = @download_config.github_repos.flat_map do |repo|
+      GithubGateway.new(
+        repo: repo,
+        project_keys: project_keys,
+        file_system: @file_system,
+        raw_pr_cache: @github_pr_cache
+      ).fetch_pull_requests(since: @download_date_range&.begin)
+    end
+
+    @file_system.save_json(
+      json: prs.map(&:raw),
+      filename: File.join(@target_path, "#{file_prefix}_github_prs.json")
+    )
+  end
+
+  def extract_project_keys_from_downloaded_issues
+    path = File.join(@target_path, "#{file_prefix}_issues")
+    return [] unless @file_system.dir_exist?(path)
+
+    keys = []
+    @file_system.foreach(path) do |filename|
+      keys << filename.split('-').first if filename.match?(/^[A-Z][A-Z_0-9]+-\d+-\d+\.json$/)
+    end
+    keys.uniq
+  end
+
   def file_prefix
     @download_config.project_config.get_file_prefix
   end