milvus/internal/datanode/flow_graph_insert_buffer_node_test.go

// Copyright (C) 2019-2020 Zilliz. All rights reserved.
//
// Licensed 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 datanode

import (
	"context"
	"fmt"
	"math"
	"path"
	"sync"
	"testing"
	"time"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"go.uber.org/zap"

	memkv "github.com/milvus-io/milvus/internal/kv/mem"
	"github.com/milvus-io/milvus/internal/log"
	"github.com/milvus-io/milvus/internal/msgstream"
	"github.com/milvus-io/milvus/internal/proto/commonpb"
	"github.com/milvus-io/milvus/internal/proto/datapb"
	"github.com/milvus-io/milvus/internal/proto/etcdpb"
	"github.com/milvus-io/milvus/internal/proto/internalpb"
	"github.com/milvus-io/milvus/internal/proto/schemapb"
	"github.com/milvus-io/milvus/internal/storage"
	"github.com/milvus-io/milvus/internal/util/flowgraph"
)

func TestFlowGraphInsertBufferNode_Operate(t *testing.T) {
	ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
	defer cancel()

	insertChannelName := "datanode-01-test-flowgraphinsertbuffernode-operate"

	testPath := "/test/datanode/root/meta"
	err := clearEtcd(testPath)
	require.NoError(t, err)
	Params.MetaRootPath = testPath

	Factory := &MetaFactory{}
	collMeta := Factory.CollectionMetaFactory(UniqueID(0), "coll1")
	mockRootCoord := &RootCoordFactory{}

	replica := newReplica(mockRootCoord, collMeta.ID)

	err = replica.addNewSegment(1, collMeta.ID, 0, insertChannelName, &internalpb.MsgPosition{}, &internalpb.MsgPosition{})
	require.NoError(t, err)

	msFactory := msgstream.NewPmsFactory()
	m := map[string]interface{}{
		"receiveBufSize": 1024,
		"pulsarAddress":  Params.PulsarAddress,
		"pulsarBufSize":  1024}
	err = msFactory.SetParams(m)
	assert.Nil(t, err)

	saveBinlog := func(fu *segmentFlushUnit) error {
		t.Log(fu)
		return nil
	}

	flushChan := make(chan *flushMsg, 100)
	iBNode := newInsertBufferNode(ctx, replica, msFactory, NewAllocatorFactory(), flushChan, saveBinlog, "string")

	dmlFlushedCh := make(chan []*datapb.ID2PathList, 1)

	flushChan <- &flushMsg{
		msgID:        1,
		timestamp:    2000,
		segmentID:    UniqueID(1),
		collectionID: UniqueID(1),
		dmlFlushedCh: dmlFlushedCh,
	}

	inMsg := genInsertMsg(insertChannelName)
	var iMsg flowgraph.Msg = &inMsg
	iBNode.Operate([]flowgraph.Msg{iMsg})
	isflushed := <-dmlFlushedCh
	assert.NotNil(t, isflushed)
	log.Debug("DML binlog paths", zap.Any("paths", isflushed))
}

func genInsertMsg(insertChannelName string) insertMsg {

	timeRange := TimeRange{
		timestampMin: 0,
		timestampMax: math.MaxUint64,
	}

	startPos := []*internalpb.MsgPosition{
		{
			ChannelName: insertChannelName,
			MsgID:       make([]byte, 0),
			Timestamp:   0,
		},
	}

	var iMsg = &insertMsg{
		insertMessages: make([]*msgstream.InsertMsg, 0),
		timeRange: TimeRange{
			timestampMin: timeRange.timestampMin,
			timestampMax: timeRange.timestampMax,
		},
		startPositions: startPos,
		endPositions:   startPos,
	}

	dataFactory := NewDataFactory()
	iMsg.insertMessages = append(iMsg.insertMessages, dataFactory.GetMsgStreamInsertMsgs(2)...)

	return *iMsg

}

