encoded_block.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 m3db

import (
	"time"

	"github.com/m3db/m3/src/dbnode/encoding"
	"github.com/m3db/m3/src/query/block"
	"github.com/m3db/m3/src/query/models"
	"github.com/m3db/m3/src/query/storage"
	"github.com/m3db/m3/src/query/ts/m3db/consolidators"
)

type consolidationSettings struct {
	consolidationFn consolidators.ConsolidationFunc
	currentTime     time.Time
	bounds          models.Bounds
}

type encodedBlock struct {
	// There is slightly different execution for the last block in the series.
	lastBlock            bool
	lookback             time.Duration
	meta                 block.Metadata
	tagOptions           models.TagOptions
	consolidation        consolidationSettings
	seriesMetas          []block.SeriesMeta
	seriesBlockIterators []encoding.SeriesIterator
}

// NewEncodedBlock builds an encoded block.
func NewEncodedBlock(
	seriesBlockIterators []encoding.SeriesIterator,
	bounds models.Bounds,
	lastBlock bool,
	opts Options,
) (block.Block, error) {
	consolidation := consolidationSettings{
		consolidationFn: consolidators.TakeLast,
		currentTime:     bounds.Start,
		bounds:          bounds,
	}

	bl := newEncodedBlock(
		seriesBlockIterators,
		opts.TagOptions(),
		consolidation,
		opts.LookbackDuration(),
		lastBlock,
	)
	err := bl.generateMetas()
	if err != nil {
		return nil, err
	}

	return &bl, nil
}

func newEncodedBlock(
	seriesBlockIterators []encoding.SeriesIterator,
	tagOptions models.TagOptions,
	consolidation consolidationSettings,
	lookback time.Duration,
	lastBlock bool,
) encodedBlock {
	return encodedBlock{
		seriesBlockIterators: seriesBlockIterators,
		tagOptions:           tagOptions,
		consolidation:        consolidation,
		lookback:             lookback,
		lastBlock:            lastBlock,
	}
}

func (b *encodedBlock) Unconsolidated() (block.UnconsolidatedBlock, error) {
	return &encodedBlockUnconsolidated{
		lastBlock:            b.lastBlock,
		lookback:             b.lookback,
		meta:                 b.meta,
		tagOptions:           b.tagOptions,
		consolidation:        b.consolidation,
		seriesMetas:          b.seriesMetas,
		seriesBlockIterators: b.seriesBlockIterators,
	}, nil
}

func (b *encodedBlock) Close() error {
	for _, bl := range b.seriesBlockIterators {
		bl.Close()
	}

	return nil
}

func (b *encodedBlock) buildSeriesMeta() error {
	b.seriesMetas = make([]block.SeriesMeta, len(b.seriesBlockIterators))
	for i, iter := range b.seriesBlockIterators {
		tags, err := storage.FromIdentTagIteratorToTags(iter.Tags(), b.tagOptions)
		if err != nil {
			return err
		}

		b.seriesMetas[i] = block.SeriesMeta{
			Name: iter.ID().Bytes(),
			Tags: tags,
		}
	}

	return nil
}

func (b *encodedBlock) buildMeta() {
	b.meta = block.Metadata{
		Tags:   models.NewTags(0, b.tagOptions),
		Bounds: b.consolidation.bounds,
	}
}

func (b *encodedBlock) generateMetas() error {
	err := b.buildSeriesMeta()
	if err != nil {
		return err
	}

	b.buildMeta()
	return nil
}

func (b *encodedBlock) WithMetadata(
	meta block.Metadata,
	seriesMetas []block.SeriesMeta,
) (block.Block, error) {
	bl := newEncodedBlock(
		b.seriesBlockIterators,
		b.tagOptions,
		b.consolidation,
		b.lookback,
		b.lastBlock,
	)

	bl.meta = meta
	bl.seriesMetas = seriesMetas
	return &bl, nil
}