Library to send mock remote notifications to the iOS simulator

Last update: Dec 20, 2022

Overview

SimulatorRemoteNotifications

SimulatorRemoteNotifications is a library to send mock remote notifications to the iOS simulator.

The library extends UIApplication by embedding a mini server that listen for UDP packets containing JSON-formated payload, and a service to send notifications to the mini server.

This project includes the iOS Simulator Notifications MacOSX app to help you send the mock notifications.

Note that SimulatorRemoteNotifications does not send notification through Apple's Push Service.

Install

Install with CocoaPods

Add a pod entry to your Podfile:

pod 'SimulatorRemoteNotifications', '~> 0.0.3'

Install the pod(s) by running:

pod install

Install the static library

Copy the project file in your project
Link your binary with the library, under Target > Build Phases > Link binary with libraries then add the libSimulatorRemoteNotifications.a
set OTHER_LINKER_FLAGS="-ObjC" for your target

Install manually

clone this repository
add the files in the SimulatorRemoteNotifications directory to your project
set OTHER_LINKER_FLAGS="-ObjC" for your target

Usage

Listening for mock remote notifications

First add #import "UIApplication+SimulatorRemoteNotifications.h" to your application delegate.

Then implement either application:didReceiveRemoteNotification: or application:didReceiveRemoteNotification:fetchCompletionHandler: (background notification, iOS7).

Finally call start listening for mock remote notifications:

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

	...

	#if DEBUG
		[application listenForRemoteNotifications];
	#endif

	return YES;
}

When listenForRemoteNotifications is called, application:didRegisterForRemoteNotificationsWithDeviceToken: receives a token in the following format instead of random characters: simulator-remote-notification=IP:PORT

The default port number is 9930. If you want to change the port, use setRemoteNotificationsPort before calling listenForRemoteNotifications:

application.remoteNotificationsPort = 1234;

Now, to send a remote notification, send an udp packet to localhost:9930.

Note that if you send a notification while the app is in the background, application:didReceiveRemoteNotification:fetchCompletionHandler: will only be called when you bring the app to the foreground.

Sending a mock remote notification with the iOS Simulator Notifications app

The project comes with a OSX app called iOS Simulator Notifications to help you send notifications to the iOS Simulator.

Build and run the target and you'll have a nice interface to send notification to your app in the simulator (see screenshots).

Sending a mock remote notification in tests

First add #import "ACSimulatorRemoteNotificationsService.h" to your test

Send you notification with

[[ACSimulatorRemoteNotificationsService sharedService] send:@{@"message":@"message"}];

You can change the host (default: 127.0.0.1) and port (default: 9930) with

[[ACSimulatorRemoteNotificationsService sharedService] setRemoteNotificationsPort:1234];
[[ACSimulatorRemoteNotificationsService sharedService] setRemoteNotificationsHost:@"10.0.0.1"];

Sending a mock remote notification from the command line

You can also send mock remote notifications from the terminal by using netcat:

echo -n '{"message":"message"}' | nc -4u -w1 localhost 9930

Screenshot

Examples

You can look at SimulatorRemoteNotifications.xcodeproj for examples:

in SimulatorRemoteNotificationsExample, the application:didReceiveRemoteNotification: method is called
in SimulatorRemoteNotificationsBackgroundExample, the application:didReceiveRemoteNotification:fetchCompletionHandler: method is called

Documentation

If you have appledoc installed, you can generate the documentation by running the corresponding target.

Note

(Real) Apple remote notifications are limited to 256 bytes content length.

Comments

Added support for iOS 7

As outlined in:

https://developer.apple.com/library/ios/documentation/uikit/reference/UIApplicationDelegate_Protocol/Reference/Reference.html#//apple_ref/occ/intfm/UIApplicationDelegate/application:didReceiveRemoteNotification:

If your delegate also implements the application:didReceiveRemoteNotification:fetchCompletionHandler: method, the app object calls that method instead of this one.

opened by mwhuss 5
Does this support IOS7?

It seems that it does not work in IOS7. My environment is MAC OSX 10.9/Xcode5.0.2/IOS7.

I excited the commands in terminal but nothing happened,why?

opened by yunzixun 2
Error with Code = 3840

