Skip to content

fix(fcm): Add ability to override default FCM endpoint via ClientOptions #373

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

Merged
merged 8 commits into from
May 28, 2020
Merged

fix(fcm): Add ability to override default FCM endpoint via ClientOptions #373

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
229d5e0
Add FIREBASE_MESSAGING_ENDPOINT environment variable to override defa…
May 15, 2020
d673f91
Use endpoint while creating new messaging client
May 16, 2020
26cba31
Add tests for custom endpoint
May 22, 2020
1a91e9a
Simplify setting default endpoint
May 22, 2020
5541e11
Remove redundant code
May 27, 2020
0ea9702
Fix formatting
May 27, 2020
4fb4994
Fix imports order
May 27, 2020
151cf08
Merge branch 'dev' into issue-189
hiranya911 May 28, 2020
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
38 changes: 38 additions & 0 deletions firebase_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import (
"testing"
"time"

"firebase.google.com/go/messaging"
"golang.org/x/oauth2"
"golang.org/x/oauth2/google"
"google.golang.org/api/option"
Expand Down Expand Up @@ -361,6 +362,43 @@ func TestMessaging(t *testing.T) {
}
}

func TestMessagingSendWithCustomEndpoint(t *testing.T) {
name := "custom-endpoint-ok"

ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
w.Write([]byte("{ \"name\":\"" + name + "\" }"))
}))
defer ts.Close()

ctx := context.Background()

tokenSource := &testTokenSource{AccessToken: "mock-token-from-custom"}
app, err := NewApp(
ctx,
nil,
option.WithCredentialsFile("testdata/service_account.json"),
option.WithTokenSource(tokenSource),
option.WithEndpoint(ts.URL),
Copy link
Contributor

@hiranya911 hiranya911 May 26, 2020

Choose a reason for hiding this comment

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

Only WithEndpoint() should be sufficient here.

Copy link
Author

@kl177 kl177 May 27, 2020

Choose a reason for hiding this comment

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

It gives an error only with WithEndpoint():

app, err := NewApp(ctx, nil, option.WithEndpoint(ts.URL))
if err != nil {
    t.Fatal(err)
}

c, err := app.Messaging(ctx)
if c == nil || err != nil {
    t.Fatalf("Messaging() = (%v, %v); want (iid, nil)", c, err)
}
--- FAIL: TestMessagingSendWithCustomEndpoint (0.59s)
    firebase_test.go:390: Messaging() = (<nil>, project ID is required to access Firebase Cloud Messaging client); want (iid, nil)

Copy link
Contributor

@hiranya911 hiranya911 May 27, 2020

Choose a reason for hiding this comment

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

Ok, I suppose the transport still requires some sort of a credential. In that case let's keep option.WithTokenSource(). You definitely don't need WithCredentialsFile() when a TokenSource is explicitly provided.

Copy link
Author

@kl177 kl177 May 28, 2020

Choose a reason for hiding this comment

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

It seems WithCredentialsFile() is required to provide project id. It gives an error without WithCredentialsFile():

tokenSource := &testTokenSource{AccessToken: "mock-token-from-custom"}
app, err := NewApp(
    ctx,
    nil,
    //option.WithCredentialsFile("testdata/service_account.json"),
    option.WithTokenSource(tokenSource),
    option.WithEndpoint(ts.URL),
)
if err != nil {
    t.Fatal(err)
}

c, err := app.Messaging(ctx)
if c == nil || err != nil {
    t.Fatalf("Messaging() = (%v, %v); want (iid, nil)", c, err)
}
--- FAIL: TestMessagingSendWithCustomEndpoint (0.00s)
    firebase_test.go:390: Messaging() = (<nil>, project ID is required to access Firebase Cloud Messaging client); want (iid, nil)

Copy link
Contributor

@hiranya911 hiranya911 May 28, 2020

Choose a reason for hiding this comment

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

Ah! :(

)
if err != nil {
t.Fatal(err)
}

c, err := app.Messaging(ctx)
if c == nil || err != nil {
t.Fatalf("Messaging() = (%v, %v); want (iid, nil)", c, err)
}

msg := &messaging.Message{
Token: "...",
}
n, err := c.Send(ctx, msg)
if n != name || err != nil {
t.Errorf("Send() = (%q, %v); want (%q, nil)", n, err, name)
}
}

func TestCustomTokenSource(t *testing.T) {
ctx := context.Background()
ts := &testTokenSource{AccessToken: "mock-token-from-custom"}
Expand Down
12 changes: 8 additions & 4 deletions messaging/messaging.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -913,13 +913,17 @@ func NewClient(ctx context.Context, c *internal.MessagingConfig) (*Client, error
return nil, errors.New("project ID is required to access Firebase Cloud Messaging client")
}

hc, _, err := transport.NewHTTPClient(ctx, c.Opts...)
hc, endpoint, err := transport.NewHTTPClient(ctx, c.Opts...)
if err != nil {
return nil, err
}

if endpoint == "" {
endpoint = messagingEndpoint
}

return &Client{
fcmClient: newFCMClient(hc, c),
fcmClient: newFCMClient(hc, c, endpoint),
iidClient: newIIDClient(hc),
}, nil
}
Expand All @@ -932,7 +936,7 @@ type fcmClient struct {
httpClient *internal.HTTPClient
}

func newFCMClient(hc *http.Client, conf *internal.MessagingConfig) *fcmClient {
func newFCMClient(hc *http.Client, conf *internal.MessagingConfig, endpoint string) *fcmClient {
client := internal.WithDefaultRetryConfig(hc)
client.CreateErrFn = handleFCMError
client.SuccessFn = internal.HasSuccessStatus
Expand All @@ -944,7 +948,7 @@ func newFCMClient(hc *http.Client, conf *internal.MessagingConfig) *fcmClient {
}

return &fcmClient{
fcmEndpoint: messagingEndpoint,
fcmEndpoint: endpoint,
batchEndpoint: batchEndpoint,
project: conf.ProjectID,
version: version,
Expand Down
37 changes: 37 additions & 0 deletions messaging/messaging_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1126,6 +1126,43 @@ func TestSend(t *testing.T) {
}
}

func TestSendWithCustomEndpoint(t *testing.T) {
var tr *http.Request
var b []byte
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
tr = r
b, _ = ioutil.ReadAll(r.Body)
w.Header().Set("Content-Type", "application/json")
w.Write([]byte("{ \"name\":\"" + testMessageID + "\" }"))
}))
defer ts.Close()

ctx := context.Background()

conf := *testMessagingConfig
optEndpoint := option.WithEndpoint(ts.URL)
conf.Opts = append(conf.Opts, optEndpoint)

client, err := NewClient(ctx, &conf)
if err != nil {
t.Fatal(err)
}

if ts.URL != client.fcmEndpoint {
t.Errorf("client.fcmEndpoint = %q; want = %q", client.fcmEndpoint, ts.URL)
}

for _, tc := range validMessages {
t.Run(tc.name, func(t *testing.T) {
name, err := client.Send(ctx, tc.req)
if name != testMessageID || err != nil {
t.Errorf("Send(%s) = (%q, %v); want = (%q, nil)", tc.name, name, err, testMessageID)
}
checkFCMRequest(t, b, tr, tc.want, false)
})
}
}

func TestSendDryRun(t *testing.T) {
var tr *http.Request
var b []byte
Expand Down