Add assignee support to issue metrics reporting

Co-authored-by: zkoppert <[email protected]>

Author: Copilot

classes.py

@@ -13,6 +13,8 @@ class IssueWithMetrics:
         title (str): The title of the issue.
         html_url (str): The URL of the issue on GitHub.
         author (str): The author of the issue.
+        assignee (str, optional): The primary assignee of the issue.
+        assignees (list, optional): All assignees of the issue.
         time_to_first_response (timedelta, optional): The time it took to
             get the first response to the issue.
         time_to_close (timedelta, optional): The time it took to close the issue.
@@ -38,10 +40,14 @@ def __init__(
         labels_metrics=None,
         mentor_activity=None,
         created_at=None,
+        assignee=None,
+        assignees=None,
     ):
         self.title = title
         self.html_url = html_url
         self.author = author
+        self.assignee = assignee
+        self.assignees = assignees or []
         self.time_to_first_response = time_to_first_response
         self.time_to_close = time_to_close
         self.time_to_answer = time_to_answer

config.py

@@ -30,6 +30,7 @@ class EnvVars:
             authentication
         gh_token (str | None): GitHub personal access token (PAT) for API authentication
         ghe (str): The GitHub Enterprise URL to use for authentication
+        hide_assignee (bool): If true, the assignee's information is hidden in the output
         hide_author (bool): If true, the author's information is hidden in the output
         hide_items_closed_count (bool): If true, the number of items closed metric is hidden
             in the output
