Added Frontend and Backend for Average Issue Resolution Time Graph

scripts/gen_graphs.py

@@ -5,6 +5,7 @@
 from datetime import timedelta
 import re
 import pygal
+import random
 
 
 def percent_formatter(x):
@@ -17,7 +18,7 @@
         A string containing the formatted version of x
     """
 
     return '{:0.2f}%'.format(x)
 
 def timedelta_formatter(x):
     """
@@ -29,9 +30,9 @@
         A string containing the formatted version of x
     """
 
     return '{} days'.format(x.days)
 
 def ignore_formatter(x):
     """
     Function to ignore values in formatting
 
@@ -59,6 +60,7 @@
         generate_language_summary_pie_chart(repo)
         generate_cost_estimates_bar_chart(repo)
         generate_time_estimates_bar_chart(repo)
+        generate_average_issue_resolution_graph(repo)
         try:
             generate_donut_graph_line_complexity_graph(repo)
             generate_time_xy_issue_graph(
@@ -104,7 +106,7 @@
         except KeyError:
             print(f"Org {org.name} has no deps data associated with it!")
 
 def write_repo_chart_to_file(repo, chart, chart_name, custom_func=None, custom_func_params={}):
     """
     This function's purpose is to save a pygals chart to a path derived from the
     repository object passed in.
@@ -142,7 +144,7 @@
     # print(chart.render_sparkline())
     # I have to do this because sparklinees don't have their own subclass and instead
     # are rendered through a special method of the Line object.
     # TODO: file a pygals issue to make sparklines their own object
     _kwargs_ = {
         "show_x_labels": False,
         "show_y_labels": True,
@@ -342,7 +344,7 @@
 
     #This is going to be kind of hacky since pygals doesn't have a
     #timeline object
     #TODO: Contribute upstream to add a timeline object to pygal
     dateline = pygal.TimeDeltaLine(x_label_rotation=25,legend_at_bottom=True)
     dateline.x_value_formatter = timedelta_formatter
     dateline.value_formatter = ignore_formatter
@@ -460,7 +462,7 @@
         return
 
     total_loc = sum(entry.get('Code', 0) for entry in language_summary)
 
     pie_chart.title = f'Language Summary \n Total Source Lines of Code (SLOC): {total_loc:,}'
 
     pie_chart.value_formatter = lambda x: f'{x} SLOC'
@@ -496,7 +498,7 @@
     average_cost = (estimated_cost_low +
                     estimated_cost_high) / 2
 
     bar_chart.title = f'Estimated Project Costs in $ From Constructive Cost Model (COCOMO) \n Average Cost: ${average_cost:,.2f}'
 
     bar_chart.add(f'Estimated Cost Low (${estimated_cost_low:,.2f})',
                   estimated_cost_low)
@@ -532,7 +534,7 @@
     bar_chart.title = 'Estimated Project Time in Months From Constructive Cost Model (COCOMO)'
 
     bar_chart.add(None, [0])
     bar_chart.add(f'Estimated Time ({formatted_estimated_months:,.1f} mos)', 
                   estimated_schedule_months_low)
     bar_chart.add(None, [0])
 
@@ -560,10 +562,40 @@
 
     bar_chart.value_formatter = lambda x: f'{x:,.0f} ppl'
 
     bar_chart.title = 'Estimated Individual Project Contributors From Constructive Cost Model (COCOMO)'
 
     bar_chart.add(None, [0])
     bar_chart.add(f'Estimated Contributors ({estimated_people_low:,.0f} ppl)', estimated_people_low)
     bar_chart.add(None, [0])
 
     write_repo_chart_to_file(oss_entity, bar_chart, "estimated_people_contributing")
+
+def generate_average_issue_resolution_graph(oss_entity):
+    """
+    This function generates a pygal gauge chart for average issue resolution time.
+
+    Arguments:
+        oss_entity: An object containing the metric data.
+    """
+    gauge_graph = pygal.Gauge(legend_at_bottom=True)
+
+    metric_data = oss_entity.metric_data.get('average_issue_resolution_time')
+    if not metric_data or not metric_data[0]:
+        print("No data available for average issue resolution time")
+        return
+
+    data = metric_data[0]
+    repo_name = data[0]
+    average_time_str = data[1]
+
+    days_str = average_time_str.split(' days ')
+    days = int(days_str[0])
+
+    random_numbers = [10,20,30,40,50,60]
+
+    gauge_graph.range = [0, (days + random.choice(random_numbers))]
+
+    gauge_graph.title = f"Average Issue Resolution Time for {repo_name} \n Average Time: {round(days)} days"
+    gauge_graph.add("Days", round(days))
+
+    write_repo_chart_to_file(oss_entity, gauge_graph, "average_issue_resolution_time")

scripts/metricsLib/metrics_definitions.py

@@ -184,7 +184,6 @@
                                 AUGUR_HOST + "/pull_request_reports/PR_time_to_first_response/" +
                                 "?repo_id={repo_id}&start_date={begin_month}&end_date={end_date}"))
 
-
 ORG_GITHUB_GRAPHQL_QUERY = """
 query ($org_login: String!) {
   organization(login: $org_login) {
@@ -252,3 +251,12 @@
   }
   )
 )
+
+SIMPLE_METRICS.append(ListMetric("averageIssueResolutionTime", sixMonthsParams, AUGUR_HOST + "/repos/" + "{repo_id}" + "/average-issue-resolution-time", {"average_issue_resolution_time": ["repo_name", "avg_issue_resolution_time"]}))
+
+# Metric for Average Commit Counts per PR
+# TODO: - Currently not working because of something wrong on Augur's end. Develop a solution here (hacky) or fix upstream.
+
+# RESOURCE_METRICS.append(ResourceMetric("averageCommitsPerPR", sixMonthsParams,
+#                                 AUGUR_HOST + "/pull_request_reports/average_commits_per_PR/" +
+#                                 "?repo_id={repo_id}&start_date={begin_month}&end_date={end_date}"))

templates/repo_report_template.md

@@ -115,6 +115,8 @@ date_stampLastWeek: {date_stamp}
     {{% assign optionsArray = 'Summary, Predominant' | split: ',' %}}
     {{% assign graphsArray = "/{repo_owner}/{repo_name}/language_summary_{repo_name}_data.svg, /{repo_owner}/{repo_name}/predominant_langs_{repo_name}_data.svg" | split: ',' %}}
     {{% render "graph-toggle" baseurl: site.baseurl, name:"language-information" options: optionsArray, graphs: graphsArray, title: "Language Information" %}}
+    <!-- Average Issue Resolution Time -->
+    {{% render "graph-section" baseurl: site.baseurl, path: "/{repo_owner}/{repo_name}/average_issue_resolution_time_{repo_name}_data.svg", title: "Average Issue Resolution Time" %}}
     <!-- Libyear Timeline Graph -->
     {{% render "graph-section" baseurl: site.baseurl, path: "/{repo_owner}/{repo_name}/libyear_timeline_{repo_name}_data.svg", title: "Dependency Libyears" %}}
     <!-- DRYness Percentages Graph -->