A Generic Enabler (GE) compatible with the FIWARE ecosystem to support Firebase Cloud Messaging.
This GE serves to complement the FIWARE ecosystem. Namely to allow the ORION subscription's notification to be send by Firebase cloud messaging (FCM) to mobile devices. An example of a mobile application that can work with this module is on the ScorpiusClient project
It is also possible to use the POST /notifyMessage endpoint to send simple notifications.
The Request to this endpoint should contain a body with the following structure:
{
"topic": "b3ed663cee243170b55f5f0396905d12",
"message": "Test with some message"
}Where the topic is the topic to which the user wants to send notifications and the message is the message to be sent in the data of the notification.
Only FCM notification by topic are supported.
For now only ORION subscriptions with the "attrsFormat":"keyValues" are supported.
That is subscriptions with this format:
{
"description": "A subscription to send notification by FCM using the scorpius GE",
"expires": "2040-01-01T14:00:00.00Z",
"subject": {
"entities": [
{
"idPattern": ".*",
"type": "questionnaire"
}
],
"condition": {
"attrs": ["course"]
}
},
"notification": {
"attrs": [
],
"attrsFormat": "keyValues",
"http": {
"url": "http://scorpius/notify"
}
}
}Notifications should be send to the POST /notify endpoint.
To define a new subscription path you should complemt the notification.json file, with a specific configuration for each type of entity.
There are 4 types of notifications attributes that can be used:
-
topic: The topic to which the notification must be sent. (default=$"{id}") -
message: A text message to be displayed or analysed by the subscribers of the topic. (default="New {type}") -
type: Type of the notification to be used for filtering by clients (default="{type}"). -
shouldSend: expression to validate if the notification should be sent by FCM (default="true") .
None of these values are required, and all of them have a default value; The default value for each of them can be seen in the list above.
These values can be hard coded or can be expressions that include the attributes of the entity. An example of a configuration for an entity of the type questionnaire that has the attribute course:
{
"questionnaire": {
"topic": "{course}",
"message": "New {type}",
"type": "new_{type}",
"shouldSend": "{time_type}==scheduled"
},
"course":{},
"car":{
"topic":"car_{color}",
"message": "A new car entity update"
}
}The notification received by orion should include the attributes used to define the path of the Scorpius notification, as such be aware of the filter in the notification.attrs field when creating the ORION's subscriptions.
Additionally, there could be an empty definiton, as for the example for the "course" entity, in that case all of the default values will be assumed.
All of the attributes are straight forward apart from the shouldSend which support expressions that can be validated to boolean.
The expressions can be hard coded or can use attributes of the entity to choose if the notification is sent or not.
For instance if we only want to send notifications about can entities that are red:
{
"car":{
"shouldSend":"{color}==red"
}
}For now this is function only support boolean values (e.g., "true", "false" or attribute mapping that gives those values)
or expressions of equality (==) and inequality (!=).
If the entity type contains a boolean attribute mapping can also be done directly:
{
"car":{
"shouldSend":"{booleanAttr}"
}
}Negation of attributes (!) is not implemented yet as such you the inequality or equality examples should be used "shouldSend": "{booleanAttr}==false" or "shouldSend": "{booleanAttr}!=true"
This is a smaller use case since ORION subscriptions already allow the filtering of subscription's notification by expressions.
Since The notification definition is made based on the entity type, only one notification per entity type is allowed.
If you required several distinct notification for the same entity type, you should deploy more instances of this GE (each with a ORION subscription).
To configure the service you need to replace the firebase-admin.json with your firebase crednetials file. If the file as a different name change the mapping in th appsettings.json file, under the FirebaseCM.AppConfig to your file path.
Additionally you need to define your notifications in the notification.json file;
The server runs by default in the port 80(http) and 443(https). But you can change this configurations in the
To run the Scorpius GE you need to have .Net6 installed. .NET6 is a powerfull cross-platform tool that allows the creation of several types of cross-platform applications, as well as microservices, MVC servers and web pages. To download and install the .NET6 to your system follow the instruction from microsoft website
If you have Visual studio 2022 or later installed you should be able to also download and install through the VS Installer.
clone the repository:
git clone https://github.com/jmSfernandes/ScorpiusGE.gitmove to the project directory:
cd ScorpiusGE\Scorpiusbuild the project:
dotnet buildExecute project by either running the .exe or the .dll:
//dll
dotnet bin\Debug\net6\Scorpius.dll
// windows executable
bin\Debug\net6\Scorpius.exeThe easiest and recommended way to use this component is by using a docker container. You can build your own by cloning the code and building the container:
git clone https://github.com/jmSfernandes/ScorpiusGE.git
cd ScorpiusGE
docker build -t jmsfernandes/scorpius:latest .Or you can pull the latest build from 🐳 DockerHub
docker pull jmsfernandes/scorpius:latestThe recommended way to use this module is to boot it up with a docker compose script, that you can add to the rest of your services definitions for other FIWARE GE (e.g, ORION, etc..)
version: "2.0"
services:
scorpius:
image: jmsfernandes/scorpius:latest
hostname: scorpius
container_name: scorpius
restart: always
expose:
- '80'
- '443'
ports:
- "80:80"
- "443:443"
environment: # if we dont need/want https support, you can comment all of these lines
- ASPNETCORE_URLS=https://+;http://+
- Kestrel__Certificates__Default__Path=/app/Certs/cert.pem
- Kestrel__Certificates__Default__KeyPath=/app/Certs/key.pem
volumes:
- ./Scorpius/custom-firebase_admin.json:/app/firebase_admin.json # map your firebase_admin.json config file
#- ./Scorpius/custom-notifications.json:/app/notifications.json #map your notification path to inside of the
- ./Scorpius/Certs/cert.pem:/app/Certs/cert.pem #map the certificates and priv key to inside of the container
- ./Scorpius/Certs/key.pem:/app/Certs/key.pem
logging:
options:
max-size: 50m
Note: your should replace the custom-firebase_admin.json mapping with your firebase admin key file. Otherwise the boot will fail.
You should also uncomment the custom-notification.json and mapp it for your own notification definition file.
You can then start the service with:
docker-compose up -dMIT License
Copyright (c) 2022 J. Fernandes
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.