Merge pull request #22 from tainguyenbui/feature/HASI-000_improves_error_handling_for_replacefile_and_upload_dataset_thumbnail

HASI-000 improves error handling for replacefile and upload dataset thumbnail

Author: tainguyenbui

package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-dataverse",
-  "version": "1.0.34",
+  "version": "1.0.35",
   "description": "A Dataverse module for JavaScript/TypeScript",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

src/dataverseClient.ts

@@ -8,6 +8,7 @@ import { DatasetUtil } from './utils/datasetUtil'
 import request from 'request-promise'
 import { DatasetVersionUpgradeType } from './@types/datasetVersionUpgradeType'
 import { DatasetVersionType } from './@types/datasetVersionType'
+import { ResponseUtil } from './utils/ResponseUtil'
 
 export class DataverseClient {
   private readonly host: string
@@ -120,7 +121,7 @@ export class DataverseClient {
     }
 
     return request.post(options).catch(error => {
-      throw new DataverseException(error.response.statusCode, error.response.body ? JSON.parse(error.response.body).message : '')
+      throw new DataverseException(error.response.statusCode, ResponseUtil.getErrorMessage(error.response.body))
     })
   }
 
@@ -163,7 +164,7 @@ export class DataverseClient {
     }
 
     return request.post(options).catch(error => {
-      throw new DataverseException(error.response.statusCode, error.response.body ? error.response.body.message : '')
+      throw new DataverseException(error.response.statusCode, ResponseUtil.getErrorMessage(error.response.body))
     })
   }
 

src/utils/ResponseUtil.ts

@@ -0,0 +1,13 @@
+export class ResponseUtil {
+  public static getErrorMessage(body: string): string {
+    let message: string
+    try {
+      message = JSON.parse(body).message
+    }
+    catch {
+      message = ''
+    }
+
+    return message
+  }
+}

test/dataverseClient.spec.ts

@@ -12,6 +12,7 @@ import { BasicDatasetInformation } from '../src/@types/basicDataset'
 import { DatasetUtil } from '../src/utils/datasetUtil'
 import fs from 'fs'
 import { DatasetVersionUpgradeType } from '../src/@types/datasetVersionUpgradeType'
