Bug 1797620 - Create modular framework for adding use case specific s…

…earch endpoints to the BMO API

Bugzilla/Bug.pm

@@ -4469,6 +4469,172 @@ sub delta_ts_non_bot {
   return $self->{delta_ts_non_bot};
 }
 
+sub to_hash {
+  my ($self, $params) = @_;
+  my $user = Bugzilla->user;
+
+  my $hash = {
+    alias            => $self->alias,
+    id               => $self->bug_id,
+    is_confirmed     => $self->everconfirmed,
+    op_sys           => $self->op_sys,
+    platform         => $self->rep_platform,
+    priority         => $self->priority,
+    resolution       => $self->resolution,
+    severity         => $self->bug_severity,
+    status           => $self->bug_status,
+    summary          => $self->short_desc,
+    target_milestone => $self->target_milestone,
+    type             => $self->bug_type,
+    url              => $self->bug_file_loc,
+    version          => $self->version,
+    whiteboard       => $self->status_whiteboard,
+  };
+
+  if ($params->{assignee}) {
+    $hash->{assignee} = $self->assigned_to->to_hash;
+  }
+  if ($params->{blocks}) {
+    $hash->{blocks} =$self->blocked;
+  }
+  if ($params->{classification}) {
+    $hash->{classification} =$self->classification;
+  }
+  if ($params->{comments}) {
+    my @result;
+    my $comments =$self->comments(
+      {order => 'oldest_to_newest', after => $params->{new_since}});
+    foreach my $comment (@$comments) {
+      next if $comment->is_private && !$user->is_insider;
+      push @result, $comment->to_hash;
+    }
+    $hash->{comments} = \@result;
+  }
+  if ($params->{component}) {
+    $hash->{component} =$self->component;
+  }
+  if ($params->{cc}) {
+    $hash->{cc} = [map { $_->to_hash } @{$self->cc_users}];
+  }
+  if ($params->{creation_time}) {
+    $hash->{creation_time} =$self->creation_ts;
+  }
+  if ($params->{creator}) {
+    $hash->{creator} = $self->reporter->to_hash;
+  }
+  if ($params->{depends_on}) {
+    $hash->{depends_on} =$self->dependson;
+  }
+  if ($params->{description}) {
+    my $comment = Bugzilla::Comment->match({bug_id =>$self->id, LIMIT => 1})->[0];
+    $hash->{description}
+      = ($comment && (!$comment->is_private || Bugzilla->user->is_insider))
+      ? $comment->body
+      : '';
+  }
+  if ($params->{dupe_of}) {
+    $hash->{dupe_of} =$self->dup_id;
+  }
+  if ($params->{duplicates}) {
+    $hash->{duplicates} =$self->duplicates;
+  }
+  if ($params->{groups}) {
+    my @groups;
+    foreach my $group (@{$self->groups_in}) {
+      next if !$user->in_group($group);
+      push @groups, $group->to_hash;
+    }
+    $hash->{groups} = \@groups;
+  }
+  if ($params->{is_open}) {
+    $hash->{is_open} =$self->status->is_open ? 1 : 0;
+  }
+  if ($params->{keywords}) {
+    $hash->{keywords} = [map { $_->name } @{$self->keyword_objects}];
+  }
+  if ($params->{last_change_time}) {
+    $hash->{last_change_time} =$self->delta_ts;
+  }
+  if ($params->{last_change_time_non_bot}) {
+    $hash->{last_change_time_non_bot} =$self->delta_ts_non_bot;
+  }
+  if ($params->{product}) {
+    $hash->{product} =$self->product;
+  }
+  if ($params->{qa_contact}) {
+    if ($self->qa_contact) {
+      $hash->{qa_contact} = $self->qa_contact->to_hash;
+    }
+  }
+  if ($params->{triage_owner}) {
+    my $triage_owner =$self->component_obj->triage_owner;
+    if ($triage_owner->login) {
+      $hash->{triage_owner} = $triage_owner->to_hash;
+    }
+  }
+  if ($params->{see_also}) {
+    $hash->{see_also} = [map { $_->name } @{$self->see_also}];
+  }
+  if ($params->{flags}) {
+    $hash->{flags} = [map { $_->to_hash } @{$self->flags}];
+  }
+
+  # Regressions
+  if (Bugzilla->params->{use_regression_fields}) {
+    if ($params->{regressed_by}) {
+      $hash->{regressed_by} =$self->regressed_by;
+    }
+    if ($params->{regressions}) {
+      $hash->{regressions} =$self->regresses;
+    }
+  }
+
+  # Custom fields
+  my @custom_fields = Bugzilla->active_custom_fields(
+    {
+      product   =>$self->product_obj,
+      component =>$self->component_obj,
+      bug_id    =>$self->id
+    },
+  );
+  foreach my $field (@custom_fields) {
+    my $name = $field->name;
+    next if !$params->{$name};
+    $hash->{$name} =$self->$name;
+  }
+
+  # Timetracking fields
+  if ($user->is_timetracker) {
+    if ($params->{estimated_time}) {
+      $hash->{estimated_time} =$self->estimated_time;
+    }
+    if ($params->{remaining_time}) {
+      $hash->{remaining_time} =$self->remaining_time;
+    }
+    if ($params->{deadline}) {
+      $hash->{deadline} =$self->deadline;
+    }
+    if ($params->{actual_time}) {
+      $hash->{actual_time} =$self->actual_time;
+    }
+  }
+
+  # Bug accessibility
+  if ($params->{is_cc_accessible}) {
+    $hash->{is_cc_accessible} =$self->cclist_accessible ? 1 : 0;
+  }
+  if ($params->{is_creator_accessible}) {
+    $hash->{is_creator_accessible} =$self->reporter_accessible ? 1 : 0;
+  }
+
+  # Bug mentors
+  if ($params->{mentors}) {
+    $hash->{mentors} = [map { $_->to_hash } @{$self->mentors}];
+  }
+
+  return $hash;
+}
+
 #####################################################################
 # Subroutines
 #####################################################################

