jirametrics 2.13 → 2.20.1

data/lib/jirametrics/downloader_for_cloud.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+class DownloaderForCloud < Downloader
+  def jira_instance_type
+    'Jira Cloud'
+  end
+
+  def search_for_issues jql:, board_id:, path:
+    log "  JQL: #{jql}"
+    escaped_jql = CGI.escape jql
+
+    hash = {}
+    max_results = 5_000 # The maximum allowed by Jira
+    next_page_token = nil
+    issue_count = 0
+
+    loop do
+      relative_url = +''
+      relative_url << '/rest/api/3/search/jql'
+      relative_url << "?jql=#{escaped_jql}&maxResults=#{max_results}"
+      relative_url << "&nextPageToken=#{next_page_token}" if next_page_token
+      relative_url << '&fields=updated'
+
+      json = @jira_gateway.call_url relative_url: relative_url
+      next_page_token = json['nextPageToken']
+
+      json['issues'].each do |i|
+        key = i['key']
+        data = DownloadIssueData.new key: key
+        data.key = key
+        data.last_modified = Time.parse i['fields']['updated']
+        data.found_in_primary_query = true
+        data.cache_path = File.join(path, "#{key}-#{board_id}.json")
+        data.up_to_date = last_modified(filename: data.cache_path) == data.last_modified
+        hash[key] = data
+        issue_count += 1
+      end
+
+      message = "    Found #{issue_count} issues"
+      log message, both: true
+
+      break unless next_page_token
+    end
+    hash
+  end
+
+  def bulk_fetch_issues issue_datas:, board:, in_initial_query:
+    # We used to use the expand option to pull in the changelog directly. Unfortunately
+    # that only returns the "recent" changes, not all of them. So now we get the issue
+    # without changes and then make a second call for that changes. Then we insert it
+    # into the raw issue as if it had been there all along.
+    log "  Downloading #{issue_datas.size} issues", both: true
+    payload = {
+      'fields' => ['*all'],
+      'issueIdsOrKeys' => issue_datas.collect(&:key)
+    }
+    response = @jira_gateway.post_request(
+      relative_url: '/rest/api/3/issue/bulkfetch',
+      payload: JSON.generate(payload)
+    )
+
+    attach_changelog_to_issues issue_datas: issue_datas, issue_jsons: response['issues']
+
+    response['issues'].each do |issue_json|
+      issue_json['exporter'] = {
+        'in_initial_query' => in_initial_query
+      }
+      issue = Issue.new(raw: issue_json, board: board)
+      data = issue_datas.find { |d| d.key == issue.key }
+      data.up_to_date = true
+      data.last_modified = issue.updated
+      data.issue = issue
+    end
+
+    issue_datas
+  end
+
+  def attach_changelog_to_issues issue_datas:, issue_jsons:
+    max_results = 10_000 # The max jira accepts is 10K
+    payload = {
+      'issueIdsOrKeys' => issue_datas.collect(&:key),
+      'maxResults' => max_results
+    }
+    loop do
+      response = @jira_gateway.post_request(
+        relative_url: '/rest/api/3/changelog/bulkfetch',
+        payload: JSON.generate(payload)
+      )
+
+      response['issueChangeLogs'].each do |issue_change_log|
+        issue_id = issue_change_log['issueId']
+        json = issue_jsons.find { |json| json['id'] == issue_id }
+
+        unless json['changelog']
+          # If this is our first time in, there won't be a changelog section
+          json['changelog'] = {
+            'startAt' => 0,
+            'maxResults' => max_results,
+            'total' => 0,
+            'histories' => []
+          }
+        end
+
+        new_changes = issue_change_log['changeHistories']
+        json['changelog']['total'] += new_changes.size
+        json['changelog']['histories'] += new_changes
+      end
+
+      next_page_token = response['nextPageToken']
+      payload['nextPageToken'] = next_page_token
+      break if next_page_token.nil?
+    end
+  end
+
+  def download_issues board:
+    log "  Downloading primary issues for board #{board.id} from #{jira_instance_type}", both: true
+    path = File.join(@target_path, "#{file_prefix}_issues/")
+    unless @file_system.dir_exist?(path)
+      log "  Creating path #{path}"
+      @file_system.mkdir(path)
+    end
+
+    filter_id = @board_id_to_filter_id[board.id]
+    jql = make_jql(filter_id: filter_id)
+    intercept_jql = @download_config.project_config.settings['intercept_jql']
+    jql = intercept_jql.call jql if intercept_jql
+
+    issue_data_hash = search_for_issues jql: jql, board_id: board.id, path: path
+
+    loop do
+      related_issue_keys = Set.new
+      issue_data_hash
+        .values
+        .reject { |data| data.up_to_date }
+        .each_slice(100) do |slice|
+          slice = bulk_fetch_issues(
+            issue_datas: slice, board: board, in_initial_query: true
+          )
+          slice.each do |data|
+            @file_system.save_json(
+              json: data.issue.raw, filename: data.cache_path
+            )
+            # Set the timestamp on the file to match the updated one so that we don't have
+            # to parse the file just to find the timestamp
+            @file_system.utime time: data.issue.updated, file: data.cache_path
+
+            issue = data.issue
+            next unless issue
+
+            parent_key = issue.parent_key(project_config: @download_config.project_config)
+            related_issue_keys << parent_key if parent_key
+
+            # Sub-tasks
+            issue.raw['fields']['subtasks']&.each do |raw_subtask|
+              related_issue_keys << raw_subtask['key']
+            end
+          end
+        end
+
+      # Remove all the ones we already downloaded
+      related_issue_keys.reject! { |key| issue_data_hash[key] }
+
+      related_issue_keys.each do |key|
+        data = DownloadIssueData.new key: key
+        data.found_in_primary_query = false
+        data.up_to_date = false
+        data.cache_path = File.join(path, "#{key}-#{board.id}.json")
+        issue_data_hash[key] = data
+      end
+      break if related_issue_keys.empty?
+
+      log "  Downloading linked issues for board #{board.id}", both: true
+    end
+
+    delete_issues_from_cache_that_are_not_in_server(
+      issue_data_hash: issue_data_hash, path: path
+    )
+  end
+
+  def delete_issues_from_cache_that_are_not_in_server issue_data_hash:, path:
+    # The gotcha with deleted issues is that they just stop being returned in queries
+    # and we have no way to know that they should be removed from our local cache.
+    # With the new approach, we ask for every issue that Jira knows about (within
+    # the parameters of the query) and then delete anything that's in our local cache
+    # but wasn't returned.
+    @file_system.foreach path do |file|
+      next if file.start_with? '.'
+      unless /^(?<key>\w+-\d+)-\d+\.json$/ =~ file
+        raise "Unexpected filename in #{path}: #{file}"
+      end
+      next if issue_data_hash[key] # Still in Jira
+
+      file_to_delete = File.join(path, file)
+      log "  Removing #{file_to_delete} from local cache"
+      file_system.unlink file_to_delete
+    end
+  end
+
+  def last_modified filename:
+    File.mtime(filename) if File.exist?(filename)
+  end
+end

