Merge pull request #3716 from AtlasOfLivingAustralia/feature/issue3715

Fix thumbnail creation for homepage fieldcapture#3715

Author: chrisala

grails-app/services/au/org/ala/merit/DocumentService.groovy

@@ -243,4 +243,8 @@ class DocumentService {
 
         url
     }
+
+    String buildDownloadUrl(Map document) {
+        buildDownloadUrl(document.filepath, document.filename)
+    }
 }

grails-app/services/au/org/ala/merit/ReportService.groovy

@@ -1,5 +1,6 @@
 package au.org.ala.merit
 
+import au.org.ala.ecodata.forms.EcpWebService
 import au.org.ala.merit.config.EmailTemplate
 import au.org.ala.merit.config.ProgramConfig
 import au.org.ala.merit.config.ReportConfig
@@ -9,6 +10,7 @@ import au.org.ala.merit.reports.ReportOwner
 import grails.plugin.cache.Cacheable
 import groovy.util.logging.Slf4j
 import org.apache.commons.io.FilenameUtils
+import org.apache.http.HttpStatus
 import org.joda.time.DateTime
 import org.joda.time.DateTimeZone
 import org.joda.time.Period
@@ -34,7 +36,7 @@ class ReportService {
     }
 
     def grailsApplication
-    def webService
+    EcpWebService webService
     def userService
     def projectService
     def authService