func TestFlushSegment(t *testing.T) {
	ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
	defer cancel()
	idAllocMock := NewAllocatorFactory(1)
	mockMinIO := memkv.NewMemoryKV()
	insertChannelName := "datanode-02-test-flushsegment"

	segmentID, _ := idAllocMock.allocID()
	partitionID, _ := idAllocMock.allocID()
	collectionID, _ := idAllocMock.allocID()
	fmt.Printf("generate segmentID, partitionID, collectionID: %v, %v, %v\n",
		segmentID, partitionID, collectionID)

	collMeta := genCollectionMeta(collectionID, "test_flush_segment_txn")
	flushMap := sync.Map{}
	mockRootCoord := &RootCoordFactory{}

	replica := newReplica(mockRootCoord, collMeta.ID)

	err := replica.addNewSegment(segmentID, collMeta.ID, 0, insertChannelName, &internalpb.MsgPosition{}, &internalpb.MsgPosition{})
	require.NoError(t, err)
	replica.updateSegmentEndPosition(segmentID, &internalpb.MsgPosition{ChannelName: "TestChannel"})

	finishCh := make(chan segmentFlushUnit, 1)

	insertData := &InsertData{
		Data: make(map[storage.FieldID]storage.FieldData),
	}
	insertData.Data[0] = &storage.Int64FieldData{
		NumRows: 10,
		Data:    []int64{0, 1, 2, 3, 4, 5, 6, 7, 8, 9},
	}
	insertData.Data[1] = &storage.Int64FieldData{
		NumRows: 10,
		Data:    []int64{1, 2, 3, 4, 5, 6, 7, 8, 9, 10},
	}
	insertData.Data[107] = &storage.FloatFieldData{
		NumRows: 10,
		Data:    make([]float32, 10),
	}
	flushMap.Store(segmentID, insertData)

	msFactory := msgstream.NewPmsFactory()
	m := map[string]interface{}{
		"receiveBufSize": 1024,
		"pulsarAddress":  Params.PulsarAddress,
		"pulsarBufSize":  1024}
	err = msFactory.SetParams(m)
	assert.Nil(t, err)
	flushChan := make(chan *flushMsg, 100)
	saveBinlog := func(*segmentFlushUnit) error {
		return nil
	}
	ibNode := newInsertBufferNode(ctx, replica, msFactory, NewAllocatorFactory(), flushChan, saveBinlog, "string")

	flushSegment(collMeta,
		segmentID,
		partitionID,
		collectionID,
		&flushMap,
		mockMinIO,
		finishCh,
		nil,
		ibNode,
		idAllocMock)

	fu := <-finishCh
	assert.NotNil(t, fu.field2Path)
	assert.Equal(t, fu.segID, segmentID)

	k, _ := idAllocMock.genKey(false, collectionID, partitionID, segmentID, 0)
	key := path.Join(Params.StatsBinlogRootPath, k)
	_, values, _ := mockMinIO.LoadWithPrefix(key)
	assert.Equal(t, len(values), 1)
	assert.Equal(t, values[0], `{"max":9,"min":0}`)
}

func genCollectionMeta(collectionID UniqueID, collectionName string) *etcdpb.CollectionMeta {
	sch := schemapb.CollectionSchema{
		Name:        collectionName,
		Description: "test collection by meta factory",
		AutoID:      true,
		Fields: []*schemapb.FieldSchema{
			{
				FieldID:     0,
				Name:        "RowID",
				Description: "RowID field",
				DataType:    schemapb.DataType_Int64,
				TypeParams: []*commonpb.KeyValuePair{
					{
						Key:   "f0_tk1",
						Value: "f0_tv1",
					},
				},
			},
			{
				FieldID:     1,
				Name:        "Timestamp",
				Description: "Timestamp field",
				DataType:    schemapb.DataType_Int64,
				TypeParams: []*commonpb.KeyValuePair{
					{
						Key:   "f1_tk1",
						Value: "f1_tv1",
					},
				},
			},
			{
				FieldID:     107,
				Name:        "float32_field",
				Description: "field 107",
				DataType:    schemapb.DataType_Float,
				TypeParams:  []*commonpb.KeyValuePair{},
				IndexParams: []*commonpb.KeyValuePair{},
			},
		},
	}

	collection := etcdpb.CollectionMeta{
		ID:           collectionID,
		Schema:       &sch,
		CreateTime:   Timestamp(1),
		SegmentIDs:   make([]UniqueID, 0),
		PartitionIDs: []UniqueID{0},
	}
	return &collection
}