data/lib/jirametrics/downloader_for_data_center.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+class DownloaderForDataCenter < Downloader
+  def jira_instance_type
+    'Jira DataCenter'
+  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
+  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
+
+      total = json['total'].to_i
+      max_results = json['maxResults']
+
+      message = "    Downloaded #{start_at + 1}-#{[start_at + max_results, total].min} of #{total} issues to #{path} "
+      log message, both: true
+
+      start_at += json['issues'].size
+    end
+  end
+
+  def make_jql filter_id:, today: Date.today
+    segments = []
+    segments << "filter=#{filter_id}"
+
+    start_date = @download_config.start_date today: today
+
+    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']
+
+      # Catch-all to pick up anything that's been around since before the range started but hasn't
+      # had an update during the range.
+      catch_all = '((status changed OR Sprint is not EMPTY) AND statusCategory != Done)'
+
+      # Pick up any issues that had a status change in the range
+      start_date_text = @start_date_in_query.strftime '%Y-%m-%d'
+      # find_in_range = %((status changed DURING ("#{start_date_text} 00:00","#{end_date_text} 23:59")))
+      find_in_range = %(updated >= "#{start_date_text} 00:00")
+
+      segments << "(#{find_in_range} OR #{catch_all})"
+    end
+
+    segments.join ' AND '
+  end
+end

data/lib/jirametrics/examples/standard_project.rb

