Bug 2002639 - Need to add see_also links to Jira in the REST API if available and the request is coming from JBI

Author: dklawren

Bugzilla/WebService/Bug.pm

@@ -503,6 +503,9 @@ sub get {
     }
   }
 
+  Bugzilla::Hook::process('webservice_bug_get',
+    {webservice => $self, user => $user, params => $params, bug_data => \@hashes,});
+
   return {bugs => \@hashes, faults => \@faults};
 }
 

extensions/JiraWebhookSync/Extension.pm

@@ -136,18 +136,8 @@ sub webhook_before_send {
 
   INFO("Processing webhook for bug $bug_id to Jira host $hostname");
 
-  # Check if there's a Jira mapping for this bug
-  if (my $jira_map
-    = Bugzilla::Extension::JiraWebhookSync::JiraBugMap->get_by_bug_id($bug_id))
-  {
-    INFO('Adding Jira see_also to webhook payload: ' . $jira_map->jira_url);
-
-    # Add the Jira URL to the see_also array in the payload if not already present
-    $payload->{bug}->{see_also} ||= [];
-    if (none { $_ eq $jira_map->jira_url } @{$payload->{bug}->{see_also}}) {
-      push @{$payload->{bug}->{see_also}}, $jira_map->jira_url;
-    }
-  }
+  # Check if there's a Jira mapping for this bug and add to see also
+  $payload->{bug}->{see_also} = _populate_jira_see_also($bug_id, $payload->{bug}->{see_also});
 
   # Make copy of the current whiteboard value
   my $whiteboard = $payload->{bug}->{whiteboard};
@@ -167,6 +157,26 @@ sub webhook_before_send {
   $payload->{bug}->{whiteboard} = _add_whiteboard_tags($whiteboard, \@new_tags);
 }
 
+sub webservice_bug_get {
+  my ($self, $args) = @_;
+  my $bug_data = $args->{bug_data};
+  my $user     = $args->{user};
+  my $params   = Bugzilla->params;
+
+  # Only add see also values for the Jira webhook sync user
+  if (!$params->{jira_webhook_sync_user} || $user->login ne $params->{jira_webhook_sync_user}) {
+    INFO('Not the jira_webhook_sync_user so skipping see also population');
+    return;
+  }
+
+  INFO('Jira sync user is accessing REST get bug. Looking for see also values');
+
+  foreach my $bug (@{$bug_data}) {
+    INFO('Processing bug id ' . $bug->{id} . ' for Jira see also population');
+    $bug->{see_also} = _populate_jira_see_also($bug->{id}, $bug->{see_also});
+  }
+}
+
 # Adds a whiteboard tag to the whiteboard string if it doesn't already exist.
 # Returns the whiteboard value with the tag in [brackets] format.
 # If the tag already exists, returns the whiteboard unchanged.
@@ -203,4 +213,22 @@ sub _bug_matches_rule {
   return 0;
 }
 
+# Adds the Jira issue URL associated with the given Bugzilla bug ID to the see_also list,
+# ensuring no duplicates. Returns the updated list.
+sub _populate_jira_see_also {
+  my ($bug_id, $see_also_list) = @_;
+
+  $see_also_list ||= [];
+
+  if (my $jira_map
+    = Bugzilla::Extension::JiraWebhookSync::JiraBugMap->get_by_bug_id($bug_id))
+  {
+    INFO('Adding Jira see_also to webhook payload: ' . $jira_map->jira_url);
+    push @{$see_also_list}, $jira_map->jira_url
+      if none { $_ eq $jira_map->jira_url } @{$see_also_list};
+  }
+
+  return $see_also_list;
+}
+
 __PACKAGE__->NAME;

extensions/JiraWebhookSync/lib/Config.pm

@@ -21,6 +21,11 @@ sub get_param_list {
 
   my @params = (
     {name => 'jira_webhook_sync_hostname', type => 't', default => ''},
+    {
+      name    => 'jira_webhook_sync_user',
+      type    => 't',
+      default => '',
+    },
     {
       name    => 'jira_webhook_sync_config',
       type    => 'l',

extensions/JiraWebhookSync/t/bmo/jira_webhook_sync.t

@@ -31,6 +31,7 @@ set_parameters(
     },
     'Jira Webhook Sync' => {
       'jira_webhook_sync_hostname' => {type => 'text', value => 'externalapi.test'},
+      'jira_webhook_sync_user'     => {type => 'text', value => $config->{editbugs_user_login}},
       'jira_webhook_sync_config'   => {
         type  => 'text',
         value => '{"BZFF": {"product": "Firefox", "component": "General"}}'
@@ -139,6 +140,24 @@ $t->get_ok('http://externalapi.test:8001/webhooks/last_payload')
   ->json_is('/bug/whiteboard', '[BZFF]')
   ->json_is('/bug/see_also/0', $jira_url);
 
+# When using the REST API to get bug details, and the calling user
+# is the jira sync user, then we need to make sure the hidden see
+# also values are included in the response.
+$t->get_ok($config->{browser_url}
+    . "/rest/bug/$bug_id_1" =>
+    {'X-Bugzilla-API-Key' => $config->{editbugs_user_api_key}})
+  ->status_is(200)
+  ->json_is('/bugs/0/id',         $bug_id_1)
+  ->json_is('/bugs/0/see_also/0', $jira_url);
+
+# And make sure the see also values are not visible to other users
+$t->get_ok($config->{browser_url}
+    . "/rest/bug/$bug_id_1" =>
+    {'X-Bugzilla-API-Key' => $config->{admin_user_api_key}})
+  ->status_is(200)
+  ->json_is('/bugs/0/id', $bug_id_1)
+  ->json_hasnt('/bugs/0/see_also/0');
+
 # Turn off webhooks and jira sync.
 log_in($sel, $config, 'admin');
 set_parameters(

extensions/JiraWebhookSync/template/en/default/admin/params/jirawebhooksync.html.tmpl

@@ -37,6 +37,7 @@ JBI config files</a>.
 [%
   param_descs = {
     jira_webhook_sync_hostname => "Only add whiteboard tag if the Jira hostname matches. Leave this blank to disable this feature.",
+    jira_webhook_sync_user => "The Bugzilla account used by Jira Bugzilla Integration service.",
     jira_webhook_sync_config => jira_webhook_sync_config_desc,
     jira_webhook_sync_project_keys => 'List of Jira project keys for which see_also values should be stored in a mapping table instead of as regular see_also links.'
   }