func TestFlowGraphInsertBufferNode_AutoFlush(t *testing.T) {
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
	defer cancel()

	testPath := "/test/datanode/root/meta"
	err := clearEtcd(testPath)
	require.NoError(t, err)
	Params.MetaRootPath = testPath

	Factory := &MetaFactory{}
	collMeta := Factory.CollectionMetaFactory(UniqueID(0), "coll1")
	dataFactory := NewDataFactory()

	mockRootCoord := &RootCoordFactory{}

	colRep := &SegmentReplica{
		collectionID:    collMeta.ID,
		newSegments:     make(map[UniqueID]*Segment),
		normalSegments:  make(map[UniqueID]*Segment),
		flushedSegments: make(map[UniqueID]*Segment),
	}

	colRep.metaService = newMetaService(mockRootCoord, collMeta.ID)

	msFactory := msgstream.NewPmsFactory()
	m := map[string]interface{}{
		"receiveBufSize": 1024,
		"pulsarAddress":  Params.PulsarAddress,
		"pulsarBufSize":  1024}
	err = msFactory.SetParams(m)
	assert.Nil(t, err)

	flushUnit := []segmentFlushUnit{}
	saveBinlog := func(fu *segmentFlushUnit) error {
		flushUnit = append(flushUnit, *fu)
		return nil
	}

	flushChan := make(chan *flushMsg, 100)
	iBNode := newInsertBufferNode(ctx, colRep, msFactory, NewAllocatorFactory(), flushChan, saveBinlog, "string")

	// Auto flush number of rows set to 2

	inMsg := genInsertMsg("datanode-03-test-autoflush")
	inMsg.insertMessages = dataFactory.GetMsgStreamInsertMsgs(2)
	var iMsg flowgraph.Msg = &inMsg

	t.Run("Pure auto flush", func(t *testing.T) {
		iBNode.insertBuffer.maxSize = 2

		for i := range inMsg.insertMessages {
			inMsg.insertMessages[i].SegmentID = int64(i%2) + 1
		}
		inMsg.startPositions = []*internalpb.MsgPosition{{Timestamp: 100}}
		inMsg.endPositions = []*internalpb.MsgPosition{{Timestamp: 123}}

		type Test struct {
			expectedSegID       UniqueID
			expectedNumOfRows   int64
			expectedStartPosTs  Timestamp
			expectedEndPosTs    Timestamp
			expectedCpNumOfRows int64
			expectedCpPosTs     Timestamp
		}

		beforeAutoFlushTests := []Test{
			// segID, numOfRow, startTs, endTs, cp.numOfRow, cp.Ts
			{1, 1, 100, 123, 0, 100},
			{2, 1, 100, 123, 0, 100},
		}

		iBNode.Operate([]flowgraph.Msg{iMsg})
		require.Equal(t, 2, len(colRep.newSegments))
		require.Equal(t, 0, len(colRep.normalSegments))
		assert.Equal(t, 0, len(flushUnit))

		for i, test := range beforeAutoFlushTests {
			seg, ok := colRep.newSegments[UniqueID(i+1)]
			assert.True(t, ok)
			assert.Equal(t, test.expectedSegID, seg.segmentID)
			assert.Equal(t, test.expectedNumOfRows, seg.numRows)
			assert.Equal(t, test.expectedStartPosTs, seg.startPos.GetTimestamp())
			assert.Equal(t, test.expectedCpNumOfRows, seg.checkPoint.numRows)
			assert.Equal(t, test.expectedCpPosTs, seg.checkPoint.pos.GetTimestamp())
		}

		for i := range inMsg.insertMessages {
			inMsg.insertMessages[i].SegmentID = int64(i%2) + 2
		}
		inMsg.startPositions = []*internalpb.MsgPosition{{Timestamp: 200}}
		inMsg.endPositions = []*internalpb.MsgPosition{{Timestamp: 234}}
		iMsg = &inMsg

		// Triger auto flush
		iBNode.Operate([]flowgraph.Msg{iMsg})
		require.Equal(t, 0, len(colRep.newSegments))
		require.Equal(t, 3, len(colRep.normalSegments))

		assert.Equal(t, 1, len(flushUnit))
		assert.Equal(t, 3, len(flushUnit[0].checkPoint))
		assert.Less(t, 0, len(flushUnit[0].field2Path))
		assert.False(t, flushUnit[0].flushed)

		afterAutoFlushTests := []Test{
			// segID, numOfRow, startTs, endTs, cp.numOfRow, cp.Ts
			{1, 1, 100, 123, 0, 100},
			{2, 2, 100, 234, 2, 234},
			{3, 1, 200, 234, 0, 200},
		}

		for i, test := range afterAutoFlushTests {
			seg, ok := colRep.normalSegments[UniqueID(i+1)]
			assert.True(t, ok)
			assert.Equal(t, test.expectedSegID, seg.segmentID)
			assert.Equal(t, test.expectedNumOfRows, seg.numRows)
			assert.Equal(t, test.expectedStartPosTs, seg.startPos.GetTimestamp())
			assert.Equal(t, test.expectedCpNumOfRows, seg.checkPoint.numRows)
			assert.Equal(t, test.expectedCpPosTs, seg.checkPoint.pos.GetTimestamp())

			assert.Equal(t, test.expectedCpNumOfRows, flushUnit[0].checkPoint[UniqueID(i+1)].numRows)
			assert.Equal(t, test.expectedCpPosTs, flushUnit[0].checkPoint[UniqueID(i+1)].pos.Timestamp)

			if i == 1 {
				assert.Equal(t, test.expectedSegID, flushUnit[0].segID)
				assert.Equal(t, int32(0), iBNode.insertBuffer.size(UniqueID(i+1)))
			} else {
				assert.Equal(t, int32(1), iBNode.insertBuffer.size(UniqueID(i+1)))
			}
		}

	})

	t.Run("Auto with manul flush", func(t *testing.T) {
		t.Skipf("Skip, fix later")
		for i := range inMsg.insertMessages {
			inMsg.insertMessages[i].SegmentID = 1
		}

		inMsg.startPositions = []*internalpb.MsgPosition{{Timestamp: 234}}
		inMsg.endPositions = []*internalpb.MsgPosition{{Timestamp: 345}}
		iBNode.Operate([]flowgraph.Msg{iMsg})
		assert.Equal(t, len(iBNode.segmentCheckPoints), 3)
		assert.Equal(t, iBNode.segmentCheckPoints[1].numRows, int64(50+16000+100+32000))
		assert.Equal(t, iBNode.segmentCheckPoints[2].numRows, int64(100+32000))
		assert.Equal(t, iBNode.segmentCheckPoints[3].numRows, int64(0))
		assert.Equal(t, iBNode.segmentCheckPoints[1].pos.Timestamp, Timestamp(345))
		assert.Equal(t, iBNode.segmentCheckPoints[2].pos.Timestamp, Timestamp(234))
		assert.Equal(t, iBNode.segmentCheckPoints[3].pos.Timestamp, Timestamp(123))

		assert.Equal(t, len(flushUnit), 2)
		assert.Equal(t, flushUnit[1].segID, int64(1))
		assert.Equal(t, len(flushUnit[1].checkPoint), 3)
		assert.Equal(t, flushUnit[1].checkPoint[1].numRows, int64(50+16000+100+32000))
		assert.Equal(t, flushUnit[1].checkPoint[2].numRows, int64(100+32000))
		assert.Equal(t, flushUnit[1].checkPoint[3].numRows, int64(0))
		assert.Equal(t, flushUnit[1].checkPoint[1].pos.Timestamp, Timestamp(345))
		assert.Equal(t, flushUnit[1].checkPoint[2].pos.Timestamp, Timestamp(234))
		assert.Equal(t, flushUnit[1].checkPoint[3].pos.Timestamp, Timestamp(123))
		assert.False(t, flushUnit[1].flushed)
		assert.Greater(t, len(flushUnit[1].field2Path), 0)
		assert.Equal(t, len(iBNode.insertBuffer.insertData), 1)
		assert.Equal(t, iBNode.insertBuffer.size(3), int32(50+16000))

		dmlFlushedCh := make(chan []*datapb.ID2PathList, 1)

		flushChan <- &flushMsg{
			msgID:        3,
			timestamp:    456,
			segmentID:    UniqueID(1),
			collectionID: UniqueID(1),
			dmlFlushedCh: dmlFlushedCh,
		}

		inMsg.insertMessages = []*msgstream.InsertMsg{}
		inMsg.endPositions = []*internalpb.MsgPosition{{Timestamp: 345}}
		inMsg.endPositions = []*internalpb.MsgPosition{{Timestamp: 456}}
		iBNode.Operate([]flowgraph.Msg{iMsg})

		flushSeg := <-dmlFlushedCh
		assert.NotNil(t, flushSeg)
		assert.Equal(t, len(flushSeg), 1)
		assert.Equal(t, flushSeg[0].ID, int64(1))
		assert.NotNil(t, flushSeg[0].Paths)
		assert.Equal(t, len(iBNode.segmentCheckPoints), 2)
		assert.Equal(t, iBNode.segmentCheckPoints[2].numRows, int64(100+32000))
		assert.Equal(t, iBNode.segmentCheckPoints[3].numRows, int64(0))
		assert.Equal(t, iBNode.segmentCheckPoints[2].pos.Timestamp, Timestamp(234))
		assert.Equal(t, iBNode.segmentCheckPoints[3].pos.Timestamp, Timestamp(123))

		assert.Equal(t, len(flushUnit), 3)
		assert.Equal(t, flushUnit[2].segID, int64(1))
		assert.Equal(t, len(flushUnit[2].checkPoint), 3)
		assert.Equal(t, flushUnit[2].checkPoint[1].numRows, int64(50+16000+100+32000))
		assert.Equal(t, flushUnit[2].checkPoint[2].numRows, int64(100+32000))
		assert.Equal(t, flushUnit[2].checkPoint[3].numRows, int64(0))
		assert.Equal(t, flushUnit[2].checkPoint[1].pos.Timestamp, Timestamp(345))
		assert.Equal(t, flushUnit[2].checkPoint[2].pos.Timestamp, Timestamp(234))
		assert.Equal(t, flushUnit[2].checkPoint[3].pos.Timestamp, Timestamp(123))
		assert.Equal(t, len(flushUnit[2].field2Path), 0)
		assert.NotNil(t, flushUnit[2].field2Path)
		assert.True(t, flushUnit[2].flushed)
		assert.Equal(t, len(iBNode.insertBuffer.insertData), 1)
		assert.Equal(t, iBNode.insertBuffer.size(3), int32(50+16000))

		flushChan <- &flushMsg{
			msgID:        4,
			timestamp:    567,
			segmentID:    UniqueID(3),
			collectionID: UniqueID(3),
			dmlFlushedCh: dmlFlushedCh,
		}
		iBNode.Operate([]flowgraph.Msg{iMsg})
		flushSeg = <-dmlFlushedCh
		assert.NotNil(t, flushSeg)
		assert.Equal(t, len(flushSeg), 1)
		assert.Equal(t, flushSeg[0].ID, int64(3))
		assert.NotNil(t, flushSeg[0].Paths)
		assert.Equal(t, len(iBNode.segmentCheckPoints), 1)
		assert.Equal(t, iBNode.segmentCheckPoints[2].numRows, int64(100+32000))
		assert.Equal(t, iBNode.segmentCheckPoints[2].pos.Timestamp, Timestamp(234))
		assert.Equal(t, len(flushUnit), 4)
		assert.Equal(t, flushUnit[3].segID, int64(3))
		assert.Equal(t, len(flushUnit[3].checkPoint), 2)
		assert.Equal(t, flushUnit[3].checkPoint[3].numRows, int64(50+16000))
		assert.Equal(t, flushUnit[3].checkPoint[2].numRows, int64(100+32000))
		assert.Equal(t, flushUnit[3].checkPoint[3].pos.Timestamp, Timestamp(234))
		assert.Equal(t, flushUnit[3].checkPoint[2].pos.Timestamp, Timestamp(234))
		assert.Greater(t, len(flushUnit[3].field2Path), 0)
		assert.NotNil(t, flushUnit[3].field2Path)
		assert.True(t, flushUnit[3].flushed)
		assert.Equal(t, len(iBNode.insertBuffer.insertData), 0)

	})
}