#129 - PR added to warning category despite having a registered label (#157)

* #129 - PR added to warning category despite having a registered label
- Reported error cannot be re-simulated. Origin PR was closed without merge.
- Fixed presence of pr among returned issues list from github API.
- Fixed skipped closed PR during filtration.
- Now PRs are in Release Notes visible as PR not an Issues.

* - Fixed checks. Could fix several AI review news already.

* - Fixed AI Review notes.

* - Fixed Black.

Author: miroslavpojer

main.py

@@ -56,8 +56,7 @@ def run() -> None:
     )
 
     generator = ReleaseNotesGenerator(py_github, custom_chapters)
-    filterer = FilterByRelease()
-    rls_notes = generator.generate(filterer)
+    rls_notes = generator.generate()
     logger.debug("Generated release notes: \n%s", rls_notes)
 
     # Set the output for the GitHub Action

release_notes_generator/filter.py

@@ -74,9 +74,15 @@ def filter(self, data: MinedData) -> MinedData:
             logger.debug("Count of issues reduced from %d to %d", len(data.issues), len(issues_list))
 
             # filter out merged PRs and commits before the date
-            pulls_list = list(
-                filter(lambda pull: pull.merged_at is not None and pull.merged_at >= data.since, data.pull_requests)
-            )
+            pulls_seen: set[int] = set()
+            pulls_list: list = []
+            for pull in data.pull_requests:
+                if (pull.merged_at is not None and pull.merged_at >= data.since) or (
+                    pull.closed_at is not None and pull.closed_at >= data.since
+                ):
+                    if pull.number not in pulls_seen:
+                        pulls_seen.add(pull.number)
+                        pulls_list.append(pull)
             logger.debug("Count of pulls reduced from %d to %d", len(data.pull_requests), len(pulls_list))
 
             commits_list = list(filter(lambda commit: commit.commit.author.date > data.since, data.commits))

release_notes_generator/generator.py

@@ -25,7 +25,7 @@
 
 from github import Github
 
-from release_notes_generator.filter import Filter
+from release_notes_generator.filter import FilterByRelease
 from release_notes_generator.miner import DataMiner
 from release_notes_generator.action_inputs import ActionInputs
 from release_notes_generator.builder import ReleaseNotesBuilder
@@ -65,7 +65,7 @@ def rate_limiter(self) -> GithubRateLimiter:
         """Getter for the GithubRateLimiter instance."""
         return self._rate_limiter
 
-    def generate(self, filterer: Filter) -> Optional[str]:
+    def generate(self) -> Optional[str]:
         """
         Generates the Release Notes for a given repository.
 
@@ -79,16 +79,19 @@ def generate(self, filterer: Filter) -> Optional[str]:
         if data.is_empty():
             return None
 
-        filtered_data = filterer.filter(data=data)
+        filterer = FilterByRelease()
+        data_filtered_by_release = filterer.filter(data=data)
 
         changelog_url: str = get_change_url(
-            tag_name=ActionInputs.get_tag_name(), repository=filtered_data.repository, git_release=filtered_data.release
+            tag_name=ActionInputs.get_tag_name(),
+            repository=data_filtered_by_release.repository,
+            git_release=data_filtered_by_release.release,
         )
 
-        assert filtered_data.repository is not None, "Repository must not be None"
+        assert data_filtered_by_release.repository is not None, "Repository must not be None"
 
         rls_notes_records: dict[int | str, Record] = RecordFactory.generate(
-            github=self._github_instance, data=filtered_data
+            github=self._github_instance, data=data_filtered_by_release
         )
 
         release_notes_builder = ReleaseNotesBuilder(

release_notes_generator/miner.py

@@ -68,7 +68,12 @@ def mine_data(self) -> MinedData:
         data.commits = list(self._safe_call(data.repository.get_commits)())
 
         logger.info("Data mining from GitHub completed.")
-        return data
+
+        logger.info("Filtering duplicated issues from the list of issues...")
+        de_duplicated_data = self.__filter_duplicated_issues(data)
+        logger.info("Filtering duplicated issues from the list of issues finished.")
+
+        return de_duplicated_data
 
     def get_latest_release(self, repository: Repository) -> Optional[GitRelease]:
         """
