Feat: Enhance error middleware

.gitignore

@@ -17,6 +17,7 @@ trash
 
 \.vscode/
 \.vs/
+\.idea/
 
 # confluent-schema-registry
 #

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+## [3.3.1] - 2024-05-30
+
+### Fixed
+- Exclude `.idea` folder from git vcs.
+- Show client-side errors when the error data is an object [#261](https://github.com/kafkajs/confluent-schema-registry/pull/261)
 
 ## [3.3.0] - 2022-10-04
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kafkajs/confluent-schema-registry",
-  "version": "3.3.0",
+  "version": "3.3.1",
   "main": "dist/index.js",
   "description": "ConfluentSchemaRegistry is a library that makes it easier to interact with the Confluent schema registry, it provides convenient methods to encode, decode and register new schemas using the Apache Avro serialization format.",
   "keywords": [

src/api/middleware/errorMiddleware.spec.ts

@@ -56,6 +56,18 @@ describe('ErrorMiddleware', () => {
       )
     })
 
+    it('raises an error with a message in case of client-side object error', async () => {
+      const message = { cause: 'unknown cause', metadata: { id: 1 } }
+      const response = createResponse(message)
+
+      await expect(
+        executedMiddleware.response(() => Promise.reject(response), undefined),
+      ).rejects.toHaveProperty(
+        'message',
+        `${middlewareParams.clientId} - Error, status 500: ${JSON.stringify(message)}`,
+      )
+    })
+
     it('raise an error with a default message if the error payload is empty', async () => {
       const response = createResponse('')
 

src/api/middleware/errorMiddleware.ts

@@ -12,9 +12,15 @@ class ResponseError extends Error {
   url: string
 
   constructor(clientName: string, response: ConfluenceResponse) {
+    const responseData = response.data()
+    const isResponseDataAnObject = typeof responseData === 'object'
+    const responseDataString = isResponseDataAnObject ? JSON.stringify(responseData) : responseData
+
     super(
-      `${clientName} - ${response.data().message ||
-        `Error, status ${response.status()}${response.data() ? `: ${response.data()}` : ''}`}`,
+      `${clientName} - ${responseData.message ||
+        `Error, status ${response.status()}${
+          responseDataString ? `: ${responseDataString}` : ''
+        }`}`,
     )
 
     const request = response.request()