feat(ticket): update ticket metadata on change of incident type (#5575)

Author: whitdog47

src/dispatch/incident/service.py

@@ -29,6 +29,7 @@
 from dispatch.project import service as project_service
 from dispatch.tag import service as tag_service
 from dispatch.term import service as term_service
+from dispatch.ticket import flows as ticket_flows
 
 from .enums import IncidentStatus
 from .models import Incident, IncidentCreate, IncidentRead, IncidentUpdate
@@ -384,6 +385,16 @@ def update(*, db_session: Session, incident: Incident, incident_in: IncidentUpda
         incident_cost_service.update_incident_response_cost(
             incident_id=incident.id, db_session=db_session
         )
+        # if the new incident type has plugin metadata and the
+        # project key of the ticket is the same, also update the ticket with the new metadata
+        if incident_type.plugin_metadata:
+            ticket_flows.update_incident_ticket_metadata(
+                db_session=db_session,
+                ticket_id=incident.ticket.resource_id,
+                project_id=incident.project.id,
+                incident_id=incident.id,
+                incident_type=incident_type,
+            )
 
     update_data = incident_in.dict(
         skip_defaults=True,

src/dispatch/plugins/dispatch_core/plugin.py

@@ -249,6 +249,14 @@ def create_case_ticket(
             "resource_type": "dispatch-internal-ticket",
         }
 
+    def update_metadata(
+        self,
+        ticket_id: str,
+        metadata: dict,
+    ):
+        """Updates the metadata of a Dispatch ticket."""
+        return
+
     def update_case_ticket(
         self,
         ticket_id: str,

src/dispatch/plugins/dispatch_jira/plugin.py

@@ -315,6 +315,7 @@ def create(
                 reporter = get_user_field(client, self.configuration, reporter_email)
 
             project_id, issue_type_name = process_plugin_metadata(incident_type_plugin_metadata)
+            other_fields = create_dict_from_plugin_metadata(incident_type_plugin_metadata)
 
             if not project_id:
                 project_id = self.configuration.default_project_id
@@ -335,6 +336,7 @@ def create(
                 "assignee": assignee,
                 "reporter": reporter,
                 "summary": title,
+                **other_fields,
             }
 
             ticket = create(self.configuration, client, issue_fields)
@@ -401,6 +403,31 @@ def update(
 
         return update(self.configuration, client, issue, issue_fields, status)
 
+    def update_metadata(
+        self,
+        ticket_id: str,
+        metadata: dict,
+    ):
+        """Updates the metadata of a Jira issue."""
+        client = create_client(self.configuration)
+        issue = client.issue(ticket_id)
+
+        # check to make sure project id matches metadata
+        project_id, issue_type_name = process_plugin_metadata(metadata)
+        if project_id and issue.fields.project.key != project_id:
+            log.warning(
+                f"Project key mismatch between Jira issue {issue.fields.project.key} and metadata {project_id} for ticket {ticket_id}"
+            )
+            return
+        other_fields = create_dict_from_plugin_metadata(metadata)
+        issue_fields = {
+            **other_fields,
+        }
+        if issue_type_name:
+            issue_fields["issuetype"] = {"name": issue_type_name}
+
+        issue.update(fields=issue_fields)
+
     def create_case_ticket(
         self,
         case_id: int,

src/dispatch/ticket/flows.py

@@ -9,6 +9,7 @@
 from dispatch.event import service as event_service
 from dispatch.incident import service as incident_service
 from dispatch.incident.models import Incident
+from dispatch.incident.type.models import IncidentType
 from dispatch.incident.type import service as incident_type_service
 from dispatch.participant import service as participant_service
 from dispatch.plugin import service as plugin_service
@@ -334,3 +335,38 @@ def create_task_ticket(task: Task, db_session: Session):
     db_session.commit()
 
     return external_ticket
+
+
+def update_incident_ticket_metadata(
+    db_session: Session,
+    ticket_id: str,
+    project_id: int,
+    incident_id: int,
+    incident_type: IncidentType,
+):
+    """
+    Updates the metadata of an incident ticket.
+    """
+    plugin = plugin_service.get_active_instance(
+        db_session=db_session, project_id=project_id, plugin_type="ticket"
+    )
+    if not plugin:
+        log.warning("Incident ticket metadata not updated. No ticket plugin enabled.")
+        return
+
+    # we update the external incident ticket
+    try:
+        plugin.instance.update_metadata(
+            ticket_id=ticket_id,
+            metadata=incident_type.get_meta(plugin.plugin.slug),
+        )
+    except Exception as e:
+        log.exception(e)
+        return
+
+    event_service.log_incident_event(
+        db_session=db_session,
+        source=plugin.plugin.title,
+        description="Incident ticket metadata updated",
+        incident_id=incident_id,
+    )