+import { ResponseUtil } from '../src/utils/ResponseUtil'
 
 describe('DataverseClient', () => {
   const sandbox: SinonSandbox = createSandbox()
@@ -20,6 +21,7 @@ describe('DataverseClient', () => {
   let host: string
   let client: DataverseClient
 
+  let mockErrorMessage: string
   let mockResponse: object
   let mockDatasetInformation: object
 
@@ -28,12 +30,14 @@ describe('DataverseClient', () => {
   let requestPostStub: SinonStub
 
   let mapBasicDatasetInformationStub: SinonStub
+  let getErrorMessageStub: SinonStub
 
   beforeEach(() => {
     apiToken = random.uuid()
     host = internet.url()
     client = new DataverseClient(host, apiToken)
 
+    mockErrorMessage = random.words()
     mockResponse = {
       status: random.number(),
       data: {}
@@ -61,6 +65,7 @@ describe('DataverseClient', () => {
     requestPostStub = sandbox.stub(request, 'post').resolves(mockResponse)
 
     mapBasicDatasetInformationStub = sandbox.stub(DatasetUtil, 'mapBasicDatasetInformation').returns(mockDatasetInformation)
+    getErrorMessageStub = sandbox.stub(ResponseUtil, 'getErrorMessage').returns(mockErrorMessage)
   })
 
   afterEach(() => {
@@ -905,8 +910,13 @@ describe('DataverseClient', () => {
     const testImage = fs.readFileSync(path.resolve(__dirname, '../test/assets/theam.png'), 'base64')
     const imageBuffer = Buffer.from(testImage, 'base64')
 
+    let datasetId: string
+
+    beforeEach(() => {
+      datasetId = random.number().toString()
+    })
+
     it('should call request with expected url', async () => {
-      const datasetId: string = random.number().toString()
       const expectedRequest = {
         url: `${host}/api/datasets/${datasetId}/thumbnail`,
         headers: { 'X-Dataverse-key': apiToken },
@@ -921,7 +931,6 @@ describe('DataverseClient', () => {
     })
 
     it('should call request with expected headers when no apiToken provided', async () => {
-      const datasetId: string = random.number().toString()
       const expectedRequest = {
         url: `${host}/api/datasets/${datasetId}/thumbnail`,
         headers: { 'X-Dataverse-key': '' },
@@ -942,7 +951,6 @@ describe('DataverseClient', () => {
         ...mockResponse,
         'test': randomValue
       }
-      const datasetId: string = random.number().toString()
 
       const expectedRequest = {
         url: `${host}/api/datasets/${datasetId}/thumbnail`,
@@ -958,19 +966,40 @@ describe('DataverseClient', () => {
       expect(response).to.be.deep.equal(expectedResponse)
     })
 
-    it('should throw expected error', async () => {
-      const datasetId = random.word()
-      const errorMessage = random.words()
-      const errorCode = random.number()
-      requestPostStub.rejects({ response: { statusCode: errorCode, body: JSON.stringify({ message: errorMessage }) } })
+    describe('on error', () => {
+      let mockErrorCode: number
+      let mockBody: string
 
-      let error: DataverseException = undefined
+      beforeEach(() => {
+        mockErrorCode = random.number()
+        mockBody = random.words()
+        requestPostStub.rejects({
+          response: {
+            statusCode: mockErrorCode,
+            body: mockBody
+          }
+        })
+      })
 
-      await client.uploadDatasetThumbnail(datasetId, imageBuffer).catch(e => error = e)
+      it('should call getErrorMessage', async () => {
+        let error: DataverseException = undefined
 
-      expect(error).to.be.instanceOf(Error)
-      expect(error.message).to.be.equal(errorMessage)
-      expect(error.errorCode).to.be.equal(errorCode)
+        await client.uploadDatasetThumbnail(datasetId, imageBuffer).catch(e => error = e)
+
+        expect(error).to.be.instanceOf(Error)
+        assert.calledOnce(getErrorMessageStub)
+        assert.calledWithExactly(getErrorMessageStub, mockBody)
+      })
+
+      it('should throw expected error', async () => {
+        let error: DataverseException = undefined
+
+        await client.uploadDatasetThumbnail(datasetId, imageBuffer).catch(e => error = e)
+
+        expect(error).to.be.instanceOf(Error)
+        expect(error.message).to.be.equal(mockErrorMessage)
+        expect(error.errorCode).to.be.equal(mockErrorCode)
+      })
     })
   })
 
@@ -1238,18 +1267,40 @@ describe('DataverseClient', () => {
       expect(response).to.be.deep.equal(expectedResponse)
     })
 
-    it('should throw expected error', async () => {
-      const errorMessage = random.words()
-      const errorCode = random.number()
-      requestPostStub.rejects({ response: { statusCode: errorCode, body: { message: errorMessage } } })
+    describe('on error', () => {
+      let mockErrorCode: number
+      let mockBody: string
 
-      let error: DataverseException = undefined
+      beforeEach(() => {
+        mockErrorCode = random.number()
+        mockBody = random.words()
+        requestPostStub.rejects({
+          response: {
+            statusCode: mockErrorCode,
+            body: mockBody
+          }
+        })
+      })
 
-      await client.replaceFile(mockFileId, mockFilename, fileBuffer).catch(e => error = e)
+      it('should call getErrorMessage', async () => {
+        let error: DataverseException = undefined
 
-      expect(error).to.be.instanceOf(Error)
-      expect(error.message).to.be.equal(errorMessage)
-      expect(error.errorCode).to.be.equal(errorCode)
+        await client.replaceFile(mockFileId, mockFilename, fileBuffer).catch(e => error = e)
+
+        expect(error).to.be.instanceOf(Error)
+        assert.calledOnce(getErrorMessageStub)
+        assert.calledWithExactly(getErrorMessageStub, mockBody)
+      })
+
+      it('should throw expected error', async () => {
+        let error: DataverseException = undefined
+
+        await client.replaceFile(mockFileId, mockFilename, fileBuffer).catch(e => error = e)
+
+        expect(error).to.be.instanceOf(Error)
+        expect(error.message).to.be.equal(mockErrorMessage)
+        expect(error.errorCode).to.be.equal(mockErrorCode)
+      })
     })
   })
 

test/utils/ResponseUtil.spec.ts

@@ -0,0 +1,20 @@
+import { ResponseUtil } from '../../src/utils/ResponseUtil'
+import { random } from 'faker'
+
+describe('ResponseUtil', () => {
+  describe('getErrorMessage', () => {
+    let mockMessage: string
+
+    beforeEach(() => {
+      mockMessage = random.words()
+    })
+
+    it('should return expected message', () => {
+      const expectedResult: string = mockMessage
+
+      const result: string = ResponseUtil.getErrorMessage(JSON.stringify({ message: mockMessage }))
+
+      expect(result).toEqual(expectedResult)
+    })
+  })
+})