@@ -154,3 +159,23 @@ def __get_latest_semantic_release(self, releases) -> Optional[GitRelease]:
                 rls = release
 
         return rls
+
+    def __filter_duplicated_issues(self, data: MinedData) -> "MinedData":
+        """
+        Filters out duplicated issues from the list of issues.
+        This method address problem in output of GitHub API where issues list contains PR values.
+
+        Parameters:
+            - data (MinedData): The mined data containing issues and pull requests.
+
+        Returns:
+            - MinedData: The mined data with duplicated issues removed.
+        """
+        pr_numbers = {pr.number for pr in data.pull_requests}
+        filtered_issues = [issue for issue in data.issues if issue.number not in pr_numbers]
+
+        logger.debug("Duplicated issues removed: %s", len(data.issues) - len(filtered_issues))
+
+        data.issues = filtered_issues
+
+        return data

release_notes_generator/record/record_factory.py

@@ -58,7 +58,9 @@ def generate(github: Github, data: MinedData) -> dict[int | str, Record]:
 
         def register_pull_request(pull: PullRequest, skip_rec: bool) -> None:
             detected_issues = extract_issue_numbers_from_body(pull)
-            detected_issues.extend(safe_call(get_issues_for_pr)(pull_number=pull.number))
+            logger.debug(f"Detected issues - from body: {detected_issues}")
+            detected_issues.update(safe_call(get_issues_for_pr)(pull_number=pull.number))
+            logger.debug(f"Detected issues - final: {detected_issues}")
 
             for parent_issue_number in detected_issues:
                 # create an issue record if not present for PR parent
@@ -89,12 +91,10 @@ def register_pull_request(pull: PullRequest, skip_rec: bool) -> None:
         records: dict[int | str, Record] = {}
         rate_limiter = GithubRateLimiter(github)
         safe_call = safe_call_decorator(rate_limiter)
-        pull_numbers = [pull.number for pull in data.pull_requests]
 
         logger.debug("Registering issues to records...")
         for issue in data.issues:
-            if issue.number not in pull_numbers:
-                RecordFactory._create_record_for_issue(records, issue)
+            RecordFactory._create_record_for_issue(records, issue)
 
         logger.debug("Registering pull requests to records...")
         for pull in data.pull_requests:
@@ -105,6 +105,7 @@ def register_pull_request(pull: PullRequest, skip_rec: bool) -> None:
                 records[pull.number] = PullRequestRecord(pull, skip=skip_record)
                 logger.debug("Created record for PR %d: %s", pull.number, pull.title)
             else:
+                logger.debug(f"Registering pull number: {pull.number}, title : {pull.title}")
                 register_pull_request(pull, skip_record)
 
         logger.debug("Registering commits to records...")

release_notes_generator/utils/pull_request_utils.py

@@ -29,7 +29,7 @@
 
 
 @lru_cache(maxsize=None)