@@ -15,15 +15,6 @@ class Exporter
       self.anonymize if anonymize
       self.settings.merge! settings
 
-      status_category_mappings.each do |status, category|
-        status_category_mapping status: status, category: category
-      end
-
-      download do
-        self.rolling_date_count(rolling_date_count) if rolling_date_count
-        self.no_earlier_than(no_earlier_than) if no_earlier_than
-      end
-
       boards.each_key do |board_id|
         block = boards[board_id]
         if block == :default
@@ -37,6 +28,15 @@ class Exporter
         end
       end
 
+      status_category_mappings.each do |status, category|
+        status_category_mapping status: status, category: category
+      end
+
+      download do
+        self.rolling_date_count(rolling_date_count) if rolling_date_count
+        self.no_earlier_than(no_earlier_than) if no_earlier_than
+      end
+
       issues.reject! do |issue|
         ignore_types.include? issue.type
       end

data/lib/jirametrics/expedited_chart.rb

@@ -48,7 +48,7 @@ class ExpeditedChart < ChartBase
     end
 
     if data_sets.empty?
-      '<h1>Expedited work</h1>There is no expedited work in this time period.'
+      '<h1 class="foldable">Expedited work</h1><p>There is no expedited work in this time period.</p>'
     else
       wrap_and_render(binding, __FILE__)
     end

data/lib/jirametrics/exporter.rb

@@ -50,24 +50,29 @@ class Exporter
       end
 
       project.download_config.run
-      downloader = Downloader.new(
+    # load_jira_config(download_config.project_config.jira_config)
+    # @ignore_ssl_errors = download_config.project_config.settings['ignore_ssl_errors']
+      gateway = JiraGateway.new(
+        file_system: file_system, jira_config: project.jira_config, settings: project.settings
+      )
+      downloader = Downloader.create(
         download_config: project.download_config,
         file_system: file_system,
-        jira_gateway: JiraGateway.new(file_system: file_system)
+        jira_gateway: gateway
       )
       downloader.run
     end
     puts "Full output from downloader in #{file_system.logfile_name}"
   end
 
-  def info keys, name_filter:
+  def info key, name_filter:
     selected = []
     each_project_config(name_filter: name_filter) do |project|
       project.evaluate_next_level
 
       project.run load_only: true
       project.issues.each do |issue|
-        selected << [project, issue] if keys.include? issue.key
+        selected << [project, issue] if key == issue.key
       end
     rescue => e # rubocop:disable Style/RescueStandardError
       # This happens when we're attempting to load an aggregated project because it hasn't been
@@ -76,7 +81,7 @@ class Exporter
     end
 
     if selected.empty?
-      file_system.log "No issues found to match #{keys.collect(&:inspect).join(', ')}"
+      file_system.log "No issues found to match #{key.inspect}"
     else
       selected.each do |project, issue|
         file_system.log "\nProject #{project.name}", also_write_to_stderr: true

data/lib/jirametrics/file_system.rb

@@ -5,6 +5,13 @@ require 'json'
 class FileSystem
   attr_accessor :logfile, :logfile_name
 
+  def initialize
+    # In almost all cases, this will be immediately replaced in the Exporter
+    # but if we fail before we get that far, this will at least let a useful
+    # error show up on the console.
+    @logfile = $stdout
+  end
+
   # Effectively the same as File.read except it forces the encoding to UTF-8
   def load filename, supress_deprecation: false
     if filename.end_with?('.json') && !supress_deprecation
@@ -31,6 +38,14 @@ class FileSystem
     File.write(filename, content)
   end
 
+  def mkdir path
+    FileUtils.mkdir_p path
+  end
+
+  def utime file:, time:
+    File.utime time, time, file
+  end
+
   def warning message, more: nil
     log "Warning: #{message}", more: more, also_write_to_stderr: true
   end
@@ -66,7 +81,15 @@ class FileSystem
   end
 
   def file_exist? filename
-    File.exist? filename
+    File.exist?(filename) && File.file?(filename)
+  end
+
+  def dir_exist? path
+    File.exist?(path) && File.directory?(path)
+  end
+
+  def unlink filename
+    File.unlink filename
   end
 
   def deprecated message:, date:, depth: 2

data/lib/jirametrics/flow_efficiency_scatterplot.rb

@@ -60,7 +60,7 @@ class FlowEfficiencyScatterplot < ChartBase
       create_dataset(issues: issues, label: rules.label, color: rules.color)
     end
 
-    return "<h1>#{@header_text}</h1>No data matched the selected criteria. Nothing to show." if data_sets.empty?
+    return "<h1 class='foldable'>#{@header_text}</h1>No data matched the selected criteria. Nothing to show." if data_sets.empty?
 
     wrap_and_render(binding, __FILE__)
   end

data/lib/jirametrics/html/aging_work_in_progress_chart.erb

@@ -40,7 +40,7 @@ new Chart(document.getElementById(<%= chart_id.inspect %>).getContext('2d'),
           color: <%= CssVariable['--grid-line-color'].to_json %>,
           z: 1 // draw the grid lines on top of the bars
         },
-        stacked: true,
+        stacked: false,
         max: <%= (@max_age * 1.1).to_i %>
       }
     },

