FCM Support #620

mirkode · 2021-07-07T19:02:39Z

This PR is a rough draft to handle the new Firebase Cloud Messaging protocol.

It currently only works by setting the needed authentication params as ENV variables.
Those are:

FIREBASE_PROJECT_ID
GOOGLE_ACCOUNT_TYPE
GOOGLE_CLIENT_ID
GOOGLE_CLIENT_EMAIL
GOOGLE_PRIVATE_KEY
(please refer to lib/rpush/daemon/fcm/delivery.rb:147

The code is based off of the gcm implementation.

Also what is still missing are tests for everything fcm related.

aried3r · 2021-08-16T11:11:12Z

Hey! Thanks for the PR. Are you using this code in production already or is this an extraction from production and you're not using this fork directly?

Testing push notifications is sadly a bit tricky since it's a long running task which also relies on clients and Google itself, so I'd love to hear at least a little success story. :)

Ping @wolak88, I believe you were also interested in this.

mirkode · 2021-08-17T08:19:05Z

Hi @aried3r,

yes, I am using my fork quite reliably in production.
All FCM notifications are delivered as they are supposed to and until now I am quite happy.
And I obviously hope that Google is not touching the protocol again haha!
I needed to deliver FCM notifications quite urgently, which is why it now resulted in that rather hacky ENV variable solution.

I was also thinking putting more effort in and also save the Firebase variables in the database, but in the end I was simply lacking time :)

Joe-noh · 2021-09-17T10:05:17Z

lib/rpush/client/active_model/fcm/notification.rb

+ 'token' => device_token
+ }
+ json['content_available'] = content_available if content_available
+ json['notification'] = alert if alert


@mirkode

Sorry for jumping in. Thank you for implementing FCM support.

I'm trying to send push notification to iOS app with this branch, but the notification does not show up.

n = Rpush::Fcm::Notification.new n.app = Rpush::Fcm::App.find_by(name: '...') n.device_token = '***' n.priority = 'normal' n.notification = { title: 'Hello' } n.save!

Rpush log says it sent succesfully but the Notification JSON does not have message.notification field.

pry(main)> Rpush::Fcm::Notification.first.as_json => {"message"=> {"data"=>nil, "android"=> {"notification"=> {"title"=>"Hello", "notification_priority"=>"PRIORITY_DEFAULT", "default_sound"=>true}, "priority"=>5, "ttl"=>"86400s"}, "token"=> "***"}}

Then I dig into this PR code, found this line. I am not sure this is the cause of the problem I have, I guess this should be:

Suggested change

json['notification'] = alert if alert

json['notification'] = notification if notification

or handle alert like

rpush/lib/rpush/client/active_record/apns/active_record_serializable_notification.rb

Lines 16 to 32 in 31ae99c

def alert

string_or_json = read_attribute(:alert)

if has_attribute?(:alert_is_json)

if alert_is_json?

multi_json_load(string_or_json)

else

string_or_json

end

else

begin

multi_json_load(string_or_json)

rescue StandardError

string_or_json

end

end

end

Hi @Joe-noh ,

Thanks for your suggestion!
If it is working for you, I don't see any issue changing it to that.
I think I remember that I had a reason to change it to that, but I would need to look into this again, since this was quite some time ago :)

Thanks a lot

@mirkode

I forked and committed Joe-noh@9c81ece, then successfully pushed notification to iOS app. A bit naive implementation though, just FYI.

aried3r · 2021-09-17T11:43:38Z

Once we have tests, maybe we can release this as an experimental feature so more people can submit feedback. It doesn't seem to be breaking existing functionality. However I'm a bit hesitant to add more gems. I wonder if we should have optional dependencies for this and perhaps also the webpush code?

Perhaps something like rpush-fcm, rpush-webpush gems would make sense. Anyway, that's beyond the scope of this PR.

WDYT @rpush/maintainers?

benlangfeld · 2021-09-17T22:14:37Z

Once we have tests, maybe we can release this as an experimental feature so more people can submit feedback. It doesn't seem to be breaking existing functionality. However I'm a bit hesitant to add more gems. I wonder if we should have optional dependencies for this and perhaps also the webpush code?

Perhaps something like rpush-fcm, rpush-webpush gems would make sense. Anyway, that's beyond the scope of this PR.

WDYT @rpush/maintainers?

I like that idea.

There is a type mismatch between message.notification and message.android.notification. The message.notification only accepts the attributes title, body, and image, whereas message.android.notification holds all the rest of the configuration. So in order to use message.notification along with message.android.notification there would be the need for an additional database field called something like android_configuration