-def extract_issue_numbers_from_body(pr: PullRequest) -> list[int]:
+def extract_issue_numbers_from_body(pr: PullRequest) -> set[int]:
     """
     Extracts the numbers of the issues mentioned in the body of the pull request.
 
@@ -43,7 +43,7 @@ def extract_issue_numbers_from_body(pr: PullRequest) -> list[int]:
     issue_matches = regex_pattern.findall(pr.body if pr.body else "")
 
     # Extract the issue numbers from the matches
-    issue_numbers = [int(match[-1]) for match in issue_matches]
+    issue_numbers = {int(match[-1]) for match in issue_matches}
 
     return issue_numbers
 

tests/release_notes/test_record_factory.py

@@ -299,7 +299,7 @@ def test_generate_with_no_commits_with_wrong_issue_number_in_pull_body_mention(m
     data = MinedData()
     # pylint: disable=unused-variable
     issue1, issue2, pr1, pr2, commit1, commit2 = setup_issues_pulls_commits(mocker)
-    pr1.body = "Closes #100"
+    pr1.body = "Closes #2"
     data.issues = [issue1]
     data.pull_requests = [pr1]  # PR linked to a non-fetched issues (due to since condition)
 
@@ -320,8 +320,8 @@ def test_generate_with_no_commits_with_wrong_issue_number_in_pull_body_mention(m
     assert isinstance(records[1], IssueRecord)
     assert isinstance(records[2], IssueRecord)
 
-    rec_issue1 = cast(IssueRecord,records[1])
-    rec_issue2 = cast(IssueRecord,records[2])
+    rec_issue1 = cast(IssueRecord, records[1])
+    rec_issue2 = cast(IssueRecord, records[2])
 
     # Verify that PRs are registered
     assert 0 == rec_issue1.pull_requests_count()

tests/test_filter.py

@@ -65,8 +65,8 @@ def test_filter_with_release(mocker):
         MagicMock(closed_at=datetime(2022, 12, 31)),
     ]
     data.pull_requests = [
-        MagicMock(merged_at=datetime(2023, 2, 3)),
-        MagicMock(merged_at=datetime(2022, 12, 30)),
+        MagicMock(merged_at=datetime(2023, 2, 3), closed_at=datetime(2022, 12, 31)),
+        MagicMock(merged_at=datetime(2022, 12, 30), closed_at=datetime(2022, 12, 31)),
     ]
     data.commits = [
         MagicMock(commit=MagicMock(author=MagicMock(date=datetime(2024, 1, 4)))),

tests/test_release_notes_generator.py

@@ -39,7 +39,7 @@ def test_generate_release_notes_repository_not_found(mocker):
 
     custom_chapters = CustomChapters(print_empty_chapters=True)
 
-    release_notes = ReleaseNotesGenerator(github_mock, custom_chapters).generate(filterer=FilterByRelease())
+    release_notes = ReleaseNotesGenerator(github_mock, custom_chapters).generate()
 
     assert release_notes is None
 
@@ -74,7 +74,7 @@ def test_generate_release_notes_latest_release_not_found(
 
     custom_chapters = CustomChapters(print_empty_chapters=True)
 
-    release_notes = ReleaseNotesGenerator(github_mock, custom_chapters).generate(filterer=FilterByRelease())
+    release_notes = ReleaseNotesGenerator(github_mock, custom_chapters).generate()
 
     assert release_notes is not None
     assert "- #121 _Fix the bug_" in release_notes
@@ -105,14 +105,15 @@ def test_generate_release_notes_latest_release_found_by_created_at(
     mock_issue_closed_i1_bug.created_at = mock_repo.created_at + timedelta(days=7)
     mock_issue_closed_i1_bug.closed_at = mock_repo.created_at + timedelta(days=6)
     mock_pull_closed_with_rls_notes_101.merged_at = mock_repo.created_at + timedelta(days=2)
+    mock_pull_closed_with_rls_notes_101.closed_at = mock_repo.created_at + timedelta(days=2)
     mock_pull_closed_with_rls_notes_102.merged_at = mock_repo.created_at + timedelta(days=7)
+    mock_pull_closed_with_rls_notes_102.closed_at = mock_repo.created_at + timedelta(days=7)
 
     mock_git_release.created_at = mock_repo.created_at + timedelta(days=5)
     mock_git_release.published_at = mock_repo.created_at + timedelta(days=5)
     mocker.patch("release_notes_generator.miner.DataMiner.get_latest_release", return_value=mock_git_release)
     mocker.patch("release_notes_generator.record.record_factory.get_issues_for_pr", return_value=[])
 
-
     mock_rate_limit = mocker.Mock()
     mock_rate_limit.core.remaining = 1000
     github_mock.get_rate_limit.return_value = mock_rate_limit
@@ -124,7 +125,7 @@ def test_generate_release_notes_latest_release_found_by_created_at(
 
     custom_chapters = CustomChapters(print_empty_chapters=True)
 
-    release_notes = ReleaseNotesGenerator(github_mock, custom_chapters).generate(filterer=FilterByRelease())
+    release_notes = ReleaseNotesGenerator(github_mock, custom_chapters).generate()
 
     assert release_notes is not None
     assert "- #122 _I1+bug_" in release_notes
@@ -155,7 +156,9 @@ def test_generate_release_notes_latest_release_found_by_published_at(
     mock_issue_closed_i1_bug.created_at = mock_repo.created_at + timedelta(days=7)
     mock_issue_closed_i1_bug.closed_at = mock_repo.created_at + timedelta(days=8)
     mock_pull_closed_with_rls_notes_101.merged_at = mock_repo.created_at + timedelta(days=2)
+    mock_pull_closed_with_rls_notes_101.closed_at = mock_repo.created_at + timedelta(days=2)
     mock_pull_closed_with_rls_notes_102.merged_at = mock_repo.created_at + timedelta(days=7)
+    mock_pull_closed_with_rls_notes_102.closed_at = mock_repo.created_at + timedelta(days=7)
 
     github_mock.get_repo().get_latest_release.return_value = mock_git_release
     mock_git_release.created_at = mock_repo.created_at + timedelta(days=5)
@@ -170,7 +173,7 @@ def test_generate_release_notes_latest_release_found_by_published_at(
 
     custom_chapters = CustomChapters(print_empty_chapters=True)
 
-    release_notes = ReleaseNotesGenerator(github_mock, custom_chapters).generate(filterer=FilterByRelease())
+    release_notes = ReleaseNotesGenerator(github_mock, custom_chapters).generate()
 
     assert release_notes is not None
     assert "- #122 _I1+bug_" in release_notes

tests/utils/test_pull_reuqest_utils.py

@@ -48,35 +48,35 @@ def test_extract_issue_numbers_from_body_no_issues(mocker):
     mock_pr = mocker.Mock(spec=PullRequest)
     mock_pr.body = "This PR does not fix any issues."
     issue_numbers = extract_issue_numbers_from_body(mock_pr)
-    assert issue_numbers == []
+    assert issue_numbers == set()
 
 
 def test_extract_issue_numbers_from_body_single_issue(mocker):
     mock_pr = mocker.Mock(spec=PullRequest)
     mock_pr.body = "This PR closes #123."
     issue_numbers = extract_issue_numbers_from_body(mock_pr)
-    assert issue_numbers == [123]
+    assert issue_numbers == {123}
 
 
 def test_extract_issue_numbers_from_body_multiple_issues(mocker):
     mock_pr = mocker.Mock(spec=PullRequest)
     mock_pr.body = "This PR fixes #123 and resolves #456."
     issue_numbers = extract_issue_numbers_from_body(mock_pr)
-    assert issue_numbers == [123, 456]
+    assert issue_numbers == {123, 456}
 
 
 def test_extract_issue_numbers_from_body_mixed_case_keywords(mocker):
     mock_pr = mocker.Mock(spec=PullRequest)
     mock_pr.body = "This PR Fixes #123 and Resolves #456."
     issue_numbers = extract_issue_numbers_from_body(mock_pr)
-    assert issue_numbers == [123, 456]
+    assert issue_numbers == {123, 456}
 
 
 def test_extract_issue_numbers_from_body_no_body(mocker):
     mock_pr = mocker.Mock(spec=PullRequest)
     mock_pr.body = None
     issue_numbers = extract_issue_numbers_from_body(mock_pr)
-    assert issue_numbers == []
+    assert issue_numbers == set()
 
 
 def test_extract_issue_numbers_from_body_complex_text_with_wrong_syntax(mocker):
@@ -88,7 +88,7 @@ def test_extract_issue_numbers_from_body_complex_text_with_wrong_syntax(mocker):
     - resolves the bug in #789
     """
     issue_numbers = extract_issue_numbers_from_body(mock_pr)
-    assert issue_numbers == [123]
+    assert issue_numbers == {123}
 
 
 # get_issues_for_pr