Add message on DocumentModelOperationException (Azure#26202)

samvaity · web-flow · commit a00245c61b64 · 2022-01-21T11:01:23.000-08:00
diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/DocumentAnalysisAsyncClient.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/DocumentAnalysisAsyncClient.java
@@ -420,7 +420,6 @@ private Mono<PollResponse<DocumentOperationResult>> processAnalyzeModelResponse(
                 status = LongRunningOperationStatus.SUCCESSFULLY_COMPLETED;
                 break;
             case FAILED:
-                // TODO (Revisit error logic https://github.com/Azure/azure-sdk-for-java-pr/issues/1337)
                 throw logger.logExceptionAsError(
                     Transforms.toDocumentModelOperationException(analyzeResultOperationResponse.getValue().getError()));
             default:
diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/administration/DocumentModelAdministrationAsyncClient.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/administration/DocumentModelAdministrationAsyncClient.java
@@ -941,7 +941,6 @@ private Mono<PollResponse<DocumentOperationResult>> processBuildingModelResponse
                 status = LongRunningOperationStatus.SUCCESSFULLY_COMPLETED;
                 break;
             case FAILED:
-                // TODO (Revisit error logic https://github.com/Azure/azure-sdk-for-java-pr/issues/1337)
                 throw logger.logExceptionAsError(
                     Transforms.toDocumentModelOperationException(getOperationResponse.getError()));
             case CANCELED:
diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/administration/models/DocumentModelOperationError.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/administration/models/DocumentModelOperationError.java
@@ -3,7 +3,7 @@
 
 package com.azure.ai.formrecognizer.administration.models;
 
-import com.azure.ai.formrecognizer.implementation.util.FormRecognizerErrorHelper;
+import com.azure.ai.formrecognizer.implementation.util.DocumentModelOperationErrorHelper;
 
 import java.util.List;
 
@@ -132,7 +132,7 @@ void setInnerError(DocumentModelOperationInnerError innerError) {
     }
 
     static {
-        FormRecognizerErrorHelper.setAccessor(new FormRecognizerErrorHelper.FormRecognizerErrorAccessor() {
+        DocumentModelOperationErrorHelper.setAccessor(new DocumentModelOperationErrorHelper.DocumentModelOperationErrorAccessor() {
             @Override
             public void setCode(DocumentModelOperationError documentModelOperationError, String errorCode) {
                 documentModelOperationError.setCode(errorCode);
diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/implementation/util/DocumentAnalysisExceptionHelper.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/implementation/util/DocumentAnalysisExceptionHelper.java
diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/implementation/util/DocumentModelOperationErrorHelper.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/implementation/util/DocumentModelOperationErrorHelper.java
@@ -11,16 +11,16 @@
 /**
  * The helper class to set the non-public properties of an {@link DocumentModelOperationError} instance.
  */
-public final class FormRecognizerErrorHelper {
-    private static FormRecognizerErrorAccessor accessor;
+public final class DocumentModelOperationErrorHelper {
+    private static DocumentModelOperationErrorAccessor accessor;
 
-    private FormRecognizerErrorHelper() {
+    private DocumentModelOperationErrorHelper() {
     }
 
     /**
      * Type defining the methods to set the non-public properties of an {@link DocumentModelOperationError} instance.
      */
-    public interface FormRecognizerErrorAccessor {
+    public interface DocumentModelOperationErrorAccessor {
         void setCode(DocumentModelOperationError documentModelOperationError, String errorCode);
         void setMessage(DocumentModelOperationError documentModelOperationError, String message);
 
@@ -34,10 +34,10 @@ public interface FormRecognizerErrorAccessor {
     /**
      * The method called from {@link DocumentModelOperationError} to set it's accessor.
      *
-     * @param formRecognizerErrorAccessor The accessor.
+     * @param documentModelOperationErrorAccessor The accessor.
      */
-    public static void setAccessor(final FormRecognizerErrorAccessor formRecognizerErrorAccessor) {
-        accessor = formRecognizerErrorAccessor;
+    public static void setAccessor(final DocumentModelOperationErrorAccessor documentModelOperationErrorAccessor) {
+        accessor = documentModelOperationErrorAccessor;
     }
 
     static void setCode(DocumentModelOperationError documentModelOperationError, String errorCode) {
diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/implementation/util/Transforms.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/implementation/util/Transforms.java
@@ -563,10 +563,9 @@ public static DocumentOperationResult toDocumentOperationResult(
     }
 
     public static DocumentModelOperationException toDocumentModelOperationException(Error error) {
-        DocumentModelOperationException documentModelOperationException = new DocumentModelOperationException();
         DocumentModelOperationError documentModelOperationError = toDocumentModelOperationError(error);
-        DocumentAnalysisExceptionHelper.setErrorInformation(documentModelOperationException,
-            documentModelOperationError);
+        DocumentModelOperationException documentModelOperationException
+            = new DocumentModelOperationException(documentModelOperationError);
         return documentModelOperationException;
     }
 
@@ -589,11 +588,11 @@ private static ResponseError toResponseError(Error error) {
     private static DocumentModelOperationError toDocumentModelOperationError(Error error) {
         if (error != null) {
             DocumentModelOperationError documentModelOperationError = new DocumentModelOperationError();
-            FormRecognizerErrorHelper.setCode(documentModelOperationError, error.getCode());
-            FormRecognizerErrorHelper.setInnerError(documentModelOperationError, toInnerError(error.getInnererror()));
-            FormRecognizerErrorHelper.setDetails(documentModelOperationError, toErrorDetails(error.getDetails()));
-            FormRecognizerErrorHelper.setMessage(documentModelOperationError, error.getMessage());
-            FormRecognizerErrorHelper.setTarget(documentModelOperationError, error.getTarget());
+            DocumentModelOperationErrorHelper.setCode(documentModelOperationError, error.getCode());
+            DocumentModelOperationErrorHelper.setInnerError(documentModelOperationError, toInnerError(error.getInnererror()));
+            DocumentModelOperationErrorHelper.setDetails(documentModelOperationError, toErrorDetails(error.getDetails()));
+            DocumentModelOperationErrorHelper.setMessage(documentModelOperationError, error.getMessage());
+            DocumentModelOperationErrorHelper.setTarget(documentModelOperationError, error.getTarget());
             return documentModelOperationError;
         }
         return null;
diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/models/DocumentModelOperationException.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/models/DocumentModelOperationException.java
@@ -4,11 +4,10 @@
 package com.azure.ai.formrecognizer.models;
 
 import com.azure.ai.formrecognizer.administration.models.DocumentModelOperationError;
-import com.azure.ai.formrecognizer.implementation.util.DocumentAnalysisExceptionHelper;
 import com.azure.core.exception.AzureException;
 
 /**
- * General exception for client-side related failures related to document model analysis, or creation
+ * Exception for failures related to errors encountered during document analysis, or creation
  * operation.
  *
  * @see DocumentModelOperationError
@@ -18,27 +17,26 @@ public final class DocumentModelOperationException extends AzureException {
     /**
      * the error information for this exception.
      */
-    private DocumentModelOperationError documentModelOperationError;
+    private final DocumentModelOperationError documentModelOperationError;
 
     /**
-     * Get the error information for this exception.
+     * Constructs a new DocumentModelOperationException
      *
-     * @return the error information for this exception.
+     * @param documentModelOperationError the documentModelOperationError underlying this exception
      */
-    public DocumentModelOperationError getDocumentModelOperationError() {
-        return this.documentModelOperationError;
+    public DocumentModelOperationException(DocumentModelOperationError documentModelOperationError) {
+        super(documentModelOperationError.getInnerError() != null
+            ? documentModelOperationError.getInnerError().getMessage()
+            : documentModelOperationError.getMessage());
+        this.documentModelOperationError = documentModelOperationError;
     }
 
     /**
-     * Set the error information for this exception.
+     * Get the error information for this exception.
+     *
+     * @return the error information for this exception.
      */
-    void setDocumentModelOperationError(DocumentModelOperationError documentModelOperationError) {
-        this.documentModelOperationError = documentModelOperationError;
-    }
-
-    static {
-        DocumentAnalysisExceptionHelper.setAccessor(
-            ((documentModelOperationException, documentModelOperationError)
-                -> documentModelOperationException.setDocumentModelOperationError(documentModelOperationError)));
+    public DocumentModelOperationError getDocumentModelOperationError() {
+        return this.documentModelOperationError;
     }
 }
diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/test/java/com/azure/ai/formrecognizer/TestUtils.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/test/java/com/azure/ai/formrecognizer/TestUtils.java
@@ -66,6 +66,8 @@ public final class TestUtils {
 
     public static final String FORM_RECOGNIZER_TRAINING_BLOB_CONTAINER_SAS_URL_CONFIGURATION =
         Configuration.getGlobalConfiguration().get("FORM_RECOGNIZER_TRAINING_BLOB_CONTAINER_SAS_URL");
+    public static final String FORM_RECOGNIZER_ERROR_TRAINING_BLOB_CONTAINER_SAS_URL_CONFIGURATION =
+        Configuration.getGlobalConfiguration().get("FORM_RECOGNIZER_ERROR_TRAINING_BLOB_CONTAINER_SAS_URL");
     public static final String FORM_RECOGNIZER_TESTING_BLOB_CONTAINER_SAS_URL_CONFIGURATION =
         Configuration.getGlobalConfiguration().get("FORM_RECOGNIZER_TESTING_BLOB_CONTAINER_SAS_URL");
     public static final String AZURE_FORM_RECOGNIZER_API_KEY_CONFIGURATION
@@ -128,6 +130,10 @@ public static void getTrainingDataContainerHelper(Consumer<String> testRunner, b
         testRunner.accept(getTrainingFilesContainerUrl(isPlaybackMode));
     }
 
+    public static void getErrorTrainingDataContainerHelper(Consumer<String> testRunner, boolean isPlaybackMode) {
+        testRunner.accept(getErrorTrainingFilesContainerUrl(isPlaybackMode));
+    }
+
     public static void getMultipageTrainingContainerHelper(Consumer<String> testRunner, boolean isPlaybackMode) {
         testRunner.accept(getMultipageTrainingSasUri(isPlaybackMode));
     }
@@ -173,6 +179,15 @@ private static String getTrainingFilesContainerUrl(boolean isPlaybackMode) {
         return isPlaybackMode ? "https://isPlaybackmode" : FORM_RECOGNIZER_TRAINING_BLOB_CONTAINER_SAS_URL_CONFIGURATION;
     }
 
+    /**
+     * Get the training data set SAS Url value based on the test running mode.
+     *
+     * @return the training data set Url
+     */
+    private static String getErrorTrainingFilesContainerUrl(boolean isPlaybackMode) {
+        return isPlaybackMode ? "https://isPlaybackmode" : FORM_RECOGNIZER_ERROR_TRAINING_BLOB_CONTAINER_SAS_URL_CONFIGURATION;
+    }
+
     /**
      * Get the multipage training data set SAS Url value based on the test running mode.
      *
diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/test/java/com/azure/ai/formrecognizer/administration/DocumentModelAdministrationAsyncClientTest.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/test/java/com/azure/ai/formrecognizer/administration/DocumentModelAdministrationAsyncClientTest.java
@@ -8,8 +8,10 @@
 import com.azure.ai.formrecognizer.administration.models.CopyAuthorization;
 import com.azure.ai.formrecognizer.administration.models.CreateComposedModelOptions;
 import com.azure.ai.formrecognizer.administration.models.DocumentModel;
+import com.azure.ai.formrecognizer.administration.models.DocumentModelOperationError;
 import com.azure.ai.formrecognizer.implementation.util.Utility;
 import com.azure.ai.formrecognizer.models.AnalyzeResult;
+import com.azure.ai.formrecognizer.models.DocumentModelOperationException;
 import com.azure.ai.formrecognizer.models.DocumentOperationResult;
 import com.azure.core.exception.HttpResponseException;
 import com.azure.core.http.HttpClient;
@@ -197,6 +199,33 @@ public void beginBuildModel(HttpClient httpClient, DocumentAnalysisServiceVersio
         });
     }
 
+    /**
+     * Verifies that building a model throws a DocumentModelOperationException when the training container is missing
+     * OCR files.
+     */
+    @ParameterizedTest(name = DISPLAY_NAME_WITH_ARGUMENTS)
+    @MethodSource("com.azure.ai.formrecognizer.TestUtils#getTestParameters")
+    public void beginBuildModelThrowsDocumentModelOperationException(HttpClient httpClient, DocumentAnalysisServiceVersion serviceVersion) {
+        client = getDocumentModelAdminAsyncClient(httpClient, serviceVersion);
+        buildModelErrorRunner((errorTrainingFilesUrl) -> {
+            DocumentModelOperationException documentModelOperationException
+                = Assertions.assertThrows(DocumentModelOperationException.class,
+                    () ->
+                        client.beginBuildModel(errorTrainingFilesUrl, null)
+                            .setPollInterval(durationTestMode)
+                            .getSyncPoller()
+                            .getFinalResult());
+
+            Assertions.assertEquals("Invalid request.", documentModelOperationException.getMessage());
+            DocumentModelOperationError actualError =
+                documentModelOperationException.getDocumentModelOperationError();
+            Assertions.assertEquals("InvalidRequest", actualError.getCode());
+            Assertions.assertEquals("Could not build the model: Can't find any OCR files for training.",
+                actualError.getDetails().get(0).getMessage());
+
+        });
+    }
+
     /**
      * Verifies the result of the copy operation for valid parameters.
      */
diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/test/java/com/azure/ai/formrecognizer/administration/DocumentModelAdministrationClientTestBase.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/test/java/com/azure/ai/formrecognizer/administration/DocumentModelAdministrationClientTestBase.java
@@ -63,7 +63,6 @@ DocumentModelAdministrationClientBuilder getDocumentModelAdminClientBuilder(Http
             if (useKeyCredential) {
                 builder.credential(new AzureKeyCredential(TestUtils.AZURE_FORM_RECOGNIZER_API_KEY_CONFIGURATION));
             } else {
-                System.out.println("In LIVE MODE");
                 builder.credential(new DefaultAzureCredentialBuilder().build());
             }
         }
@@ -108,6 +107,10 @@ void buildModelRunner(Consumer<String> testRunner) {
         TestUtils.getTrainingDataContainerHelper(testRunner, interceptorManager.isPlaybackMode());
     }
 
+    void buildModelErrorRunner(Consumer<String> testRunner) {
+        TestUtils.getErrorTrainingDataContainerHelper(testRunner, interceptorManager.isPlaybackMode());
+    }
+
     void multipageTrainingRunner(Consumer<String> testRunner) {
         TestUtils.getMultipageTrainingContainerHelper(testRunner, interceptorManager.isPlaybackMode());
     }
diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/test/resources/session-records/DocumentModelAdministrationAsyncClientTest.beginBuildModelThrowsDocumentModelOperationException[1].json b/sdk/formrecognizer/azure-ai-formrecognizer/src/test/resources/session-records/DocumentModelAdministrationAsyncClientTest.beginBuildModelThrowsDocumentModelOperationException[1].json
@@ -0,0 +1,44 @@
+{
+  "networkCallRecords" : [ {
+    "Method" : "POST",
+    "Uri" : "https://REDACTED.cognitiveservices.azure.com/formrecognizer/documentModels:build?api-version=2021-09-30-preview",
+    "Headers" : {
+      "User-Agent" : "azsdk-java-azure-ai-formrecognizer/4.0.0-beta.4 (11.0.9; Windows 10; 10.0)",
+      "x-ms-client-request-id" : "6a2a76df-508d-4416-aebd-19a977645f4e",
+      "Content-Type" : "application/json"
+    },
+    "Response" : {
+      "content-length" : "0",
+      "x-envoy-upstream-service-time" : "3284",
+      "Strict-Transport-Security" : "max-age=31536000; includeSubDomains; preload",
+      "operation-location" : "https://shafangfr.cognitiveservices.azure.com/formrecognizer/operations/31523652547_8d9dc44b-6aa1-4e63-8c6a-f944d037d4b5?api-version=2021-09-30-preview",
+      "x-content-type-options" : "nosniff",
+      "apim-request-id" : "8d9dc44b-6aa1-4e63-8c6a-f944d037d4b5",
+      "retry-after" : "0",
+      "StatusCode" : "202",
+      "Date" : "Thu, 20 Jan 2022 21:50:55 GMT"
+    },
+    "Exception" : null
+  }, {
+    "Method" : "GET",
+    "Uri" : "https://REDACTED.cognitiveservices.azure.com/formrecognizer/operations/31523652547_8d9dc44b-6aa1-4e63-8c6a-f944d037d4b5?api-version=2021-09-30-preview",
+    "Headers" : {
+      "User-Agent" : "azsdk-java-azure-ai-formrecognizer/4.0.0-beta.4 (11.0.9; Windows 10; 10.0)",
+      "x-ms-client-request-id" : "438b69b5-fb4d-4590-841d-a5a20f5e99c9"
+    },
+    "Response" : {
+      "Transfer-Encoding" : "chunked",
+      "x-envoy-upstream-service-time" : "23",
+      "Strict-Transport-Security" : "max-age=31536000; includeSubDomains; preload",
+      "x-content-type-options" : "nosniff",
+      "apim-request-id" : "357b742d-78ec-4a80-8e22-88772439278b",
+      "retry-after" : "0",
+      "StatusCode" : "200",
+      "Body" : "{\n  \"operationId\": \"31523652547_8d9dc44b-6aa1-4e63-8c6a-f944d037d4b5\",\n  \"kind\": \"documentModelBuild\",\n  \"status\": \"failed\",\n  \"createdDateTime\": \"2022-01-20T21:50:53Z\",\n  \"lastUpdatedDateTime\": \"2022-01-20T21:50:56Z\",\n  \"resourceLocation\": \"https://shafangfr.cognitiveservices.azure.com/formrecognizer/documentModels/e653bb79-29f7-401b-a165-38a149c0eced?api-version=2021-09-30-preview\",\n  \"percentCompleted\": 100,\n  \"error\": {\n    \"code\": \"InvalidRequest\",\n    \"message\": \"Invalid request.\",\n    \"details\": [\n      {\n        \"code\": \"ModelBuildError\",\n        \"message\": \"Could not build the model: Can\\u0027t find any OCR files for training.\"\n      }\n    ]\n  }\n}",
+      "Date" : "Thu, 20 Jan 2022 21:51:00 GMT",
+      "Content-Type" : "application/json; charset=utf-8"
+    },
+    "Exception" : null
+  } ],
+  "variables" : [ ]
+}
diff --git a/sdk/formrecognizer/test-resources.json b/sdk/formrecognizer/test-resources.json
@@ -54,6 +54,10 @@
       "type": "string",
       "defaultValue": "trainingdata"
     },
+    "errorTrainingDataContainer": {
+      "type": "string",
+      "defaultValue": "trainingdata-error"
+    },
     "blobResourceId": {
       "type": "string",
       "defaultValue": "[resourceId('2cd617ea-1866-46b1-90e3-fffb087ebf9b', 'TrainingData', 'Microsoft.Storage/storageAccounts', parameters('blobStorageAccount'))]"
@@ -67,6 +71,15 @@
         "signedResource": "c"
       }
     },
+    "errorTrainingDataSasProperties": {
+      "type": "object",
+      "defaultValue": {
+        "canonicalizedResource": "[concat('/blob/', parameters('blobStorageAccount'), '/', parameters('errorTrainingDataContainer'))]",
+        "signedExpiry": "[dateTimeAdd(utcNow('u'), 'PT2H')]",
+        "signedPermission": "rl",
+        "signedResource": "c"
+      }
+    },
     "testingDataContainer": {
       "type": "string",
       "defaultValue": "testingdata"
@@ -166,6 +179,10 @@
       "type": "string",
       "value": "[concat(reference(parameters('blobResourceId'), '2019-06-01').primaryEndpoints.blob, parameters('trainingDataContainer'), '?', listServiceSas(parameters('blobResourceId'), '2019-06-01', parameters('trainingDataSasProperties')).serviceSasToken)]"
     },
+    "FORM_RECOGNIZER_ERROR_TRAINING_BLOB_CONTAINER_SAS_URL": {
+      "type": "string",
+      "value": "[concat(reference(parameters('blobResourceId'), '2019-06-01').primaryEndpoints.blob, parameters('errorTrainingDataContainer'), '?', listServiceSas(parameters('blobResourceId'), '2019-06-01', parameters('errorTrainingDataSasProperties')).serviceSasToken)]"
+    },
     "FORM_RECOGNIZER_TESTING_BLOB_CONTAINER_SAS_URL": {
       "type": "string",
       "value": "[concat(reference(parameters('blobResourceId'), '2019-06-01').primaryEndpoints.blob, parameters('testingDataContainer'), '?', listServiceSas(parameters('blobResourceId'), '2019-06-01', parameters('testingDataSasProperties')).serviceSasToken)]"

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,6 @@ DocumentModelAdministrationClientBuilder getDocumentModelAdminClientBuilder(Http`
`63`	`63`	`if (useKeyCredential) {`
`64`	`64`	`builder.credential(new AzureKeyCredential(TestUtils.AZURE_FORM_RECOGNIZER_API_KEY_CONFIGURATION));`
`65`	`65`	`} else {`
`66`		`- System.out.println("In LIVE MODE");`
`67`	`66`	`builder.credential(new DefaultAzureCredentialBuilder().build());`
`68`	`67`	`}`
`69`	`68`	`}`
`@@ -108,6 +107,10 @@ void buildModelRunner(Consumer<String> testRunner) {`
`108`	`107`	`TestUtils.getTrainingDataContainerHelper(testRunner, interceptorManager.isPlaybackMode());`
`109`	`108`	`}`
`110`	`109`
	`110`	`+ void buildModelErrorRunner(Consumer<String> testRunner) {`
	`111`	`+ TestUtils.getErrorTrainingDataContainerHelper(testRunner, interceptorManager.isPlaybackMode());`
	`112`	`+ }`
	`113`	`+`
`111`	`114`	`void multipageTrainingRunner(Consumer<String> testRunner) {`
`112`	`115`	`TestUtils.getMultipageTrainingContainerHelper(testRunner, interceptorManager.isPlaybackMode());`
`113`	`116`	`}`