Add merr package to utilize milvus error

client/client_mock_test.go

@@ -271,6 +271,7 @@ const (
 	MDescribeIndex         ServiceMethod = 403
 	MGetIndexState         ServiceMethod = 404
 	MGetIndexBuildProgress ServiceMethod = 405
+	MAlterIndex            ServiceMethod = 406
 
 	MCreateCredential ServiceMethod = 500
 	MUpdateCredential ServiceMethod = 501
@@ -285,6 +286,7 @@ const (
 	MDelete        ServiceMethod = 605
 	MQuery         ServiceMethod = 606
 	MUpsert        ServiceMethod = 607
+	MSearchV2      ServiceMethod = 608
 
 	MManualCompaction            ServiceMethod = 700
 	MGetCompactionState          ServiceMethod = 701
@@ -1005,3 +1007,22 @@ func (m *MockServer) Upsert(ctx context.Context, req *milvuspb.UpsertRequest) (*
 	s, err := SuccessStatus()
 	return &milvuspb.MutationResult{Status: s}, err
 }
+
+func (m *MockServer) AlterIndex(ctx context.Context, req *milvuspb.AlterIndexRequest) (*commonpb.Status, error) {
+	f := m.GetInjection(MUpsert)
+	if f != nil {
+		r, err := f(ctx, req)
+		return r.(*commonpb.Status), err
+	}
+	return SuccessStatus()
+}
+
+func (m *MockServer) SearchV2(ctx context.Context, req *milvuspb.SearchRequestV2) (*milvuspb.SearchResults, error) {
+	f := m.GetInjection(MUpsert)
+	if f != nil {
+		r, err := f(ctx, req)
+		return r.(*milvuspb.SearchResults), err
+	}
+	status, err := SuccessStatus()
+	return &milvuspb.SearchResults{Status: status}, err
+}

common/common.go

@@ -2,5 +2,5 @@ package common
 
 const (
 	// SDKVersion const value for current version
-	SDKVersion = `v2.3.3`
+	SDKVersion = `v2.4.0-dev`
 )

go.mod

@@ -7,7 +7,7 @@ require (
 	github.com/go-faker/faker/v4 v4.1.0
 	github.com/golang/protobuf v1.5.2
 	github.com/grpc-ecosystem/go-grpc-middleware v1.3.0
-	github.com/milvus-io/milvus-proto/go-api/v2 v2.3.3
+	github.com/milvus-io/milvus-proto/go-api/v2 v2.3.4
 	github.com/stretchr/testify v1.8.1
 	github.com/tidwall/gjson v1.14.4
 	google.golang.org/grpc v1.48.0
@@ -20,6 +20,7 @@ require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/getsentry/sentry-go v0.12.0 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/klauspost/compress v1.16.7 // indirect
 	github.com/kr/pretty v0.3.0 // indirect
 	github.com/kr/text v0.2.0 // indirect
 	github.com/pkg/errors v0.9.1 // indirect

go.sum

@@ -133,6 +133,8 @@ github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI
 github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
 github.com/klauspost/compress v1.8.2/go.mod h1:RyIbtBH6LamlWaDj8nUwkbUhJ87Yi3uG0guNDohfE1A=
 github.com/klauspost/compress v1.9.7/go.mod h1:RyIbtBH6LamlWaDj8nUwkbUhJ87Yi3uG0guNDohfE1A=
+github.com/klauspost/compress v1.16.7 h1:2mk3MPGNzKyxErAw8YaohYh69+pa4sIQSC0fPGCFR9I=
+github.com/klauspost/compress v1.16.7/go.mod h1:ntbaceVETuRiXiv4DpjP66DpAtAGkEQskQzEyD//IeE=
 github.com/klauspost/cpuid v1.2.1/go.mod h1:Pj4uuM528wm8OyEC2QMXAi2YiTZ96dNQPGgoMS4s3ek=
 github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
 github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc=
@@ -161,6 +163,8 @@ github.com/milvus-io/milvus-proto/go-api/v2 v2.3.2 h1:tBcKiEUcX6i3MaFYvMJO1F7R6f
 github.com/milvus-io/milvus-proto/go-api/v2 v2.3.2/go.mod h1:1OIl0v5PQeNxIJhCvY+K55CBUOYDZevw9g9380u1Wek=
 github.com/milvus-io/milvus-proto/go-api/v2 v2.3.3 h1:j6Ru7Lq421Ukp+XH8I+ny7dsVF2rLDLLoWpuFgoDZLM=
 github.com/milvus-io/milvus-proto/go-api/v2 v2.3.3/go.mod h1:1OIl0v5PQeNxIJhCvY+K55CBUOYDZevw9g9380u1Wek=
+github.com/milvus-io/milvus-proto/go-api/v2 v2.3.4 h1:HtNGcUb52ojnl+zDAZMmbHyVaTdBjzuCnnBHpb675TU=
+github.com/milvus-io/milvus-proto/go-api/v2 v2.3.4/go.mod h1:1OIl0v5PQeNxIJhCvY+K55CBUOYDZevw9g9380u1Wek=
 github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
 github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
 github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=

merr/errors.go

@@ -0,0 +1,243 @@
+// Licensed to the LF AI & Data foundation under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package merr
+
+import (
+	"github.com/cockroachdb/errors"
+)
+
+const (
+	CanceledCode int32 = 10000
+	TimeoutCode  int32 = 10001
+)
+
+// Define leaf errors here,
+// WARN: take care to add new error,
+// check whehter you can use the erorrs below before adding a new one.
+// Name: Err + related prefix + error name
+var (
+	// Service related
+	ErrServiceNotReady             = newMilvusError("service not ready", 1, true) // This indicates the service is still in init
+	ErrServiceUnavailable          = newMilvusError("service unavailable", 2, true)
+	ErrServiceMemoryLimitExceeded  = newMilvusError("memory limit exceeded", 3, false)
+	ErrServiceRequestLimitExceeded = newMilvusError("request limit exceeded", 4, true)
+	ErrServiceInternal             = newMilvusError("service internal error", 5, false) // Never return this error out of Milvus
+	ErrServiceCrossClusterRouting  = newMilvusError("cross cluster routing", 6, false)
+	ErrServiceDiskLimitExceeded    = newMilvusError("disk limit exceeded", 7, false)
+	ErrServiceRateLimit            = newMilvusError("rate limit exceeded", 8, true)
+	ErrServiceForceDeny            = newMilvusError("force deny", 9, false)
+	ErrServiceUnimplemented        = newMilvusError("service unimplemented", 10, false)
+
+	// Collection related
+	ErrCollectionNotFound         = newMilvusError("collection not found", 100, false)
+	ErrCollectionNotLoaded        = newMilvusError("collection not loaded", 101, false)
+	ErrCollectionNumLimitExceeded = newMilvusError("exceeded the limit number of collections", 102, false)
+	ErrCollectionNotFullyLoaded   = newMilvusError("collection not fully loaded", 103, true)
+
+	// Partition related
+	ErrPartitionNotFound       = newMilvusError("partition not found", 200, false)
+	ErrPartitionNotLoaded      = newMilvusError("partition not loaded", 201, false)
+	ErrPartitionNotFullyLoaded = newMilvusError("partition not fully loaded", 202, true)
+
+	// ResourceGroup related
+	ErrResourceGroupNotFound = newMilvusError("resource group not found", 300, false)
+
+	// Replica related
+	ErrReplicaNotFound     = newMilvusError("replica not found", 400, false)
+	ErrReplicaNotAvailable = newMilvusError("replica not available", 401, false)
+
+	// Channel & Delegator related
+	ErrChannelNotFound     = newMilvusError("channel not found", 500, false)
+	ErrChannelLack         = newMilvusError("channel lacks", 501, false)
+	ErrChannelReduplicate  = newMilvusError("channel reduplicates", 502, false)
+	ErrChannelNotAvailable = newMilvusError("channel not available", 503, false)
+
+	// Segment related
+	ErrSegmentNotFound    = newMilvusError("segment not found", 600, false)
+	ErrSegmentNotLoaded   = newMilvusError("segment not loaded", 601, false)
+	ErrSegmentLack        = newMilvusError("segment lacks", 602, false)
+	ErrSegmentReduplicate = newMilvusError("segment reduplicates", 603, false)
+
+	// Index related
+	ErrIndexNotFound     = newMilvusError("index not found", 700, false)
+	ErrIndexNotSupported = newMilvusError("index type not supported", 701, false)
+	ErrIndexDuplicate    = newMilvusError("index duplicates", 702, false)
+
+	// Database related
+	ErrDatabaseNotFound         = newMilvusError("database not found", 800, false)
+	ErrDatabaseNumLimitExceeded = newMilvusError("exceeded the limit number of database", 801, false)
+	ErrDatabaseInvalidName      = newMilvusError("invalid database name", 802, false)
+
+	// Node related
+	ErrNodeNotFound     = newMilvusError("node not found", 901, false)
+	ErrNodeOffline      = newMilvusError("node offline", 902, false)
+	ErrNodeLack         = newMilvusError("node lacks", 903, false)
+	ErrNodeNotMatch     = newMilvusError("node not match", 904, false)
+	ErrNodeNotAvailable = newMilvusError("node not available", 905, false)
+
+	// IO related
+	ErrIoKeyNotFound = newMilvusError("key not found", 1000, false)
+	ErrIoFailed      = newMilvusError("IO failed", 1001, false)
+
+	// Parameter related
+	ErrParameterInvalid = newMilvusError("invalid parameter", 1100, false)
+
+	// Metrics related
+	ErrMetricNotFound = newMilvusError("metric not found", 1200, false)
+
+	// Message queue related
+	ErrMqTopicNotFound = newMilvusError("topic not found", 1300, false)
+	ErrMqTopicNotEmpty = newMilvusError("topic not empty", 1301, false)
+	ErrMqInternal      = newMilvusError("message queue internal error", 1302, false)
+	ErrDenyProduceMsg  = newMilvusError("deny to write the message to mq", 1303, false)
+
+	// Privilege related
+	// this operation is denied because the user not authorized, user need to login in first
+	ErrPrivilegeNotAuthenticated = newMilvusError("not authenticated", 1400, false)
+	// this operation is denied because the user has no permission to do this, user need higher privilege
+	ErrPrivilegeNotPermitted = newMilvusError("privilege not permitted", 1401, false)
+
+	// Alias related
+	ErrAliasNotFound               = newMilvusError("alias not found", 1600, false)
+	ErrAliasCollectionNameConfilct = newMilvusError("alias and collection name conflict", 1601, false)
+	ErrAliasAlreadyExist           = newMilvusError("alias already exist", 1602, false)
+
+	// field related
+	ErrFieldNotFound    = newMilvusError("field not found", 1700, false)
+	ErrFieldInvalidName = newMilvusError("field name invalid", 1701, false)
+
+	// high-level restful api related
+	ErrNeedAuthenticate          = newMilvusError("user hasn't authenticated", 1800, false)
+	ErrIncorrectParameterFormat  = newMilvusError("can only accept json format request", 1801, false)
+	ErrMissingRequiredParameters = newMilvusError("missing required parameters", 1802, false)
+	ErrMarshalCollectionSchema   = newMilvusError("fail to marshal collection schema", 1803, false)
+	ErrInvalidInsertData         = newMilvusError("fail to deal the insert data", 1804, false)
+	ErrInvalidSearchResult       = newMilvusError("fail to parse search result", 1805, false)
+	ErrCheckPrimaryKey           = newMilvusError("please check the primary key and its' type can only in [int, string]", 1806, false)
+
+	// replicate related
+	ErrDenyReplicateMessage = newMilvusError("deny to use the replicate message in the normal instance", 1900, false)
+	ErrInvalidMsgBytes      = newMilvusError("invalid replicate msg bytes", 1901, false)
+	ErrNoAssignSegmentID    = newMilvusError("no assign segment id", 1902, false)
+	ErrInvalidStreamObj     = newMilvusError("invalid stream object", 1903, false)
+
+	// Segcore related
+	ErrSegcore = newMilvusError("segcore error", 2000, false)
+
+	// Do NOT export this,
+	// never allow programmer using this, keep only for converting unknown error to milvusError
+	errUnexpected = newMilvusError("unexpected error", (1<<16)-1, false)
+
+	// import
+	ErrImportFailed = newMilvusError("importing data failed", 2100, false)
+)
+
+type milvusError struct {
+	msg       string
+	detail    string
+	retriable bool
+	errCode   int32
+}
+
+func newMilvusError(msg string, code int32, retriable bool) milvusError {
+	return milvusError{
+		msg:       msg,
+		detail:    msg,
+		retriable: retriable,
+		errCode:   code,
+	}
+}
+
+func newMilvusErrorWithDetail(msg string, detail string, code int32, retriable bool) milvusError {
+	return milvusError{
+		msg:       msg,
+		detail:    detail,
+		retriable: retriable,
+		errCode:   code,
+	}
+}
+
+func (e milvusError) code() int32 {
+	return e.errCode
+}
+
+func (e milvusError) Error() string {
+	return e.msg
+}
+
+func (e milvusError) Detail() string {
+	return e.detail
+}
+
+func (e milvusError) Is(err error) bool {
+	cause := errors.Cause(err)
+	if cause, ok := cause.(milvusError); ok {
+		return e.errCode == cause.errCode
+	}
+	return false
+}
+
+type multiErrors struct {
+	errs []error
+}
+
+func (e multiErrors) Unwrap() error {
+	if len(e.errs) <= 1 {
+		return nil
+	}
+	// To make merr work for multi errors,
+	// we need cause of multi errors, which defined as the last error
+	if len(e.errs) == 2 {
+		return e.errs[1]
+	}
+
+	return multiErrors{
+		errs: e.errs[1:],
+	}
+}
+
+func (e multiErrors) Error() string {
+	final := e.errs[0]
+	for i := 1; i < len(e.errs); i++ {
+		final = errors.Wrap(e.errs[i], final.Error())
+	}
+	return final.Error()
+}
+
+func (e multiErrors) Is(err error) bool {
+	for _, item := range e.errs {
+		if errors.Is(item, err) {
+			return true
+		}
+	}
+	return false
+}
+
+func Combine(errs ...error) error {
+	var filtered []error
+	for _, e := range errs {
+		if e != nil {
+			filtered = append(filtered, e)
+		}
+	}
+	if len(filtered) == 0 {
+		return nil
+	}
+	return multiErrors{
+		errs,
+	}
+}