benchmark_stream.go

// Copyright (c) 2021 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 main

import (
	"io"
	"time"

	"github.com/yarpc/yab/encoding"
	"github.com/yarpc/yab/transport"
)

// benchmarkStreamMethod benchmarks stream requests.
type benchmarkStreamMethod struct {
	serializer            encoding.Serializer
	streamRequest         *transport.StreamRequest
	streamRequestMessages [][]byte
	opts                  StreamRequestOptions
}

// Call dispatches stream request on the provided transport.
func (m benchmarkStreamMethod) Call(t transport.Transport) (benchmarkCallReporter, error) {
	streamIO := newStreamIOBenchmark(m.streamRequestMessages)

	start := time.Now()
	err := makeStreamRequest(t, m.streamRequest, m.serializer, streamIO, m.opts)
	callReport := newBenchmarkStreamCallReport(time.Since(start), streamIO.streamMessagesReceived(), streamIO.streamMessagesSent())

	if err != nil {
		return callReport, err
	}

	// response validation is delayed to avoid consuming benchmark time for
	// deserializing the responses.
	for _, res := range streamIO.streamResponses {
		if err = m.serializer.CheckSuccess(&transport.Response{Body: res}); err != nil {
			return callReport, err
		}
	}

	return callReport, err
}

func (m benchmarkStreamMethod) CallMethodType() encoding.MethodType {
	return m.serializer.MethodType()
}

// streamIOBenchmark provides stream IO methods using the provided stream requests
// and records the stream responses.
type streamIOBenchmark struct {
	streamRequestsIdx int      // current stream request iterator index
	streamRequests    [][]byte // provided stream requests

	streamResponses [][]byte // recorded stream responses
}

func newStreamIOBenchmark(streamRequests [][]byte) *streamIOBenchmark {
	return &streamIOBenchmark{
		streamRequests: streamRequests,
	}
}

// NextRequest returns next stream request from provided requests
// returns EOF if last index has been reached.
func (b *streamIOBenchmark) NextRequest() ([]byte, error) {
	if len(b.streamRequests) == b.streamRequestsIdx {
		return nil, io.EOF
	}

	// TODO: support `stream-interval` option which throttles the rate of input.
	req := b.streamRequests[b.streamRequestsIdx]
	b.streamRequestsIdx++
	return req, nil
}

// HandleResponse records stream response.
func (b *streamIOBenchmark) HandleResponse(res []byte) error {
	b.streamResponses = append(b.streamResponses, res)
	return nil
}

func (b *streamIOBenchmark) streamMessagesReceived() int {
	return len(b.streamResponses)
}

func (b *streamIOBenchmark) streamMessagesSent() int {
	return b.streamRequestsIdx
}

type benchmarkStreamCallReport struct {
	latency                time.Duration
	streamMessagesReceived int
	streamMessagesSent     int
}

func newBenchmarkStreamCallReport(latency time.Duration, streamMessagesReceived, streamMessagesSent int) benchmarkStreamCallReport {
	return benchmarkStreamCallReport{
		latency:                latency,
		streamMessagesReceived: streamMessagesReceived,
		streamMessagesSent:     streamMessagesSent,
	}
}

func (r benchmarkStreamCallReport) Latency() time.Duration {
	return r.latency
}

func (r benchmarkStreamCallReport) StreamMessagesReceived() int {
	return r.streamMessagesReceived
}

func (r benchmarkStreamCallReport) StreamMessagesSent() int {
	return r.streamMessagesSent
}