Merge pull request #197 from RADAR-base/release-1.1.0

Release 1.1.0

Author: yatharthranjan

.gitignore

@@ -35,4 +35,8 @@
 /kubernetes
 
 # logs
-/logs
+/logs
+
+# vscode
+/.vscode
+bin/

Dockerfile

@@ -1,4 +1,4 @@
-FROM openjdk:11.0.1-jdk-slim AS builder
+FROM openjdk:11-jdk-slim AS builder
 
 RUN mkdir /code
 WORKDIR /code
@@ -11,10 +11,11 @@ RUN ./gradlew --version
 
 COPY ./build.gradle ./settings.gradle /code/
 COPY ./src /code/src
+COPY ./shadow-radar-auth /code/shadow-radar-auth
 
 RUN ./gradlew unpack
 
-FROM openjdk:11.0.1-jre-slim
+FROM openjdk:11-jre-slim
 
 LABEL maintainer="Yatharth Ranjan <yatharth.ranjan@kcl.ac.uk>"
 
@@ -26,6 +27,11 @@ ENV SPRING_PROFILES_ACTIVE prod
 VOLUME /tmp
 ARG DEPENDENCY=/code/build/dependency
 
+RUN apt-get update && apt-get install -y \
+        curl \
+        wget \
+        && rm -rf /var/lib/apt/lists/*
+
 COPY --from=builder ${DEPENDENCY}/BOOT-INF/lib /app/lib
 COPY --from=builder ${DEPENDENCY}/META-INF /app/META-INF
 COPY --from=builder ${DEPENDENCY}/BOOT-INF/classes /app

README.md

@@ -29,15 +29,21 @@ There is also support for legacy XMPP protocol for FCM.
 
         This will start the database at `localhost:9001`
 
-   3.2. To use as an embedded in-memory database instance (Not recommended for production deployments), set the `spring.datasource.url=jdbc:hsqldb:mem:/appserver` in `application-<profile>.properties`.
+   3.2. To use as an embedded in-memory database instance (Not recommended for production deployments), set the `spring.datasource.url=jdbc:hsqldb:mem:/appserver` in `application-<profile>.properties`.  Also, change the properties in `src/main/resources/application.properties` to dev or prod according to your requirements. 
 
-4. Build the project using gradle wrapper and run using spring boot. Note: This project uses JAVA 11, please download and install it before building. On mac or linux, run the below -
+4. Build the project using gradle wrapper and run using spring boot. Note: This project uses JAVA 11, please download and install it before building. 
+
+5. The build will need to create a logs directory. The default path is `/usr/local/var/lib/radar/appserver/logs`. Either create the directory there using `sudo mkdir -p /usr/local/var/lib/radar/appserver/logs` followed by `sudo chown $USER /usr/local/var/lib/radar/appserver/logs` or change logs file directory in `src/main/resources/logback-spring.xml` to local log directory like `<property name="LOGS" value="logs" />`
+
+6. There are 2 ways to communicate with the Firebase Cloud Messaging- XMPP and Admin SDK. At least one of these needs to be configured. To configure these, please look at the [FCM section](#fcm).
+
+7. To run the build on mac or linux, run the below -
    ```bash
     ./gradlew bootRun
    ```
    You can also run in an IDE (like IntelliJ Idea) by giving the `/src/main/java/org/radarbase/appserver/AppserverApplication.java` as the main class.
 
-5. The App-server is now connected to the FCM XMPP server and is able to send and receive messages. On your mobile application, try sending an upstream message using the FCM sdk for your platform. Notification scheduling parses payloads from upstream messages containing the action SCHEDULE. The format of the data payload of upstream message should contain at least-    
+8. The App-server is now connected to the FCM XMPP server and is able to send and receive messages. On your mobile application, try sending an upstream message using the FCM sdk for your platform. Notification scheduling parses payloads from upstream messages containing the action SCHEDULE. The format of the data payload of upstream message should contain at least-    
    ```json
     {
      "data":
@@ -54,11 +60,11 @@ There is also support for legacy XMPP protocol for FCM.
      }
    ```
 
-6. Voila!, you will now receive a notification at the schedule time (specified by `time` in the payload) on your device.
+9. Voila!, you will now receive a notification at the schedule time (specified by `time` in the payload) on your device.
 
-7. You can also achieve the same using more reliable and flexible REST API using the schedule endpoint. Please refer to REST API section below for more info.
+10. You can also achieve the same using more reliable and flexible REST API using the schedule endpoint. Please refer to REST API section below for more info.
 
-8. API documentation is available via Swagger UI when you launch the app server. Please refer to the Documentation section below.
+11. API documentation is available via Swagger UI when you launch the app server. Please refer to the Documentation section below.
 
 ## REST API
 
@@ -107,6 +113,8 @@ The same result as stated in [Getting Started](#getting-started) can be achieved
   There are other features provided via the REST endpoints. These can be explored using swagger-ui. Please refer to [Documentation](#documentation) section.
 
 ## FCM
+
+### XMPP
 The FCM related code is provided in the `org.radarbase.fcm` package. This can be explored in java-docs as mention in the [Documentation](#documentation) section.
 To use Firebase Cloud Messaging(FCM), you will need to configure the following properties -
 
@@ -116,7 +124,11 @@ To use Firebase Cloud Messaging(FCM), you will need to configure the following p
 | fcmserver.serverkey | Server Key from FCM. Can be found in the FCM project settings                             |                      NA                      |    Yes    |
 | fcmserver.fcmsender | The Sender to use for sending messages. There is a choice of using XMPP or FCM Admin SDK. | `org.radarbase.fcm.downstream.XmppFcmSender` |    No     |
 
-**Note:** Only sending messages via XMPP protocol supports Delivery Receipts on FCM.
+**Note:** Only sending messages via XMPP protocol supports Delivery Receipts on FCM. 
+
+### AdminSDK
+To configure AdminSDK, follow the official Firebase [documentation](https://firebase.google.com/docs/admin/setup#initialize-sdk) till you setup the enviroment variable. In the properties file, you would need to change `fcmserver.fcmsender` to `org.radarbase.fcm.downstream.AdminSdkFcmSender` and set `fcmserver.xmpp.upstream.enable` to `false`. 
+
 
 ## Docker/ Docker Compose
 The AppServer is also available as a docker container. It's [Dockerfile](/Dockerfile) is provided with the project. It can be run as follows -
@@ -132,7 +144,7 @@ The same can be achieved by running as a docker-compose service. Just specify th
 ```yml
     services:
       appserver:
-        image: radarbase/radar-appserver:0.0.1
+        image: radarbase/radar-appserver:1.1.0
         restart: always
         ports:
           - 8080:8080
@@ -344,7 +356,7 @@ To enable security of specific provider, please read the sections below.
 ### Management Portal
 To enable security via the [RADAR Management Portal](https://github.com/RADAR-base/ManagementPortal), set the following property -
 ```ini
-managementportal.security.enabled=true
+security.radar.managementportal.url=true
 ```
 This will instantiate all the classes needed for security using the management portal. Per endpoint level auth is controlled using Pre and Post annotations for each permission.
 All the classes are located in [/src/main/java/org/radarbase/appserver/auth/managementportal](/src/main/java/org/radarbase/appserver/auth/managementportal). 
@@ -468,20 +480,4 @@ This will run checkstyle, PMD, spot bugs, unit tests and integration tests.
 - Uses [lombok.data](https://projectlombok.org/) in most places to reduce boiler plate code and make it more readable.
 - Has support for Auditing of database entities.
 - Uses and extends the Spring XMPP integration library for implementing the XMPP protocol. 
-- Extends `XmppConnectionFactoryBean` with support for Reconnection and connection draining implementation using a Back-off strategy.
-
-### TODO
-
-- Add better documentation.
-- Add validation of notification requests using the protocol and enrolment date of the user.
-- Add endpoint to filter notifications based on different params.
-- ~~Update lastOpened metric for user when a request is received.~~
-- ~~Add batch scheduling of notifications.~~
-- Add Management Portal service for getting any missing info not present in a request.
-- Add support for sending messages via Firebase Admin SDK.
-- ~~Make the Xmpp Connection more robust by adding reconnection logic.~~
-- Break out the org.radarbase.fcm package into its own module to be used as a library.
-- ~~Add docker builds.~~
-- Add a Angular UI to view, update and schedule/send notifications to subjects.
-- Investigate the feasibility of adding as an integration to the Management Portal for various tasks. (For instance, a new token can be sent via push notification using a button on MP to the device if the token has expired).
-- ~~Add security to the application using MP OAuth client resource.~~
+- Extends `XmppConnectionFactoryBean` with support for Reconnection and connection draining implementation using a Back-off strategy.

build.gradle

@@ -15,6 +15,7 @@ plugins {
     id "com.github.spotbugs" version "4.5.0"
     id 'jacoco'
     id "com.github.lkishalmi.gatling" version "3.3.4"
+    id 'com.github.johnrengelman.shadow' version '6.1.0'
 }
 
 apply plugin: 'java'
@@ -24,7 +25,7 @@ apply plugin: 'io.spring.dependency-management'
 apply plugin: 'scala'
 
 group = 'org.radarbase'
-version = '1.0.0'
+version = '1.1.0'
 sourceCompatibility = 1.11
 
 repositories {
@@ -115,6 +116,8 @@ dependencies {
         exclude group: 'javax.servlet', module: 'servlet-api'
     }
 
+    implementation project(path: ':shadow-radar-auth', configuration: 'shadow')
+
     codacy 'com.github.codacy:codacy-coverage-reporter:-SNAPSHOT'
 
     testCompile group: 'io.gatling.highcharts', name: 'gatling-charts-highcharts', version: '3.3.1'

settings.gradle

@@ -1 +1,2 @@
 rootProject.name = 'appserver'
+include 'shadow-radar-auth'

shadow-radar-auth/build.gradle

@@ -0,0 +1,20 @@
+plugins {
+    id 'com.github.johnrengelman.shadow'
+}
+apply plugin: 'java-library'
+
+repositories {
+    mavenCentral()
+    jcenter()
+}
+
+dependencies {
+    implementation "com.fasterxml.jackson.core:jackson-databind:2.11.4"
+    implementation "com.fasterxml.jackson.core:jackson-annotations:2.11.4"
+    implementation "commons-codec:commons-codec:1.15"
+}
+
+shadowJar {
+    relocate 'org.apache.commons.codec', 'shadow.org.apache.commons.codec'
+    relocate 'com.fasterxml.jackson', 'shadow.com.fasterxml.jackson'
+}

src/main/java/org/radarbase/appserver/config/AuthConfig.java

@@ -1,5 +1,9 @@
 package org.radarbase.appserver.config;
 
+import lombok.extern.slf4j.Slf4j;
+import org.radarcns.auth.config.TokenValidatorConfig;
+import org.radarcns.auth.config.TokenVerifierPublicKeyConfig;
+import org.radarcns.auth.exception.ConfigurationException;
 import org.radarcns.auth.token.RadarToken;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
@@ -17,6 +21,7 @@
 @Configuration
 @ConditionalOnProperty(name = "security.radar.managementportal.enabled", havingValue = "true")
 @EnableAspectJAutoProxy
+@Slf4j
 public class AuthConfig {
 
   @Value("${security.radar.managementportal.url}")
@@ -30,10 +35,25 @@ public ManagementPortalAuthProperties getAuthProperties() {
     return new ManagementPortalAuthProperties(baseUrl, resourceName);
   }
 
+  /**
+   * First tries to load config from radar_is.yml config file. If any issues, then uses the default
+   * MP oauth token key endpoint.
+   *
+   * @param managementPortalAuthProperties
+   * @return
+   */
   @Bean
   AuthValidator<RadarToken> getAuthValidator(
       @Autowired ManagementPortalAuthProperties managementPortalAuthProperties) {
-    return new ManagementPortalAuthValidator(managementPortalAuthProperties);
+    try {
+      TokenValidatorConfig validatorConfig = TokenVerifierPublicKeyConfig.readFromFileOrClasspath();
+      return new ManagementPortalAuthValidator(managementPortalAuthProperties, validatorConfig);
+    } catch (ConfigurationException exc) {
+      log.warn(
+          "Could not loading config from RADAR_IS file. Now using default public key "
+              + "endpoint...");
+      return new ManagementPortalAuthValidator(managementPortalAuthProperties);
+    }
   }
 
   @Bean

