Comments are not included in payload if Asynchronous Webhooks are enabled

XMLWordPrintable

    • Type: Bug
    • Resolution: Fixed
    • Priority: Low
    • 10.3.9, 10.7.3, 11.0.0
    • Affects Version/s: 8.20.2, 8.20.5, 8.22.0, 10.3.5
    • Component/s: Webhooks
    • None
    • 8.2
    • 5
    • Severity 2 - Major
    • 3

      Summary

      Since Jira 8.19 Asynchronous Webhooks were introduced to alleviate potential performance problems (see JRASERVER-71557 for more details), but when they are enabled the JSON payload does not include historical comments for an issue.

      Expected Results

      The comments are included, similar to when the async webhooks are not enabled:

      "comment": {
        "comments": [
          {
            "self": "http://localhost:48205/j8205/rest/api/2/issue/10000/comment/10000",
            "id": "10000",
            "author": {
              "self": "http://localhost:48205/j8205/rest/api/2/user?username=admin",
              "name": "admin",
              "key": "JIRAUSER10000",
              "emailAddress": "admin@admin.com",
              "avatarUrls": {
                "48x48": "https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=48",
                "24x24": "https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=24",
                "16x16": "https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=16",
                "32x32": "https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=32"
              },
              "displayName": "Administrator",
              "active": true,
              "timeZone": "America/Sao_Paulo"
            },
            "body": "First comment!",
            "updateAuthor": {
              "self": "http://localhost:48205/j8205/rest/api/2/user?username=admin",
              "name": "admin",
              "key": "JIRAUSER10000",
              "emailAddress": "admin@admin.com",
              "avatarUrls": {
                "48x48": "https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=48",
                "24x24": "https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=24",
                "16x16": "https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=16",
                "32x32": "https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=32"
              },
              "displayName": "Administrator",
              "active": true,
              "timeZone": "America/Sao_Paulo"
            },
            "created": "2022-07-07T10:38:24.038-0300",
            "updated": "2022-07-07T10:38:24.038-0300"
          }
        ],
        "maxResults": 1,
        "total": 1,
        "startAt": 0
      },

      Current Results

      The comments array in the payload is empty:

            "comment": {
        "comments": [],
        "maxResults": 0,
        "total": 0,
        "startAt": 0
      },

      Work-around

      Disable the asynchronous webhooks (note that it could cause performance issues similar to JRASERVER-68174) and restart the instance, so changes can be applied, as per instructions below:

      1. Access the dark features page URL as a Jira administrator account (detailed instructions here: 
        <BASE_URL>/secure/admin/SiteDarkFeatures!default.jspa
      1. Disable the com.atlassian.jira.webhookEventsAsyncProcessing.enabled feature flag.
      2. Restart your Jira instance (or each node in case of DC) 

       The workaround doesn't work in Jira 10 as Webhooks work in async mode there by default, even without  com.atlassian.jira.webhookEventsAsyncProcessing.enabled dark feature enabled.

            Assignee:
            Tomasz Ziółkowski
            Reporter:
            Arthur Gonçalves (Inactive)
            Votes:
            6 Vote for this issue
            Watchers:
            9 Start watching this issue

              Created:
              Updated:
              Resolved: