feat: Send Android push notifications to Firebase Cloud Messaging API (HTTP v1) by setting the push adapter option `firebaseServiceAccount` #222

jimnor0xF · 2023-08-20T15:08:31Z

New Pull Request Checklist

I am not disclosing a vulnerability.
I am creating this PR in reference to an issue.

Issue Description

Closes #219.

Adds FCM support to the parse-server-push-adapter.

Approach

Mostly re-uses the structure from GCM.js.
Currently makes all deviceTypes use FCM. Not sure if this is what we want.
Tested on both iOS and Android (flutter).
Requires the user to specify the exact payload they want.

https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages
Payload example:

  await Parse.Push.send(
    {
      where: query,
      notification: {
        title: title,
        body: body
      },
      data: {
        type: type
      },
      android: {
        priority: 'high'
      },
      apns: {
        headers: {
          'apns-priority': '5'
        },
        payload: {
          aps: {
            contentAvailable: true
          }
        }
      }
    },
    { useMasterKey: true }
  )

TODOs before merging

Add tests
Add entry to changelog
Add changes to documentation (guides, repository pages, in-code descriptions)

parse-github-assistant · 2023-08-20T15:08:34Z

Thanks for opening this pull request!

❌ Please link an issue that describes the reason for this pull request, otherwise your pull request will be closed. Make sure to write it as Closes: #123 in the PR description, so I can recognize it.

mtrezza · 2023-08-21T17:02:55Z

If I understand this PR correctly, you are adding a "raw FCM support" to the adapter, correct? That just to clarify, because this push adapter already has FCM support, in fact I believe GCM has been first deprecated in 2019 and has already been turned off by now. In code the term "GCM" is still used, but the payload is handled by dependency @parse/node-gcm which is already using FCM -- but with an API that is deprecated, as described in #219.

Currently makes all deviceTypes use FCM. Not sure if this is what we want.

I don't think so, because we'd force a developer to use a 3rd party service (Firebase) to send a push to APNS. But I think you're making a good point; it should be configurable to use FCM also for Apple devices. So we'll probably need a new adapter option to configure the routing according to deviceType.

Since this is our current adapter config structure:

push: {
    android: {
      apiKey: '...'
    },
    ios: {
      pfx: '/file/path/to/XXX.p12',
      passphrase: '', // optional password to your p12/PFX
      bundleId: '',
      production: false
    }
}

It's based on device type android, ios, so we could introduce new keys like ios.fcmApiKey and android.fcmApiKey. For ios.fcmApiKey it means that notifications to Apple devices will also be sent through FCM. For android.fcmApiKey it means hat it will require the "raw" FCM payload. For a developer it has the advantage that it's the same FCM payload structure bot all device types, if they configure the adapter this way and want to set up FCM to send pushes to APNS.

The "raw" FCM payload would be a breaking change from the current FCM payload if I'm not mistaken. We don't want this to be a breaking change, so while I think it makes sense allow to pass this "raw" payload, we would need an additional change to adapt the current "GCM" file to use the firebase-admin SDK while maintaining the current payload structure. But since you have already managed to write the "raw" FCM code, it would just require a payload conversion I assume?

I'd split this up into 2 changes (in 2 PRs if you like):

a) Change the current logic for Android pushes to use the new FCM API
b) Allow to send APNS pushes via FCM

jimnor0xF · 2023-08-21T20:24:39Z

Correct, and I agree with all points listed above. Mostly wanted to get something working quick for myself to begin with ;)
I'll go ahead with the approach you suggested.

mtrezza · 2023-08-21T23:42:53Z

Great, and thanks for taking this on, this is really a key issue for many Parse Server deployments.

jimnor0xF · 2023-09-16T22:08:44Z

@mtrezza
Addressed some of the above mentioned issues.

You mentioned this:
"so while I think it makes sense allow to pass this "raw" payload, we would need an additional change to adapt the current "GCM" file to use the firebase-admin SDK while maintaining the current payload structure."

GCM uses "apiKey" which is not compatible with the FCM v1 API. Instead, I added some logic so GCM payloads are supported in the FCM module.

If "rawPayload" is present in the Parse.Push.send method it will use the raw FCM payload instead.

codecov · 2023-09-16T22:26:54Z

Codecov Report

Attention: 67 lines in your changes are missing coverage. Please review.

Comparison is base (5536102) 100.00% compared to head (707223e) 81.38%.

❗ Current head 707223e differs from pull request most recent head cccba90. Consider uploading reports for the commit cccba90 to get more accurate results

Additional details and impacted files

@@             Coverage Diff              @@
##            master     #222       +/-   ##
============================================
- Coverage   100.00%   81.38%   -18.62%     
============================================
  Files            5        6        +1     
  Lines          277      360       +83     
============================================
+ Hits           277      293       +16     
- Misses           0       67       +67

Files	Coverage Δ
src/ParsePushAdapter.js	`95.12% <71.42%> (-4.88%)`	⬇️
src/FCM.js	`16.66% <16.66%> (ø)`

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

