Changeset 35242 for gs3-extensions/atea-nlp-tools

Timestamp:

2021-08-03T17:12:35+12:00 (3 years ago)

Author:

davidb

Message:

Improve error handling for calls to the Reo Tuhituhi API

Location:

gs3-extensions/atea-nlp-tools/trunk/src/koreromaori-proxy/src/main/java/org/atea/nlptools/koreromaoriinterface

Files:

• TranscriptionServlet.java (modified) (4 diffs)
• exceptions (added)
• exceptions/ReoTuhituhiException.java (added)
• services/ReoTuhituhiApiService.java (modified) (6 diffs)

gs3-extensions/atea-nlp-tools/trunk/src/koreromaori-proxy/src/main/java/org/atea/nlptools/koreromaoriinterface/TranscriptionServlet.java

@@ -23 +23 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.atea.nlptools.koreromaoriinterface.exceptions.ReoTuhituhiException;
 import org.atea.nlptools.koreromaoriinterface.models.AudioFilePart;
 import org.atea.nlptools.koreromaoriinterface.models.MyTranscriptionResponse;
@@ -87 +88 @@
         String[] audioFileKeys = audioFileKeysParameter.split("\\|");
 
+        // Create our own representation of each part
         ArrayList<AudioFilePart> audioFileParts = new ArrayList<AudioFilePart>(audioFileKeys.length);
         for (String audioFileKey : audioFileKeys)
@@ -95 +97 @@
         }
 
-        try
+        try 
         {
-            List<AudioFilePart> results = transcriptionService.GetTranscriptions(audioFileParts);
+            List<AudioFilePart> results = transcriptionService.getTranscriptions(audioFileParts);
+
             List<MyTranscriptionResponse> responses = new ArrayList<MyTranscriptionResponse>(results.size());
-
             for (AudioFilePart result : results) {
                 responses.add(MyTranscriptionResponse.FromTranscriptionResult(result.getTranscriptionResult(), result.fileName));
@@ -107 +109 @@
             writer.append(json);
         }
+        catch (ReoTuhituhiException rtex)
+        {
+            response.sendError(502, "Call to the Reo Tuhituhi API failed.");
+        }
         catch (Exception ex)
         {
-            response.sendError(500, "Call to the Reo Tuhituhi API failed." + ex);
+            response.sendError(500, "Failed to process the request.");
             logger.error("Failed to complete API call", ex);
         }

gs3-extensions/atea-nlp-tools/trunk/src/koreromaori-proxy/src/main/java/org/atea/nlptools/koreromaoriinterface/services/ReoTuhituhiApiService.java

@@ -11 +11 @@
 
 import com.google.gson.Gson;
+import com.google.gson.JsonSyntaxException;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.atea.nlptools.koreromaoriinterface.exceptions.ReoTuhituhiException;
 import org.atea.nlptools.koreromaoriinterface.models.AudioFilePart;
 import org.atea.nlptools.koreromaoriinterface.models.TranscriptionResult;
+import org.atea.nlptools.koreromaoriinterface.services.HttpRequestService.HttpRequestException;
 
 /**
@@ -43 +46 @@
      * @param audioFileParts The audio files to retrieve a transcription for.
      * @return A list of {@link TranscriptionResult} objects.
-     * @throws Exception
+     * @throws HttpRequestException When the API call fails.
+     * @throws JsonSyntaxException When the result cannot be parsed.
      */
-    public List<AudioFilePart> GetTranscriptions(Iterable<AudioFilePart> audioFileParts)
-        throws Exception
+    public List<AudioFilePart> getTranscriptions(Iterable<AudioFilePart> audioFileParts)
+        throws HttpRequestException, JsonSyntaxException, Exception
     {
         Queue<Future<AudioFilePart>> apiCalls = new LinkedList<Future<AudioFilePart>>();
@@ -64 +68 @@
             TranscriptionResult res = getTranscription(part.dataStream);
             part.setTranscriptionResult(res);
+
             apiResults.add(part);
         }
@@ -78 +83 @@
     }
 
+    /**
+     * Calls the Reo Tuhituhi API to transcribe a wave audio file.
+     * 
+     * @param audioStream The wave audio stream.
+     * @return A {@link TranscriptionResult} object.
+     * @throws HttpRequestException Thrown when the API call fails.
+     * @throws JsonSyntaxException Thrown when the result cannot be parsed.
+     * @throws ReoTuhituhiException Thrown when the Reo Tuhituhi API returns an invalid response.
+     */
+    public TranscriptionResult getTranscription(InputStream audioStream)
+        throws HttpRequestException, JsonSyntaxException, ReoTuhituhiException
+    {
+        HttpRequestService request = HttpRequestService
+            .post(apiEndpoint)
+            .authorization("Basic " + apiKey)
+            .send(audioStream);
+
+        // Check that the request returned an OK status
+        if (!request.ok())
+        {
+            logger.error
+            (
+                "The Reo Tuhituhi API returned a non-OK status code {} with message {}",
+                request.code(),
+                request.message()
+            );
+
+            throw new ReoTuhituhiException(request.code(), request.message(), "Non-OK status code");
+        }
+
+        // Check that the content type is valid
+        if (request.contentType() != "application/json")
+        {
+            logger.error
+            (
+                "The Reo Tuhituhi API returned an invalid content type {}. Provided content was {}",
+                request.contentType(),
+                request.body()
+            );
+
+            throw new ReoTuhituhiException(request.code(), request.message(), "Invalid content type: " + request.contentType());
+        }
+
+        TranscriptionResult res = jsonSerialiser.fromJson(request.body(), TranscriptionResult.class);
+
+        return res;
+    }
+
     private Callable<AudioFilePart> getTranscriptionCallable(final AudioFilePart part)
     {
@@ -83 +136 @@
         {
             @Override
-            public AudioFilePart call() throws Exception
+            public AudioFilePart call()
+                throws Exception
             {
                 TranscriptionResult res = getTranscription(part.dataStream);
@@ -91 +145 @@
         };
     }
-
-    private TranscriptionResult getTranscription(InputStream audioStream)
-        throws Exception
-    {
-        String jsonResponse = HttpRequestService
-            .post(apiEndpoint)
-            .authorization("Basic " + apiKey)
-            .send(audioStream)
-            .body();
-
-        logger.trace("Reo Tuhituhi API responded with a success status.");
-        TranscriptionResult res = jsonSerialiser.fromJson(jsonResponse, TranscriptionResult.class);
-        logger.trace("Reo Tuhituhi API response was succesfully deserialised.");
-        return res;
-    }
 }