Design of dividing pkg/agent/handler/grpc interfaces

[kevindiu]

I have listed up all the functions, type definition, const and variables defined in the pkg/agent/ngt/handler/grpc/handler.go and designed the file to store each type of files.

Implementation

• handler.go
  Store common type/const/var/func definition.

type Server interface 
type server struct 

const (
	apiName         = "vald/agent/core/ngt"
	ngtResourceType = "vald/internal/core/algorithm"
)
var errNGT = new(errors.NGTError)

func New(opts ...Option) (Server, error) 
func (s *server) newLocations(uuids ...string) (locs *payload.Object_Locations) 
func (s *server) newLocation(uuid string) *payload.Object_Location

• search.go
  Store search related functions. (linear search is not included)

func (s *server) Search(ctx context.Context, req *payload.Search_Request) (res *payload.Search_Response, err error) 
func (s *server) SearchByID(ctx context.Context, req *payload.Search_IDRequest) (res *payload.Search_Response, err error) 
func toSearchResponse(dists []model.Distance, err error) (res *payload.Search_Response, rerr error) 
func (s *server) StreamSearch(stream vald.Search_StreamSearchServer) (err error) 
func (s *server) StreamSearchByID(stream vald.Search_StreamSearchByIDServer) (err error) 
func (s *server) MultiSearch(ctx context.Context, reqs *payload.Search_MultiRequest) (res *payload.Search_Responses, errs error) 
func (s *server) MultiSearchByID(ctx context.Context, reqs *payload.Search_MultiIDRequest) (res *payload.Search_Responses, errs error) 

• linearsearch.go
  Store linear search related functions.

func (s *server) LinearSearch(ctx context.Context, req *payload.Search_Request) (res *payload.Search_Response, err error) 
func (s *server) LinearSearchByID(ctx context.Context, req *payload.Search_IDRequest) (res *payload.Search_Response, err error) 
func (s *server) StreamLinearSearch(stream vald.Search_StreamLinearSearchServer) (err error) 
func (s *server) StreamLinearSearchByID(stream vald.Search_StreamLinearSearchByIDServer) (err error) 
func (s *server) MultiLinearSearch(ctx context.Context, reqs *payload.Search_MultiRequest) (res *payload.Search_Responses, errs error) 
func (s *server) MultiLinearSearchByID(ctx context.Context, reqs *payload.Search_MultiIDRequest) (res *payload.Search_Responses, errs error) 

• insert.go

func (s *server) Insert(ctx context.Context, req *payload.Insert_Request) (res *payload.Object_Location, err error) 
func (s *server) StreamInsert(stream vald.Insert_StreamInsertServer) (err error) 
func (s *server) MultiInsert(ctx context.Context, reqs *payload.Insert_MultiRequest) (res *payload.Object_Locations, err error) 

• update.go

func (s *server) Update(ctx context.Context, req *payload.Update_Request) (res *payload.Object_Location, err error) 
func (s *server) StreamUpdate(stream vald.Update_StreamUpdateServer) (err error) 
func (s *server) MultiUpdate(ctx context.Context, reqs *payload.Update_MultiRequest) (res *payload.Object_Locations, err error) 

• upsert.go

func (s *server) Upsert(ctx context.Context, req *payload.Upsert_Request) (loc *payload.Object_Location, err error) 
func (s *server) StreamUpsert(stream vald.Upsert_StreamUpsertServer) (err error) 
func (s *server) MultiUpsert(ctx context.Context, reqs *payload.Upsert_MultiRequest) (res *payload.Object_Locations, err error) 

• remove.go

func (s *server) Remove(ctx context.Context, req *payload.Remove_Request) (res *payload.Object_Location, err error) 
func (s *server) StreamRemove(stream vald.Remove_StreamRemoveServer) (err error) 
func (s *server) MultiRemove(ctx context.Context, reqs *payload.Remove_MultiRequest) (res *payload.Object_Locations, err error) 

• object.go
  Store object functions.

func (s *server) Exists(ctx context.Context, uid *payload.Object_ID) (res *payload.Object_ID, err error) 
func (s *server) GetObject(ctx context.Context, id *payload.Object_VectorRequest) (res *payload.Object_Vector, err error) 
func (s *server) StreamGetObject(stream vald.Object_StreamGetObjectServer) (err error) 

• index.go
  Store index related functions.

func (s *server) CreateIndex(ctx context.Context, c *payload.Control_CreateIndexRequest) (res *payload.Empty, err error) 
func (s *server) SaveIndex(ctx context.Context, _ *payload.Empty) (res *payload.Empty, err error) 
func (s *server) CreateAndSaveIndex(ctx context.Context, c *payload.Control_CreateIndexRequest) (res *payload.Empty, err error) 
func (s *server) IndexInfo(ctx context.Context, _ *payload.Empty) (res *payload.Info_Index_Count, err error) 

Test implementation

Also we will need to divide the corresponding test implementation in hanlder_test.go file with the same design above.

[vankichi]

LGTM

[vankichi]

#1690