go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/milo/rpc/list_projects.go (about)

     1  // Copyright 2023 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package rpc
    16  
    17  import (
    18  	"context"
    19  	"encoding/base64"
    20  
    21  	"google.golang.org/protobuf/proto"
    22  
    23  	"go.chromium.org/luci/common/errors"
    24  	"go.chromium.org/luci/grpc/appstatus"
    25  	"go.chromium.org/luci/milo/internal/projectconfig"
    26  	milopb "go.chromium.org/luci/milo/proto/v1"
    27  )
    28  
    29  var listProjectsPageSize = PageSizeLimiter{
    30  	Max:     10000,
    31  	Default: 100,
    32  }
    33  
    34  // ListProjects implements milopb.MiloInternal service
    35  func (s *MiloInternalService) ListProjects(ctx context.Context, req *milopb.ListProjectsRequest) (_ *milopb.ListProjectsResponse, err error) {
    36  	// Validate request.
    37  	err = validateListProjectsRequest(req)
    38  	if err != nil {
    39  		return nil, appstatus.BadRequest(err)
    40  	}
    41  
    42  	// Validate and get page token.
    43  	pageToken, err := validateListProjectsPageToken(req)
    44  	if err != nil {
    45  		return nil, appstatus.BadRequest(err)
    46  	}
    47  
    48  	pageSize := int(listProjectsPageSize.Adjust(req.PageSize))
    49  
    50  	return s.listProjects(ctx, pageSize, pageToken)
    51  }
    52  
    53  func (s *MiloInternalService) listProjects(ctx context.Context, pageSize int, pageToken *milopb.ListProjectsPageToken) (_ *milopb.ListProjectsResponse, err error) {
    54  	res := &milopb.ListProjectsResponse{
    55  		Projects: make([]*milopb.ProjectListItem, 0, pageSize),
    56  	}
    57  
    58  	projects, err := projectconfig.GetVisibleProjects(ctx)
    59  	if err != nil {
    60  		return nil, errors.Annotate(err, "getting visible projects").Err()
    61  	}
    62  
    63  	pageStart := int(pageToken.GetNextProjectIndex())
    64  	pageEnd := pageStart + pageSize
    65  	if pageEnd > len(projects) {
    66  		pageEnd = len(projects)
    67  	}
    68  
    69  	for _, project := range projects[pageStart:pageEnd] {
    70  		res.Projects = append(res.Projects, &milopb.ProjectListItem{Id: project.ID, LogoUrl: project.LogoURL})
    71  	}
    72  
    73  	// If there are more projects, populate `res.NextPageToken`.
    74  	if len(projects) > pageEnd {
    75  		nextPageToken, err := serializeListProjectsPageToken(&milopb.ListProjectsPageToken{
    76  			NextProjectIndex: int32(pageEnd),
    77  		})
    78  		if err != nil {
    79  			return nil, err
    80  		}
    81  		res.NextPageToken = nextPageToken
    82  	}
    83  	return res, nil
    84  }
    85  
    86  func validateListProjectsRequest(req *milopb.ListProjectsRequest) error {
    87  	switch {
    88  	case req.PageSize < 0:
    89  		return errors.Reason("page_size can not be negative").Err()
    90  	default:
    91  		return nil
    92  	}
    93  }
    94  
    95  func validateListProjectsPageToken(req *milopb.ListProjectsRequest) (*milopb.ListProjectsPageToken, error) {
    96  	if req.PageToken == "" {
    97  		return nil, nil
    98  	}
    99  
   100  	token, err := parseListProjectsPageToken(req.PageToken)
   101  	if err != nil {
   102  		return nil, errors.Annotate(err, "unable to parse page_token").Err()
   103  	}
   104  
   105  	if token.NextProjectIndex < 0 {
   106  		return nil, errors.New("page_token index cannot be negative")
   107  	}
   108  
   109  	return token, nil
   110  }
   111  
   112  func parseListProjectsPageToken(tokenStr string) (token *milopb.ListProjectsPageToken, err error) {
   113  	bytes, err := base64.RawStdEncoding.DecodeString(tokenStr)
   114  	if err != nil {
   115  		return nil, err
   116  	}
   117  	token = &milopb.ListProjectsPageToken{}
   118  	err = proto.Unmarshal(bytes, token)
   119  	return
   120  }
   121  
   122  func serializeListProjectsPageToken(token *milopb.ListProjectsPageToken) (string, error) {
   123  	bytes, err := proto.Marshal(token)
   124  	return base64.RawStdEncoding.EncodeToString(bytes), err
   125  }