fix: Use a global tenant ID when retrieving secrets information (#1260)

mem · web-flow · commit f171fc456d6b · 2025-03-21T10:57:33.000-04:00
We have several places that need a global tenant ID. We usually
communicate this by using models.GlobalTenantID instead of just int64,
but the GetTenant function takes a structure that doesn't make a
distinction, because it would require updating the protocol buffer
definition in a way that would be hard to handle.

Fix the various locations that are using a local ID instead of a global
ID.

Signed-off-by: Marcelo E. Magallon &lt;marcelo.magallon@grafana.com&gt;
diff --git a/internal/prober/browser/browser.go b/internal/prober/browser/browser.go
@@ -36,7 +36,7 @@ func NewProber(ctx context.Context, check model.Check, logger zerolog.Logger, ru
 		return p, errUnsupportedCheck
 	}
 
-	secretStore, err := store.GetSecretCredentials(ctx, check.TenantId)
+	secretStore, err := store.GetSecretCredentials(ctx, check.GlobalTenantID())
 	if err != nil {
 		return p, err
 	}
diff --git a/internal/prober/browser/browser_test.go b/internal/prober/browser/browser_test.go
@@ -86,6 +86,6 @@ func (noopRunner) Run(ctx context.Context, script k6runner.Script) (*k6runner.Ru
 
 type noopSecretStore struct{}
 
-func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID int64) (*sm.SecretStore, error) {
+func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID model.GlobalID) (*sm.SecretStore, error) {
 	return &sm.SecretStore{}, nil
 }
diff --git a/internal/prober/multihttp/multihttp.go b/internal/prober/multihttp/multihttp.go
@@ -46,7 +46,7 @@ func NewProber(ctx context.Context, check model.Check, logger zerolog.Logger, ru
 		augmentHttpHeaders(&check.Check, reservedHeaders)
 	}
 
-	secretStore, err := store.GetSecretCredentials(ctx, check.TenantId)
+	secretStore, err := store.GetSecretCredentials(ctx, check.GlobalTenantID())
 	if err != nil {
 		return p, err
 	}
diff --git a/internal/prober/multihttp/multihttp_test.go b/internal/prober/multihttp/multihttp_test.go
@@ -161,6 +161,6 @@ func (noopRunner) Run(ctx context.Context, script k6runner.Script) (*k6runner.Ru
 
 type noopSecretStore struct{}
 
-func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID int64) (*sm.SecretStore, error) {
+func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID model.GlobalID) (*sm.SecretStore, error) {
 	return &sm.SecretStore{}, nil
 }
diff --git a/internal/prober/prober_test.go b/internal/prober/prober_test.go
@@ -31,6 +31,6 @@ func TestProberFactoryCoverage(t *testing.T) {
 
 type noopSecretStore struct{}
 
-func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID int64) (*sm.SecretStore, error) {
+func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID model.GlobalID) (*sm.SecretStore, error) {
 	return &sm.SecretStore{}, nil
 }
diff --git a/internal/prober/scripted/scripted.go b/internal/prober/scripted/scripted.go
@@ -36,7 +36,7 @@ func NewProber(ctx context.Context, check model.Check, logger zerolog.Logger, ru
 		return p, errUnsupportedCheck
 	}
 
-	secretStore, err := store.GetSecretCredentials(ctx, check.TenantId)
+	secretStore, err := store.GetSecretCredentials(ctx, check.GlobalTenantID())
 	if err != nil {
 		return p, err
 	}
diff --git a/internal/prober/scripted/scripted_test.go b/internal/prober/scripted/scripted_test.go
@@ -85,7 +85,7 @@ func (noopRunner) Run(ctx context.Context, script k6runner.Script) (*k6runner.Ru
 
 type noopSecretStore struct{}
 
-func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID int64) (*sm.SecretStore, error) {
+func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID model.GlobalID) (*sm.SecretStore, error) {
 	return &sm.SecretStore{}, nil
 }
 
diff --git a/internal/scraper/scraper_test.go b/internal/scraper/scraper_test.go
@@ -2028,6 +2028,6 @@ func TestTickWithOffset(t *testing.T) {
 
 type noopSecretStore struct{}
 
-func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID int64) (*sm.SecretStore, error) {
+func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID model.GlobalID) (*sm.SecretStore, error) {
 	return &sm.SecretStore{}, nil
 }
diff --git a/internal/secrets/tenant.go b/internal/secrets/tenant.go
@@ -5,11 +5,12 @@ import (
 
 	"github.com/rs/zerolog"
 
+	"github.com/grafana/synthetic-monitoring-agent/internal/model"
 	sm "github.com/grafana/synthetic-monitoring-agent/pkg/pb/synthetic_monitoring"
 )
 
 type SecretProvider interface {
-	GetSecretCredentials(ctx context.Context, tenantID int64) (*sm.SecretStore, error)
+	GetSecretCredentials(ctx context.Context, tenantID model.GlobalID) (*sm.SecretStore, error)
 }
 
 type TenantProvider interface {
@@ -28,9 +29,9 @@ func NewTenantSecrets(tp TenantProvider, logger zerolog.Logger) *TenantSecrets {
 	}
 }
 
-func (ts *TenantSecrets) GetSecretCredentials(ctx context.Context, tenantID int64) (*sm.SecretStore, error) {
+func (ts *TenantSecrets) GetSecretCredentials(ctx context.Context, tenantID model.GlobalID) (*sm.SecretStore, error) {
 	tenant, err := ts.tp.GetTenant(ctx, &sm.TenantInfo{
-		Id: tenantID,
+		Id: int64(tenantID),
 	})
 	if err != nil {
 		return nil, err
diff --git a/internal/secrets/tenant_test.go b/internal/secrets/tenant_test.go
@@ -7,6 +7,7 @@ import (
 
 	"github.com/rs/zerolog"
 
+	"github.com/grafana/synthetic-monitoring-agent/internal/model"
 	sm "github.com/grafana/synthetic-monitoring-agent/pkg/pb/synthetic_monitoring"
 	"github.com/stretchr/testify/assert"
 )
@@ -26,7 +27,7 @@ func TestGetSecretCredentials_Success(t *testing.T) {
 	mockTenantProvider := &tenantProvider{tenant: mockTenant}
 	ts := NewTenantSecrets(mockTenantProvider, zerolog.Nop())
 	ctx := context.Background()
-	tenantID := int64(1234)
+	tenantID := model.GlobalID(1234)
 
 	secretStore, err := ts.GetSecretCredentials(ctx, tenantID)
 
@@ -39,7 +40,7 @@ func TestGetSecretCredentials_Error(t *testing.T) {
 	mockTenantProvider := &tenantProvider{err: getTenantErr}
 	ts := NewTenantSecrets(mockTenantProvider, zerolog.Nop())
 	ctx := context.Background()
-	tenantID := int64(1234)
+	tenantID := model.GlobalID(1234)
 
 	secretStore, err := ts.GetSecretCredentials(ctx, tenantID)
 

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ func NewProber(ctx context.Context, check model.Check, logger zerolog.Logger, ru`
`36`	`36`	`return p, errUnsupportedCheck`
`37`	`37`	`}`
`38`	`38`
`39`		`- secretStore, err := store.GetSecretCredentials(ctx, check.TenantId)`
	`39`	`+ secretStore, err := store.GetSecretCredentials(ctx, check.GlobalTenantID())`
`40`	`40`	`if err != nil {`
`41`	`41`	`return p, err`
`42`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -86,6 +86,6 @@ func (noopRunner) Run(ctx context.Context, script k6runner.Script) (*k6runner.Ru`
`86`	`86`
`87`	`87`	`type noopSecretStore struct{}`
`88`	`88`
`89`		`-func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID int64) (*sm.SecretStore, error) {`
	`89`	`+func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID model.GlobalID) (*sm.SecretStore, error) {`
`90`	`90`	`return &sm.SecretStore{}, nil`
`91`	`91`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ func NewProber(ctx context.Context, check model.Check, logger zerolog.Logger, ru`
`46`	`46`	`augmentHttpHeaders(&check.Check, reservedHeaders)`
`47`	`47`	`}`
`48`	`48`
`49`		`- secretStore, err := store.GetSecretCredentials(ctx, check.TenantId)`
	`49`	`+ secretStore, err := store.GetSecretCredentials(ctx, check.GlobalTenantID())`
`50`	`50`	`if err != nil {`
`51`	`51`	`return p, err`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -161,6 +161,6 @@ func (noopRunner) Run(ctx context.Context, script k6runner.Script) (*k6runner.Ru`
`161`	`161`
`162`	`162`	`type noopSecretStore struct{}`
`163`	`163`
`164`		`-func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID int64) (*sm.SecretStore, error) {`
	`164`	`+func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID model.GlobalID) (*sm.SecretStore, error) {`
`165`	`165`	`return &sm.SecretStore{}, nil`
`166`	`166`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,6 @@ func TestProberFactoryCoverage(t *testing.T) {`
`31`	`31`
`32`	`32`	`type noopSecretStore struct{}`
`33`	`33`
`34`		`-func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID int64) (*sm.SecretStore, error) {`
	`34`	`+func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID model.GlobalID) (*sm.SecretStore, error) {`
`35`	`35`	`return &sm.SecretStore{}, nil`
`36`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ func (noopRunner) Run(ctx context.Context, script k6runner.Script) (*k6runner.Ru`
`85`	`85`
`86`	`86`	`type noopSecretStore struct{}`
`87`	`87`
`88`		`-func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID int64) (*sm.SecretStore, error) {`
	`88`	`+func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID model.GlobalID) (*sm.SecretStore, error) {`
`89`	`89`	`return &sm.SecretStore{}, nil`
`90`	`90`	`}`
`91`	`91`
Original file line number	Diff line number	Diff line change
`@@ -2028,6 +2028,6 @@ func TestTickWithOffset(t *testing.T) {`
`2028`	`2028`
`2029`	`2029`	`type noopSecretStore struct{}`
`2030`	`2030`
`2031`		`-func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID int64) (*sm.SecretStore, error) {`
	`2031`	`+func (n noopSecretStore) GetSecretCredentials(ctx context.Context, tenantID model.GlobalID) (*sm.SecretStore, error) {`
`2032`	`2032`	`return &sm.SecretStore{}, nil`
`2033`	`2033`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,12 @@ import (`
`5`	`5`
`6`	`6`	`"github.com/rs/zerolog"`
`7`	`7`
	`8`	`+ "github.com/grafana/synthetic-monitoring-agent/internal/model"`
`8`	`9`	`sm "github.com/grafana/synthetic-monitoring-agent/pkg/pb/synthetic_monitoring"`
`9`	`10`	`)`
`10`	`11`
`11`	`12`	`type SecretProvider interface {`
`12`		`- GetSecretCredentials(ctx context.Context, tenantID int64) (*sm.SecretStore, error)`
	`13`	`+ GetSecretCredentials(ctx context.Context, tenantID model.GlobalID) (*sm.SecretStore, error)`
`13`	`14`	`}`
`14`	`15`
`15`	`16`	`type TenantProvider interface {`
`@@ -28,9 +29,9 @@ func NewTenantSecrets(tp TenantProvider, logger zerolog.Logger) *TenantSecrets {`
`28`	`29`	`}`
`29`	`30`	`}`
`30`	`31`
`31`		`-func (ts TenantSecrets) GetSecretCredentials(ctx context.Context, tenantID int64) (sm.SecretStore, error) {`
	`32`	`+func (ts TenantSecrets) GetSecretCredentials(ctx context.Context, tenantID model.GlobalID) (sm.SecretStore, error) {`
`32`	`33`	`tenant, err := ts.tp.GetTenant(ctx, &sm.TenantInfo{`
`33`		`- Id: tenantID,`
	`34`	`+ Id: int64(tenantID),`
`34`	`35`	`})`
`35`	`36`	`if err != nil {`
`36`	`37`	`return nil, err`