Print out details of AggregateError originating from Spectral (@microsoft.azure/openapi-validator v2.1.4 -> v2.1.5)

common/changes/@microsoft.azure/openapi-validator/log_aggregate_errors_2023-09-21-05-40.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft.azure/openapi-validator",
+      "comment": "Add printing out of details of spectral run AggregateErrors. Addresses https://github.com/Azure/azure-sdk-tools/issues/6856",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@microsoft.azure/openapi-validator"
+}

packages/azure-openapi-validator/autorest/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft.azure/openapi-validator",
-  "version": "2.1.4",
+  "version": "2.1.5",
   "description": "Azure OpenAPI Validator",
   "main": "./dist/index.js",
   "scripts": {

packages/azure-openapi-validator/autorest/src/spectral-plugin-func.ts

@@ -80,10 +80,7 @@ export async function spectralPluginFunc(initiator: IAutoRestPluginInitiator): P
       const normalizedFile = file.startsWith("file:///") ? fileURLToPath(file) : file
       await runSpectral(openapiDefinitionObject, normalizedFile, initiator.Message.bind(initiator), spectral)
     } catch (e) {
-      initiator.Message({
-        Channel: "fatal",
-        Text: `spectralPluginFunc: Failed validating: '${file}', error encountered: ` + e,
-      })
+      catchSpectralRunErrors(file, e, initiator)
     }
   }
 
@@ -233,3 +230,29 @@ export async function getRuleSet(openapiType: OpenApiTypes): Promise<[ruleset: R
     return namesOfRulesInStagingOnly
   }
 }
+
+/** Spectral (from "@stoplight/spectral-core") may throw https://www.npmjs.com/package/es-aggregate-error
+ * If so, we print out all the constituent errors.
+ * For additional context, see: https://github.com/Azure/azure-sdk-tools/issues/6856
+ */
+function catchSpectralRunErrors(file: string, e: any, initiator: any) {
+  // Initialize an array to collect error messages
+  const errorMessages: string[] = [e]
+
+  // Check if "e" contains the "errors" property
+  if (e && e.errors && Array.isArray(e.errors)) {
+    e.errors.forEach((error: any, index: number) => {
+      // Push each error message into the array
+      errorMessages.push(`Error ${index + 1}: ${error.message}`)
+    })
+  }
+
+  // Combine all error messages with newlines
+  const combinedErrorMessages = errorMessages.join("\n")
+
+  // Call initiator.Message with the combined error message
+  initiator.Message({
+    Channel: "fatal",
+    Text: `spectralPluginFunc: Failed validating: '${file}'. Errors encountered:\n${combinedErrorMessages}`,
+  })
+}