This module allows a player to be notified of events using long-polling.
Notificatinos are created by other ganomede services by posting notification:
Notificatinos from different services will be of different type and will contain different data, but following fields will always be present in every notification:
{ "id": '12', // String Notification ID
"timestamp": 1429084002258, // JSTimestmap Created at this time
"from": "turngame/v1", // String Created by this service
"type": "invitation", // String Notification type (depends on the service)
"data": {} // Object Notification data (depends on the service and type)
"push": {} // Object Optional, include if you want this notification to be also sent as push-notification to user devices.
}Notifications containing .push object will also be sent as push notifications to user devices. Payload of that push notification will contain original ganomede notification. Fields in .push describe how notification will be displayed to user.
{ "app": "triominos/v1" // String, required Which app to notify
"title": [ "localization-key", "args..." ], // String[], optional
"message": [ "localization-key", "args..." ], // String[], optional
"titleArgsTypes": [ ], // String[], optional
"messageArgsTypes": [ "username..." ] // String[], optional
}.push.title and .push.message must be String arrays of at least 1 length containing localization key at [0] followed by any number of localization arguments. If either title, or message, or both are not present, notificaiton alert will default to config.pushApi.apn.defaultAlert string.
.push.messageArgsTypes and .push.titleArgsTypes define the types of localization arguments. Use specific types here so service will perform lookups and expand your arguments into "better-looking" strings.
Note: arg type considered special if it is formated as <type>:<subtype> (contains : char). Arg type is passed to expansion function:
type part will be used to lookup expansion function (name of export from translators.coffee);subtype is used by you to further specify how to expand a string (but only used by your expansion func);all of info is grouped inside PushTranslator.Translatable instance:
Translatable {
field: 'title',
type: 'directory:email', // arg type
index: 3, // index in the title array
value: 'alice' // original string at that index
}For example:
// Based in userIds, this…
{ "title": [ "invite-title", "Invitation mailed to ", "alice" ],
"titleArgsTypes": [ "string", "directory:email" ],
"message": [ "invite-message", "bob", " invited you somewhere nice. Details are in your email, ", "alice", "." ],
"messageArgsTypes": [ "directory:username", "string", "directory:username", "string" ]
}
// …will get expanded to this:
{ "title": [ "invite-title", "Invitation mailed to ", "alice@wonderland.com" ],
"titleArgsTypes": [ "string", "directory:email" ],
"message": [ "invite-message", "Magnificent Bob", " invited you somewhere nice. Details are in your email, ", "Alice of the Wonderland", "." ],
"messageArgsTypes": [ "directory:username", "string", "directory:username", "string" ]
}For now, only aliases are expanded from userIds via ganomede-directory. See translators.coffee for details.
Variables available for service configuration (see config.js):
PORTROUTE_PREFIXREDIS_AUTH_PORT_6379_TCP_ADDR — IP of the AuthDB redisREDIS_AUTH_PORT_6379_TCP_PORT — Port of the AuthDB redisNODE_ENV — Antything except production means that app is running in development (debug) modeREDIS_NOTIFICATIONS_PORT_6379_TCP_ADDR — Redis notifications hostREDIS_NOTIFICATIONS_PORT_6379_TCP_PORT — Redis notifications portMESSAGE_QUEUE_SIZE — Redis notifications queue sizeAPI_SECRET — Secret passcode required to send notificationsONLINE_LIST_SIZE — Redis list size with users most recently onlineONLINE_LIST_INVISIBLE_MATCH - Regex matching invisible playersREDIS_ONLINELIST_PORT_6379_TCP_ADDR — Redis online list hostREDIS_ONLINELIST_PORT_6379_TCP_PORT — Redis online list portDIRECTORY_PORT_8000_TCP_[ADDR|PORT|PROTOCOL] - Link to ganomede-directory (optional)REDIS_PUSHAPI_PORT_6379_TCP_ADDR — Redis host for storing push tokensREDIS_PUSHAPI_PORT_6379_TCP_PORT — Redis port for storing push tokensAPN_CERT_FILEPATH — Path to .pem file with APN certificateAPN_CERT_BASE64 — Base64 encoded APN certificate (pem)APN_KEY_FILEPATH — Path to .pem file with APN private keyAPN_KEY_BASE64 — Base64 encoded APN private key (pem)GCM_API_KEY — API key for Google Cloud MessagingNODE_ENV - set to production to connect to the production gateway. Otherwise it will connect to the sandbox.BATCH_SIZE — Size of the batch of messages to process each iteration (default: 10)+ Parameters
+ authToken (string, required) ... Authentication token+ GET parameters
+ after (integer) ... All message received after the one with given IDWill retrieve all recent messages for the given user. In case no new messages are available, the request will wait for data until a timeout occurs.
[{
"id": 12,
"timestamp": 1429084002258,
"from": "turngame/v1",
"type": "MOVE",
"data": { ... }
},
{
"id": 19,
"timestamp": 1429084002258,
"from": "invitations/v1",
"type": "INVITE",
"data": { ... }
}]If authToken is invalid.
{
"to": "some_username",
"from": "turngame/v1",
"secret": "some secret passphrase",
"type": "MOVE",
"data": { ... }
}{
"id": 12
"timestamp": 1429084002258
}If secret is invalid.
The value of "secret" should be equal to the API_SECRET environment variable.
Alias to /notifications/v1/online/default (listid = default)
Alias to /auth/:authToken/online/default (listid = default)
List of players in the the listid list of online users.
Will return a list of usernames of most recently online users. Lists are publicly available (no API_SECRET or auth required).
[ "username",
"alice",
...
"bob"
]User is online.
Add user to the list of online players with id listid, returns the list of users.
The list is trimmed at ONLINE_LIST_SIZE most recent users.
[
"username",
"alice",
...
"bob"
]Saves user's push notifications token to database. Example Body:
{
app: 'substract-game', // String, which app this token is for
type: 'apn', // String, which push notifications provider
// this token is for, `apn` or `gcm`
// (see Token.TYPES)
value: 'alicesubstracttoken' // token value
}The server doesn't send push notifications, only add them to a task list. A worker will read from this task list and do the actual sending.
Worker is found in src/push-api/sender-cli.coffee
A way of running it continously is through the push-worker.sh script, that'll spawn one worker every second.