data/lib/jirametrics/html/collapsible_issues_panel.erb

@@ -1,5 +1,5 @@
-[<a id='<%= link_id %>' href="#" onclick='expand_collapse("<%= link_id %>", "<%= issues_id %>"); return false;'>Show details</a>]
-<table class='standard' id='<%= issues_id %>' style='display: none;'>
+<div class='foldable startFolded'>Show details</div>
+<table class='standard' id='<%= issues_id %>'>
   <thead>
     <tr>
       <th>Issue</th>

data/lib/jirametrics/html/cycletime_histogram.erb

@@ -6,8 +6,8 @@ if show_stats
   link_id = next_id
   issues_id = next_id
 %>
-[<a id='<%= link_id %>' href="#" onclick='expand_collapse("<%= link_id %>", "<%= issues_id %>"); return false;'>Show details</a>]
-<div id="<%= issues_id %>" style="display: none;">
+<div class='foldable' style="padding-left: 1em;">Statistics</div>
+<div id="<%= issues_id %>" style="padding-left: 1em;">
   <div>
      <table class="standard">
       <tr>

data/lib/jirametrics/html/index.css

@@ -78,11 +78,6 @@ body {
   color: var(--default-text-color);
 }
 
-h1 {
-  border: 1px solid black;
-  background: lightgray;
-  padding-left: 0.2em;
-}
 dl, dd, dt {
   padding: 0;
   margin: 0;
@@ -191,6 +186,11 @@ div.daily_issue {
     padding-right: 0.2em;
     border-radius: 0.2em;
   }
+  h1 {
+    border: none;
+    background: none;
+    padding-left: 0;
+  }
   margin-bottom: 0.5em;
 }
 div.child_issue:hover {
@@ -239,11 +239,6 @@ div.child_issue {
     --daily-view-selected-issue-background: #474747;
   }
 
-  h1 {
-    color: #e0e0e0;
-    background-color: #656565;
-  }
-
   a[href] {
     color: #1e8ad6;
   }

data/lib/jirametrics/html/index.erb

@@ -5,41 +5,9 @@
     <script src="https://cdn.jsdelivr.net/npm/moment@2.29.1/moment.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/chartjs-adapter-moment@^1"></script>
-    <script src="https://cdnjs.cloudflare.com/ajax/libs/chartjs-plugin-annotation/1.2.2/chartjs-plugin-annotation.min.js" integrity="sha512-HycvvBSFvDEVyJ0tjE2rPmymkt6XqsP/Zo96XgLRjXwn6SecQqsn+6V/7KYev66OshZZ9+f9AttCGmYqmzytiw==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/chartjs-plugin-annotation/3.1.0/chartjs-plugin-annotation.min.js"></script>
     <script type="text/javascript">
-      function expand_collapse(link_id, issues_id)  {
-        link_text = document.getElementById(link_id).textContent
-        if( link_text == 'Show details') {
-          document.getElementById(link_id).textContent = 'Hide details'
-          document.getElementById(issues_id).style.display = 'block'
-        }
-        else {
-          document.getElementById(link_id).textContent = 'Show details'
-          document.getElementById(issues_id).style.display = 'none'
-        }
-      }
-
-      function toggle_visibility(open_link_id, close_link_id, toggleable_id) {
-        let open_link = document.getElementById(open_link_id)
-        let close_link = document.getElementById(close_link_id)
-        let toggleable_element = document.getElementById(toggleable_id)
-
-        if(open_link.style.display == 'none') {
-          open_link.style.display = 'block'
-          close_link.style.display = 'none'
-          toggleable_element.style.display = 'none'
-        }
-        else {
-          open_link.style.display = 'none'
-          close_link.style.display = 'block'
-          toggleable_element.style.display = 'block'
-        }
-      }
-      // If we switch between light/dark mode then force a refresh so all charts will redraw correctly
-      // in the other colour scheme.
-      window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
-        location.reload()
-      })
+<%= javascript %>
     </script>
     <style>
 <%= css %>

