AWS Lambda running NodeJS and Pusher Beams for iOS notifications

Introduction

In this tutorial, We’re going to explore how we can setup Pusher Beams on an iOS client using an AWS Lambda function running NodeJS to trigger the notifications.

Pusher Beams allows you to customize push notifications you send to your devices via a server. However it can be expensive to run a server 24 hours a day 7 days a week and we may only need to send notifications every so often. This is where AWS Lambda can help. Lambda functions are serverless and work on a pay as you go model (with a generous free tier). This means that you only pay for when you use the function.

Prerequisites

• A free AWS account. You can create one here.
• A free Pusher account. You can create one here.
• NodeJS 8.10+ installed on your local machine. Download here.
• Xcode 10+
• MacOS
• An iOS device for testing notifications.
• An understanding of iOS development and Xcode environment.
• Cocoapods - Install instructions here.

Create your Lambda function

Creating a Pusher Beams instance

Login or create an account to access your dashboard here. Create a new beams instance using the dashboard.

Complete step one of the iOS setup guide, by providing your APNS key and team ID and clicking Continue. We will pick up the remainder later on in this tutorial. Press the X to exit the setup guide and you will be returned to your dashboard for that instance. Scroll to the bottom of the page and you will find your Beams instance ID and secret key, make note of these you will need them later.

Writing our function

We will need to install our packages and write our function on our local machine before we can upload it to a Lambda function. Create a new working directory on your local machine and within that create a file named index.js. Run the following command in your terminal working directory:

    $ npm init

Press the Return key for each of the commands and run the following commands:

bash
1$ npm install async --save
2    $ npm install @pusher/push-notifications-server --save
Copy

Open your index.js file and add the following code:

javascript
1// index.js
2    exports.handler = function(event, context, callback) {
3        const PushNotifications = require('@pusher/push-notifications-server');
4        let beamsClient = new PushNotifications({
5          instanceId: 'YOUR_INSTANCE_ID',
6          secretKey: 'YOUR_SECRET_KEY'
7        });
8        beamsClient.publishToInterests(['hello'], {
9          apns: {
10            aps: {
11              "alert" : {
12                "title" : event.title,
13                "body" : event.message
14              },
15            }
16          }
17        }).then((publishResponse) => {
18           callback(null, 'Just published:' + publishResponse.publishId);
19        }).catch((error) => {
20          callback(error);
21        });
22    };
Copy

This code will be used by our Lambda function later on to publish notifications to devices that our registered for the hello interest. We use the event.title and event.message to form part of the message. We’ll look at this in more detail when we come to test our integration. Remember to replace YOUR_INSTANCE_ID and YOUR_SECRET_KEY with the credentials from your Pusher Beams console.

Next we need to compress the directory we have been working in and make a .zip such that we can upload our code and dependencies to our function later on. Name your zip file NodeJS.zip.

Creating a Lambda function

Log in or create an account to access your AWS console here. Once you are logged in use the search bar to find Lambda and select it from the list.

Note: Set your AWS region to N. Virginia in the top right if it is not already.

You should be redirected to the Lambda service and see an option Create Function, select this. Choose the Author from Scratch option at the top of the next page. This will provide us a basic “hello world” template we can use to create our function. Complete the basic setup as shown in the image below.

• Function name - Name this whatever you want for example “Pusher-Beams-NodeJS”.
• Runtime - We will be using Node.js 8.10 so select this from the drop down list.
• Execution role - Select Create a new role from AWS policy templates. If you already have a role you would rather use you can select Use an existing role.
• Role name - You can name this anything you like for example “lambda_basic_execution”.
• Policy templates - You can leave this blank.

Once complete select the Create function button at the bottom of the page. You should be redirected to your Lambda function console once it has been created. We can ignore the Designer section of the console. This area allows us to tie together different AWS services, you may wish to use this with a production function such that it can be accessed from the wider internet. However, we will just be using the test service for the purpose of this tutorial.

Now we need to upload our code. In the Function code section select the Upload a .zip file from the Code entry type dropdown menu. Use the Upload button to search your local machine for the NodeJS.zip we created earlier. Finally change the Handler to be NodeJS/index.handler, this will allow AWS Lambda to find our function within our folder. If everything looks like the below image click Save in the top right.

The default timeout for a Lambda function is three seconds, this may not be long enough for our function to complete. Scroll down the page to Basic Settings and change the timeout to be ten seconds. This should be enough time for our function to send the notification. Click Save before continuing.

Create your iOS application

Now that we have created our Lambda function, we need to have a user that has actually registered for notifications and signed up for the hello interest so we can test out our implementation. We’re going to create a very basic app that doesn’t actually show anything to the user except for the notification on the lock screen.

Project setup

Create a new Single View App using Xcode and name it something like LambdaPush. Once the project is created we need to install the Beams SDK. Open the terminal and go to the working directory of the newly created project and run the following command.

    $ pod init

Open the newly created Podfile and add the following pod:

    pod 'PushNotifications'

In the terminal run:

    $ pod install

Make sure you close your Xcode project and reopen the newly created Xcode Workspace before continuing. Within your project capabilities make sure you have switched on the Push Notifications capability. Also turn on the Background Modes capability and tick the box for Remote Notifications.

Open your AppDelegate.swift file and replace its contents with the following. Remembering to replace the instance ID with your own.

swift
1// AppDelegate.swift
2    import UIKit
3    import PushNotifications
4    
5    @UIApplicationMain
6    class AppDelegate: UIResponder, UIApplicationDelegate {
7        var window: UIWindow?
8        let pushNotifications = PushNotifications.shared
9    
10        func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
11            self.pushNotifications.start(instanceId: "YOUR_INSTANCE_ID")
12            self.pushNotifications.registerForRemoteNotifications()
13            try? self.pushNotifications.subscribe(interest: "hello")
14    
15            return true
16        }
17    
18        func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
19            self.pushNotifications.registerDeviceToken(deviceToken)
20        }
21    
22        func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable: Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
23            self.pushNotifications.handleNotification(userInfo: userInfo)
24        }
25    }
Copy

You can now run the application on your iOS device and accept to receive notifications. The SDK will then manage registering our interest in hello. Remember to replace YOUR_INSTANCE_ID with your instance ID credential from your Pusher Beams console.

Testing our implementation

Return to your Lambda function console. In the top right select the Test button. We need to configure a test option. Create a new test event like the below image. Notice how our keys in the JSON object are title and message. These are the event keys we were using in our code to provide the title and body for the push notification.

Once you are done press the Create button at the bottom. The dialog box will close and the test HelloTest should be selected in the dropdown menu by the Test button, Press Test. If everything has worked as expected you should receive a push to your device and a similar log output from your Lambda console.

Conclusion

We’ve learnt how to create an AWS Lambda function using NodeJS that can publish a push notification using Pusher Beams to an iOS device. The source code for this tutorial can be found here.