delayed_spans_test.go

// (c) Copyright IBM Corp. 2022

package instana

import (
	"context"
	"fmt"
	"net/http"
	"net/http/httptest"
	"os"
	"sync"
	"sync/atomic"
	"testing"

	"github.com/instana/go-sensor/acceptor"
	"github.com/instana/go-sensor/autoprofile"
	"github.com/stretchr/testify/assert"
)

func TestAppendALotDelayedSpans(t *testing.T) {
	ds := &delayedSpans{
		spans: make(chan *spanS, maxDelayedSpans),
	}

	i := 0
	for i <= 2*maxDelayedSpans {
		ds.append(&spanS{})
		i++
	}

	assert.Len(t, ds.spans, maxDelayedSpans)
}

func resetDelayedSpans() {
	delayed = &delayedSpans{
		spans: make(chan *spanS, maxDelayedSpans),
	}
}

func TestPartiallyFlushDelayedSpans(t *testing.T) {
	defer resetDelayedSpans()

	recorder := NewTestRecorder()
	s := NewSensorWithTracer(NewTracerWithEverything(&Options{
		Service: "go-sensor-test",
		Tracer: TracerOptions{
			Secrets: DefaultSecretsMatcher(),
		},
	}, recorder))
	defer ShutdownSensor()

	generateSomeTraffic(s, maxDelayedSpans)

	// serverless agent should not be present for this test to pass.
	// following check is added for debugging random failures in the unit tests of delayed spans
	// TODO: remove it once the issue is resolved.
	url, _ := os.LookupEnv("INSTANA_ENDPOINT_URL")
	assert.Equal(t, "", url)

	assert.Len(t, delayed.spans, maxDelayedSpans)

	notReadyAfter := maxDelayedSpans / 10
	sensor.agent = &eventuallyNotReadyClient{
		notReadyAfter: uint64(notReadyAfter),
	}

	delayed.flush()

	assert.Len(t, delayed.spans, maxDelayedSpans-notReadyAfter)
}

func TestFlushDelayedSpans(t *testing.T) {
	defer resetDelayedSpans()

	recorder := NewTestRecorder()
	s := NewSensorWithTracer(NewTracerWithEverything(&Options{
		Service: "go-sensor-test",
		Tracer: TracerOptions{
			Secrets: DefaultSecretsMatcher(),
		},
	}, recorder))
	defer ShutdownSensor()

	generateSomeTraffic(s, maxDelayedSpans)

	// serverless agent should not be present for this test to pass.
	// following check is added for debugging random failures in the unit tests of delayed spans
	// TODO: remove it once the issue is resolved.
	_, isURLPresent := os.LookupEnv("INSTANA_ENDPOINT_URL")
	assert.Equal(t, false, isURLPresent)

	assert.Len(t, delayed.spans, maxDelayedSpans)

	sensor.agent = alwaysReadyClient{}

	delayed.flush()

	assert.Len(t, delayed.spans, 0)
}

func TestParallelFlushDelayedSpans(t *testing.T) {
	defer resetDelayedSpans()

	m, _ := NamedMatcher(ContainsIgnoreCaseMatcher, []string{"q", "secret"})

	recorder := NewTestRecorder()
	s := NewSensorWithTracer(NewTracerWithEverything(&Options{
		Service: "go-sensor-test",
		Tracer: TracerOptions{
			Secrets: m,
		},
	}, recorder))
	defer ShutdownSensor()

	generateSomeTraffic(s, maxDelayedSpans*2)

	// serverless agent should not be present for this test to pass.
	// following check is added for debugging random failures in the unit tests of delayed spans
	// TODO: remove it once the issue is resolved.
	_, isURLPresent := os.LookupEnv("INSTANA_ENDPOINT_URL")
	assert.Equal(t, false, isURLPresent)

	assert.Len(t, delayed.spans, maxDelayedSpans)

	workers := 15
	worker := 0
	wg := sync.WaitGroup{}
	wg.Add(workers)

	sensor.agent = alwaysReadyClient{}

	for worker < workers {
		go func() {
			delayed.flush()
			wg.Done()
		}()
		worker++
	}

	wg.Wait()

	recordedSpans := recorder.GetQueuedSpans()
	assert.Equal(t, maxDelayedSpans, len(recordedSpans))

	for _, v := range recordedSpans {
		if v, ok := v.Data.(HTTPSpanData); ok {
			assert.Equal(t, "q=%3Credacted%3E&secret=%3Credacted%3E", v.Tags.Params)
		} else {
			assert.Fail(t, "wrong span type")
		}
	}
}

type eventuallyNotReadyClient struct {
	notReadyAfter uint64
	ops           uint64
}

func (e *eventuallyNotReadyClient) Ready() bool {
	n := atomic.AddUint64(&e.ops, 1)
	return n <= e.notReadyAfter
}

func (*eventuallyNotReadyClient) SendMetrics(data acceptor.Metrics) error           { return nil }
func (*eventuallyNotReadyClient) SendEvent(event *EventData) error                  { return nil }
func (*eventuallyNotReadyClient) SendSpans(spans []Span) error                      { return nil }
func (*eventuallyNotReadyClient) SendProfiles(profiles []autoprofile.Profile) error { return nil }
func (*eventuallyNotReadyClient) Flush(context.Context) error                       { return nil }

func generateSomeTraffic(s TracerLogger, amount int) {
	h := TracingNamedHandlerFunc(s, "action", "/{action}", func(w http.ResponseWriter, req *http.Request) {
		fmt.Fprintln(w, "Ok")
	})

	req := httptest.NewRequest(http.MethodGet, "/test?q=term&secret=mypassword", nil)

	rec := httptest.NewRecorder()

	for i := 0; i < amount; i++ {
		h.ServeHTTP(rec, req)
	}
}