Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: Add X-Goog-Api-Client metric header to outgoing requests #655

Merged
merged 3 commits into from
Nov 21, 2024
+58 −23
Merged

chore: Add X-Goog-Api-Client metric header to outgoing requests #655

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
084440c
chore: Add `X-Goog-Api-Client` metric header to outgoing requests
jonathanedey Nov 19, 2024
c04763b
Fix lint and test
jonathanedey Nov 19, 2024
4bd3b45
Remove App Check headers
jonathanedey Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions appcheck/appcheck.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package appcheck
import (
"context"
"errors"
"net/http"
"strings"
"time"

Expand Down Expand Up @@ -77,6 +78,7 @@ func NewClient(ctx context.Context, conf *internal.AppCheckConfig) (*Client, err
jwks, err := keyfunc.Get(JWKSUrl, keyfunc.Options{
Ctx: ctx,
RefreshInterval: 6 * time.Hour,
RequestFactory: makeRequestFactory(conf),
Copy link
Contributor Author

@jonathanedey jonathanedey Nov 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only way to pass headers here is to pass it through a request factory. This is a little more involved, should I separate this change into it's own PR?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this request is just for the key server (we might not track the requests there anyways) let's skip it for now then.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good

})
if err != nil {
return nil, err
Expand All @@ -88,6 +90,23 @@ func NewClient(ctx context.Context, conf *internal.AppCheckConfig) (*Client, err
}, nil
}

func makeRequestFactory(conf *internal.AppCheckConfig) func(ctx context.Context, url string) (*http.Request, error) {
opts := []internal.HTTPOption{
internal.WithHeader("x-goog-api-client", internal.GetMetricsHeader(conf.Version)),
}

return func(ctx context.Context, url string) (*http.Request, error) {
hr, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
if err != nil {
return nil, err
}
for _, o := range opts {
o(hr)
}
return hr, nil
}
}

// VerifyToken verifies the given App Check token.
//
// VerifyToken considers an App Check token string to be valid if all the following conditions are met:
Expand Down
37 changes: 21 additions & 16 deletions appcheck/appcheck_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,14 @@ import (
"github.com/google/go-cmp/cmp"
)

var testAppCheckConfig = &internal.AppCheckConfig{
ProjectID: "project_id",
Version: "test-version",
}

func TestVerifyTokenHasValidClaims(t *testing.T) {
ts, err := setupFakeJWKS()
var tr http.Request
ts, err := setupFakeJWKS(&tr)
if err != nil {
t.Fatalf("Error setting up fake JWKS server: %v", err)
}
Expand All @@ -30,15 +36,17 @@ func TestVerifyTokenHasValidClaims(t *testing.T) {
}

JWKSUrl = ts.URL
conf := &internal.AppCheckConfig{
ProjectID: "project_id",
}

client, err := NewClient(context.Background(), conf)
client, err := NewClient(context.Background(), testAppCheckConfig)
if err != nil {
t.Errorf("Error creating NewClient: %v", err)
}

xGoogAPIClientHeader := internal.GetMetricsHeader(testAppCheckConfig.Version)
if h := tr.Header.Get("x-goog-api-client"); h != xGoogAPIClientHeader {
t.Errorf("x-goog-api-client header = %q; want = %q", h, xGoogAPIClientHeader)
}

type appCheckClaims struct {
Aud []string `json:"aud"`
jwt.RegisteredClaims
Expand Down Expand Up @@ -169,18 +177,16 @@ func TestVerifyTokenHasValidClaims(t *testing.T) {
}

func TestVerifyTokenMustExist(t *testing.T) {
ts, err := setupFakeJWKS()
var tr http.Request
ts, err := setupFakeJWKS(&tr)
if err != nil {
t.Fatalf("Error setting up fake JWK server: %v", err)
}
defer ts.Close()

JWKSUrl = ts.URL
conf := &internal.AppCheckConfig{
ProjectID: "project_id",
}

client, err := NewClient(context.Background(), conf)
client, err := NewClient(context.Background(), testAppCheckConfig)
if err != nil {
t.Errorf("Error creating NewClient: %v", err)
}
Expand All @@ -197,7 +203,8 @@ func TestVerifyTokenMustExist(t *testing.T) {
}

func TestVerifyTokenNotExpired(t *testing.T) {
ts, err := setupFakeJWKS()
var tr http.Request
ts, err := setupFakeJWKS(&tr)
if err != nil {
t.Fatalf("Error setting up fake JWKS server: %v", err)
}
Expand All @@ -209,11 +216,8 @@ func TestVerifyTokenNotExpired(t *testing.T) {
}

JWKSUrl = ts.URL
conf := &internal.AppCheckConfig{
ProjectID: "project_id",
}

client, err := NewClient(context.Background(), conf)
client, err := NewClient(context.Background(), testAppCheckConfig)
if err != nil {
t.Errorf("Error creating NewClient: %v", err)
}
Expand Down Expand Up @@ -264,12 +268,13 @@ func TestVerifyTokenNotExpired(t *testing.T) {
}
}

func setupFakeJWKS() (*httptest.Server, error) {
func setupFakeJWKS(tr *http.Request) (*httptest.Server, error) {
jwks, err := os.ReadFile("../testdata/mock.jwks.json")
if err != nil {
return nil, err
}
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
*tr = *r
w.Write(jwks)
}))
return ts, nil
Expand Down
4 changes: 1 addition & 3 deletions auth/auth.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ import (
"errors"
"fmt"
"os"
"runtime"
"strings"
"time"

Expand Down Expand Up @@ -134,12 +133,11 @@ func NewClient(ctx context.Context, conf *internal.AuthConfig) (*Client, error)
return nil, err
}

goVersion := strings.TrimPrefix(runtime.Version(), "go")
hc := internal.WithDefaultRetryConfig(transport)
hc.CreateErrFn = handleHTTPError
hc.Opts = []internal.HTTPOption{
internal.WithHeader("X-Client-Version", fmt.Sprintf("Go/Admin/%s", conf.Version)),
internal.WithHeader("x-goog-api-client", fmt.Sprintf("gl-go/%s fire-admin/%s", goVersion, conf.Version)),
internal.WithHeader("x-goog-api-client", internal.GetMetricsHeader(conf.Version)),
}

baseURL := defaultAuthURL
Expand Down
9 changes: 3 additions & 6 deletions auth/auth_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ import (
"log"
"net/http"
"os"
"runtime"
"strings"
"syscall"
"testing"
Expand Down Expand Up @@ -1452,11 +1451,9 @@ func checkBaseClient(client *Client, wantProjectID string) error {
return fmt.Errorf("version = %q; want = %q", version, wantVersion)
}

goVersion := strings.TrimPrefix(runtime.Version(), "go")
xGoogAPIClientHeader := req.Header.Get("x-goog-api-client")
wantXGoogAPIClientHeader := fmt.Sprintf("gl-go/%s fire-admin/%s", goVersion, testVersion)
if xGoogAPIClientHeader != wantXGoogAPIClientHeader {
return fmt.Errorf("x-goog-api-client header = %q; want = %q", xGoogAPIClientHeader, wantXGoogAPIClientHeader)
xGoogAPIClientHeader := internal.GetMetricsHeader(testVersion)
if h := req.Header.Get("x-goog-api-client"); h != xGoogAPIClientHeader {
return fmt.Errorf("x-goog-api-client header = %q; want = %q", h, xGoogAPIClientHeader)
}

return nil
Expand Down
3 changes: 3 additions & 0 deletions auth/token_generator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,9 @@ func newIAMSigner(ctx context.Context, config *internal.AuthConfig) (*iamSigner,
if err != nil {
return nil, err
}
hc.Opts = []internal.HTTPOption{
internal.WithHeader("x-goog-api-client", internal.GetMetricsHeader(config.Version)),
}

return &iamSigner{
mutex: &sync.Mutex{},
Expand Down
13 changes: 11 additions & 2 deletions auth/token_generator_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ func TestIAMSigner(t *testing.T) {
conf := &internal.AuthConfig{
Opts: optsWithTokenSource,
ServiceAccountID: "test-service-account",
Version: testVersion,
}
signer, err := newIAMSigner(ctx, conf)
if err != nil {
Expand Down Expand Up @@ -155,6 +156,7 @@ func TestIAMSignerHTTPError(t *testing.T) {
conf := &internal.AuthConfig{
Opts: optsWithTokenSource,
ServiceAccountID: "test-service-account",
Version: testVersion,
}
signer, err := newIAMSigner(context.Background(), conf)
if err != nil {
Expand Down Expand Up @@ -182,6 +184,7 @@ func TestIAMSignerUnknownHTTPError(t *testing.T) {
conf := &internal.AuthConfig{
Opts: optsWithTokenSource,
ServiceAccountID: "test-service-account",
Version: testVersion,
}
signer, err := newIAMSigner(context.Background(), conf)
if err != nil {
Expand All @@ -208,7 +211,8 @@ func TestIAMSignerUnknownHTTPError(t *testing.T) {
func TestIAMSignerWithMetadataService(t *testing.T) {
ctx := context.Background()
conf := &internal.AuthConfig{
Opts: optsWithTokenSource,
Opts: optsWithTokenSource,
Version: testVersion,
}

signer, err := newIAMSigner(ctx, conf)
Expand Down Expand Up @@ -253,7 +257,8 @@ func TestIAMSignerWithMetadataService(t *testing.T) {
func TestIAMSignerNoMetadataService(t *testing.T) {
ctx := context.Background()
conf := &internal.AuthConfig{
Opts: optsWithTokenSource,
Opts: optsWithTokenSource,
Version: testVersion,
}

signer, err := newIAMSigner(ctx, conf)
Expand Down Expand Up @@ -340,6 +345,10 @@ func iamServer(t *testing.T, serviceAcct, signature string) *httptest.Server {
if r.URL.Path != wantPath {
t.Errorf("Path = %q; want = %q", r.URL.Path, wantPath)
}
xGoogAPIClientHeader := internal.GetMetricsHeader(testVersion)
if h := r.Header.Get("x-goog-api-client"); h != xGoogAPIClientHeader {
t.Errorf("x-goog-api-client header = %q; want = %q", h, xGoogAPIClientHeader)
}

w.Header().Set("Content-Type", "application/json")
b, err := json.Marshal(resp)
Expand Down
3 changes: 1 addition & 2 deletions auth/user_mgt_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ import (
"net/http"
"net/http/httptest"
"reflect"
"runtime"
"sort"
"strconv"
"strings"
Expand Down Expand Up @@ -2317,7 +2316,7 @@ func echoServer(resp interface{}, t *testing.T) *mockAuthServer {
}

gh = r.Header.Get("x-goog-api-client")
wh = fmt.Sprintf("gl-go/%s fire-admin/%s", strings.TrimPrefix(runtime.Version(), "go"), testVersion)
wh = internal.GetMetricsHeader(testVersion)
if gh != wh {
t.Errorf("x-goog-api-client header = %q; want: %q", gh, wh)
}
Expand Down
2 changes: 2 additions & 0 deletions firebase.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ func (a *App) InstanceID(ctx context.Context) (*iid.Client, error) {
conf := &internal.InstanceIDConfig{
ProjectID: a.projectID,
Opts: a.opts,
Version: Version,
}
return iid.NewClient(ctx, conf)
}
Expand All @@ -133,6 +134,7 @@ func (a *App) Messaging(ctx context.Context) (*messaging.Client, error) {
func (a *App) AppCheck(ctx context.Context) (*appcheck.Client, error) {
conf := &internal.AppCheckConfig{
ProjectID: a.projectID,
Version: Version,
}
return appcheck.NewClient(ctx, conf)
}
Expand Down
3 changes: 3 additions & 0 deletions iid/iid.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,9 @@ func NewClient(ctx context.Context, c *internal.InstanceIDConfig) (*Client, erro
if err != nil {
return nil, err
}
hc.Opts = []internal.HTTPOption{
internal.WithHeader("x-goog-api-client", internal.GetMetricsHeader(c.Version)),
}

hc.CreateErrFn = createError
return &Client{
Expand Down
13 changes: 13 additions & 0 deletions iid/iid_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ var testIIDConfig = &internal.InstanceIDConfig{
Opts: []option.ClientOption{
option.WithTokenSource(&internal.MockTokenSource{AccessToken: "test-token"}),
},
Version: "test-version",
}

func TestNoProjectID(t *testing.T) {
Expand Down Expand Up @@ -83,6 +84,10 @@ func TestDeleteInstanceID(t *testing.T) {
if h := tr.Header.Get("Authorization"); h != "Bearer test-token" {
t.Errorf("Authorization = %q; want = %q", h, "Bearer test-token")
}
xGoogAPIClientHeader := internal.GetMetricsHeader(testIIDConfig.Version)
if h := tr.Header.Get("x-goog-api-client"); h != xGoogAPIClientHeader {
t.Errorf("x-goog-api-client header = %q; want = %q", h, xGoogAPIClientHeader)
}
}

func TestDeleteInstanceIDError(t *testing.T) {
Expand Down Expand Up @@ -156,6 +161,10 @@ func TestDeleteInstanceIDError(t *testing.T) {
if h := tr.Header.Get("Authorization"); h != "Bearer test-token" {
t.Errorf("Authorization = %q; want = %q", h, "Bearer test-token")
}
xGoogAPIClientHeader := internal.GetMetricsHeader(testIIDConfig.Version)
if h := tr.Header.Get("x-goog-api-client"); h != xGoogAPIClientHeader {
t.Errorf("x-goog-api-client header = %q; want = %q", h, xGoogAPIClientHeader)
}
tr = nil
}
}
Expand Down Expand Up @@ -201,6 +210,10 @@ func TestDeleteInstanceIDUnexpectedError(t *testing.T) {
if h := tr.Header.Get("Authorization"); h != "Bearer test-token" {
t.Errorf("Authorization = %q; want = %q", h, "Bearer test-token")
}
xGoogAPIClientHeader := internal.GetMetricsHeader(testIIDConfig.Version)
if h := tr.Header.Get("x-goog-api-client"); h != xGoogAPIClientHeader {
t.Errorf("x-goog-api-client header = %q; want = %q", h, xGoogAPIClientHeader)
}
}

func TestDeleteInstanceIDConnectionError(t *testing.T) {
Expand Down
8 changes: 8 additions & 0 deletions internal/http_client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ import (
"io/ioutil"
"math"
"net/http"
"runtime"
"strconv"
"strings"
"time"

"google.golang.org/api/option"
Expand Down Expand Up @@ -441,3 +443,9 @@ func retryNetworkAndHTTPErrors(statusCodes ...int) RetryCondition {
return false
}
}

// GetMetricsHeader constructs header value for metrics attribution
func GetMetricsHeader(sdkVersion string) string {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to access the Version in here? That might be better than passing it in from all the APIs separately.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not possible, that would cause a dependency cycle. I'm not a fan of how this is structured either. I would prefer if we kept the Version value separately from firebase.go.

goVersion := strings.TrimPrefix(runtime.Version(), "go")
return fmt.Sprintf("gl-go/%s fire-admin/%s", goVersion, sdkVersion)
}
2 changes: 2 additions & 0 deletions internal/internal.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ type HashConfig map[string]interface{}
type InstanceIDConfig struct {
Opts []option.ClientOption
ProjectID string
Version string
}

// DatabaseConfig represents the configuration of Firebase Database service.
Expand All @@ -76,6 +77,7 @@ type MessagingConfig struct {
// AppCheckConfig represents the configuration of App Check service.
type AppCheckConfig struct {
ProjectID string
Version string
}

// MockTokenSource is a TokenSource implementation that can be used for testing.
Expand Down
6 changes: 2 additions & 4 deletions messaging/messaging.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ import (
"fmt"
"net/http"
"regexp"
"runtime"
"strconv"
"strings"
"time"
Expand Down Expand Up @@ -878,7 +877,7 @@ func NewClient(ctx context.Context, c *internal.MessagingConfig) (*Client, error

return &Client{
fcmClient: newFCMClient(hc, c, messagingEndpoint, batchEndpoint),
iidClient: newIIDClient(hc),
iidClient: newIIDClient(hc, c),
}, nil
}

Expand All @@ -894,12 +893,11 @@ func newFCMClient(hc *http.Client, conf *internal.MessagingConfig, messagingEndp
client := internal.WithDefaultRetryConfig(hc)
client.CreateErrFn = handleFCMError

goVersion := strings.TrimPrefix(runtime.Version(), "go")
version := fmt.Sprintf("fire-admin-go/%s", conf.Version)
client.Opts = []internal.HTTPOption{
internal.WithHeader(apiFormatVersionHeader, apiFormatVersion),
internal.WithHeader(firebaseClientHeader, version),
internal.WithHeader("x-goog-api-client", fmt.Sprintf("gl-go/%s fire-admin/%s", goVersion, conf.Version)),
internal.WithHeader("x-goog-api-client", internal.GetMetricsHeader(conf.Version)),
}

return &fcmClient{
Expand Down
Loading