package.json

mtrezza · 2023-10-21T11:13:14Z

@jimnor0xF Would you be so king and rebase this PR to resolve the conflicts? I've done some upgrading in other PRs.

* Uses FCM if firebaseServiceAccount key is present in config.

jimnor0xF · 2023-10-30T14:48:35Z

@jimnor0xF Would you be so king and rebase this PR to resolve the conflicts? I've done some upgrading in other PRs.

Rebased.

mtrezza · 2023-10-30T17:57:53Z

The package-lock has a suspiciously large change, even though only 1 dep has been added; could you please use the file from alpha and just run npm i -ED firebase-admin@11.10.1?

mtrezza · 2023-11-06T18:58:03Z

@jimnor0xF Apologies, I wrote -ED, but this shouldn't be a dev dependency, right? Because it's currently only added under devDependencies. If this shouldn't be a dev dependency, could you use the alpha file again and just do npm i -E firebase-admin@11.10.1?

mtrezza · 2023-11-07T16:19:14Z

Thanks, running CI...

Credit goes to: https://github.com/jimnor0xF PR & Discussion: parse-community#222

paulrolfe · 2024-02-19T17:22:54Z

Hey, just wanted to say thank you for this PR @jimnor0xF, I've put it into use in my project to send pushes using FCM and it's working great. Hope it gets merged into master soon.

# [5.1.0](5.0.2...5.1.0) (2024-03-02) ### Features * Send Android push notifications to Firebase Cloud Messaging API (HTTP v1) by setting the push adapter option `firebaseServiceAccount` ([#222](#222)) ([be40b1d](be40b1d))

parseplatformorg · 2024-03-02T14:58:27Z

🎉 This change has been released in version 5.1.0

breadluvr · 2024-05-14T08:06:50Z

Hello,

I'm experiencing issues with integrating Firebase Cloud Messaging using a service account on Heroku with parse-server@7.1.0-alpha.6. While the server functions correctly with the older GCM API, transitioning to FCM with service account credentials leads to a generic Heroku error without detailed diagnostics. Here are the steps I've followed:

Base Installation: parse-server@7.1.0-alpha.6 works with the legacy GCM API.

Issue with FCM Service Account: Problems begin when configuring the firebaseServiceAccount for FCM.

Configuration Details:

I exported the service account JSON file from the Google Cloud Console.

Set up the service account credentials in the server configuration as follows:

push: {
  android: {
    firebaseServiceAccount: {
      type: "service_account",
      project_id: process.env.PUSH_ANDROID_PROJECT_ID,
      private_key_id: process.env.PUSH_ANDROID_PRIVATE_KEY_ID,
      private_key: process.env.PUSH_ANDROID_PRIVATE_KEY,
      client_email: process.env.PUSH_ANDROID_CLIENT_EMAIL,
      client_id: process.env.PUSH_ANDROID_CLIENT_ID,
      auth_uri: "https://accounts.google.com/o/oauth2/auth",
      token_uri: "https://oauth2.googleapis.com/token",
      auth_provider_x509_cert_url: "https://www.googleapis.com/oauth2/v1/certs",
      client_x509_cert_url: process.env.PUSH_ANDROID_CERT_URL,
      universe_domain: "googleapis.com",
    }
  }
}

I also tried using JSON.stringify on the object.

Alternative Attempt: I've also tried etting the firebaseServiceAccount as a path to the JSON file as suggested in spec/ParsePushAdapter.spec.js:

push: {
  android: {
    firebaseServiceAccount: path.join(__dirname, 'foo', 'bar.json')
  }
}

Both methods result in a generic Heroku error, and I'm unable to find relevant documentation on setting up the new FCM authentication method using a service account. Could you provide any insights or guidance on what might be causing these issues or how to resolve them?

mtrezza · 2024-05-14T08:18:19Z

There is a fix we'll merge. If you then still encounter a bug please open a new GitHub issue.

Note that we don't use GitHub for support. For help with Parse Platform we recommend our community forum or our community chat.

jimnor0xF mentioned this pull request Aug 20, 2023

Switch from node-gcm to firebase-admin dependency #219

Closed

3 tasks

mtrezza changed the title ~~Fcm support~~ feat: Add support for sending Apple push notifications via Firebase Cloud Messaging Aug 21, 2023

mtrezza changed the title ~~feat: Add support for sending Apple push notifications via Firebase Cloud Messaging~~ feat: Send Android push notifications to new Firebase Cloud Messaging API Aug 21, 2023

mtrezza requested changes Oct 6, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

jimnor0xF added 13 commits October 24, 2023 20:15

Stuff

937cd14

Use credential interface

23f2c0c

Change imports

83ddf79

Initialization

f6a8923

Test

ccf35c1

Fix

81c80b0

FCM support

3ab11bd

Not used, can specify TTL in the payload itself

2846f97

Adjust logging

fe9bb62

Fix

04529b5

const

61ee68b

typo

da9663d

* Adds backwards compatibility with old GCM payload.

ccdb678

