feat: Add automatic tagging for github integration #4028

novakzaballa · 2024-05-27T04:04:53Z

Thanks for submitting a PR! Please check the boxes below:

I have run pre-commit to check linting
I have added information to docs/ if required so people know about the feature!
I have filled in the "Changes" section below?
I have filled in the "How did you test this code" section below?
I have used a Conventional Commit title for this Pull Request

Changes

When a project is lilnked to a GitHub repository, the following tags are added to the project:
The tags added are:
PR Open
PR Merged
PR Closed
PR Draft
Issue Open
Issue Closed
Add automatic tagging of features linked to GitHub resources. The tags are added on response to events in Flagsmith, like linking/unlinking PR/Issues, and also in response to events in GitHub like closing/reopening/marking as draft/merging PR/Issues. Each feature can have only one active PR tag and one active Issue tag at any time.

How did you test this code?

Unit tests added.

For local manual testing, the corresponding FE PR is #4035
It would be necessary to configure a local dev environment with these two branches (BE/FE) for testing until this BE PR is merged.

NOTE

For the case of multiple PRs/Issues linked to the same feature, we should consider tagging the feature as closed/merged only when all the linked Issues/PRs are closed/merged correspondingly.

vercel · 2024-05-27T04:04:56Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Skipped Deployments

Name	Status	Preview	Updated (UTC)
docs	⬜️ Ignored (Inspect)	Visit Preview	Aug 12, 2024 1:20pm
flagsmith-frontend-preview	⬜️ Ignored (Inspect)	Visit Preview	Aug 12, 2024 1:20pm
flagsmith-frontend-staging	⬜️ Ignored (Inspect)	Visit Preview	Aug 12, 2024 1:20pm

github-actions · 2024-05-27T04:07:51Z

Uffizzi Preview deployment-55059 was deleted.

codecov · 2024-05-27T17:59:18Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.91%. Comparing base (948a87a) to head (479c8a0).
Report is 11 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4028      +/-   ##
==========================================
+ Coverage   96.88%   96.91%   +0.02%     
==========================================
  Files        1172     1176       +4     
  Lines       39035    39345     +310     
==========================================
+ Hits        37820    38131     +311     
+ Misses       1215     1214       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

zachaysan

A lot of comments but nothing I don't trust that you'll handle.

zachaysan · 2024-05-27T21:03:30Z

api/conftest.py

+    from tests.unit.features.test_unit_feature_external_resources_views import (
+        mocked_requests_post,
+    )


I think mocked_requests_post should be converted into a fixture and added to a conftest.py instead of importing it like this.

Converted into a fixture in conftest.py

zachaysan · 2024-05-27T21:04:22Z

api/conftest.py

+    )
+    mock_generate_token.return_value = "mocked_token"
+
+    mocker.patch("requests.post", side_effect=mocked_requests_post)


Where is mocked_requests_post coming from?

Converted into a fixture in conftest

zachaysan · 2024-05-27T21:07:12Z

api/integrations/github/github.py

+tag_by_event_type = {
+    "pull_request": {
+        "closed": GitHubTag.PR_CLOSED.value,
+        "converted_to_draft": GitHubTag.PR_DRAFT.value,
+        "opened": GitHubTag.PR_OPEN.value,
+        "reopened": GitHubTag.PR_OPEN.value,
+        "ready_for_review": GitHubTag.PR_OPEN.value,
+        "merged": GitHubTag.PR_MERGED.value,
+    },
+    "issues": {
+        "closed": GitHubTag.ISSUE_CLOSED.value,
+        "opened": GitHubTag.ISSUE_OPEN.value,
+        "reopened": GitHubTag.ISSUE_OPEN.value,
+    },
+}


This section should probably live in the constants.py module.

I was tempted to put it in constants, however, it would lose context and require extra comments since it's used only in the context of the github.py file. i.e. the event_type in its name refers to a webhook request event type.

zachaysan · 2024-05-27T21:08:11Z

api/integrations/github/github.py

+def handle_installation_deleted(payload: dict[str, typing.Any]) -> None:
+    installation_id = payload.get("installation", {}).get("id")
+    if installation_id:


Do we really want to fail without an exception if installation_id is None?

Good catch! At least initially we want an unhandled exception in case of these unexpected cases. GitHub should never send an "installation.delete" event without an installation ID, if that happens we want the alerts.

zachaysan · 2024-05-27T21:10:14Z

api/integrations/github/github.py

