Release/1.5.2 (#105)

alexhuang091 · web-flow · commit 324ab8be841e · 2021-04-08T09:37:34.000+10:00
* correct totalRecords count since it could be -1 (when firewhennotzero not set) * correctly handle unsubscribe myannotation with token (#99) * Updated email template, set pageSize=300 for records query * release 1.5.2
diff --git a/build.gradle b/build.gradle
@@ -28,7 +28,7 @@ plugins {
     id "com.gorylenko.gradle-git-properties" version "1.4.17"
 }
 
-version "1.5.2-SNAPSHOT"
+version "1.5.2"
 group "au.org.ala"
 
 apply plugin:"eclipse"
diff --git a/grails-app/controllers/au/org/ala/alerts/UnsubscribeController.groovy b/grails-app/controllers/au/org/ala/alerts/UnsubscribeController.groovy
@@ -7,6 +7,8 @@ class UnsubscribeController {
     static allowedMethods = [index: "GET", unsubscribe: "POST"]
 
     UserService userService
+    NotificationService notificationService
+    QueryService queryService
 
     def index() {
         User loggedInUser = userService.getUser()
@@ -37,10 +39,17 @@ class UnsubscribeController {
             response.sendError(HttpStatus.SC_FORBIDDEN)
         } else {
             if (userAndNotifications.notifications) {
+                // delete notifications and update user
                 Notification.deleteAll(userAndNotifications.notifications)
                 userAndNotifications.user.notifications?.removeAll(userAndNotifications.notifications)
                 userAndNotifications.user.save(flush: true)
 
+                // for my annotation, we also need to delete the query and query result
+                String myAnnotationQueryPath = queryService.constructMyAnnotationQueryPath(userAndNotifications.user.userId)
+                if (userAndNotifications.notifications.any { it.query.queryPath == myAnnotationQueryPath }) {
+                    notificationService.deleteMyAnnotation(userAndNotifications.user)
+                }
+                
                 render view: "unsubscribed"
             }
         }
diff --git a/grails-app/i18n/messages.properties b/grails-app/i18n/messages.properties
@@ -71,6 +71,7 @@ alert.title=Email alert from {0}
 alert.details=View details
 alert.manage=Manage your email subscriptions
 biocache.view.list=View a list of all the added/changed records
+biocache.view.myannotation.list=View the list of records you have annotated
 biocache.disable.this=Disable this alert or manage your alerts
 biocache.settings.frequency=Your current settings are to receive alert emails {0}.
 biocache.occurrences.record.update=Occurrence records update
diff --git a/grails-app/services/au/org/ala/alerts/DiffService.groovy b/grails-app/services/au/org/ala/alerts/DiffService.groovy
@@ -40,7 +40,7 @@ class DiffService {
         if (current != null && previous != null) {
 
             try {
-                if (!queryService.isUserSpecific(query)) {
+                if (!queryService.isMyAnnotation(query)) {
                     def ids1 = JsonPath.read(current, query.recordJsonPath + "." + query.idJsonPath)
                     if (!isCollectionOrArray(ids1)) {
                         ids1 = [ids1]
@@ -135,7 +135,7 @@ class DiffService {
 
                 if(!last.startsWith("<") && !previous.startsWith("<")) {
                     // Don't try and process 401, 301, 500, etc., responses that contain HTML
-                    if (!queryService.isUserSpecific(queryResult.query)) {
+                    if (!queryService.isMyAnnotation(queryResult.query)) {
                         List<String> ids1 = JsonPath.read(last, queryResult.query.recordJsonPath + "." + queryResult.query.idJsonPath)
                         List<String> ids2 = JsonPath.read(previous, queryResult.query.recordJsonPath + "." + queryResult.query.idJsonPath)
                         List<String> diff = ids1.findAll { !ids2.contains(it) }
diff --git a/grails-app/services/au/org/ala/alerts/EmailService.groovy b/grails-app/services/au/org/ala/alerts/EmailService.groovy
@@ -87,6 +87,7 @@ class EmailService {
             title           : query.name,
             message         : query.updateMessage,
             moreInfo        : queryResult.queryUrlUIUsed,
+            listcode        : queryService.isMyAnnotation(query) ? "biocache.view.myannotation.list" : "biocache.view.list",
             query           : query,
             stopNotification: grailsApplication.config.security.cas.appServerName + grailsApplication.config.security.cas.contextPath + '/notification/myAlerts',
             frequency       : frequency,
@@ -137,10 +138,11 @@ class EmailService {
                         message: query.updateMessage,
                         query: query,
                         moreInfo: queryResult.queryUrlUIUsed,
+                        listcode: queryService.isMyAnnotation(query) ? "biocache.view.myannotation.list" : "biocache.view.list",
                         stopNotification: urlPrefix + '/notification/myAlerts',
                         records: records,
                         frequency: messageSource.getMessage('frequency.' + frequency, null, siteLocale),
-                        totalRecords: totalRecords,
+                        totalRecords: (totalRecords >= 0 ? totalRecords : records.size()),
                         unsubscribeAll: urlPrefix + "/unsubscribe?token=" + userUnsubToken,
                         unsubscribeOne: urlPrefix + "/unsubscribe?token=" + notificationUnsubToken
                     ])
diff --git a/grails-app/services/au/org/ala/alerts/NotificationService.groovy b/grails-app/services/au/org/ala/alerts/NotificationService.groovy
@@ -273,7 +273,7 @@ class NotificationService {
     }
 
     private def processQueryReturnedJson(Query query, String json) {
-        if (!queryService.isUserSpecific(query) || !queryService.getUserId(query)) {
+        if (!queryService.isMyAnnotation(query) || !queryService.getUserId(query)) {
             return json
         }
 
@@ -587,8 +587,8 @@ class NotificationService {
     }
 
     def deleteMyAnnotation(User user) {
-        Query myAnnotationQuery = queryService.createMyAnnotationQuery(user?.userId)
-        Query retrievedQuery = Query.findByBaseUrlAndQueryPath(myAnnotationQuery.baseUrl, myAnnotationQuery.queryPath)
+        String myAnnotationQueryPath = queryService.constructMyAnnotationQueryPath(user?.userId)
+        Query retrievedQuery = Query.findByQueryPath(myAnnotationQueryPath)
 
         if (retrievedQuery != null) {
             // delete the notification
diff --git a/grails-app/services/au/org/ala/alerts/QueryService.groovy b/grails-app/services/au/org/ala/alerts/QueryService.groovy
@@ -33,20 +33,20 @@ class QueryService {
   }
 
   Boolean checkChangeByDiff(Query query) {
-    !hasAFireProperty(query) && (query.idJsonPath || isUserSpecific(query))
+    !hasAFireProperty(query) && (query.idJsonPath || isMyAnnotation(query))
   }
 
   Boolean hasAFireProperty(Query query){
     query.propertyPaths.any {it.fireWhenChange || it.fireWhenNotZero}
   }
 
-  Boolean isUserSpecific(Query query) {
+  Boolean isMyAnnotation(Query query) {
     // Currently only 'my annotation' alert is user specific (among all non-custom queries)
     query.name.startsWith(messageSource.getMessage("query.myannotations.title", null, siteLocale))
   }
 
   String getUserId(Query query) {
-    if (!isUserSpecific(query)) return null
+    if (!isMyAnnotation(query)) return null
     String queryPath = query.queryPath
     queryPath.substring(queryPath.indexOf('assertion_user_id:') + 'assertion_user_id:'.length(), queryPath.indexOf('&dir=desc'))
   }
@@ -265,10 +265,14 @@ class QueryService {
       name: messageSource.getMessage("query.myannotations.title", null, siteLocale),
       updateMessage: messageSource.getMessage("myannotations.update.message", null, siteLocale),
       description: messageSource.getMessage("query.myannotations.descr", null, siteLocale),
-      queryPath: '/occurrences/search?fq=assertion_user_id:' + userId + '&dir=desc&facets=basis_of_record',
-      queryPathForUI: '/occurrences/search?fq=assertion_user_id:' + userId + '&dir=desc&facets=basis_of_record',
+      queryPath: constructMyAnnotationQueryPath(userId),
+      queryPathForUI: '/occurrences/search?fq=assertion_user_id:' + userId + '&dir=desc',
       emailTemplate: '/email/biocache',
       recordJsonPath: '\$.occurrences[*]',
     ])
   }
+
+  String constructMyAnnotationQueryPath(String userId) {
+    '/occurrences/search?fq=assertion_user_id:' + userId + '&dir=desc&pageSize=300'
+  }
 }
diff --git a/grails-app/views/email/biocache.gsp b/grails-app/views/email/biocache.gsp
@@ -7,8 +7,7 @@
     <p>
       <g:message code="${message}" default="${message}" args="${[totalRecords]}"/>
     </p>
-    <p><a href="${moreInfo}"><g:message code="biocache.view.list" /></a></p>
-
+    <p><a href="${moreInfo}"><g:message code="${listcode ? listcode : "biocache.view.list"}"/></a></p>
     <style type="text/css">
     	body { font-family:Arial; }
     	table { border-collapse: collapse; border: 1px solid #CCC; padding:2px; }
diff --git a/src/test/groovy/au/org/ala/alerts/UnsubscribeControllerSpec.groovy b/src/test/groovy/au/org/ala/alerts/UnsubscribeControllerSpec.groovy
@@ -6,11 +6,13 @@ import org.apache.http.HttpStatus
 import spock.lang.Specification
 
 @TestFor(UnsubscribeController)
-@Mock([Notification, User, Query])
+@Mock([Notification, User, Query, QueryResult])
 class UnsubscribeControllerSpec extends Specification {
 
     def setup() {
         controller.userService = Mock(UserService)
+        controller.queryService = Mock(QueryService)
+        controller.notificationService = Mock(NotificationService)
     }
 
     def "index() should return a HTTP 400 (BAD_REQUEST) if there is no logged in user and no token"() {
@@ -249,6 +251,7 @@ class UnsubscribeControllerSpec extends Specification {
     def "unsubscribe() should delete all the user's notifications if the token matches the token for a user with notifications"() {
         setup:
         controller.userService.getUser() >> null
+        controller.queryService.createMyAnnotationQuery(_ as String) >> new Query([name: 'emptyquery'])
         Query query1 = newQuery("query1")
         Query query2 = newQuery("query2")
         User user1 = new User(userId: "user1", email: "fred@bla.com")
@@ -282,9 +285,44 @@ class UnsubscribeControllerSpec extends Specification {
         Notification.count() == 1
     }
 
+    def "unsubscribe() should delete my annotaions alert if the token matches the token for a user with notifications"() {
+        setup:
+        User user = new User(userId: "userid", email: "fred@bla.com", frequency: new Frequency([name: 'hourly']))
+        Query query = new Query([
+                name: 'testquery',
+                queryPath: '/occurrences/search?fq=assertion_user_id:' + 'userid' + '&dir=desc&facets=basis_of_record',
+                updateMessage: 'updateMessage',
+                baseUrl: 'baseUrl',
+                baseUrlForUI: 'baseUrlForUI',
+                resourceName: 'resourceName',
+                queryPathForUI: 'queryPathForUI'
+        ])
+
+        controller.userService.getUser() >> null
+        controller.queryService.constructMyAnnotationQueryPath(_ as String) >> '/occurrences/search?fq=assertion_user_id:' + user.userId + '&dir=desc&facets=basis_of_record'
+
+        user.save(failOnError: true, flush: true)
+        query.save(failOnError: true, flush: true)
+        Notification notification = new Notification(user: user, query: query)
+        notification.save(failOnError: true, flush: true)
+        QueryResult queryResult = new QueryResult([query: query, frequency: user.frequency])
+        queryResult.save(failOnError: true, flush: true)
+
+        when:
+        params.token = notification.unsubscribeToken
+        request.method = 'POST'
+        controller.unsubscribe()
+
+        then:
+        log.info "token = ${params.token}"
+        1 * controller.notificationService.deleteMyAnnotation(user)
+        response.status == HttpStatus.SC_OK
+    }
+
     def "unsubscribe() should delete only 1 notification if the token matches the token for a notification"() {
         setup:
         controller.userService.getUser() >> null
+        controller.queryService.createMyAnnotationQuery(_ as String) >> new Query([name: 'emptyquery'])
         Query query1 = newQuery("query1")
         Query query2 = newQuery("query2")
         User user = new User(userId: "user1", email: "fred@bla.com")
@@ -323,6 +361,7 @@ class UnsubscribeControllerSpec extends Specification {
         user.addToNotifications(notification2)
         user.save(failOnError: true, flush: true)
         controller.userService.getUser() >> user
+        controller.queryService.createMyAnnotationQuery(_ as String) >> new Query([name: 'emptyquery'])
 
         when:
         params.token = notification1.unsubscribeToken

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ plugins {`
`28`	`28`	`id "com.gorylenko.gradle-git-properties" version "1.4.17"`
`29`	`29`	`}`
`30`	`30`
`31`		`-version "1.5.2-SNAPSHOT"`
	`31`	`+version "1.5.2"`
`32`	`32`	`group "au.org.ala"`
`33`	`33`
`34`	`34`	`apply plugin:"eclipse"`
Original file line number	Diff line number	Diff line change
`@@ -273,7 +273,7 @@ class NotificationService {`
`273`	`273`	`}`
`274`	`274`
`275`	`275`	`private def processQueryReturnedJson(Query query, String json) {`
`276`		`- if (!queryService.isUserSpecific(query) \|\| !queryService.getUserId(query)) {`
	`276`	`+ if (!queryService.isMyAnnotation(query) \|\| !queryService.getUserId(query)) {`
`277`	`277`	`return json`
`278`	`278`	`}`
`279`	`279`
`@@ -587,8 +587,8 @@ class NotificationService {`
`587`	`587`	`}`
`588`	`588`
`589`	`589`	`def deleteMyAnnotation(User user) {`
`590`		`- Query myAnnotationQuery = queryService.createMyAnnotationQuery(user?.userId)`
`591`		`- Query retrievedQuery = Query.findByBaseUrlAndQueryPath(myAnnotationQuery.baseUrl, myAnnotationQuery.queryPath)`
	`590`	`+ String myAnnotationQueryPath = queryService.constructMyAnnotationQueryPath(user?.userId)`
	`591`	`+ Query retrievedQuery = Query.findByQueryPath(myAnnotationQueryPath)`
`592`	`592`
`593`	`593`	`if (retrievedQuery != null) {`
`594`	`594`	`// delete the notification`
Original file line number	Diff line number	Diff line change
`@@ -33,20 +33,20 @@ class QueryService {`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`Boolean checkChangeByDiff(Query query) {`
`36`		`- !hasAFireProperty(query) && (query.idJsonPath \|\| isUserSpecific(query))`
	`36`	`+ !hasAFireProperty(query) && (query.idJsonPath \|\| isMyAnnotation(query))`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`Boolean hasAFireProperty(Query query){`
`40`	`40`	`query.propertyPaths.any {it.fireWhenChange \|\| it.fireWhenNotZero}`
`41`	`41`	`}`
`42`	`42`
`43`		`- Boolean isUserSpecific(Query query) {`
	`43`	`+ Boolean isMyAnnotation(Query query) {`
`44`	`44`	`// Currently only 'my annotation' alert is user specific (among all non-custom queries)`
`45`	`45`	`query.name.startsWith(messageSource.getMessage("query.myannotations.title", null, siteLocale))`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`String getUserId(Query query) {`
`49`		`- if (!isUserSpecific(query)) return null`
	`49`	`+ if (!isMyAnnotation(query)) return null`
`50`	`50`	`String queryPath = query.queryPath`
`51`	`51`	`queryPath.substring(queryPath.indexOf('assertion_user_id:') + 'assertion_user_id:'.length(), queryPath.indexOf('&dir=desc'))`
`52`	`52`	`}`
`@@ -265,10 +265,14 @@ class QueryService {`
`265`	`265`	`name: messageSource.getMessage("query.myannotations.title", null, siteLocale),`
`266`	`266`	`updateMessage: messageSource.getMessage("myannotations.update.message", null, siteLocale),`
`267`	`267`	`description: messageSource.getMessage("query.myannotations.descr", null, siteLocale),`
`268`		`- queryPath: '/occurrences/search?fq=assertion_user_id:' + userId + '&dir=desc&facets=basis_of_record',`
`269`		`- queryPathForUI: '/occurrences/search?fq=assertion_user_id:' + userId + '&dir=desc&facets=basis_of_record',`
	`268`	`+ queryPath: constructMyAnnotationQueryPath(userId),`
	`269`	`+ queryPathForUI: '/occurrences/search?fq=assertion_user_id:' + userId + '&dir=desc',`
`270`	`270`	`emailTemplate: '/email/biocache',`
`271`	`271`	`recordJsonPath: '\$.occurrences[*]',`
`272`	`272`	`])`
`273`	`273`	`}`
	`274`	`+`
	`275`	`+ String constructMyAnnotationQueryPath(String userId) {`
	`276`	`+ '/occurrences/search?fq=assertion_user_id:' + userId + '&dir=desc&pageSize=300'`
	`277`	`+ }`
`274`	`278`	`}`