* Uses FCM if firebaseServiceAccount key is present in config.

jimnor0xF force-pushed the fcm_support branch from f3e5f2c to ccdb678 Compare October 24, 2023 18:17

Update package.json/package-lock.json

07cb9ff

firebase-admin should not be in devDeps

cccba90

bdubale added a commit to bdubale/parse-server-push-adapter-fcm that referenced this pull request Feb 16, 2024

FCM support

04140e1

Credit goes to: https://github.com/jimnor0xF PR & Discussion: parse-community#222

mtrezza changed the title ~~feat: Send Android push notifications to new Firebase Cloud Messaging API~~ feat: Send Android push notifications to Firebase Cloud Messaging API (HTTP v1) Mar 2, 2024

mtrezza changed the title ~~feat: Send Android push notifications to Firebase Cloud Messaging API (HTTP v1)~~ feat: Send Android push notifications to Firebase Cloud Messaging API HTTP v1 Mar 2, 2024

mtrezza changed the title ~~feat: Send Android push notifications to Firebase Cloud Messaging API HTTP v1~~ feat: Send Android push notifications to Firebase Cloud Messaging API (HTTP v1) Mar 2, 2024

mtrezza changed the title ~~feat: Send Android push notifications to Firebase Cloud Messaging API (HTTP v1)~~ feat: Send Android push notifications to Firebase Cloud Messaging API (HTTP v1); requires setting the new push adapter config option firebaseServiceAccount Mar 2, 2024

mtrezza merged commit be40b1d into parse-community:master Mar 2, 2024
5 checks passed

parseplatformorg added the state:released label Mar 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Send Android push notifications to Firebase Cloud Messaging API (HTTP v1) by setting the push adapter option `firebaseServiceAccount` #222

feat: Send Android push notifications to Firebase Cloud Messaging API (HTTP v1) by setting the push adapter option `firebaseServiceAccount` #222

jimnor0xF commented Aug 20, 2023 •

edited by mtrezza

Loading

parse-github-assistant bot commented Aug 20, 2023 •

edited

Loading

mtrezza commented Aug 21, 2023 •

edited

Loading

jimnor0xF commented Aug 21, 2023

mtrezza commented Aug 21, 2023

jimnor0xF commented Sep 16, 2023 •

edited

Loading

codecov bot commented Sep 16, 2023 •

edited

Loading

mtrezza commented Oct 21, 2023

jimnor0xF commented Oct 30, 2023

mtrezza commented Oct 30, 2023 •

edited

Loading

mtrezza commented Nov 6, 2023 •

edited

Loading

mtrezza commented Nov 7, 2023

paulrolfe commented Feb 19, 2024

parseplatformorg commented Mar 2, 2024

breadluvr commented May 14, 2024 •

edited

Loading

mtrezza commented May 14, 2024 •

edited

Loading

feat: Send Android push notifications to Firebase Cloud Messaging API (HTTP v1) by setting the push adapter option firebaseServiceAccount #222

feat: Send Android push notifications to Firebase Cloud Messaging API (HTTP v1) by setting the push adapter option firebaseServiceAccount #222

Conversation

jimnor0xF commented Aug 20, 2023 • edited by mtrezza Loading

New Pull Request Checklist

Issue Description

Approach

TODOs before merging

parse-github-assistant bot commented Aug 20, 2023 • edited Loading

Thanks for opening this pull request!

mtrezza commented Aug 21, 2023 • edited Loading

jimnor0xF commented Aug 21, 2023

mtrezza commented Aug 21, 2023

jimnor0xF commented Sep 16, 2023 • edited Loading

codecov bot commented Sep 16, 2023 • edited Loading

Codecov Report

mtrezza commented Oct 21, 2023

jimnor0xF commented Oct 30, 2023

mtrezza commented Oct 30, 2023 • edited Loading

mtrezza commented Nov 6, 2023 • edited Loading

mtrezza commented Nov 7, 2023

paulrolfe commented Feb 19, 2024

parseplatformorg commented Mar 2, 2024

breadluvr commented May 14, 2024 • edited Loading

mtrezza commented May 14, 2024 • edited Loading

feat: Send Android push notifications to Firebase Cloud Messaging API (HTTP v1) by setting the push adapter option `firebaseServiceAccount` #222

feat: Send Android push notifications to Firebase Cloud Messaging API (HTTP v1) by setting the push adapter option `firebaseServiceAccount` #222

jimnor0xF commented Aug 20, 2023 •

edited by mtrezza

Loading

parse-github-assistant bot commented Aug 20, 2023 •

edited

Loading

mtrezza commented Aug 21, 2023 •

edited

Loading

jimnor0xF commented Sep 16, 2023 •

edited

Loading

codecov bot commented Sep 16, 2023 •

edited

Loading

mtrezza commented Oct 30, 2023 •

edited

Loading

mtrezza commented Nov 6, 2023 •

edited

Loading

breadluvr commented May 14, 2024 •

edited

Loading

mtrezza commented May 14, 2024 •

edited

Loading