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

Timestamp:

2021-08-04T15:06:10+12:00 (3 years ago)

Author:

davidb

Message:

Prevent one failed request from causing all other transcribed files from being returned
Implement timeout failsafe

Location:

gs3-extensions/atea-nlp-tools/trunk/src/koreromaori-proxy

Files:

• notes.md (added)
• src/main/java/org/atea/nlptools/koreromaoriinterface/TranscriptionServlet.java (modified) (3 diffs)
• src/main/java/org/atea/nlptools/koreromaoriinterface/models/MyTranscriptionResponse.java (deleted)
• src/main/java/org/atea/nlptools/koreromaoriinterface/models/TranscriptionResult.java (modified) (1 diff)
• src/main/java/org/atea/nlptools/koreromaoriinterface/models/TranscriptionResultDto.java (added)
• src/main/java/org/atea/nlptools/koreromaoriinterface/services/ReoTuhituhiApiService.java (modified) (7 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;
+import org.atea.nlptools.koreromaoriinterface.models.TranscriptionResultDto;
 import org.atea.nlptools.koreromaoriinterface.models.TranscriptionResult;
 import org.atea.nlptools.koreromaoriinterface.services.ReoTuhituhiApiService;
@@ -115 +114 @@
 
             // Transform the Tuhituhi response into our own format
-            List<MyTranscriptionResponse> responses = new ArrayList<MyTranscriptionResponse>(results.size());
+            List<TranscriptionResultDto> responses = new ArrayList<TranscriptionResultDto>(results.size());
             for (AudioFilePart result : results) {
-                responses.add(MyTranscriptionResponse.FromTranscriptionResult(result.getTranscriptionResult(), result.fileName));
+                responses.add(TranscriptionResultDto.FromTranscriptionResult(result.getTranscriptionResult(), result.fileName));
             }
 
@@ -123 +122 @@
             String json = jsonSerialiser.toJson(responses, transcriptionListType);
             writer.append(json);
-        }
-        catch (ReoTuhituhiException rtex)
-        {
-            response.sendError(502, "Call to the Reo Tuhituhi API failed.");
         }
         catch (Exception ex)

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

@@ -11 +11 @@
     private String transcription;
 
-    public String getLog() {
+    /**
+     * Initialises an empty instance of the {@link TranscriptionResult} class.
+     */
+    public TranscriptionResult() {
+
+    }
+
+    /**
+     * Initialises a new instance of the {@link TranscriptionResult} class.
+     * 
+     * @param log
+     * @param metadata
+     * @param modelVersion
+     * @param success
+     * @param transcription
+     */
+    public TranscriptionResult(
+        String log,
+        TranscriptionResultMetadata[] metadata,
+        String modelVersion,
+        Boolean success,
+        String transcription)
+    {
+        this.log = log;
+        this.metadata = metadata;
+        this.modelVersion = modelVersion;
+        this.success = success;
+        this.transcription = transcription;
+    }
+
+    /**
+     * Initialises a new instance of the {@link TranscriptionResult} class, with the intention of logging an unsuccessful result. 
+     * As such, each field is set to null bar the provided log, and {@link getSuccess} being set to false.
+     * 
+     * @param log
+     */
+    public TranscriptionResult(
+        String log)
+    {
+        this.log = log;
+        this.metadata = null;
+        this.modelVersion = null;
+        this.success = false;
+        this.transcription = null;
+    }
+
+    public String getLog()
+    {
         return log;
     }
     
-    public TranscriptionResultMetadata[] getMetadata() {
+    public TranscriptionResultMetadata[] getMetadata()
+    {
         return metadata;
     }
     
-    public String getModelVersion() {
+    public String getModelVersion()
+    {
         return modelVersion;
     }
     
-    public Boolean getSuccess() {
+    public Boolean getSuccess()
+    {
         return success;
     }
     
-    public String getTranscription() {
+    public String getTranscription()
+    {
         return transcription;
     }

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

@@ -3 +3 @@
 import java.io.IOException;
 import java.io.InputStream;
+import java.net.SocketTimeoutException;
 import java.util.LinkedList;
 import java.util.List;
@@ -43 +44 @@
      */
     public List<AudioFilePart> getTranscriptions(Iterable<AudioFilePart> audioFileParts)
-        throws HttpRequestException, JsonSyntaxException, Exception
+        throws HttpRequestException, IOException
     {
         List<AudioFilePart> apiResults = new LinkedList<AudioFilePart>();
@@ -49 +50 @@
         for (AudioFilePart part : audioFileParts)
         {
-            TranscriptionResult res = getTranscription(part.dataStream);
+            TranscriptionResult res = null;
+            try
+            {
+                res = getTranscription(part.dataStream);
+            }
+            catch (ReoTuhituhiException rtex)
+            {
+                res = new TranscriptionResult("The Reo Tuhituhi API didn't respond successfully.");
+            }
+            catch (JsonSyntaxException jsex)
+            {
+                res = new TranscriptionResult("That's on me! I failed to parse the response from the Reo Tuhituhi API.");
+            }
+            catch (HttpRequestException hrex)
+            {
+                if (hrex.getCause().getClass() == SocketTimeoutException.class) {
+                    res = new TranscriptionResult("The Reo Tuhituhi API timed out.");
+                }
+                else {
+                    throw hrex;
+                }
+            }
+            
             part.setTranscriptionResult(res);
-
             apiResults.add(part);
         }
@@ -66 +88 @@
      * @throws JsonSyntaxException Thrown when the result cannot be parsed.
      * @throws ReoTuhituhiException Thrown when the Reo Tuhituhi API returns an invalid response.
+     * @throws IOException Thrown at any time.
      */
     public TranscriptionResult getTranscription(InputStream audioStream)
@@ -74 +97 @@
         HttpRequestService request = HttpRequestService
             .post(apiEndpoint)
+            .connectTimeout(2000)
+            .readTimeout(5000)
             .authorization("Basic " + apiKey)
             .send(audioStream);
@@ -87 +112 @@
             );
 
-            throw new ReoTuhituhiException(request.code(), request.message(), "Non-OK status code");
+            throw new ReoTuhituhiException(request.code(), request.message(), "API returned a non-OK status code");
         }
 
@@ -100 +125 @@
             );
 
-            throw new ReoTuhituhiException(request.code(), request.message(), "Invalid content type: " + request.contentType());
+            throw new ReoTuhituhiException(request.code(), request.message(), "API specified an invalid content type: " + request.contentType());
         }