Skip to content

Commit

Permalink
Merge branch 'PrescribeFIT-pkm/support-gcp-default-application-creden…
Browse files Browse the repository at this point in the history 
…tials'
  • Loading branch information
@hpopp
hpopp committed Sep 10, 2024
2 parents 043e09a + 10ef21a commit eb296f3
Show file tree
Hide file tree
Showing 8 changed files with 196 additions and 125 deletions.
2 changes: 1 addition & 1 deletion config/test.exs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ config :pigeon, PigeonTest.APNS.JWT,
config :pigeon, PigeonTest.FCM,
adapter: Pigeon.FCM,
project_id: System.get_env("FCM_PROJECT"),
service_account_json: System.get_env("FCM_SERVICE_ACCOUNT_JSON")
token_fetcher: PigeonTest.Goth

config :pigeon, PigeonTest.Sandbox, adapter: Pigeon.Sandbox
5 changes: 3 additions & 2 deletions lib/pigeon/dispatcher.ex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ defmodule Pigeon.Dispatcher do
opts = [
adapter: Pigeon.FCM,
project_id: "example-project-123",
service_account_json: File.read!("service-account.json")
token_fetcher: YourApp.Goth
]
{:ok, pid} = Pigeon.Dispatcher.start_link(opts)
Expand All @@ -33,6 +33,7 @@ defmodule Pigeon.Dispatcher do
@doc false
def start(_type, _args) do
children = [
{Goth, name: YourApp.Goth},
YourApp.Repo,
{Registry, keys: :unique, name: Registry.YourApp}
] ++ push_workers()
Expand Down Expand Up @@ -62,7 +63,7 @@ defmodule Pigeon.Dispatcher do
adapter: Pigeon.FCM,
name: {:via, Registry, {Registry.YourApp, config.name}},
project_id: config.project_id,
service_account_json: config.service_account_json
token_fetcher: String.to_existing_atom(config.token_fetcher)
]}
end
end
Expand Down
127 changes: 68 additions & 59 deletions lib/pigeon/fcm.ex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,16 @@ defmodule Pigeon.FCM do
end
```
2. (Optional) Add configuration to your `config.exs`.
2. Configure the [`goth`](https://hexdocs.pm/goth/1.4.3/readme.html#installation) library, and add it to `config.exs`
```
# config.exs
# See Step 3 for alternative configuration
config :your_app, YourApp.FCM,
adapter: Pigeon.FCM,
project_id: "example-project-123",
service_account_json: File.read!("service-account.json")
token_fetcher: YourApp.Goth
```
3. Start your dispatcher on application boot.
Expand All @@ -35,6 +36,7 @@ defmodule Pigeon.FCM do
@doc false
def start(_type, _args) do
children = [
{Goth, name: YourApp.Goth},
YourApp.FCM
]
opts = [strategy: :one_for_one, name: YourApp.Supervisor]
Expand All @@ -43,7 +45,7 @@ defmodule Pigeon.FCM do
end
```
If you skipped step two, include your configuration.
If preferred, you can include your configuration directly
```
defmodule YourApp.Application do
Expand All @@ -54,6 +56,7 @@ defmodule Pigeon.FCM do
@doc false
def start(_type, _args) do
children = [
{Goth, name: YourApp.Goth},
{YourApp.FCM, fcm_opts()}
]
opts = [strategy: :one_for_one, name: YourApp.Supervisor]
Expand All @@ -64,7 +67,7 @@ defmodule Pigeon.FCM do
[
adapter: Pigeon.FCM,
project_id: "example-project-123",
service_account_json: File.read!("service-account.json")
token_fetcher: YourApp.Goth
]
end
end
Expand All @@ -75,63 +78,97 @@ defmodule Pigeon.FCM do
```
n = Pigeon.FCM.Notification.new({:token, "reg ID"}, %{"body" => "test message"})
```
5. Send the notification.
On successful response, `:name` will be set to the name returned from the FCM
API and `:response` will be `:success`. If there was an error, `:error` will
5. Send the notification.
On successful response, `:name` will be set to the name returned from the FCM
API and `:response` will be `:success`. If there was an error, `:error` will
contain a JSON map of the response and `:response` will be an atomized version
of the error type.
```
YourApp.FCM.push(n)
```
## Customizable Goth Token Fetcher
If you need a customizable `:token_fetcher` that handles fetching its own configuration, here's
an example you can use to get started.
For other `:source` configurations of `YourApp.Goth`, check out the `goth` documentation for [`Goth.start_link/1`](https://hexdocs.pm/goth/Goth.html#start_link/1)
```
# lib/your_app/goth.ex
defmodule YourApp.Goth
@spec child_spec(any()) :: Supervisor.child_spec()
def child_spec(_args) do
env_opts = Keyword.new(Application.get_env(:your_app, YourApp.Goth, []))
opts = Keyword.merge([name: YourApp.Goth], env_opts)
%{
:id => YourApp.Goth,
:start => {Goth, :start_link, [opts]}
}
end
end
# config.exs
config :your_app, YourApp.Goth, source: {:metadata, []}
# config/test.exs
config :your_app, YourApp.Goth,
source: {:metadata, []},
http_client: {&PigeonTest.GothHttpClient.Stub.access_token_response/1, []}
# application.exs
def start(_type, _args) do
children = [
# The `child_spec/1` handles fetching the proper config
YourApp.Goth,
YourApp.FCM
]
opts = [strategy: :one_for_one, name: YourApp.Supervisor]
Supervisor.start_link(children, opts)
end
```
"""

@max_retries 3

defstruct config: nil,
queue: Pigeon.NotificationQueue.new(),
refresh_before: 5 * 60,
retries: @max_retries,
socket: nil,
stream_id: 1,
token: nil
stream_id: 1

@behaviour Pigeon.Adapter

alias Pigeon.{Configurable, NotificationQueue}
alias Pigeon.Http2.{Client, Stream}

@refresh :"$refresh"
@retry_after 1000

@scopes [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase.messaging"
]

@impl true
@impl Pigeon.Adapter
def init(opts) do
config = Pigeon.FCM.Config.new(opts)

Configurable.validate!(config)

state = %__MODULE__{config: config}

with {:ok, socket} <- connect_socket(config),
{:ok, token} <- fetch_token(config) do
Configurable.schedule_ping(config)
schedule_refresh(state, token)
{:ok, %{state | socket: socket, token: token}}
else
{:error, reason} -> {:stop, reason}
case connect_socket(config) do
{:ok, socket} ->
Configurable.schedule_ping(config)
{:ok, %{state | socket: socket}}

{:error, reason} ->
{:stop, reason}
end
end

@impl true
@impl Pigeon.Adapter
def handle_push(notification, state) do
%{config: config, queue: queue, token: token} = state
headers = Configurable.push_headers(config, notification, token: token)
%{config: config, queue: queue} = state
headers = Configurable.push_headers(config, notification, [])
payload = Configurable.push_payload(config, notification, [])

Client.default().send_request(state.socket, headers, payload)
Expand All @@ -146,7 +183,7 @@ defmodule Pigeon.FCM do
{:noreply, state}
end

@impl true
@impl Pigeon.Adapter
def handle_info(:ping, state) do
Client.default().send_ping(state.socket)
Configurable.schedule_ping(state.config)
Expand All @@ -171,22 +208,6 @@ defmodule Pigeon.FCM do
end
end

def handle_info(@refresh, %{config: config} = state) do
case fetch_token(config) do
{:ok, token} ->
schedule_refresh(state, token)
{:noreply, %{state | retries: @max_retries, token: token}}

{:error, exception} ->
if state.retries > 0 do
Process.send_after(self(), @refresh, @retry_after)
{:noreply, %{state | retries: state.retries - 1}}
else
raise "too many failed attempts to refresh, last error: #{inspect(exception)}"
end
end
end

def handle_info(msg, state) do
case Client.default().handle_end_stream(msg, state) do
{:ok, %Stream{} = stream} -> process_end_stream(stream, state)
Expand All @@ -210,18 +231,6 @@ defmodule Pigeon.FCM do
end
end

defp fetch_token(config) do
source = {:service_account, config.service_account_json, [scopes: @scopes]}
Goth.Token.fetch(%{source: source})
end

defp schedule_refresh(state, token) do
time_in_seconds =
max(token.expires - System.system_time(:second) - state.refresh_before, 0)

Process.send_after(self(), @refresh, time_in_seconds * 1000)
end

@doc false
def process_end_stream(%Stream{id: stream_id} = stream, state) do
%{queue: queue, config: config} = state
Expand Down
Loading

0 comments on commit eb296f3

Please sign in to comment.