github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/cmd/services/m3coordinator/downsample/flush_handler_test.go

// Copyright (c) 2018 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package downsample

import (
	"bytes"
	"sync"
	"testing"

	"github.com/m3db/m3/src/metrics/metric/aggregated"
	"github.com/m3db/m3/src/metrics/metric/id"
	"github.com/m3db/m3/src/metrics/policy"
	"github.com/m3db/m3/src/query/models"
	"github.com/m3db/m3/src/query/storage/mock"
	"github.com/m3db/m3/src/x/ident"
	"github.com/m3db/m3/src/x/instrument"
	"github.com/m3db/m3/src/x/pool"
	"github.com/m3db/m3/src/x/serialize"
	xsync "github.com/m3db/m3/src/x/sync"
	xtest "github.com/m3db/m3/src/x/test"

	"github.com/golang/mock/gomock"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"github.com/uber-go/tally"
)

func TestDownsamplerFlushHandlerCopiesTags(t *testing.T) {
	ctrl := xtest.NewController(t)
	defer ctrl.Finish()

	store := mock.NewMockStorage()
	pool := serialize.NewMockMetricTagsIteratorPool(ctrl)

	workers := xsync.NewWorkerPool(1)
	workers.Init()

	instrumentOpts := instrument.NewOptions()

	handler := newDownsamplerFlushHandler(store, pool,
		workers, models.NewTagOptions(), instrumentOpts)
	writer, err := handler.NewWriter(tally.NoopScope)
	require.NoError(t, err)

	var (
		expectedID = []byte("foo")
		tagName    = []byte("name")
		tagValue   = []byte("value")
		annotation = []byte("annotation")
	)
	iter := serialize.NewMockMetricTagsIterator(ctrl)
	gomock.InOrder(
		iter.EXPECT().Reset(expectedID),
		iter.EXPECT().NumTags().Return(1),
		iter.EXPECT().Next().Return(true),
		iter.EXPECT().Current().Return(tagName, tagValue),
		iter.EXPECT().Next().Return(false),
		iter.EXPECT().Err().Return(nil),
		iter.EXPECT().Close(),
	)

	pool.EXPECT().Get().Return(iter)

	// Write metric
	err = writer.Write(aggregated.ChunkedMetricWithStoragePolicy{
		ChunkedMetric: aggregated.ChunkedMetric{
			ChunkedID:  id.ChunkedID{Data: expectedID},
			TimeNanos:  123,
			Value:      42.42,
			Annotation: annotation,
		},
		StoragePolicy: policy.MustParseStoragePolicy("1s:1d"),
	})
	require.NoError(t, err)

	// Wait for flush
	err = writer.Flush()
	require.NoError(t, err)

	// Inspect the write
	writes := store.Writes()
	require.Equal(t, 1, len(writes))

	// Ensure tag pointers _DO_NOT_ match but equal to same content
	tags := writes[0].Tags().Tags
	require.Equal(t, 1, len(tags))

	tag := tags[0]
	assert.True(t, bytes.Equal(tagName, tag.Name))
	assert.True(t, bytes.Equal(tagValue, tag.Value))
	assert.False(t, xtest.ByteSlicesBackedBySameData(tagName, tag.Name))
	assert.False(t, xtest.ByteSlicesBackedBySameData(tagValue, tag.Value))

	assert.Equal(t, annotation, writes[0].Annotation())
}

func graphiteTags(
	t *testing.T, first string, encPool serialize.TagEncoderPool) []byte {
	enc := encPool.Get()
	defer enc.Finalize()

	err := enc.Encode(ident.MustNewTagStringsIterator(
		"__g0__", first,
		"__g1__", "y",
		"__g2__", "z",
		string(MetricsOptionIDSchemeTagName), string(GraphiteIDSchemeTagValue),
	))

	require.NoError(t, err)
	data, ok := enc.Data()
	require.True(t, ok)
	return append(make([]byte, 0, data.Len()), data.Bytes()...)
}

func TestDownsamplerFlushHandlerHighConcurrencyNoTagMixing(t *testing.T) {
	ctrl := xtest.NewController(t)
	defer ctrl.Finish()

	store := mock.NewMockStorage()

	size := 10
	decodeOpts := serialize.NewTagDecoderOptions(serialize.TagDecoderOptionsConfig{
		CheckBytesWrapperPoolSize: &size,
	})

	poolOpts := pool.NewObjectPoolOptions()
	tagDecoderPool := serialize.NewTagDecoderPool(decodeOpts, poolOpts)
	tagDecoderPool.Init()

	pool := serialize.NewMetricTagsIteratorPool(tagDecoderPool, poolOpts)
	pool.Init()

	workers := xsync.NewWorkerPool(1)
	workers.Init()

	instrumentOpts := instrument.NewOptions()

	handler := newDownsamplerFlushHandler(store, pool,
		workers, models.NewTagOptions(), instrumentOpts)
	writer, err := handler.NewWriter(tally.NoopScope)
	require.NoError(t, err)

	encodeOpts := serialize.NewTagEncoderOptions()
	encPool := serialize.NewTagEncoderPool(encodeOpts, poolOpts)
	encPool.Init()

	xBytes := graphiteTags(t, "x", encPool)
	fooBytes := graphiteTags(t, "foo", encPool)

	var wg sync.WaitGroup
	for i := 0; i < 100; i++ {
		wg.Add(1)
		xData := append(make([]byte, 0, len(xBytes)), xBytes...)
		fooData := append(make([]byte, 0, len(fooBytes)), fooBytes...)
		go func() {
			defer wg.Done()
			err := writer.Write(aggregated.ChunkedMetricWithStoragePolicy{
				ChunkedMetric: aggregated.ChunkedMetric{
					ChunkedID: id.ChunkedID{Data: xData},
					TimeNanos: 123,
					Value:     42.42,
				},
				StoragePolicy: policy.MustParseStoragePolicy("1s:1d"),
			})
			require.NoError(t, err)

			err = writer.Write(aggregated.ChunkedMetricWithStoragePolicy{
				ChunkedMetric: aggregated.ChunkedMetric{
					ChunkedID: id.ChunkedID{Data: fooData},
					TimeNanos: 123,
					Value:     42.42,
				},
				StoragePolicy: policy.MustParseStoragePolicy("1s:1d"),
			})
			require.NoError(t, err)
		}()
	}

	wg.Wait()
	// Wait for flush
	err = writer.Flush()
	require.NoError(t, err)

	// Inspect the write
	writes := store.Writes()
	require.Equal(t, 200, len(writes))

	seenMap := make(map[string]int, 10)
	for _, w := range writes {
		str := w.Tags().String()
		seenMap[str] = seenMap[str] + 1
	}

	assert.Equal(t, map[string]int{
		"__g0__: foo, __g1__: y, __g2__: z": 100,
		"__g0__: x, __g1__: y, __g2__: z":   100,
	}, seenMap)
}