// Package metrics provides common functionality for working with metrics,
// particularly useful for monitoring components. It includes types to store,
// check and filter metrics.
package metrics

import (
	"container/ring"
	"errors"
	"sync"
	"time"

	"github.com/ipfs/ipfs-cluster/api"
)

// DefaultWindowCap sets the amount of metrics to store per peer.
var DefaultWindowCap = 25

// ErrNoMetrics is returned when there are no metrics in a Window.
var ErrNoMetrics = errors.New("no metrics have been added to this window")

// Window implements a circular queue to store metrics.
type Window struct {
	wMu    sync.RWMutex
	window *ring.Ring
}

// NewWindow creates an instance with the given
// window capacity.
func NewWindow(windowCap int) *Window {
	if windowCap <= 0 {
		panic("invalid windowCap")
	}

	w := ring.New(windowCap)
	return &Window{
		window: w,
	}
}

// Add adds a new metric to the window. If the window capacity
// has been reached, the oldest metric (by the time it was added),
// will be discarded. Add leaves the cursor on the next spot,
// which is either empty or the oldest record.
func (mw *Window) Add(m api.Metric) {
	m.ReceivedAt = time.Now().UnixNano()

	mw.wMu.Lock()
	mw.window.Value = m
	mw.window = mw.window.Next()
	mw.wMu.Unlock()
}

// Latest returns the last metric added. It returns an error
// if no metrics were added.
func (mw *Window) Latest() (api.Metric, error) {
	var last api.Metric
	var ok bool

	mw.wMu.RLock()
	// This just returns the previous ring and
	// doesn't set the window "cursor" to the previous
	// ring. Therefore this is just a read operation
	// as well.
	prevRing := mw.window.Prev()
	mw.wMu.RUnlock()

	last, ok = prevRing.Value.(api.Metric)

	if !ok || !last.Defined() {
		return last, ErrNoMetrics
	}

	return last, nil
}

// All returns all the metrics in the window, in the inverse order
// they were Added. That is, result[0] will be the last added
// metric.
func (mw *Window) All() []api.Metric {
	values := make([]api.Metric, 0, mw.window.Len())

	mw.wMu.RLock()
	mw.window.Do(func(v interface{}) {
		i, ok := v.(api.Metric)
		if ok {
			// append younger values to older value
			values = append([]api.Metric{i}, values...)
		}
	})
	mw.wMu.RUnlock()

	return values
}