Merge pull request #341 from AtlasOfLivingAustralia/feature/issue3715

Added file download support to EcpWebService, fixed a bug with non-au…

Author: chrisala

.github/workflows/build.yml

@@ -28,7 +28,7 @@ jobs:
       - name: Install nodejs
         uses: actions/setup-node@v4
         with:
-          node-version: '20.x'
+          node-version: '24.x'
           registry-url: 'https://npm.pkg.github.com'
           scope: 'AtlasOfLivingAustralia'
 
@@ -40,7 +40,7 @@ jobs:
         id: pre-release-version
         uses: adobe/update-prerelease-npm-version@4dea8f295023f5b18126afd79bae1057a5b92d6e #v1.2.0
 
-      - run: npm publish
+      - run: npm publish --tag=snapshot
         env:
           NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

grails-app/services/au/org/ala/ecodata/forms/EcpWebService.groovy

@@ -95,6 +95,41 @@ class EcpWebService {
         }
     }
 
+    /**
+     * This method is used when the response is expected to be a stream, e.g. for downloading files.
+     * It returns a Map with keys [statusCode: <http status code>, error: <error message if applicable>]
+     * The supplied outputStream will be written to with the response from the web service if the call is successful.
+     * The caller is responsible for closing the outputStream.
+     */
+    Map readToStream(String url, OutputStream outputStream, boolean includeUserId = true, Integer timeout = null) {
+        HttpURLConnection conn = null
+        Map resp = [:]
+        try {
+            conn = configureConnection(url, includeUserId, timeout)
+            try (InputStream inputStream = conn.inputStream) {
+                outputStream << inputStream
+            }
+            resp = [statusCode: conn.responseCode]
+
+        } catch (SocketTimeoutException e) {
+            int statusCode = conn ? (conn.responseCode ?: HttpStatus.SC_GATEWAY_TIMEOUT) : HttpStatus.SC_GATEWAY_TIMEOUT
+            resp = [error: "Timed out calling web service. URL= ${url}.", statusCode: statusCode]
+            log.error "Timed out calling web service. URL= ${url}.", e
+        } catch (SocketException se) {
+            int statusCode = conn ? (conn.responseCode ?: HttpStatus.SC_GATEWAY_TIMEOUT) : HttpStatus.SC_GATEWAY_TIMEOUT
+            resp = [error: "Timed out calling web service. URL= ${url}.", statusCode: statusCode]
+
+            log.warn "Socket connection closed. ${se.getMessage()} URL= ${url}.", se
+        } catch (Exception e) {
+            int statusCode = conn ? (conn.responseCode ?: HttpStatus.SC_INTERNAL_SERVER_ERROR) : HttpStatus.SC_INTERNAL_SERVER_ERROR
+            resp = [error: "Timed out calling web service. URL= ${url}.", statusCode: statusCode]
+
+            log.error "Failed calling web service. ${e.getClass()} ${e.getMessage()} URL= ${url}.", e
+        }
+
+        resp
+    }
+
     Map getString(String url, boolean includeAuth) {
         URLConnection conn = null
         Map resp = [:]
@@ -104,7 +139,7 @@ class EcpWebService {
             resp.statusCode = conn.responseCode
         } catch (SocketTimeoutException e) {
             resp.error = "Timed out calling web service. URL= ${url}."
-            resp.statusCode = HttpStatus.CONNECTION_TIMED_OUT
+            resp.statusCode = HttpStatus.SC_GATEWAY_TIMEOUT
             log.warn resp.error
         } catch (SocketException se) {
             resp.error = "Socket connection closed. ${se.getMessage()} URL= ${url}."
@@ -607,9 +642,10 @@ class EcpWebService {
             }
 
             def user = userService.getUser()
-            String userId = user.userId
-            String userIdHeader = grailsApplication.config.getProperty('app.http.header.userId')
+
             if (user) {
+                String userIdHeader = grailsApplication.config.getProperty('app.http.header.userId')
+                String userId = user.userId
                 requestBuilder.addHeader(userIdHeader, userId)
             } else {
                 log.warn("No user associated with request: ${url}")

package.json

@@ -3,7 +3,7 @@
   "version": "9.1.0-snapshot",
   "repository": {
     "type": "git",
-    "url": "https://github.com/AtlasOfLivingAustralia/ecodata-client-plugin.git"
+    "url": "git+https://github.com/AtlasOfLivingAustralia/ecodata-client-plugin.git"
   },
   "publishConfig": {
     "registry": "https://npm.pkg.github.com/"