@@ -836,14 +838,28 @@ class ReportService {
     private Map createCustomThumbnail(Map document) {
         String thumbName = document.documentId+'-thumb-500.'+FilenameUtils.getExtension(document.filename)
         File homePageThumb = new File(imageService.fullPath(thumbName))
+        File tmpFullSizeImage = null
         try {
-            if (!homePageThumb.exists() && document.url) {
-                imageService.createThumbnail(new URL(document.url).openStream(), homePageThumb, document.contentType, HOME_PAGE_IMAGE_SIZE)
+            if (!homePageThumb.exists()  && document.url) {
+                String documentUrl = documentService.buildDownloadUrl(document)
+                tmpFullSizeImage = File.createTempFile(document.documentId+"-tmp", '.'+FilenameUtils.getExtension(document.filename))
+                Map resp = null
+                tmpFullSizeImage.withOutputStream {
+                   resp = webService.readToStream(documentUrl, it, true)
+                }
+                if (resp?.statusCode == HttpStatus.SC_OK) {
+                    imageService.createThumbnail(tmpFullSizeImage, homePageThumb, document.contentType, HOME_PAGE_IMAGE_SIZE)
+                }
             }
         }
         catch (Exception e) {
             log.warn("Unable to create thumbnail: ${homePageThumb}")
         }
+        finally {
+            if (tmpFullSizeImage?.exists()) {
+                tmpFullSizeImage.delete()
+            }
+        }
 
         [thumbnailFile:homePageThumb, fileName:thumbName]
     }

src/test/groovy/au/org/ala/merit/ReportServiceSpec.groovy

@@ -19,6 +19,9 @@ class ReportServiceSpec extends Specification implements ServiceUnitTest<ReportS
     def emailService = Mock(EmailService)
     def userService = Mock(UserService)
     def authService = Mock(AuthService)
+    def documentService = Mock(DocumentService)
+    def imageService = Mock(ImageService)
+    def grailsLinkGenerator = Mock(grails.web.mapping.LinkGenerator)
 
     def setup() {
 
@@ -30,6 +33,9 @@ class ReportServiceSpec extends Specification implements ServiceUnitTest<ReportS
         service.grailsApplication = grailsApplication
         service.userService = userService
         service.authService = authService
+        service.documentService = documentService
+        service.imageService = imageService
+        service.grailsLinkGenerator = grailsLinkGenerator
     }
 
     /**
@@ -549,4 +555,162 @@ class ReportServiceSpec extends Specification implements ServiceUnitTest<ReportS
         1 * webService.doPost({it.endsWith('search/targetsReportForScoreIds')}, expectedParams) >> [statusCode:200, resp:targetsData]
         results.scores[0].target == 100
     }
+
+    def "homePageImages returns image details with thumbnail URLs when thumbnails exist"() {
+        setup:
+        File tmpDir = File.createTempDir()
+        File thumb1 = new File(tmpDir, 'd1-thumb-500.jpg')
+        thumb1.text = 'thumb1'
+        File thumb2 = new File(tmpDir, 'd2-thumb-500.png')
+        thumb2.text = 'thumb2'
+
+        List documents = [
+                [documentId:'d1', name:'Image 1', attribution:'Author 1', projectId:'p1', filename:'image1.jpg', url:'http://original/image1.jpg', contentType:'image/jpeg'],
+                [documentId:'d2', name:'Image 2', attribution:'Author 2', projectId:'p2', filename:'image2.png', url:'http://original/image2.png', contentType:'image/png']
+        ]
+
+        when:
+        List result = service.homePageImages()
+
+        then:
+        1 * documentService.search({it.max == 1}) >> [count:10]
+        1 * documentService.search({it.max == 5}) >> [documents:documents]
+        projectService.search([projectId:['p1', 'p2']]) >> [resp:[projects:[[projectId:'p1', name:'Project 1'], [projectId:'p2', name:'Project 2']]]]
+        1 * imageService.fullPath('d1-thumb-500.jpg') >> thumb1.absolutePath
+        1 * imageService.fullPath('d2-thumb-500.png') >> thumb2.absolutePath
+        1 * grailsLinkGenerator.link([controller:'image', id:'d1-thumb-500.jpg']) >> '/image/d1-thumb-500.jpg'
+        1 * grailsLinkGenerator.link([controller:'image', id:'d2-thumb-500.png']) >> '/image/d2-thumb-500.png'
+
+        and:
+        result.size() == 2
+        result[0].name == 'Image 1'
+        result[0].attribution == 'Author 1'
+        result[0].projectName == 'Project 1'
+        result[0].url == '/image/d1-thumb-500.jpg'
+        result[0].projectId == 'p1'
+        result[1].name == 'Image 2'
+        result[1].projectName == 'Project 2'
+        result[1].url == '/image/d2-thumb-500.png'
+
+        cleanup:
+        tmpDir.deleteDir()
+    }
+
+    def "homePageImages downloads and creates a thumbnail when one does not already exist"() {
+        setup:
+        File tmpDir = File.createTempDir()
+        String thumbPath = new File(tmpDir, 'd1-thumb-500.jpg').absolutePath
+
+        List documents = [
+                [documentId:'d1', name:'Image 1', attribution:'Author 1', projectId:'p1', filename:'image1.jpg', filepath:'2024-01', url:'http://original/image1.jpg', contentType:'image/jpeg']
+        ]
+
+        when:
+        List result = service.homePageImages()
+
+        then:
+        1 * documentService.search({it.max == 1}) >> [count:10]
+        1 * documentService.search({it.max == 5}) >> [documents:documents]
+        projectService.search(_) >> [resp:[projects:[[projectId:'p1', name:'Project 1']]]]
+        1 * imageService.fullPath('d1-thumb-500.jpg') >> thumbPath
+        1 * documentService.buildDownloadUrl(documents[0]) >> 'http://ecodata/document/download/2024-01/image1.jpg'
+        1 * webService.readToStream('http://ecodata/document/download/2024-01/image1.jpg', _, true) >> [statusCode:200]
+        1 * imageService.createThumbnail(_, {it.absolutePath == thumbPath}, 'image/jpeg', 500) >> { File src, File dest, String ct, int sz ->
+            dest.text = 'thumbnail'
+            true
+        }
+        1 * grailsLinkGenerator.link([controller:'image', id:'d1-thumb-500.jpg']) >> '/image/d1-thumb-500.jpg'
+
+        and:
+        result.size() == 1
+        result[0].url == '/image/d1-thumb-500.jpg'
+
+        cleanup:
+        tmpDir.deleteDir()
+    }
+
+    def "homePageImages keeps original URL when thumbnail download fails"() {
+        setup:
+        File tmpDir = File.createTempDir()
+        String thumbPath = new File(tmpDir, 'd1-thumb-500.jpg').absolutePath
+
+        List documents = [
+                [documentId:'d1', name:'Image 1', attribution:'Author 1', projectId:'p1', filename:'image1.jpg', filepath:'2024-01', url:'http://original/image1.jpg', contentType:'image/jpeg']
+        ]
+
+        when:
+        List result = service.homePageImages()
+
+        then:
+        1 * documentService.search({it.max == 1}) >> [count:10]
+        1 * documentService.search({it.max == 5}) >> [documents:documents]
+        projectService.search(_) >> [resp:[projects:[[projectId:'p1', name:'Project 1']]]]
+        1 * imageService.fullPath('d1-thumb-500.jpg') >> thumbPath
+        1 * documentService.buildDownloadUrl(documents[0]) >> 'http://ecodata/document/download/2024-01/image1.jpg'
+        1 * webService.readToStream(_, _, true) >> [statusCode:500]
+        0 * imageService.createThumbnail(_, _, _, _)
+        0 * grailsLinkGenerator.link(_)
+
+        and:
+        result.size() == 1
+        result[0].url == 'http://original/image1.jpg'
+
+        cleanup:
+        tmpDir.deleteDir()
+    }
+
+    def "homePageImages handles exceptions during thumbnail creation gracefully"() {
+        setup:
+        File tmpDir = File.createTempDir()
+        String thumbPath = new File(tmpDir, 'd1-thumb-500.jpg').absolutePath
+
+        List documents = [
+                [documentId:'d1', name:'Image 1', attribution:'Author 1', projectId:'p1', filename:'image1.jpg', filepath:'2024-01', url:'http://original/image1.jpg', contentType:'image/jpeg']
+        ]
+
+        when:
+        List result = service.homePageImages()
+
+        then:
+        1 * documentService.search({it.max == 1}) >> [count:10]
+        1 * documentService.search({it.max == 5}) >> [documents:documents]
+        projectService.search(_) >> [resp:[projects:[[projectId:'p1', name:'Project 1']]]]
+        1 * imageService.fullPath('d1-thumb-500.jpg') >> thumbPath
+        1 * documentService.buildDownloadUrl(documents[0]) >> { throw new RuntimeException("connection error") }
+        0 * grailsLinkGenerator.link(_)
+
+        and: "no exception is thrown and the original URL is preserved"
+        result.size() == 1
+        result[0].url == 'http://original/image1.jpg'
+
+        cleanup:
+        tmpDir.deleteDir()
+    }
+
+    def "homePageImages returns empty project name when project is not found"() {
+        setup:
+        File tmpDir = File.createTempDir()
+        File thumb1 = new File(tmpDir, 'd1-thumb-500.jpg')
+        thumb1.text = 'thumb1'
+
+        List documents = [
+                [documentId:'d1', name:'Image 1', attribution:'Author 1', projectId:'p1', filename:'image1.jpg', url:'http://original/image1.jpg', contentType:'image/jpeg']
+        ]
+
+        when:
+        List result = service.homePageImages()
+
+        then:
+        1 * documentService.search({it.max == 1}) >> [count:10]
+        1 * documentService.search({it.max == 5}) >> [documents:documents]
+        projectService.search(_) >> [resp:[projects:[]]]
+        1 * imageService.fullPath('d1-thumb-500.jpg') >> thumb1.absolutePath
+        1 * grailsLinkGenerator.link([controller:'image', id:'d1-thumb-500.jpg']) >> '/image/d1-thumb-500.jpg'
+
+        and:
+        result[0].projectName == ''
+
+        cleanup:
+        tmpDir.deleteDir()
+    }
 }