+    if feature:
+        if (


I would return early here.

if not feature: return if ( #....

In this case, it's the same, right? I will keep this since it is a positive condition, it is returning early anyway, and the code is readable in this way.

zachaysan · 2024-05-27T21:13:33Z

api/integrations/github/migrations/0004_auto_20240527_1503.py

+from django.db import migrations
+
+
+class Migration(migrations.Migration):


You should be able to combine this migration with the other one.

Right. Done.

zachaysan · 2024-05-27T21:15:08Z

api/integrations/github/models.py

+        from integrations.github.constants import (
+            GitHubTag,
+            github_tag_description,
+        )


Are you sure you need to inline import these constants? Surely they would be topline imports since there should be no cyclical import issues.

Yes. I have a circular import issue otherwise.

zachaysan · 2024-05-27T21:18:34Z

api/tests/unit/integrations/github/test_unit_github_views.py

+
+    print(feature_external_resource)


I think you want to remove this print statement.

zachaysan · 2024-05-27T21:19:26Z

api/tests/unit/integrations/github/test_unit_github_views.py

+    url = reverse("api-v1:github-webhook")
+
+    # When
+    client = APIClient()


Why not use the api_client fixture instead?

zachaysan · 2024-05-27T21:20:39Z

api/tests/unit/integrations/github/test_unit_github_views.py

+# def test_handle_installation_deleted_with_non_existing_installation(mocker: MockerFixture):
+#     payload = {"installation": {"id": 456}}
+#     handle_installation_deleted(payload)
+#     mock_logger.error.assert_called_once_with(
+#         "Github Configuration with installation_id 456 does not exist"
+#     )


Extra commented out code. Should be deleted, yes?

Oops. Thanks! Deleted

zachaysan

Approved with some comments that may be helpful

zachaysan · 2024-08-09T14:28:18Z

api/integrations/github/github.py

+        feature.tags.remove(
+            *feature.tags.filter(
+                Q(type=TagType.GITHUB.value) & Q(label__startswith=tag_label_pattern)
+            )
+        )
+
+        feature.tags.add(github_tag)


Do we need to call save() when removing or adding the tags?

zachaysan · 2024-08-09T14:36:19Z

api/tests/unit/features/test_unit_feature_external_resources_views.py

+    assert (
+        response.json()["non_field_errors"][0]
+        == "The fields feature, url must make a unique set."
+    )


I don't understand why the fields feature and url do not make a unique set. Does the test set these as duplicates elsewhere?

This is because already exists in this fixture:
this:

flagsmith/api/conftest.py

Line 1044 in e9e1e59

def feature_external_resource_gh_pr(

zachaysan · 2024-08-09T14:38:06Z

api/tests/unit/integrations/github/test_unit_github_views.py

+    feature_external_resource: FeatureExternalResource,
+) -> None:
+    # Given
+    settings.GITHUB_WEBHOOK_SECRET = WEBHOOK_SECRET


If settings is being set like this it is better pulling it into the test as a fixture.

zachaysan · 2024-08-09T14:39:04Z

api/tests/unit/integrations/github/test_unit_github_views.py

    mocker_logger.error.assert_called_once_with(
-        "GitHub Configuration with installation_id 765432 does not exist"
+        "The installation_id is not present in the payload: {'installation': {'test': 765432}, 'action': 'deleted'}"
    )
    assert response.status_code == status.HTTP_200_OK


Should this error really return an HTTP 200 response?

In this case, 200 is enough.

zachaysan · 2024-08-09T14:39:32Z

api/tests/unit/integrations/github/test_unit_github_views.py

    mocker_logger.error.assert_called_once_with(
-        "The installation_id is not present in the payload: {'installation': {'test': 765432}, 'action': 'deleted'}"
+        "GitHub Configuration with installation_id 765432 does not exist"
    )
    assert response.status_code == status.HTTP_200_OK


Same idea with this error, should these really be 200 responses?

In this case, 200 is enough.

github-actions bot added the api Issue related to the REST API label May 27, 2024

novakzaballa changed the title ~~feat: Add automatic tagging for github integration~~ feat: Add automatic tagging for github integration - WIP May 27, 2024

vercel bot deployed to Preview – flagsmith-frontend-preview May 27, 2024 17:53 View deployment

vercel bot deployed to Preview – flagsmith-frontend-staging May 27, 2024 17:56 View deployment

vercel bot deployed to Preview – docs May 27, 2024 17:56 View deployment

vercel bot deployed to Preview – flagsmith-frontend-preview May 27, 2024 20:27 View deployment

vercel bot deployed to Preview – docs May 27, 2024 20:27 View deployment

vercel bot deployed to Preview – flagsmith-frontend-staging May 27, 2024 20:29 View deployment

vercel bot deployed to Preview – docs May 27, 2024 20:59 View deployment

vercel bot deployed to Preview – flagsmith-frontend-staging May 27, 2024 21:01 View deployment

vercel bot deployed to Preview – flagsmith-frontend-preview May 27, 2024 21:03 View deployment

novakzaballa changed the title ~~feat: Add automatic tagging for github integration - WIP~~ feat: Add automatic tagging for github integration May 27, 2024

zachaysan approved these changes May 27, 2024

View reviewed changes

vercel bot deployed to Preview – flagsmith-frontend-preview May 27, 2024 21:25 View deployment

vercel bot deployed to Preview – docs May 27, 2024 21:26 View deployment

vercel bot deployed to Preview – flagsmith-frontend-staging May 27, 2024 21:28 View deployment

novakzaballa mentioned this pull request May 27, 2024

feat: Add tags for GitHub integration FE #4035

Merged

5 tasks

vercel bot deployed to Preview – flagsmith-frontend-preview May 28, 2024 06:49 View deployment

vercel bot deployed to Preview – flagsmith-frontend-staging May 28, 2024 06:52 View deployment

vercel bot deployed to Preview – docs May 28, 2024 06:52 View deployment

vercel bot deployed to Preview – flagsmith-frontend-preview May 28, 2024 07:08 View deployment

vercel bot deployed to Preview – docs May 28, 2024 07:08 View deployment

vercel bot deployed to Preview – flagsmith-frontend-staging May 28, 2024 07:10 View deployment

feat: Add tags for github integration

856e670

novakzaballa force-pushed the feat/add-tags-for-github-integration branch from 918207d to 856e670 Compare May 31, 2024 01:02

vercel bot deployed to Preview – docs May 31, 2024 01:02 View deployment

vercel bot deployed to Preview – flagsmith-frontend-preview May 31, 2024 01:04 View deployment

vercel bot deployed to Preview – docs August 7, 2024 19:09 View deployment

vercel bot deployed to Preview – flagsmith-frontend-preview August 7, 2024 19:11 View deployment

vercel bot deployed to Preview – flagsmith-frontend-staging August 7, 2024 19:11 View deployment

Solve labeling issue

1811c01

github-actions bot added feature New feature or request and removed feature New feature or request labels Aug 7, 2024

Solve tests

4cfc478

github-actions bot added feature New feature or request and removed feature New feature or request labels Aug 7, 2024

code cov 1

76e5f3d

github-actions bot added feature New feature or request and removed feature New feature or request labels Aug 9, 2024

zachaysan approved these changes Aug 9, 2024

View reviewed changes

github-actions bot added feature New feature or request and removed feature New feature or request labels Aug 9, 2024

novakzaballa force-pushed the feat/add-tags-for-github-integration branch from 07292e4 to 42d2ade Compare August 9, 2024 17:49

github-actions bot added feature New feature or request and removed feature New feature or request labels Aug 9, 2024

Code cov 2

e9e1e59

novakzaballa force-pushed the feat/add-tags-for-github-integration branch from 42d2ade to e9e1e59 Compare August 9, 2024 19:15

github-actions bot added feature New feature or request and removed feature New feature or request labels Aug 9, 2024

Make sure to save the changes in the features models

479c8a0

github-actions bot added feature New feature or request and removed feature New feature or request labels Aug 12, 2024

novakzaballa added this pull request to the merge queue Aug 12, 2024

Merged via the queue into main with commit 7920e8e Aug 12, 2024
35 checks passed

novakzaballa deleted the feat/add-tags-for-github-integration branch August 12, 2024 13:34

flagsmithdev mentioned this pull request Aug 12, 2024

chore(main): release 2.136.0 #4478

Merged

		from django.db import migrations


		class Migration(migrations.Migration):

feat: Add automatic tagging for github integration #4028

feat: Add automatic tagging for github integration #4028

Conversation

novakzaballa commented May 27, 2024 • edited Loading

Changes

How did you test this code?

NOTE

vercel bot commented May 27, 2024 • edited Loading

github-actions bot commented May 27, 2024 • edited Loading

codecov bot commented May 27, 2024 • edited Loading

Codecov Report

zachaysan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

novakzaballa May 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

novakzaballa May 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zachaysan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

novakzaballa commented May 27, 2024 •

edited

Loading

vercel bot commented May 27, 2024 •

edited

Loading

github-actions bot commented May 27, 2024 •

edited

Loading

codecov bot commented May 27, 2024 •

edited

Loading

novakzaballa May 28, 2024 •

edited

Loading

novakzaballa May 28, 2024 •

edited

Loading