Fix #578: remove mention of 'allow_private' (#580)

* Fix #578: remove mention of 'allow_private'

* Remove private bug support in list of changes

* Ignore private bugs from runner

Author: leplatrem

config/config.nonprod.yaml

@@ -8,7 +8,6 @@
     labels_brackets: both
 
 - whiteboard_tag: flowstate
-  allow_private: true
   bugzilla_user_id: 91159
   description: Flowstate whiteboard tag
   parameters:

docs/actions.md

@@ -6,7 +6,6 @@ The system reads the actions configuration from a YAML file, one per environment
 Below is a full example of an action configuration:
 ```yaml
 - whiteboard_tag: example
-  allow_private: false
   bugzilla_user_id: 514230
   description: example configuration
   module: jbi.actions.default
@@ -18,11 +17,6 @@ A bit more about the different fields...
 - `whiteboard_tag`
     - string
     - The tag to be matched in the Bugzilla `whiteboard` field
-- `allow_private` (optional)
-    - bool [true, false]
-    - default: false
-    - If `false`, bugs will not be synchronized if they are not public. Note that in order to synchronize private bugs,
-     the bugzilla user that JBI runs as must be in the security groups that are making the bug private.
 - `bugzilla_user_id`
     - a bugzilla user id, a list of user ids, or a literal "tbd" to signify that no bugzilla user id is available
     - If an issue arises with the workflow, communication will be established with these users

docs/troubleshooting.md

@@ -12,7 +12,6 @@ If you have access to the configured Bugzilla account:
 - Open https://bugzilla.mozilla.org/userprefs.cgi?tab=webhooks
 - Check that Webhook is still **enabled**
 - Check that WebHook is setup to be executed for your product
-- (*if applies*) Check that account can read the private bugs
 
 ## Log Explorer Queries Examples
 

jbi/models.py

@@ -32,7 +32,6 @@ class Action(YamlModel):
     bugzilla_user_id: int | list[int] | Literal["tbd"]
     description: str
     enabled: bool = True
-    allow_private: bool = False
     parameters: dict = {}
     _caller: Optional[Callable] = PrivateAttr(default=None)
     _required_jira_permissions: set[str] = PrivateAttr(default=None)
@@ -172,15 +171,7 @@ class BugzillaWebhookEvent(BaseModel):
 
     def changed_fields(self) -> list[str]:
         """Returns the names of changed fields in a bug"""
-        if self.changes:
-            return [c.field for c in self.changes]
-
-        # Private bugs don't include the changes field in the event, but the
-        # field names are in the routing key.
-        if self.routing_key is not None and self.routing_key[0:11] == "bug.modify:":
-            return self.routing_key[11:].split(",")
-
-        return []
+        return [c.field for c in self.changes] if self.changes else []
 
 
 class BugzillaWebhookAttachment(BaseModel):

jbi/runner.py

@@ -44,6 +44,9 @@ def execute_action(
         operation=Operation.HANDLE,
     )
     try:
+        if bug.is_private:
+            raise IgnoreInvalidRequestError("private bugs are not supported")
+
         logger.debug(
             "Handling incoming request",
             extra=runner_context.dict(),
@@ -68,11 +71,6 @@ def execute_action(
             ) from err
         runner_context = runner_context.update(action=action)
 
-        if bug.is_private and not action.allow_private:
-            raise IgnoreInvalidRequestError(
-                f"private bugs are not valid for action {action.whiteboard_tag!r}"
-            )
-
         linked_issue_key: Optional[str] = bug.extract_from_see_also()
 
         action_context = ActionContext(

tests/conftest.py

@@ -146,7 +146,12 @@ def context_update_resolution_example() -> ActionContext:
         see_also=["https://mozilla.atlassian.net/browse/JBI-234"]
     )
     event = factories.webhook_event_factory(
-        action="modify", routing_key="bug.modify:resolution"
+        action="modify",
+        changes=[
+            factories.webhook_event_change_factory(
+                field="resolution", removed="OPEN", added="FIXED"
+            ),
+        ],
     )
     context = factories.action_context_factory(
         operation=Operation.UPDATE,
@@ -190,44 +195,21 @@ def webhook_private_comment_example() -> BugzillaWebhookRequest:
     return webhook_payload
 
 
-@pytest.fixture
-def webhook_create_private_example() -> BugzillaWebhookRequest:
-    return factories.webhook_factory(
-        event=factories.webhook_event_factory(),
-        bug={"id": 654321, "is_private": True},
-    )
-
-
 @pytest.fixture
 def webhook_change_status_assignee():
     changes = [
-        {
-            "field": "status",
-            "removed": "OPEN",
-            "added": "FIXED",
-        },
-        {
-            "field": "assignee",
-            "removed": "[email protected]",
-            "added": "[email protected]",
-        },
+        factories.webhook_event_change_factory(
+            field="status", removed="OPEN", added="FIXED"
+        ),
+        factories.webhook_event_change_factory(
+            field="assignee", removed="[email protected]", added="[email protected]"
+        ),
     ]
     event = factories.webhook_event_factory(routing_key="bug.modify", changes=changes)
     webhook_payload = factories.webhook_factory(event=event)
     return webhook_payload
 
 
-@pytest.fixture
-def webhook_modify_private_example() -> BugzillaWebhookRequest:
-    event = factories.webhook_event_factory(
-        action="modify", routing_key="bug.modify:status"
-    )
-    webhook_payload = factories.webhook_factory(
-        bug={"id": 654321, "is_private": True}, event=event
-    )
-    return webhook_payload
-
-
 @pytest.fixture
 def action_factory():
     return factories.action_factory

tests/unit/actions/test_steps.py

@@ -260,7 +260,9 @@ def test_create_with_assignee(
 
 def test_clear_assignee(context_update_example: ActionContext, mocked_jira):
     context_update_example.event.action = "modify"
-    context_update_example.event.routing_key = "bug.modify:assigned_to"
+    context_update_example.event.changes = [
+        webhook_event_change_factory(field="assigned_to", removed="user", added="")
+    ]
 
     callable_object = default.init(
         jira_project_key=context_update_example.jira.project, steps=ALL_STEPS
@@ -279,7 +281,11 @@ def test_clear_assignee(context_update_example: ActionContext, mocked_jira):
 def test_set_assignee(context_update_example: ActionContext, mocked_jira):
     context_update_example.bug.assigned_to = "[email protected]"
     context_update_example.event.action = "modify"
-    context_update_example.event.routing_key = "bug.modify:assigned_to"
+    context_update_example.event.changes = [
+        webhook_event_change_factory(
+            field="assigned_to", removed="", added="[email protected]"
+        )
+    ]
 
     mocked_jira.user_find_by_user_string.return_value = [{"accountId": "6254"}]
 
@@ -393,7 +399,9 @@ def test_change_to_known_status(context_update_example: ActionContext, mocked_ji
     context_update_example.bug.status = "ASSIGNED"
     context_update_example.bug.resolution = ""
     context_update_example.event.action = "modify"
-    context_update_example.event.routing_key = "bug.modify:status"
+    context_update_example.event.changes = [
+        webhook_event_change_factory(field="status", removed="NEW", added="ASSIGNED")
+    ]
 
     callable_object = default.init(
         jira_project_key=context_update_example.jira.project,
@@ -414,7 +422,9 @@ def test_change_to_known_resolution(context_update_example: ActionContext, mocke
     context_update_example.bug.status = "RESOLVED"
     context_update_example.bug.resolution = "FIXED"
     context_update_example.event.action = "modify"
-    context_update_example.event.routing_key = "bug.modify:resolution"
+    context_update_example.event.changes = [
+        webhook_event_change_factory(field="resolution", removed="FIXED", added="OPEN")
+    ]
 
     callable_object = default.init(
         jira_project_key=context_update_example.jira.project,

tests/unit/test_bugzilla.py

@@ -84,13 +84,3 @@ def test_payload_changes_list(webhook_change_status_assignee):
         "status",
         "assignee",
     ]
-
-
-def test_payload_changes_list_in_routing_key(webhook_change_status_assignee):
-    webhook_change_status_assignee.event.changes = None
-    webhook_change_status_assignee.event.routing_key = "bug.modify:assigned_to,status"
-
-    assert webhook_change_status_assignee.event.changed_fields() == [
-        "assigned_to",
-        "status",
-    ]

tests/unit/test_runner.py

@@ -29,33 +29,33 @@ def test_bugzilla_object_is_always_fetched(
     )
     mocked_bugzilla.get_bug.return_value = fetched_bug
 
-    # when the runner executes a private bug
     execute_action(
         request=webhook_create_example,
         actions=actions_example,
         settings=settings,
     )
 
-    # then
     mocked_bugzilla.get_bug.assert_called_once_with(webhook_create_example.bug.id)
 
 
 def test_request_is_ignored_because_private(
-    webhook_create_private_example: BugzillaWebhookRequest,
+    webhook_create_example: BugzillaWebhookRequest,
     actions_example: Actions,
     settings: Settings,
     mocked_bugzilla,
 ):
-    bug = bug_factory(id=webhook_create_private_example.bug.id, is_private=True)
+    bug = bug_factory(id=webhook_create_example.bug.id, is_private=True)
+    webhook_create_example.bug = bug
     mocked_bugzilla.get_bug.return_value = bug
+
     with pytest.raises(IgnoreInvalidRequestError) as exc_info:
         execute_action(
-            request=webhook_create_private_example,
+            request=webhook_create_example,
             actions=actions_example,
             settings=settings,
         )
 
-    assert str(exc_info.value) == "private bugs are not valid for action 'devtest'"
+    assert str(exc_info.value) == "private bugs are not supported"
 
 
 def test_request_matched_whiteboard_with_dash(
@@ -83,27 +83,6 @@ def test_request_matched_whiteboard_with_dash(
     assert result_bug.id == bug.id
 
 
-def test_private_request_is_allowed(
-    webhook_create_private_example: BugzillaWebhookRequest,
-    settings: Settings,
-    actions_example,
-    mocked_bugzilla,
-):
-    bug = bug_factory(id=webhook_create_private_example.bug.id, is_private=True)
-    mocked_bugzilla.get_bug.return_value = bug
-
-    actions_example["devtest"].allow_private = True
-
-    result = execute_action(
-        request=webhook_create_private_example,
-        actions=actions_example,
-        settings=settings,
-    )
-
-    bug = BugzillaBug.parse_raw(result["bug"])
-    assert bug.id == 654321
-
-
 def test_added_comment_without_linked_issue_is_ignored(
     webhook_comment_example: BugzillaWebhookRequest,
     actions_example: Actions,