See rpush#620 for further information

aried3r · 2022-05-23T13:46:36Z

lib/rpush/reflection_collection.rb

- :notification_failed, :notification_will_retry, :gcm_delivered_to_recipient,
- :gcm_failed_to_recipient, :gcm_canonical_id, :gcm_invalid_registration_id,
+ :notification_failed, :notification_will_retry, :fcm_delivered_to_recipient,
+ :fcm_failed_to_recipient, :fcm_canonical_id, :fcm_invalid_device_token,


Will this change not affect the GCM implementation of Rpush? I'd assume we should add, rather than replace the new reflections.

aried3r · 2022-05-23T13:50:34Z

lib/rpush/client/active_model/fcm/notification.rb

+ def as_json(options = nil) # rubocop:disable Metrics/PerceivedComplexity
+ json = {
+ 'data' => data,
+ 'android' => android_config,


I'm assuming this meant that this PR only implements Android support for FCM, not iOS, web etc?

aried3r · 2022-05-23T14:20:46Z

lib/rpush/daemon/fcm/delivery.rb

+
+ def obtain_access_token
+ authorizer = ::Google::Auth::ServiceAccountCredentials.make_creds(scope: SCOPE)
+ authorizer.fetch_access_token


I could only find the bang-! version of this. https://googleapis.dev/ruby/googleauth/latest/Signet/OAuth2/Client.html#fetch_access_token!-instance_method. Is there an alias for it somewhere that I'm missing?

In general, I'm wondering if this is the most efficient implementation. As far as I understand, this will always request a new token, even if it hasn't expired yet.

This article mentions caching it. I don't think we need to use Google's cache stores but could use Rails.cache for it. There's also a .needs_access_token? helper. For this we'd need at least v1.1.0 of googleauth according to googleapis/google-auth-library-ruby#347.

What do you think?

Some debug logs would probably help, because I don't recall how often Delivery is being instantiated off the top of my head.

aried3r · 2022-05-23T14:21:00Z

lib/rpush/daemon/gcm/delivery.rb

-end
+end


Please revert this change.

Ankita9818 · 2023-05-02T11:02:18Z

Any updates on this PR?? When will we be merging it to the core rpush??

kmsopra · 2023-09-13T07:00:24Z

Thanks everyone for the great work already put into this topic.

Can I somehow offer my help in order to finalise it?

michaltomaszwlodarczyk · 2023-09-20T10:45:43Z

any news?

RowanH · 2023-12-05T18:56:09Z

I'm sure we all just got the reminder email that June '24 is the decommission date of this API. @aried3r as you appear to be one of the maintainers here what's the plan for ongoing support of Rpush library?. I keep checking back and there's no commits in the main repo, and this particular change which seems fundamentally pivotal to Rpush being viable has not had any commentary.

While it certainly seems that this is the go-to gem, it also seems like it might be not maintained going forward? As I said above very happy to help in what way we can (beer/gift cards etc!) to help show our appreciation, we're just not at the skill level that we would trust taking on core maintenance or providing an alternative pull request to resolve some of the PR feedback above.

Also would be very useful to know if this isn't going to be maintained going forward so we can put in place alternative strategies. I completely understand this is the downside of a library becoming popular that overtime people just don't have the time to commit to it... it works so well we don't want to ditch it :)

viktor-shmigol · 2023-12-06T09:26:47Z

lib/rpush/daemon/fcm/delivery.rb

+ @notification = notification
+ @batch = batch
+
+ @uri = URI.parse("#{HOST}/v1/projects/#{ENV['FIREBASE_PROJECT_ID']}/messages:send")


I think it's better to add firebase_project_id and other firebase credentials to the app model instead of the env variables.
There are projects which are supporting multi-project functionality such as "WhiteLabel" apps. At this point it will be an issue to support multiple apps.
Why not add credentials to the Rpush::Fcm::App in the same way as Rpush::Apnsp8::App?

E.g:

app = Rpush::Fcm::App.new( name: 'My app', project_id: ENV['FIREBASE_PROJECT_ID'], account_type: ENV['FIREBASE_ACCOUNT_TYPE'], client_id: ENV['FIREBASE_CLIENT_ID'], client_email: ENV['FIREBASE_CLIENT_EMAIL'], private_key: ENV['FIREBASE_PRIVATE_KEY'] ) app.save!

then just get these credentials from the app.

@uri = URI.parse("#{HOST}/v1/projects/#{app.project_id}/messages:send")

Thanks!

KevinColemanInc · 2024-01-19T01:40:11Z

@mirkode are you still working on this? If not, can I (or someone else?) take this on? The deadline is in 5 months (June 2024).

Get tests working without all the ENV variables

AnilRh · 2024-01-24T00:54:14Z

I made an effort to keep this MR alive - see #660. /cc @mirkode

See rpush#620 for further information

Get tests working without all the ENV variables

mirkode mentioned this pull request Jul 7, 2021

Support for FCM HTTP v1 #588

Open

Joe-noh reviewed Sep 17, 2021

View reviewed changes

mirkode added 4 commits April 27, 2022 16:47

Implement proof of concept authorization

74b4258

Fix logger error

509dae4

Add some fields to AndroidNotification

d8559d6

mirkode force-pushed the fcm-support branch from eab8c34 to 8f3cacf Compare April 27, 2022 14:53

mirkode added 2 commits April 27, 2022 20:44

Fix notification handling in fcm/notification.rb

0279be2

See rpush#620 for further information

Add comment to necessary_data_exists? method

9e083a9

aried3r requested changes May 23, 2022

View reviewed changes

viktor-shmigol reviewed Dec 6, 2023

View reviewed changes

AnilRh added a commit to AnilRh/rpush that referenced this pull request Jan 24, 2024

Adding debug line requested in PR rpush#620

fb5d567

Get tests working without all the ENV variables

AnilRh mentioned this pull request Jan 24, 2024

FCM support - v1.1 #660

Open

Adrian1707 pushed a commit to Adrian1707/rpush that referenced this pull request Apr 24, 2024

Fix notification handling in fcm/notification.rb

7269fbc

See rpush#620 for further information

Adrian1707 pushed a commit to Adrian1707/rpush that referenced this pull request Apr 24, 2024

Adding debug line requested in PR rpush#620

d6aefc2

Get tests working without all the ENV variables

nat-aryucharoen mentioned this pull request May 14, 2024

JS-7167 Add fcm api support Codefied/rpush#13

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FCM Support #620

FCM Support #620

mirkode commented Jul 7, 2021

aried3r commented Aug 16, 2021

mirkode commented Aug 17, 2021

Joe-noh Sep 17, 2021

mirkode Sep 17, 2021

Joe-noh Sep 27, 2021

aried3r commented Sep 17, 2021

benlangfeld commented Sep 17, 2021

aried3r May 23, 2022

aried3r May 23, 2022

aried3r May 23, 2022

aried3r May 23, 2022

Ankita9818 commented May 2, 2023

kmsopra commented Sep 13, 2023

michaltomaszwlodarczyk commented Sep 20, 2023

RowanH commented Dec 5, 2023

viktor-shmigol Dec 6, 2023 •

edited

KevinColemanInc commented Jan 19, 2024

AnilRh commented Jan 24, 2024

	json['notification'] = alert if alert
	json['notification'] = notification if notification

	def alert
	string_or_json = read_attribute(:alert)

	if has_attribute?(:alert_is_json)
	if alert_is_json?
	multi_json_load(string_or_json)
	else
	string_or_json
	end
	else
	begin
	multi_json_load(string_or_json)
	rescue StandardError
	string_or_json
	end
	end
	end

FCM Support #620

Are you sure you want to change the base?

FCM Support #620

Conversation

mirkode commented Jul 7, 2021

aried3r commented Aug 16, 2021

mirkode commented Aug 17, 2021

Joe-noh Sep 17, 2021

Choose a reason for hiding this comment

mirkode Sep 17, 2021

Choose a reason for hiding this comment

Joe-noh Sep 27, 2021

Choose a reason for hiding this comment

aried3r commented Sep 17, 2021

benlangfeld commented Sep 17, 2021

aried3r May 23, 2022

Choose a reason for hiding this comment

aried3r May 23, 2022

Choose a reason for hiding this comment

aried3r May 23, 2022

Choose a reason for hiding this comment

aried3r May 23, 2022

Choose a reason for hiding this comment

Ankita9818 commented May 2, 2023

kmsopra commented Sep 13, 2023

michaltomaszwlodarczyk commented Sep 20, 2023

RowanH commented Dec 5, 2023

viktor-shmigol Dec 6, 2023 • edited

Choose a reason for hiding this comment

KevinColemanInc commented Jan 19, 2024

AnilRh commented Jan 24, 2024

viktor-shmigol Dec 6, 2023 •

edited