milvus/internal/datacoord/compaction_policy_clustering_test.go
XuanYang-cn 1165a5300f
fix: [cp25]Use diskSegmentMaxSize for coll with sparse and dense vectors (#43195)
Previous code uses diskSegmentMaxSize if and only if all of the
collection's vector fields are indexed with DiskANN index.

When introducing sparse vectors, since sparse vector cannot be indexed
with DiskANN index, collections with both dense and sparse vectors will
use maxSize instead.

This PR changes the requirments of using diskSegmentMaxSize to all dense
vectors are indexed with DiskANN indexs, ignoring sparse vector fields.

See also: #43193
pr: #43194

---------

Signed-off-by: yangxuan <xuan.yang@zilliz.com>
2025-07-18 11:16:52 +08:00

462 lines
14 KiB
Go

// 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 datacoord
import (
"context"
"testing"
"time"
"github.com/cockroachdb/errors"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/suite"
"go.uber.org/atomic"
"github.com/milvus-io/milvus-proto/go-api/v2/commonpb"
"github.com/milvus-io/milvus-proto/go-api/v2/schemapb"
"github.com/milvus-io/milvus/internal/datacoord/allocator"
"github.com/milvus-io/milvus/internal/metastore/mocks"
"github.com/milvus-io/milvus/pkg/v2/common"
"github.com/milvus-io/milvus/pkg/v2/proto/datapb"
"github.com/milvus-io/milvus/pkg/v2/util/paramtable"
"github.com/milvus-io/milvus/pkg/v2/util/typeutil"
)
func TestClusteringCompactionPolicySuite(t *testing.T) {
suite.Run(t, new(ClusteringCompactionPolicySuite))
}
type ClusteringCompactionPolicySuite struct {
suite.Suite
mockAlloc *allocator.MockAllocator
mockTriggerManager *MockTriggerManager
handler *NMockHandler
mockPlanContext *MockCompactionPlanContext
catalog *mocks.DataCoordCatalog
meta *meta
clusteringCompactionPolicy *clusteringCompactionPolicy
}
func (s *ClusteringCompactionPolicySuite) SetupTest() {
catalog := mocks.NewDataCoordCatalog(s.T())
catalog.EXPECT().SavePartitionStatsInfo(mock.Anything, mock.Anything).Return(nil).Maybe()
catalog.EXPECT().ListPartitionStatsInfos(mock.Anything).Return(nil, nil).Maybe()
catalog.EXPECT().ListCompactionTask(mock.Anything).Return(nil, nil).Maybe()
catalog.EXPECT().SaveCompactionTask(mock.Anything, mock.Anything).Return(nil).Maybe()
catalog.EXPECT().ListIndexes(mock.Anything).Return(nil, nil).Maybe()
catalog.EXPECT().ListSegmentIndexes(mock.Anything).Return(nil, nil).Maybe()
s.catalog = catalog
compactionTaskMeta, _ := newCompactionTaskMeta(context.TODO(), s.catalog)
partitionStatsMeta, _ := newPartitionStatsMeta(context.TODO(), s.catalog)
indexMeta, _ := newIndexMeta(context.TODO(), s.catalog)
meta := &meta{
segments: NewSegmentsInfo(),
collections: typeutil.NewConcurrentMap[UniqueID, *collectionInfo](),
compactionTaskMeta: compactionTaskMeta,
partitionStatsMeta: partitionStatsMeta,
indexMeta: indexMeta,
}
s.meta = meta
mockAllocator := allocator.NewMockAllocator(s.T())
mockAllocator.EXPECT().AllocID(mock.Anything).Return(19530, nil).Maybe()
mockHandler := NewNMockHandler(s.T())
s.handler = mockHandler
s.clusteringCompactionPolicy = newClusteringCompactionPolicy(s.meta, mockAllocator, mockHandler)
}
func (s *ClusteringCompactionPolicySuite) TestEnable() {
// by default
s.False(s.clusteringCompactionPolicy.Enable())
// enable
enableAutoCompactionKey := paramtable.Get().DataCoordCfg.EnableAutoCompaction.Key
clusteringCompactionEnableKey := paramtable.Get().DataCoordCfg.ClusteringCompactionEnable.Key
clusteringCompactionAutoEnableKey := paramtable.Get().DataCoordCfg.ClusteringCompactionAutoEnable.Key
paramtable.Get().Save(enableAutoCompactionKey, "true")
paramtable.Get().Save(clusteringCompactionEnableKey, "true")
paramtable.Get().Save(clusteringCompactionAutoEnableKey, "true")
defer paramtable.Get().Reset(enableAutoCompactionKey)
defer paramtable.Get().Reset(clusteringCompactionEnableKey)
defer paramtable.Get().Reset(clusteringCompactionAutoEnableKey)
s.True(s.clusteringCompactionPolicy.Enable())
}
func (s *ClusteringCompactionPolicySuite) TestTriggerWithNoCollecitons() {
// trigger with no collections
events, err := s.clusteringCompactionPolicy.Trigger(context.Background())
s.NoError(err)
gotViews, ok := events[TriggerTypeClustering]
s.True(ok)
s.NotNil(gotViews)
s.Equal(0, len(gotViews))
}
func (s *ClusteringCompactionPolicySuite) TestTriggerWithCollections() {
// valid collection
s.meta.collections.Insert(1, &collectionInfo{
ID: 1,
Schema: newTestScalarClusteringKeySchema(),
})
// deleted collection
s.meta.collections.Insert(2, &collectionInfo{
ID: 2,
Schema: newTestScalarClusteringKeySchema(),
})
s.clusteringCompactionPolicy.meta = s.meta
s.handler.EXPECT().GetCollection(mock.Anything, mock.Anything).RunAndReturn(func(ctx context.Context, collectionID int64) (*collectionInfo, error) {
if collectionID == 2 {
return nil, errors.New("mock get collection fail error")
}
coll, exist := s.meta.collections.Get(collectionID)
if exist {
return coll, nil
}
return nil, nil
})
// trigger
events, err := s.clusteringCompactionPolicy.Trigger(context.Background())
s.NoError(err)
gotViews, ok := events[TriggerTypeClustering]
s.True(ok)
s.NotNil(gotViews)
s.Equal(0, len(gotViews))
}
func (s *ClusteringCompactionPolicySuite) TestCalculateClusteringCompactionConfig() {
testCases := []struct {
description string
coll *collectionInfo
view CompactionView
totalRows int64
maxSegmentRows int64
preferSegmentRows int64
err error
}{
{
description: "",
coll: &collectionInfo{
Schema: &schemapb.CollectionSchema{
Fields: []*schemapb.FieldSchema{
{
DataType: schemapb.DataType_Int64,
},
{
DataType: schemapb.DataType_FloatVector,
TypeParams: []*commonpb.KeyValuePair{
{Key: common.DimKey, Value: "128"},
},
},
},
},
},
view: &ClusteringSegmentsView{
segments: []*SegmentView{
{
NumOfRows: 1000,
},
},
},
totalRows: int64(1000),
maxSegmentRows: int64(2064888),
preferSegmentRows: int64(1651910),
err: nil,
},
}
for _, test := range testCases {
s.Run(test.description, func() {
expectedSegmentSize := getExpectedSegmentSize(s.meta, test.coll.ID, test.coll.Schema)
totalRows, maxSegmentRows, preferSegmentRows, err := calculateClusteringCompactionConfig(test.coll, test.view, expectedSegmentSize)
s.Equal(test.totalRows, totalRows)
s.Equal(test.maxSegmentRows, maxSegmentRows)
s.Equal(test.preferSegmentRows, preferSegmentRows)
s.Equal(test.err, err)
})
}
}
func (s *ClusteringCompactionPolicySuite) TestTriggerOneCollectionAbnormal() {
// mock error in handler.GetCollection
s.handler.EXPECT().GetCollection(mock.Anything, mock.Anything).Return(&collectionInfo{}, errors.New("mock Error")).Once()
views, triggerID, err := s.clusteringCompactionPolicy.triggerOneCollection(context.TODO(), 1, false)
s.Error(err)
s.Nil(views)
s.Equal(int64(0), triggerID)
// mock "collection not exist" in handler.GetCollection
s.handler.EXPECT().GetCollection(mock.Anything, mock.Anything).Return(nil, nil).Once()
views2, triggerID2, err2 := s.clusteringCompactionPolicy.triggerOneCollection(context.TODO(), 1, false)
s.NoError(err2)
s.Nil(views2)
s.Equal(int64(0), triggerID2)
}
func (s *ClusteringCompactionPolicySuite) TestTriggerOneCollectionNoClusteringKeySchema() {
ctx := context.Background()
coll := &collectionInfo{
ID: 100,
Schema: newTestSchema(),
}
s.handler.EXPECT().GetCollection(mock.Anything, mock.Anything).Return(coll, nil)
s.meta.compactionTaskMeta.SaveCompactionTask(ctx, &datapb.CompactionTask{
TriggerID: 1,
PlanID: 10,
CollectionID: 100,
State: datapb.CompactionTaskState_executing,
})
views, triggerID, err := s.clusteringCompactionPolicy.triggerOneCollection(context.TODO(), 100, false)
s.NoError(err)
s.Nil(views)
s.Equal(int64(0), triggerID)
}
func (s *ClusteringCompactionPolicySuite) TestTriggerOneCollectionCompacting() {
ctx := context.Background()
coll := &collectionInfo{
ID: 100,
Schema: newTestScalarClusteringKeySchema(),
}
s.handler.EXPECT().GetCollection(mock.Anything, mock.Anything).Return(coll, nil)
s.meta.compactionTaskMeta.SaveCompactionTask(ctx, &datapb.CompactionTask{
TriggerID: 1,
PlanID: 10,
CollectionID: 100,
State: datapb.CompactionTaskState_executing,
})
views3, triggerID3, err3 := s.clusteringCompactionPolicy.triggerOneCollection(context.TODO(), 100, false)
s.NoError(err3)
s.Nil(views3)
s.Equal(int64(1), triggerID3)
}
func (s *ClusteringCompactionPolicySuite) TestCollectionIsClusteringCompacting() {
ctx := context.Background()
s.Run("no collection is compacting", func() {
compacting, triggerID := s.clusteringCompactionPolicy.collectionIsClusteringCompacting(collID)
s.False(compacting)
s.Equal(int64(0), triggerID)
})
s.Run("collection is compacting, different state", func() {
tests := []struct {
state datapb.CompactionTaskState
isCompacting bool
triggerID int64
}{
{datapb.CompactionTaskState_pipelining, true, 1},
{datapb.CompactionTaskState_executing, true, 1},
{datapb.CompactionTaskState_completed, false, 1},
{datapb.CompactionTaskState_failed, false, 1},
{datapb.CompactionTaskState_timeout, false, 1},
{datapb.CompactionTaskState_analyzing, true, 1},
{datapb.CompactionTaskState_indexing, true, 1},
{datapb.CompactionTaskState_cleaned, false, 1},
{datapb.CompactionTaskState_meta_saved, true, 1},
}
for _, test := range tests {
s.Run(test.state.String(), func() {
collID := int64(19530)
compactionTaskMeta := newTestCompactionTaskMeta(s.T())
s.clusteringCompactionPolicy.meta = &meta{
compactionTaskMeta: compactionTaskMeta,
}
compactionTaskMeta.SaveCompactionTask(ctx, &datapb.CompactionTask{
TriggerID: 1,
PlanID: 10,
CollectionID: collID,
State: test.state,
})
compacting, triggerID := s.clusteringCompactionPolicy.collectionIsClusteringCompacting(collID)
s.Equal(test.isCompacting, compacting)
s.Equal(test.triggerID, triggerID)
})
}
})
}
func (s *ClusteringCompactionPolicySuite) TestTriggerOneCollectionNormal() {
paramtable.Get().Save(Params.DataCoordCfg.ClusteringCompactionNewDataSizeThreshold.Key, "0")
defer paramtable.Get().Reset(Params.DataCoordCfg.ClusteringCompactionNewDataSizeThreshold.Key)
testLabel := &CompactionGroupLabel{
CollectionID: 1,
PartitionID: 10,
Channel: "ch-1",
}
s.meta.collections.Insert(testLabel.CollectionID, &collectionInfo{
ID: testLabel.CollectionID,
Schema: newTestScalarClusteringKeySchema(),
})
segments := genSegmentsForMeta(testLabel)
for id, segment := range segments {
s.meta.segments.SetSegment(id, segment)
}
s.handler.EXPECT().GetCollection(mock.Anything, mock.Anything).RunAndReturn(func(ctx context.Context, collectionID int64) (*collectionInfo, error) {
coll, exist := s.meta.collections.Get(collectionID)
if exist {
return coll, nil
}
return nil, nil
})
// trigger
view, _, err := s.clusteringCompactionPolicy.triggerOneCollection(context.TODO(), 1, false)
s.Equal(1, len(view))
s.NoError(err)
s.Equal(testLabel, view[0].GetGroupLabel())
}
func (s *ClusteringCompactionPolicySuite) TestGetExpectedSegmentSize() {
}
func (s *ClusteringCompactionPolicySuite) TestTimeIntervalLogic() {
ctx := context.TODO()
collectionID := int64(100)
partitionID := int64(101)
channel := "ch1"
tests := []struct {
description string
partitionStats []*datapb.PartitionStatsInfo
currentVersion int64
segments []*SegmentInfo
succeed bool
}{
{"no partition stats and not enough new data", []*datapb.PartitionStatsInfo{}, emptyPartitionStatsVersion, []*SegmentInfo{}, false},
{"no partition stats and enough new data", []*datapb.PartitionStatsInfo{}, emptyPartitionStatsVersion, []*SegmentInfo{
{
size: *atomic.NewInt64(1024 * 1024 * 1024 * 10),
},
}, true},
{
"very recent partition stats and enough new data",
[]*datapb.PartitionStatsInfo{
{
CollectionID: collectionID,
PartitionID: partitionID,
VChannel: channel,
CommitTime: time.Now().Unix(),
Version: 100,
},
},
100,
[]*SegmentInfo{
{
size: *atomic.NewInt64(1024 * 1024 * 1024 * 10),
},
},
false,
},
{
"very old partition stats and not enough new data",
[]*datapb.PartitionStatsInfo{
{
CollectionID: collectionID,
PartitionID: partitionID,
VChannel: channel,
CommitTime: time.Unix(1704038400, 0).Unix(),
Version: 100,
},
},
100,
[]*SegmentInfo{
{
size: *atomic.NewInt64(1024),
},
},
true,
},
{
"partition stats and enough new data",
[]*datapb.PartitionStatsInfo{
{
CollectionID: collectionID,
PartitionID: partitionID,
VChannel: channel,
CommitTime: time.Now().Add(-3 * time.Hour).Unix(),
SegmentIDs: []int64{100000},
Version: 100,
},
},
100,
[]*SegmentInfo{
{
SegmentInfo: &datapb.SegmentInfo{ID: 9999},
size: *atomic.NewInt64(1024 * 1024 * 1024 * 10),
},
},
true,
},
{
"partition stats and not enough new data",
[]*datapb.PartitionStatsInfo{
{
CollectionID: collectionID,
PartitionID: partitionID,
VChannel: channel,
CommitTime: time.Now().Add(-3 * time.Hour).Unix(),
SegmentIDs: []int64{100000},
Version: 100,
},
},
100,
[]*SegmentInfo{
{
SegmentInfo: &datapb.SegmentInfo{ID: 9999},
size: *atomic.NewInt64(1024),
},
},
false,
},
}
for _, test := range tests {
s.Run(test.description, func() {
partitionStatsMeta, err := newPartitionStatsMeta(ctx, s.catalog)
s.NoError(err)
for _, partitionStats := range test.partitionStats {
partitionStatsMeta.SavePartitionStatsInfo(partitionStats)
}
if test.currentVersion != 0 {
partitionStatsMeta.partitionStatsInfos[channel][partitionID].currentVersion = test.currentVersion
}
meta := &meta{
partitionStatsMeta: partitionStatsMeta,
}
succeed, err := triggerClusteringCompactionPolicy(ctx, meta, collectionID, partitionID, channel, test.segments)
s.NoError(err)
s.Equal(test.succeed, succeed)
})
}
}