Bugzilla/Comment.pm

@@ -298,6 +298,29 @@ sub body_full {
   return $body;
 }
 
+sub to_hash {
+  my $self = shift;
+
+  my $attach_id = $self->is_about_attachment ? $self->extra_data : undef;
+
+  my $hash = {
+    id            => $self->id,
+    bug_id        => $self->bug_id,
+    creator       => $self->author->to_hash,
+    creation_time => $self->creation_ts,
+    is_private    => $self->is_private,
+    text          => $self->body_full,
+    attachment_id => $attach_id,
+  };
+
+  # Don't load comment tags unless enabled
+  if (Bugzilla->params->{'comment_taggers_group'}) {
+    $hash->{tags} = $self->tags;
+  }
+
+  return $hash;
+}
+
 ############
 # Mutators #
 ############

Bugzilla/Flag.pm

@@ -219,6 +219,26 @@ sub bug {
   return $self->{'bug'} ||= new Bugzilla::Bug({id => $self->bug_id, cache => 1});
 }
 
+sub to_hash {
+  my $self = shift;
+
+  my $hash = {
+    id                => $self->id,
+    name              => $self->name,
+    type_id           => $self->type_id,
+    creation_date     => $self->creation_date,
+    modification_date => $self->modification_date,
+    status            => $self->status
+  };
+
+  foreach my $field (qw(setter requestee)) {
+    my $field_id = $field . "_id";
+    $hash->{$field} = $self->$field->to_hash if $self->$field_id;
+  }
+
+  return $hash;
+}
+
 ################################
 ## Searching/Retrieving Flags ##
 ################################

Bugzilla/Group.pm

@@ -217,6 +217,19 @@ sub owner {
   return $self->{owner} || undef;
 }
 
+sub to_hash {
+  my $self = shift;
+
+  my $hash = {
+    id          => $self->id,
+    name        => $self->name,
+    description => $self->description,
+    is_active   => $self->is_active,
+  };
+
+  return $hash;
+}
+
 ###############################
 ####        Methods        ####
 ###############################

Bugzilla/User.pm

@@ -2762,6 +2762,23 @@ sub set_bounce_count {
   $self->{bounce_count} = $count;
 }
 
+sub to_hash {
+  my $self = shift;
+
+  my $hash = {
+    id => $self->id,
+    real_name => $self->name,
+    nick => $self->nick
+  };
+
+  # Only include if current user is logged in
+  if (Bugzilla->user->id) {
+    $hash->{name}  = $self->login;
+    $hash->{email} = $self->email;
+  }
+
+  return $hash;
+}
 
 ###############
 # Subroutines #

Dockerfile

@@ -1,4 +1,4 @@
-FROM mozillabteam/bmo-perl-slim:20230512.1
+FROM mozillabteam/bmo-perl-slim:20230613.1
 
 ENV DEBIAN_FRONTEND noninteractive
 

cpanfile

@@ -99,6 +99,7 @@ requires 'Pod::Coverage::TrustPod';
 requires 'Regexp::Common';
 requires 'Role::Tiny', '2.000003';
 requires 'SOAP::Lite', '0.712';
+requires 'SQL::Tokenizer';
 requires 'Scope::Guard', '0.21';
 requires 'Sereal', '4.004';
 requires 'Sub::Quote', '2.005000';