data/lib/jirametrics/html/index.js

@@ -0,0 +1,90 @@
+function makeFoldable() {
+  // Get all elements with the "foldable" class
+  const foldableElements = document.querySelectorAll('.foldable');
+  
+  if (foldableElements.length === 0) {
+    return; // No foldable elements found
+  }
+  
+  // Process each foldable element
+  foldableElements.forEach((element, index) => {
+    // Skip if this is the footer element
+    if (element.id === 'footer') {
+      return;
+    }
+    
+    // Create a unique ID for this section
+    const sectionId = `foldable-section-${index}`;
+    const toggleId = `foldable-toggle-${index}`;
+    
+    // Create a container div for the foldable element and its content
+    const container = document.createElement('div');
+    container.className = 'foldable-section';
+    container.id = sectionId;
+    
+    // Create a toggle button
+    const toggleButton = document.createElement(element.tagName); //'button');
+    toggleButton.id = toggleId;
+    toggleButton.className = 'foldable-toggle-btn';
+    toggleButton.innerHTML = '▼ ' + element.textContent;
+    
+    // Create a content container
+    const contentContainer = document.createElement('div');
+    contentContainer.className = 'foldable-content';
+    contentContainer.style.cssText = `
+      border-left: 2px solid #ccc;
+      padding-left: 15px;
+    `;
+    
+    // Move the foldable element into the container and replace it with the toggle button
+    element.parentNode.insertBefore(container, element);
+    container.appendChild(toggleButton);
+    container.appendChild(contentContainer);
+    
+    // Move all elements between this foldable element and the next foldable element (or end of document) into the content container
+    let nextElement = element.nextElementSibling;
+    while (nextElement && !nextElement.classList.contains('foldable')) {
+      // Skip the footer element
+      if (nextElement.id === 'footer') {
+        break;
+      }
+      
+      const temp = nextElement.nextElementSibling;
+      contentContainer.appendChild(nextElement);
+      nextElement = temp;
+    }
+    
+    // Remove the original foldable element
+    element.remove();
+    
+    // Add click event to toggle visibility
+    toggleButton.addEventListener('click', function() {
+      const content = this.nextElementSibling;
+      if (content.style.display === 'none') {
+        content.style.display = 'block';
+        this.innerHTML = '▼ ' + this.innerHTML.substring(2);
+      } else {
+        content.style.display = 'none';
+        this.innerHTML = '▶ ' + this.innerHTML.substring(2);
+      }
+    });
+    
+    // Initially show the content (you can change this to 'none' if you want sections collapsed by default)
+    contentContainer.style.display = 'block';
+    if(element.classList.contains('startFolded')) {
+      toggleButton.click();
+    }
+  });
+}
+
+// Auto-initialize when DOM is loaded
+document.addEventListener('DOMContentLoaded', function() {
+  makeFoldable();
+});
+
+
+// If we switch between light/dark mode then force a refresh so all charts will redraw correctly
+// in the other colour scheme.
+window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
+  location.reload()
+})

data/lib/jirametrics/html/sprint_burndown.erb

@@ -68,8 +68,9 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
   link_id = next_id
   issues_id = next_id
 %>
-[<a id='<%= link_id %>' href="#" onclick='expand_collapse("<%= link_id %>", "<%= issues_id %>"); return false;'>Show details</a>]
-<div id="<%= issues_id %>" style="display: none;">
+<section>
+<div class='foldable startFolded'>Show statistics</div>
+<div id="<%= issues_id %>">
 <table class='standard' style="margin-left: 1em;">
   <thead>
     <th>Sprint</th>
@@ -109,4 +110,5 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
     <% end %>
   </ul>
 </p>
-</div>
+</div>
+</section>