Swiftpack.co - Package - MihaelIsaev/FCM

Mihael Isaev

Intro 👏

It's a swift lib that gives ability to send push notifications through Firebase Cloud Messaging.

Built for Vapor4 and depends on JWT Vapor lib.

💡Vapor3 version is available in vapor3 branch and from 1.0.0 tag

If you have great ideas of how to improve this package write me (@iMike#3049) in Vapor's discord chat or just send pull request.

Hope it'll be useful for someone :)

Install through Swift Package Manager ❤️

Edit your Package.swift

//add this repo to dependencies
.package(url: "https://github.com/MihaelIsaev/FCM.git", from: "2.7.0")
//and don't forget about targets
//.product(name: "FCM", package: "FCM")

How it works ?

First of all you should configure FCM in configure.swift

import FCM

// Called before your application initializes.
func configure(_ app: Application) throws {
    /// case 1
    /// with service account json file
    /// put into your environment variables the following key:
    /// FCM_SERVICE_ACCOUNT_KEY_PATH=path/to/serviceAccountKey.json
    app.fcm.configuration = .envServiceAccountKey
    
    /// case 2
    /// put into your environment variables the following keys:
    /// FCM_EMAIL=...          // `client_email` in service.json
    /// FCM_PROJECT_ID=...     // `project_id` in service.json
    /// FCM_PRIVATE_KEY=...    // `private_key` in service.json
    app.fcm.configuration = .envServiceAccountKeyFields

    /// case 3
    /// put into your environment variables the following keys:
    /// FCM_EMAIL=...
    /// FCM_PROJECT_ID=...
    /// FCM_KEY_PATH=path/to/key.pem
    app.fcm.configuration = .envCredentials

    /// case 4
    /// manually
    app.fcm.configuration = .init(email: "...", projectId: "...", key: "...")
}

⚠️ TIP: serviceAccountKey.json you could get from Firebase Console

🔑 Just go to Settings -> Service Accounts tab and press Create Private Key button in e.g. NodeJS tab

OPTIONAL: Set default configurations, e.g. to enable notification sound

Add the following code to your configure.swift after app.fcm.configuration = ...

app.fcm.configuration?.apnsDefaultConfig = FCMApnsConfig(headers: [:], 
                                                         aps: FCMApnsApsObject(sound: "default"))

app.fcm.configuration?.androidDefaultConfig = FCMAndroidConfig(ttl: "86400s",
                                                               restricted_package_name: "com.example.myapp",
                                                               notification: FCMAndroidNotification(sound: "default"))
                                                
app.fcm.configuration?.webpushDefaultConfig = FCMWebpushConfig(headers: [:],
                                                               data: [:],
                                                               notification: [:])

Let's send first push notification! 🚀

Then you could send push notifications using token, topic or condition.

Here's an example route handler with push notification sending using token

import FCM

func routes(_ app: Application) throws {
    app.get("testfcm") { req -> EventLoopFuture<String> in
        let token = "<YOUR FIREBASE DEVICE TOKEN>" // get it from iOS/Android SDK
        let notification = FCMNotification(title: "Vapor is awesome!", body: "Swift one love! ❤️")
        let message = FCMMessage(token: token, notification: notification)
        return req.fcm.send(message, on: req.eventLoop).map { name in
            return "Just sent: \(name)"
        }
    }
}

fcm.send returns message name like projects/example-3ab5c/messages/1531222329648135

FCMMessage struct is absolutely the same as Message struct in Firebase docs https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages So you could take a look on its source code to build proper message.

Batch sending

Preparation

  1. Go to Firebase Console -> Project Settings -> Cloud Messaging tab
  2. Copy Server Key from Project Credentials area
  3. Put server key into environment variables as FCM_SERVER_KEY=<YOUR_SERVER_KEY> (or put it into serviceAccountKey.json file as server_key)

Sending

// get it from iOS/Android SDK
let token1 = "<YOUR FIREBASE DEVICE TOKEN>"
let token2 = "<YOUR FIREBASE DEVICE TOKEN>"
let token3 = "<YOUR FIREBASE DEVICE TOKEN>"
...
let token100500 = "<YOUR FIREBASE DEVICE TOKEN>"

let notification = FCMNotification(title: "Life is great! 😃", body: "Swift one love! ❤️")
let message = FCMMessage(notification: notification)
application.fcm.batchSend(message, tokens: [token1, token2, token3, ..., token100500]).map {
    print("sent!")
}

APNS to Firebase token conversion

You can throw away Firebase libs from dependencies of your iOS apps because you can send pure APNS tokens to your server and it will register it in Firebase by itself.

It is must have for developers who don't want to add Firebase libs into their apps, and especially for iOS projects who use Swift Package Manager cause Firebase doesn't have SPM support for its libs yet.

How to use

Preparation

  1. Go to Firebase Console -> Project Settings -> Cloud Messaging tab
  2. Copy Server Key from Project Credentials area

Next steps are optional

  1. Put server key into environment variables as FCM_SERVER_KEY=<YOUR_SERVER_KEY> (or put it into serviceAccountKey.json file as server_key)
  2. Put your app bundle identifier into environment variables as FCM_APP_BUNDLE_ID=<APP_BUNDLE_ID>

Tokens registration

/// The simplest way
/// .env here means that FCM_SERVER_KEY and FCM_APP_BUNDLE_ID will be used
application.fcm.registerAPNS(.env, tokens: "token1", "token3", ..., "token100").flatMap { tokens in
    /// `tokens` is array of `APNSToFirebaseToken` structs
    /// which contains:
    /// registration_token - Firebase token
    /// apns_token - APNS token
    /// isRegistered - boolean value which indicates if registration was successful
}

/// instead of .env you could declare your own identifier
extension RegisterAPNSID {
   static var myApp: RegisterAPNSID { .init(appBundleId: "com.myapp") }
}

/// Advanced way
application.fcm.registerAPNS(
    appBundleId: String, // iOS app bundle identifier
    serverKey: String?, // optional server key, if nil then env variable will be used
    sandbox: Bool, // optional sandbox key, false by default
    tokens: [String], // an array of APNS tokens
    on: EventLoop? // optional event loop, if nil then application.eventLoopGroup.next() will be used
).flatMap { tokens in
    /// the same as in above example
}

💡 Please note that push token taken from Xcode while debugging is for sandbox, so either use .envSandbox or don't forget to set sandbox: true

Contributors

Special thanks to @grahamburgsma for GoogleError and FCMError #10

Github

link
Stars: 74

Dependencies

Used By

Total: 0

Releases

Fix memory issues (#26) by @grahamburgsma -

  • Use Vapor client instead to get helpers and reduce lower level work
  • Update all other uses of client
  • Generalize response error handling

Implement one more convenient initialization -

app.fcm.configuration = .envServiceAccountKeyFields

it will initialize FCM by reading the following environment variables

FCM_EMAIL - `client_email` in service.json
FCM_PROJECT_ID - `project_id` in service.json
FCM_PRIVATE_KEY - `private_key` in service.json

☄️ Implement batch sending -

// get it from iOS/Android SDK
let token1 = "<YOUR FIREBASE DEVICE TOKEN>"
let token2 = "<YOUR FIREBASE DEVICE TOKEN>"
let token3 = "<YOUR FIREBASE DEVICE TOKEN>"
...
let token100500 = "<YOUR FIREBASE DEVICE TOKEN>"

let notification = FCMNotification(title: "Life is great! 😃", body: "Swift one love! ❤️")
let message = FCMMessage(notification: notification)
application.fcm.batchSend(message, tokens: [token1, token2, token3, ..., token100500]).map {
    print("sent!")
}

🔥 Implement pure APNS to Firebase token converter -

Now you can throw away Firebase libs from dependencies of your iOS apps because you can send pure APNS tokens to your server and it will register it in Firebase by itself.

It is must have for developers who don't want to add Firebase libs into their apps, and especially for iOS projects who use Swift Package Manager cause Firebase doesn't have SPM support for its libs yet.

How to use

Preparation

  1. Go to Firebase Console -> Project Settings -> Cloud Messaging tab
  2. Copy Server Key from Project Credentials area

Next steps are optional

  1. Put server key into environment variables as FCM_SERVER_KEY=<YOUR_SERVER_KEY>
  2. Put your app bundle identifier into environment variables as FCM_APP_BUNDLE_ID=<APP_BUNDLE_ID>

Tokens registration

/// The simplest way
/// .env here means that FCM_SERVER_KEY and FCM_APP_BUNDLE_ID will be used
application.fcm.registerAPNS(.env, tokens: "token1", "token3", ..., "token100").flatMap { tokens in
    /// `tokens` is array of `APNSToFirebaseToken` structs
    /// which contains:
    /// registration_token - Firebase token
    /// apns_token - APNS token
    /// isRegistered - boolean value which indicates if registration was successful
}

/// instead of .env you could declare your own identifier
extension RegisterAPNSID {
   static var myApp: RegisterAPNSID { .init(appBundleId: "com.myapp") }
}

/// Advanced way
application.fcm.registerAPNS(
    appBundleId: String, // iOS app bundle identifier
    serverKey: String?, // optional server key, if nil then env variable will be used
    sandbox: Bool, // optional sandbox key, false by default
    tokens: [String], // an array of APNS tokens
    on: EventLoop? // optional event loop, if nil then application.eventLoopGroup.next() will be used
).flatMap { tokens in
    /// the same as in above example
}

Fix annoying moments -

  • fix annoying warning: cannot modify client configuration after client has been used
  • add send method with eventLoop argument to avoid manual hop(to:) call so now if you send from Request you could write
req.fcm.send(message, on: req.eventLoop)

instead of

req.fcm.send(message).hop(to: req.eventLoop)

New properties for `FCMAndroidNotification` (#18) -

Thanks to @nerzh ❤️

New properties for `FCMAndroidNotification` (#18) -

Thanks to @nerzh ❤️

Vapor 4 🚀 -

Please read the readme to get all the details

Add `sendMessage` to the FCMProvider protocol -

Add sendMessage to the FCMProvider protocol so it can be mocked in tests (#13)

Added FCMError to make handling specific errors easier -

Many thanks to @grahamburgsma

So, now we can parse Google and FCM errors, let's take a look how

return try fcm.sendMessage(container.make(Client.self), message: message).transform(to: ()).catchFlatMap { error in
    guard let googleError = error as? GoogleError, let fcmError = googleError.fcmError else {
        return container.eventLoop.newFailedFuture(error: error)
    }
    switch fcmError.errorCode {
    case .unspecified: break
    case .invalid: break
    case .unregistered: break
    case .senderIDMismatch: break
    case .quotaExceeded: break
    case .apnsAuth: break
    case .unavailable: break
    case .internal: break
    }
}

And now we can delete token if we're getting unregistered error like this:

return try fcm.sendMessage(container.make(Client.self), message: message).transform(to: ()).catchFlatMap { error in
    guard let googleError = error as? GoogleError, let fcmError = googleError.fcmError else {
        return container.eventLoop.newSucceededFuture(result: ())
    }
    switch fcmError.errorCode {
        case .unregistered: // drop token only if unregistered
            return container.requestPooledConnection(to: .psql).flatMap { conn in
                return Self.query(on: conn).filter(\.firebaseToken == token).first().flatMap { model in
                    defer { try? container.releasePooledConnection(conn, to: .psql) }
                    guard var model = model else { return container.eventLoop.newSucceededFuture(result: ()) }
                    model.firebaseToken = nil
                    return model.save(on: conn).transform(to: ())
                }.always {
                    try? container.releasePooledConnection(conn, to: .psql)
                }
            }
        default:
            return container.eventLoop.newSucceededFuture(result: ())
    }
}

Throw an error if unable to get access token -

Fixing access token refreshing -

This is fixing unexpected behavior when the server is unable to send pushes after an hour after launch.