I send two JSON's: echo -n '{"aps":{"alert" : "message","badge" : 99,"sound" : "default"},"storeId" : 5475878}' | nc -4u -w1 localhost 9930

echo -n '{"aps":{"alert" : "message","badge" : 99,"sound" : "default"},"storeId" : 54758}' | nc -4u -w1 localhost 9930

Difference only in storeId. First works fine, but second causes error: SimulatorRemoteNotification: error = Error Domain=NSCocoaErrorDomain Code=3840 "The operation couldn’t be completed. (Cocoa error 3840.)" (Garbage at end.) UserInfo=0xb23dc90 {NSDebugDescription=Garbage at end.}

I tried to resolve this issue but failed: When we take string from buffer in second case string looks like this: {"aps":{"alert" : "message","badge" : 99,"sound" : "default"},"storeId" : 54758 }}

Two braces instead of one in first case.

I don't understand how could it be.

opened by DevAlloy 2
didReceiveRemoteNotification: fetchCompletionHandler - background

Hi, thanks a lot for this library !

didReceiveRemoteNotification: fetchCompletionHandler is called even if the app is in background when I send a notification from your iOS Simulator Notifications. (on 4s 9.0)

In your documentation, you said: Note that if you send a notification while the app is in the background, application:didReceiveRemoteNotification:fetchCompletionHandler: will only be called when you bring the app to the foreground.

How to call it only when I bring the app to the foreground ?

opened by grifas 1
Enabled didReceiveRemoteNotification: for iOS 7 apps that use old API

It seems that application:didReceiveRemoteNotification: should be called even if the app is running in iOS 7 because not all apps will have migrated to use the newer method that has a completion block.

opened by 5teveroy 1
$Change NULL to '\0'$

Change NULL to '\0'

at 44 line in UIApplication+SimulatorRemoteNotifications.m

How about change

__buffer[size] = NULL; to __buffer[size] = '\0';

for turn of [ Incompatible pointer to integer conversion assigning to 'char' from 'void *' ] warning ?

opened by iziz 1
4k buffer for modern iOS versions

This PR updates the notification buffer size to 4k matching current documentation modern http/2 non voip based notification payload sizes.

We hit the previous size limit during development/testing of our app, and this patch fixed the issue.

opened by crafterm 0
Updated notification payload size for iOS >= 8
Hello! First of all, I'd like to thank you for this nice tool!

I'm trying to simulate some notifications on an iOS 9 device, which supports a new payload size limit of either 2KB or 4KB. However, SimulatorRemoteNotification seems to truncate the payload after a certain amount of bytes (256?), which results in the following error:

SimulatorRemoteNotification: error = Error Domain=NSCocoaErrorDomain Code=3840 "Unterminated string around character 313." UserInfo={NSDebugDescription=Unterminated string around character 313.}

I tried multiplying the values of the following constants by 8, but this seemed to have no effect:

UIApplication+SimulatorRemoteNotifications.m\SimulatorRemoteNotificationsBufferLength ACSimulatorRemoteNotificationsService.m\SimulatorRemoteNotificationsServiceBufferLength

How can the code be modified to support the increased payload size?

P.S. I know the payload I'm testing is valid because it gets delivered successfully through APNS when testing with a real device.

(Edit: updated the link to the documentation where the payload size is discussed)
opened by Dev-iL 3
Disabling automaticQuoteSubstitutionEnabled for payloadTextView in the iOS Simulator Notifications Mac app.

Currently the NSTextView replaces any input quotes with quotes that break the JSON validation.

So "key":"value" becomes “key”:”value”. This just disables that in applicationDidFinishLaunching.

opened by adamtootle 0

Owner

Arnaud Coomans

GitHub

How to Add Local Push Notification With timeInterval & Test On Simulator

Technicalisto How to Add Local Push Notification With timeInterval & Test On Simulator In Project Target ( Signing & Capapilities ) Add Capapility : 1

0 Jun 24, 2022

Push notifications allow developers to reach users, even when users aren't actively using an app!

Push notifications allow developers to reach users, even when users aren't actively using an app! With the latest update of iOS Apple provide very useful extensions which are user-friendly. In this tutorial, I am going to share the configuration, set up of Notification with the media attachments like.