api/v3/frontend_servicer.py

# Copyright 2020 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

from __future__ import print_function
from __future__ import division
from __future__ import absolute_import

from api import resource_name_converters as rnc
from api.v3 import monorail_servicer
from api.v3.api_proto import frontend_pb2
from api.v3.api_proto import project_objects_pb2
from api.v3.api_proto import frontend_prpc_pb2
from businesslogic import work_env


class FrontendServicer(monorail_servicer.MonorailServicer):
  """Handle frontend specific API requests.
  Each API request is implemented with a method as defined in the
  .proto file. Each method does any request-specific validation, uses work_env
  to safely operate on business objects, and returns a response proto.
  """

  DESCRIPTION = frontend_prpc_pb2.FrontendServiceDescription

  @monorail_servicer.PRPCMethod
  def GatherProjectEnvironment(self, mc, request):
    # type: (MonorailContext, GatherProjectEnvironmentRequest) ->
    #     GatherProjectEnvironmentResponse
    """pRPC API method that implements GatherProjectEnvironment.

    Raises:
      InputException if the project resource name provided is invalid.
      NoSuchProjectException if the parent project is not found.
      PermissionException if user is not allowed to view this project.
    """

    project_id = rnc.IngestProjectName(mc.cnxn, request.parent, self.services)

    with work_env.WorkEnv(mc, self.services) as we:
      project = we.GetProject(project_id)
      project_config = we.GetProjectConfig(project_id)

    api_project = self.converter.ConvertProject(project)
    api_project_config = self.converter.ConvertProjectConfig(project_config)
    api_status_defs = self.converter.ConvertStatusDefs(
        project_config.well_known_statuses, project_id)
    api_label_defs = self.converter.ConvertLabelDefs(
        project_config.well_known_labels, project_id)
    api_component_defs = self.converter.ConvertComponentDefs(
        project_config.component_defs, project_id)
    api_field_defs = self.converter.ConvertFieldDefs(
        project_config.field_defs, project_id)
    api_approval_defs = self.converter.ConvertApprovalDefs(
        project_config.approval_defs, project_id)
    saved_queries = self.services.features.GetCannedQueriesByProjectID(
        mc.cnxn, project_id)
    api_sqs = self.converter.ConvertProjectSavedQueries(
        saved_queries, project_id)

    return frontend_pb2.GatherProjectEnvironmentResponse(
        project=api_project,
        project_config=api_project_config,
        statuses=api_status_defs,
        well_known_labels=api_label_defs,
        components=api_component_defs,
        fields=api_field_defs,
        approval_fields=api_approval_defs,
        saved_queries=api_sqs)

  @monorail_servicer.PRPCMethod
  def GatherProjectMembershipsForUser(self, mc, request):
    # type: (MonorailContext, GatherProjectMembershipsForUserRequest) ->
    #     GatherProjectMembershipsForUserResponse
    """pRPC API method that implements GatherProjectMembershipsForUser.

    Raises:
      NoSuchUserException if the user is not found.
      InputException if the user resource name is invalid.
    """

    user_id = rnc.IngestUserName(mc.cnxn, request.user, self.services)

    project_memberships = []

    with work_env.WorkEnv(mc, self.services) as we:
      owner, committer, contributor = we.GatherProjectMembershipsForUser(
          user_id)

    for project_id in owner:
      project_member = self.converter.CreateProjectMember(
          mc.cnxn, project_id, user_id, 'OWNER')
      project_memberships.append(project_member)

    for project_id in committer:
      project_member = self.converter.CreateProjectMember(
          mc.cnxn, project_id, user_id, 'COMMITTER')
      project_memberships.append(project_member)

    for project_id in contributor:
      project_member = self.converter.CreateProjectMember(
          mc.cnxn, project_id, user_id, 'CONTRIBUTOR')
      project_memberships.append(project_member)

    return frontend_pb2.GatherProjectMembershipsForUserResponse(
        project_memberships=project_memberships)