@@ -64,6 +65,7 @@ def __init__(
         gh_app_enterprise_only: bool,
         gh_token: str | None,
         ghe: str | None,
+        hide_assignee: bool,
         hide_author: bool,
         hide_items_closed_count: bool,
         hide_label_metrics: bool,
@@ -92,6 +94,7 @@ def __init__(
         self.ghe = ghe
         self.ignore_users = ignore_user
         self.labels_to_measure = labels_to_measure
+        self.hide_assignee = hide_assignee
         self.hide_author = hide_author
         self.hide_items_closed_count = hide_items_closed_count
         self.hide_label_metrics = hide_label_metrics
@@ -119,6 +122,7 @@ def __repr__(self):
             f"{self.gh_app_enterprise_only},"
             f"{self.gh_token},"
             f"{self.ghe},"
+            f"{self.hide_assignee},"
             f"{self.hide_author},"
             f"{self.hide_items_closed_count}),"
             f"{self.hide_label_metrics},"
@@ -226,6 +230,7 @@ def get_env_vars(test: bool = False) -> EnvVars:
     draft_pr_tracking = get_bool_env_var("DRAFT_PR_TRACKING", False)
 
     # Hidden columns
+    hide_assignee = get_bool_env_var("HIDE_ASSIGNEE", False)
     hide_author = get_bool_env_var("HIDE_AUTHOR", False)
     hide_items_closed_count = get_bool_env_var("HIDE_ITEMS_CLOSED_COUNT", False)
     hide_label_metrics = get_bool_env_var("HIDE_LABEL_METRICS", False)
@@ -246,6 +251,7 @@ def get_env_vars(test: bool = False) -> EnvVars:
         gh_app_enterprise_only,
         gh_token,
         ghe,
+        hide_assignee,
         hide_author,
         hide_items_closed_count,
         hide_label_metrics,

issue_metrics.py

@@ -85,6 +85,9 @@ def get_per_issue_metrics(
                 None,
                 None,
             )
+            # Discussions typically don't have assignees in the same way as issues/PRs
+            issue_with_metrics.assignee = None
+            issue_with_metrics.assignees = []
             if env_vars.hide_time_to_first_response is False:
                 issue_with_metrics.time_to_first_response = (
                     measure_time_to_first_response(None, issue, ignore_users)
@@ -119,6 +122,20 @@ def get_per_issue_metrics(
                 author=issue.user["login"],  # type: ignore
             )
 
+            # Extract assignee information from the issue
+            issue_dict = issue.issue.as_dict()  # type: ignore
+            assignee = None
+            assignees = []
+            
+            if issue_dict.get("assignee"):
+                assignee = issue_dict["assignee"]["login"]
+                
+            if issue_dict.get("assignees"):
+                assignees = [a["login"] for a in issue_dict["assignees"]]
+                
+            issue_with_metrics.assignee = assignee
+            issue_with_metrics.assignees = assignees
+
             # Check if issue is actually a pull request
             pull_request, ready_for_review_at = None, None
             if issue.issue.pull_request_urls:  # type: ignore

json_writer.py

@@ -177,6 +177,8 @@ def write_to_json(
                 "title": issue.title,
                 "html_url": issue.html_url,
                 "author": issue.author,
+                "assignee": issue.assignee,
+                "assignees": issue.assignees,
                 "time_to_first_response": str(issue.time_to_first_response),
                 "time_to_close": str(issue.time_to_close),
                 "time_to_answer": str(issue.time_to_answer),

markdown_writer.py

@@ -55,6 +55,10 @@ def get_non_hidden_columns(labels) -> List[str]:
     env_vars = get_env_vars()
 
     # Find the number of columns and which are to be hidden
+    hide_assignee = env_vars.hide_assignee
+    if not hide_assignee:
+        columns.append("Assignee")
+
     hide_author = env_vars.hide_author
     if not hide_author:
         columns.append("Author")
@@ -203,6 +207,11 @@ def write_to_markdown(
                 )
             else:
                 file.write(f"| {issue.title} | {issue.html_url} |")
+            if "Assignee" in columns:
+                if issue.assignee:
+                    file.write(f" [{issue.assignee}](https://{endpoint}/{issue.assignee}) |") 
+                else:
+                    file.write(" None |")
             if "Author" in columns:
                 file.write(f" [{issue.author}](https://{endpoint}/{issue.author}) |")
             if "Time to first response" in columns:

test_assignee_functionality.py

@@ -0,0 +1,96 @@
+"""Test assignee functionality added to issue metrics."""
+
+import os
+import unittest
+from unittest.mock import patch
+from markdown_writer import get_non_hidden_columns
+
+
+class TestAssigneeFunctionality(unittest.TestCase):
+    """Test suite for the assignee functionality."""
+
+    @patch.dict(
+        os.environ,
+        {
+            "GH_TOKEN": "test_token",
+            "SEARCH_QUERY": "is:issue is:open repo:user/repo",
+            "HIDE_ASSIGNEE": "false",
+            "HIDE_AUTHOR": "false",
+        },
+        clear=True,
+    )
+    def test_get_non_hidden_columns_includes_assignee_by_default(self):
+        """Test that assignee column is included by default."""
+        columns = get_non_hidden_columns(labels=None)
+        self.assertIn("Assignee", columns)
+        self.assertIn("Author", columns)
+
+    @patch.dict(
+        os.environ,
+        {
+            "GH_TOKEN": "test_token",
+            "SEARCH_QUERY": "is:issue is:open repo:user/repo",
+            "HIDE_ASSIGNEE": "true",
+            "HIDE_AUTHOR": "false",
+        },
+        clear=True,
+    )
+    def test_get_non_hidden_columns_hides_assignee_when_env_set(self):
+        """Test that assignee column is hidden when HIDE_ASSIGNEE is true."""
+        columns = get_non_hidden_columns(labels=None)
+        self.assertNotIn("Assignee", columns)
+        self.assertIn("Author", columns)
+
+    @patch.dict(
+        os.environ,
+        {
+            "GH_TOKEN": "test_token",
+            "SEARCH_QUERY": "is:issue is:open repo:user/repo",
+            "HIDE_ASSIGNEE": "false",
+            "HIDE_AUTHOR": "true",
+        },
+        clear=True,
+    )
+    def test_get_non_hidden_columns_shows_assignee_but_hides_author(self):
+        """Test that assignee can be shown while author is hidden."""
+        columns = get_non_hidden_columns(labels=None)
+        self.assertIn("Assignee", columns)
+        self.assertNotIn("Author", columns)
+
+    @patch.dict(
+        os.environ,
+        {
+            "GH_TOKEN": "test_token",
+            "SEARCH_QUERY": "is:issue is:open repo:user/repo",
+            "HIDE_ASSIGNEE": "true",
+            "HIDE_AUTHOR": "true",
+        },
+        clear=True,
+    )
+    def test_get_non_hidden_columns_hides_both_assignee_and_author(self):
+        """Test that both assignee and author can be hidden."""
+        columns = get_non_hidden_columns(labels=None)
+        self.assertNotIn("Assignee", columns)
+        self.assertNotIn("Author", columns)
+
+    def test_assignee_column_position(self):
+        """Test that assignee column appears before author column."""
+        with patch.dict(
+            os.environ,
+            {
+                "GH_TOKEN": "test_token",
+                "SEARCH_QUERY": "is:issue is:open repo:user/repo",
+                "HIDE_ASSIGNEE": "false",
+                "HIDE_AUTHOR": "false",
+            },
+            clear=True,
+        ):
+            columns = get_non_hidden_columns(labels=None)
+            assignee_index = columns.index("Assignee")
+            author_index = columns.index("Author")
+            self.assertLess(assignee_index, author_index, 
+                          "Assignee column should appear before Author column")
+
+
+if __name__ == "__main__":
+    unittest.main()

test_config.py

@@ -123,6 +123,7 @@ def test_get_env_vars_with_github_app(self):
             gh_app_enterprise_only=False,
             gh_token="",
             ghe="",
+            hide_assignee=False,
             hide_author=False,
             hide_items_closed_count=False,
             hide_label_metrics=False,
@@ -177,6 +178,7 @@ def test_get_env_vars_with_token(self):
             gh_app_enterprise_only=False,
             gh_token=TOKEN,
             ghe="",
+            hide_assignee=False,
             hide_author=False,
             hide_items_closed_count=False,
             hide_label_metrics=False,
@@ -266,6 +268,7 @@ def test_get_env_vars_optional_values(self):
             gh_app_enterprise_only=False,
             gh_token=TOKEN,
             ghe="",
+            hide_assignee=False,
             hide_author=True,
             hide_items_closed_count=True,
             hide_label_metrics=True,
@@ -309,6 +312,7 @@ def test_get_env_vars_optionals_are_defaulted(self):
             gh_app_enterprise_only=False,
             gh_token="TOKEN",
             ghe="",
+            hide_assignee=False,
             hide_author=False,
             hide_items_closed_count=False,
             hide_label_metrics=False,

test_json_writer.py

@@ -21,6 +21,8 @@ def test_write_to_json(self):
                 title="Issue 1",
                 html_url="https://github.com/owner/repo/issues/1",
                 author="alice",
+                assignee="charlie",
+                assignees=["charlie"],
                 time_to_first_response=timedelta(days=3),
                 time_to_close=timedelta(days=6),
                 time_to_answer=None,
@@ -34,6 +36,8 @@ def test_write_to_json(self):
                 title="Issue 2",
                 html_url="https://github.com/owner/repo/issues/2",
                 author="bob",
+                assignee=None,
+                assignees=[],
                 time_to_first_response=timedelta(days=2),
                 time_to_close=timedelta(days=4),
                 time_to_answer=timedelta(days=1),
@@ -96,6 +100,8 @@ def test_write_to_json(self):
                     "title": "Issue 1",
                     "html_url": "https://github.com/owner/repo/issues/1",
                     "author": "alice",
+                    "assignee": "charlie",
+                    "assignees": ["charlie"],
                     "time_to_first_response": "3 days, 0:00:00",
                     "time_to_close": "6 days, 0:00:00",
                     "time_to_answer": "None",
@@ -107,6 +113,8 @@ def test_write_to_json(self):
                     "title": "Issue 2",
                     "html_url": "https://github.com/owner/repo/issues/2",
                     "author": "bob",
+                    "assignee": None,
+                    "assignees": [],
                     "time_to_first_response": "2 days, 0:00:00",
                     "time_to_close": "4 days, 0:00:00",
                     "time_to_answer": "1 day, 0:00:00",
@@ -143,6 +151,8 @@ def test_write_to_json_with_no_response(self):
                 title="Issue 1",
                 html_url="https://github.com/owner/repo/issues/1",
                 author="alice",
+                assignee=None,
+                assignees=[],
                 time_to_first_response=None,
                 time_to_close=None,
                 time_to_answer=None,
@@ -153,6 +163,8 @@ def test_write_to_json_with_no_response(self):
                 title="Issue 2",
                 html_url="https://github.com/owner/repo/issues/2",
                 author="bob",
+                assignee=None,
+                assignees=[],
                 time_to_first_response=None,
                 time_to_close=None,
                 time_to_answer=None,
@@ -199,6 +211,8 @@ def test_write_to_json_with_no_response(self):
                     "title": "Issue 1",
                     "html_url": "https://github.com/owner/repo/issues/1",
                     "author": "alice",
+                    "assignee": None,
+                    "assignees": [],
                     "time_to_first_response": "None",
                     "time_to_close": "None",
                     "time_to_answer": "None",
@@ -210,6 +224,8 @@ def test_write_to_json_with_no_response(self):
                     "title": "Issue 2",
                     "html_url": "https://github.com/owner/repo/issues/2",
                     "author": "bob",
+                    "assignee": None,
+                    "assignees": [],
                     "time_to_first_response": "None",
                     "time_to_close": "None",
                     "time_to_answer": "None",