chore: use '%o' to format errors in ErrorWrapper (#59)

* use %o to format errors in ErrorWrapper
* fix: linter issues

Author: sbellone

src/SDKErrors.js

@@ -45,19 +45,19 @@ module.exports = {
 
 // Define your error codes with the wrapper
 E('ERROR_SDK_INITIALIZATION', 'SDK initialization error(s). Missing arguments: %s')
-E('ERROR_GET_CALCULATED_METRICS', '%s')
-E('ERROR_GET_CALCULATED_METRIC_BY_ID', '%s')
-E('ERROR_GET_COLLECTIONS', '%s')
-E('ERROR_GET_COLLECTION_BY_ID', '%s')
-E('ERROR_GET_DATE_RANGES', '%s')
-E('ERROR_GET_DATE_RANGE_BY_ID', '%s')
-E('ERROR_GET_DIMENSIONS', '%s')
-E('ERROR_GET_DIMENSION_BY_ID', '%s')
-E('ERROR_GET_METRICS', '%s')
-E('ERROR_GET_METRIC_BY_ID', '%s')
-E('ERROR_GET_REPORT', '%s')
-E('ERROR_GET_SEGMENTS', '%s')
-E('ERROR_VALIDATE_SEGMENT', '%s')
-E('ERROR_GET_USERS', '%s')
-E('ERROR_GET_CURRENT_USER', '%s')
-E('ERROR_GET_USAGE_LOGS', '%s')
+E('ERROR_GET_CALCULATED_METRICS', '%o')
+E('ERROR_GET_CALCULATED_METRIC_BY_ID', '%o')
+E('ERROR_GET_COLLECTIONS', '%o')
+E('ERROR_GET_COLLECTION_BY_ID', '%o')
+E('ERROR_GET_DATE_RANGES', '%o')
+E('ERROR_GET_DATE_RANGE_BY_ID', '%o')
+E('ERROR_GET_DIMENSIONS', '%o')
+E('ERROR_GET_DIMENSION_BY_ID', '%o')
+E('ERROR_GET_METRICS', '%o')
+E('ERROR_GET_METRIC_BY_ID', '%o')
+E('ERROR_GET_REPORT', '%o')
+E('ERROR_GET_SEGMENTS', '%o')
+E('ERROR_VALIDATE_SEGMENT', '%o')
+E('ERROR_GET_USERS', '%o')
+E('ERROR_GET_CURRENT_USER', '%o')
+E('ERROR_GET_USAGE_LOGS', '%o')

test/index.test.js

@@ -119,6 +119,8 @@ test('test getCollectionById', async () => {
   res = await checkErrorResponse(api, url, method, new errorSDK.codes.ERROR_GET_COLLECTION_BY_ID(), [123])
   mockResponseWithMethod(url, method, mock.errors.Internal_Server_Error.err)
   res = await checkErrorResponse(api, url, method, new errorSDK.codes.ERROR_GET_COLLECTION_BY_ID(), [123])
+  mockResponseWithMethod(url, method, mock.errors.Resource_Not_Found.err)
+  res = await checkErrorResponse(api, url, method, new errorSDK.codes.ERROR_GET_COLLECTION_BY_ID(), [123])
 })
 
 test('test getDateRanges', async () => {
@@ -155,6 +157,8 @@ test('test getDateRangeById', async () => {
   // check error responses
   mockResponseWithMethod(url, method, mock.errors.Internal_Server_Error.err)
   res = await checkErrorResponse(api, url, method, new errorSDK.codes.ERROR_GET_DATE_RANGE_BY_ID(), [123])
+  mockResponseWithMethod(url, method, mock.errors.Resource_Not_Found.err)
+  res = await checkErrorResponse(api, url, method, new errorSDK.codes.ERROR_GET_DATE_RANGE_BY_ID(), [123])
 })
 
 test('test getDimensions', async () => {
@@ -239,6 +243,8 @@ test('test getMetricById', async () => {
   // check error responses
   mockResponseWithMethod(url, method, mock.errors.Unauthorized_Request.err)
   res = await checkErrorResponse(api, url, method, new errorSDK.codes.ERROR_GET_METRIC_BY_ID(), [111, 123])
+  mockResponseWithMethod(url, method, mock.errors.Resource_Not_Found.err)
+  res = await checkErrorResponse(api, url, method, new errorSDK.codes.ERROR_GET_METRIC_BY_ID(), [111, 123])
 })
 
 test('test getReport', async () => {
@@ -255,6 +261,8 @@ test('test getReport', async () => {
   // check error responses
   mockResponseWithMethod(url, method, mock.errors.Bad_Request.err)
   res = await checkErrorResponse(api, url, method, new errorSDK.codes.ERROR_GET_REPORT(), [{}])
+  mockResponseWithMethod(url, method, mock.errors.Invalid_Parameter.err)
+  res = await checkErrorResponse(api, url, method, new errorSDK.codes.ERROR_GET_REPORT(), [{}])
 })
 
 test('test getSegments', async () => {
@@ -397,6 +405,7 @@ function checkErrorResponse (fn, url, method, error, args = []) {
       .catch(e => {
         expect(e.name).toEqual(error.name)
         expect(e.code).toEqual(error.code)
+        expect(e.message).not.toContain('response: [Object]')
         resolve()
       })
   })

test/mock.js

@@ -9,13 +9,76 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
+class InvalidParametersError extends Error {
+  constructor () {
+    super('Bad Request')
+    this.status = 400
+    this.statusCode = 400
+    this.response = {
+      status: 400,
+      statusCode: 400,
+      response: {
+        ok: false,
+        url: 'https://analytics.adobe.io/api/test',
+        status: 400,
+        statusText: 'Bad Request',
+        headers: {},
+        text: '{"errorCode":"invalid_parameters","errorDescription":"The passed parameter is not valid","errorId":"e9610fe6-e700-4644-835a-33ed517572f2"}',
+        data: '{"errorCode":"invalid_parameters","errorDescription":"The passed parameter is not valid","errorId":"e9610fe6-e700-4644-835a-33ed517572f2"}',
+        body: {
+          errorCode: 'invalid_parameters',
+          errorDescription: 'The passed parameter is not valid',
+          errorId: 'e9610fe6-e700-4644-835a-33ed517572f2'
+        },
+        obj: {
+          errorCode: 'invalid_parameters',
+          errorDescription: 'The passed parameter is not valid',
+          errorId: 'e9610fe6-e700-4644-835a-33ed517572f2'
+        }
+      }
+    }
+  }
+}
+
+class ResourceNotFoundError extends Error {
+  constructor () {
+    super('Not Found')
+    this.status = 404
+    this.statusCode = 404
+    this.response = {
+      ok: false,
+      url: 'https://analytics.adobe.io/api/test',
+      status: 404,
+      statusText: 'Not Found',
+      headers: {},
+      text: '{"errorCode":"resource_not_found","errorDescription":"The asked resource was not found","errorId":"fb62df94-01a2-446b-b69d-024efe1afade"}',
+      data: '{"errorCode":"resource_not_found","errorDescription":"The asked resource was not found","errorId":"fb62df94-01a2-446b-b69d-024efe1afade"}',
+      body: {
+        errorCode: 'resource_not_found',
+        errorDescription: 'The asked resource was not found',
+        errorId: 'fb62df94-01a2-446b-b69d-024efe1afade'
+      },
+      obj: {
+        errorCode: 'resource_not_found',
+        errorDescription: 'The asked resource was not found',
+        errorId: 'fb62df94-01a2-446b-b69d-024efe1afade'
+      }
+    }
+  }
+}
+
 const BadRequest = {
   err: {
     throws: new Error('Bad Request')
   },
   message: 'Bad Request'
 
 }
+const InvalidParameter = {
+  err: {
+    throws: new InvalidParametersError()
+  }
+}
 const UnauthorizedRequest = {
   err: {
     throws: new Error('Unauthorized')
@@ -34,6 +97,11 @@ const NotFound = {
   },
   message: 'Not Found'
 }
+const ResourceNotFound = {
+  err: {
+    throws: new ResourceNotFoundError()
+  }
+}
 const InternalServerError = {
   err: {
     throws: new Error('Internal Server Error')
@@ -552,6 +620,8 @@ module.exports = {
     Unauthorized_Request: UnauthorizedRequest,
     Forbidden_Request: ForbiddenRequest,
     Not_Found: NotFound,
-    Internal_Server_Error: InternalServerError
+    Internal_Server_Error: InternalServerError,
+    Invalid_Parameter: InvalidParameter,
+    Resource_Not_Found: ResourceNotFound
   }
 }