Merge pull request #289 from newrelic/fix_race_condition_new_metric_set

Fix race condition when calling entityMetadata Key endpoint

Author: alvarocabanas

integration/entity.go

@@ -29,6 +29,7 @@ type EntityMetadata struct {
 	Name      string       `json:"name"`
 	Namespace string       `json:"type"`          // For compatibility reasons we keep the type.
 	IDAttrs   IDAttributes `json:"id_attributes"` // For entity Key uniqueness
+	lock      sync.Locker
 }
 
 // EqualsTo returns true when both metadata are equal.
@@ -89,6 +90,7 @@ func newEntity(
 			Name:      name,
 			Namespace: namespace,
 			IDAttrs:   idAttributes(idAttrs...),
+			lock:      &sync.Mutex{},
 		},
 	}
 
@@ -105,7 +107,6 @@ func (e *Entity) SameAs(b *Entity) bool {
 	if e.Metadata == nil || b.Metadata == nil {
 		return false
 	}
-
 	return e.Metadata.EqualsTo(b.Metadata)
 }
 

integration/entity_id.go

@@ -36,6 +36,9 @@ func (k EntityKey) String() string {
 
 // Key generates the entity key based on the entity metadata.
 func (m *EntityMetadata) Key() (EntityKey, error) {
+	m.lock.Lock()
+	defer m.lock.Unlock()
+
 	if len(m.Name) == 0 {
 		return EmptyKey, nil // Empty value means this agent's default entity identifier
 	}

integration/entity_test.go

@@ -10,6 +10,7 @@ import (
 
 	"github.com/newrelic/infra-integrations-sdk/data/attribute"
 	"github.com/newrelic/infra-integrations-sdk/data/event"
+	"github.com/newrelic/infra-integrations-sdk/data/metric"
 	"github.com/newrelic/infra-integrations-sdk/persist"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -248,3 +249,29 @@ func TestEntity_SameAs(t *testing.T) {
 	assert.True(t, e1.SameAs(e2))
 	assert.False(t, e1.SameAs(e3))
 }
+
+func TestEntity_NewMetricSet(t *testing.T) {
+	i, err := New(integrationName, integrationVersion)
+
+	entity, err := i.Entity("a-name", "a-type")
+	assert.NoError(t, err)
+
+	metricSetChan := make(chan *metric.Set)
+	go func(e *Entity) {
+		metricSetChan <- e.NewMetricSet("F5BigIpPoolMemberSample",
+			attribute.Attribute{Key: "displayName", Value: "entityName"},
+			attribute.Attribute{Key: "entityName", Value: "entityName"},
+			attribute.Attribute{Key: "poolName", Value: "description"},
+			attribute.Attribute{Key: "url", Value: "url"},
+		)
+	}(entity)
+
+	// We retrieve the entity at the same time to check for race conditions
+	go func(i *Integration) {
+		_, err := i.Entity("a-name", "a-type")
+		assert.NoError(t, err)
+	}(i)
+
+	metricSet := <-metricSetChan
+	assert.NotEmpty(t, metricSet)
+}