Merge pull request #17 from apivideo/improve-errors

Improve error management

Author: olivier-lando

CHANGELOG.md

@@ -1,7 +1,10 @@
 # Changelog
 All changes to this project will be documented in this file.
 
-## [1.0.5] - 2022-03-24
+## [1.0.6] - 2022-04-22
+- Improve errors management
+
+## [1.0.5] - 2022-04-21
 - Fix date attributes types
 - Add authentication using an API key
 

dist/index.js

@@ -29,4 +29,12 @@ export declare type VideoUploadResponse = {
         readonly thumbnail?: string;
     };
 };
+export declare type VideoUploadError = {
+    status: number;
+    type?: string;
+    title?: string;
+    reason?: string;
+    raw: string;
+};
 export declare const apiResponseToVideoUploadResponse: (response: any) => VideoUploadResponse;
+export declare const parseErrorResponse: (xhr: XMLHttpRequest) => VideoUploadError;

dist/src/common.d.ts

@@ -1,6 +1,6 @@
 {
   "name": "@api.video/video-uploader",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "api.video video uploader",
   "repository": {
     "type": "git",

package-lock.json

@@ -31,6 +31,14 @@ export declare type VideoUploadResponse = {
   };
 };
 
+export type VideoUploadError = {
+  status: number;
+  type?: string;
+  title?: string;
+  reason?: string;
+  raw: string;
+}
+
 export const apiResponseToVideoUploadResponse = (response: any): VideoUploadResponse => {
   const res = {
     ...response,
@@ -41,4 +49,24 @@ export const apiResponseToVideoUploadResponse = (response: any): VideoUploadResp
   };
   delete res.public;
   return res;
+}
+
+export const parseErrorResponse = (xhr: XMLHttpRequest): VideoUploadError => {
+  try {
+    const parsedResponse = JSON.parse(xhr.response);
+
+    return {
+      status: xhr.status,
+      raw: xhr.response,
+      ...parsedResponse
+    }
+  } catch(e) {
+    // empty
+  }
+
+  return {
+    status: xhr.status,
+    raw: xhr.response,
+    reason: "UNKWOWN",
+  }
 }

package.json

@@ -1,4 +1,4 @@
-import { apiResponseToVideoUploadResponse, DEFAULT_API_HOST, DEFAULT_RETRIES, MIN_CHUNK_SIZE, VideoUploadResponse } from "./common";
+import { apiResponseToVideoUploadResponse, DEFAULT_API_HOST, DEFAULT_RETRIES, MIN_CHUNK_SIZE, parseErrorResponse, VideoUploadResponse } from "./common";
 import { PromiseQueue } from "./promise-queue";
 
 export interface ProgressiveUploaderOptionsWithUploadToken extends Options {
@@ -129,10 +129,7 @@ export class ProgressiveUploader {
             xhr.onreadystatechange = (_) => {
                 if (xhr.readyState === 4) { // DONE
                     if (xhr.status >= 400) {
-                        reject({
-                            status: xhr.status,
-                            message: xhr.response
-                        });
+                        reject(parseErrorResponse(xhr));
                     }
                 }
             };

src/common.ts

@@ -1,4 +1,4 @@
-import { apiResponseToVideoUploadResponse, DEFAULT_API_HOST, DEFAULT_CHUNK_SIZE, DEFAULT_RETRIES, MAX_CHUNK_SIZE, MIN_CHUNK_SIZE, VideoUploadResponse } from "./common";
+import { apiResponseToVideoUploadResponse, DEFAULT_API_HOST, DEFAULT_CHUNK_SIZE, DEFAULT_RETRIES, MAX_CHUNK_SIZE, MIN_CHUNK_SIZE, parseErrorResponse, VideoUploadResponse } from "./common";
 import { PromiseQueue } from "./promise-queue";
 
 export interface VideoUploaderOptionsWithUploadToken extends Options {
@@ -150,10 +150,7 @@ export class VideoUploader {
             xhr.onreadystatechange = (_) => {
                 if (xhr.readyState === 4) { // DONE
                     if (xhr.status >= 400) {
-                        reject({
-                            status: xhr.status,
-                            message: xhr.response
-                        });
+                        reject(parseErrorResponse(xhr));
                     }
                 }
             };

src/progressive-video-uploader.ts

@@ -166,8 +166,7 @@ describe('Errors & retries', () => {
         uploader.uploadPart(new File([new ArrayBuffer(5*1024*1024)], "filename")).then(() => {
             throw new Error('should not succeed');
         }).catch((e) => {
-            expect(e.status).to.be.eq(500);
-            expect(e.message).to.be.eq('{"error": "oups"}');
+            expect(e).to.be.eqls({ status: 500, raw: '{"error": "oups"}', error: 'oups' });
             done();
         });
     }).timeout(20000);

src/video-uploader.ts

@@ -192,8 +192,7 @@ describe('Errors & retries', () => {
         uploader.upload().then(() => {
             throw new Error('should not succeed');
         }).catch((e) => {
-            expect(e.status).to.be.eq(500);
-            expect(e.message).to.be.eq('{"error": "oups"}');
+            expect(e).to.be.eqls({ status: 500, raw: '{"error": "oups"}', error: 'oups' });
             done();
         });
     }).timeout(10000);