src/main/java/org/radarbase/appserver/controller/FcmNotificationController.java

@@ -138,15 +138,67 @@ public ResponseEntity<FcmNotifications> getNotificationsUsingProjectId(
   public ResponseEntity<FcmNotificationDto> addSingleNotification(
       @PathVariable String projectId,
       @PathVariable String subjectId,
+      @RequestParam(required = false, defaultValue = "true") boolean schedule,
       @Valid @RequestBody FcmNotificationDto notification)
       throws URISyntaxException {
     FcmNotificationDto notificationDto =
-        this.notificationService.addNotification(notification, subjectId, projectId);
+        this.notificationService.addNotification(notification, subjectId, projectId, schedule);
     return ResponseEntity.created(
             new URI("/" + PathsUtil.MESSAGING_NOTIFICATION_PATH + "/" + notificationDto.getId()))
         .body(notificationDto);
   }
 
+  @Authorized(
+      permission = AuthPermissions.UPDATE,
+      entity = AuthEntities.SUBJECT,
+      permissionOn = PermissionOn.SUBJECT)
+  @PostMapping(
+      "/"
+          + PathsUtil.PROJECT_PATH
+          + "/"
+          + PathsUtil.PROJECT_ID_CONSTANT
+          + "/"
+          + PathsUtil.USER_PATH
+          + "/"
+          + PathsUtil.SUBJECT_ID_CONSTANT
+          + "/"
+          + PathsUtil.MESSAGING_NOTIFICATION_PATH
+          + "/schedule")
+  public ResponseEntity<FcmNotifications> scheduleUserNotifications(
+      @PathVariable String projectId,
+      @PathVariable String subjectId)
+      throws URISyntaxException {
+        return ResponseEntity.ok(
+            this.notificationService.scheduleAllUserNotifications(subjectId, projectId));
+    }
+
+    @Authorized(
+        permission = AuthPermissions.UPDATE,
+        entity = AuthEntities.SUBJECT,
+        permissionOn = PermissionOn.SUBJECT)
+    @PostMapping(
+        "/"
+            + PathsUtil.PROJECT_PATH
+            + "/"
+            + PathsUtil.PROJECT_ID_CONSTANT
+            + "/"
+            + PathsUtil.USER_PATH
+            + "/"
+            + PathsUtil.SUBJECT_ID_CONSTANT
+            + "/"
+            + PathsUtil.MESSAGING_NOTIFICATION_PATH
+            + "/"
+            + PathsUtil.NOTIFICATION_ID_CONSTANT
+            + "/schedule")
+    public ResponseEntity<FcmNotificationDto> scheduleUserNotification(
+        @PathVariable String projectId,
+        @PathVariable String subjectId,
+        @PathVariable long notificationId)
+        throws URISyntaxException {
+          return ResponseEntity.ok(
+              this.notificationService.scheduleNotification(subjectId, projectId, notificationId));
+      }
+
   @Authorized(
       permission = AuthPermissions.UPDATE,
       entity = AuthEntities.SUBJECT,
@@ -166,9 +218,10 @@ public ResponseEntity<FcmNotificationDto> addSingleNotification(
   public ResponseEntity<FcmNotifications> addBatchNotifications(
       @PathVariable String projectId,
       @PathVariable String subjectId,
+      @RequestParam(required = false, defaultValue = "true") boolean schedule,
       @Valid @RequestBody FcmNotifications notifications) {
     return ResponseEntity.ok(
-        this.notificationService.addNotifications(notifications, subjectId, projectId));
+        this.notificationService.addNotifications(notifications, subjectId, projectId, schedule));
   }
 
   @Authorized(