Merge pull request #6 from Vatis-Tech/refactor/VAT-382

VAT-382: add error handling

Author: einazare

CHANGELOG.md

@@ -51,6 +51,26 @@ No fixes were made.
 
 Each time you add new changes to this file, please add them bellow this line - i.e. between the [insertion](#insterion) section and the last version added.
 
+## [1.1.0] - 2022-04-04
+
+### Added
+
+- Added `errorHandler` prop for the client: this will be called now, instead of `console.error` and `throw` of the errors
+
+### Changed
+
+- Changed the way errors are handled: no error is consoled or thrown anymore, they are sent through the `errorHandler` prop so that the user/client can catch them and action accordingly
+
+### Removed
+
+- `const errorMessage = ...`
+- `console.error(errorMessage);`
+- `throw errorMessage;`
+
+### Fixed
+
+No fixes were made.
+
 ## [1.0.0] - 2022-03-28
 
 ### Added

README.md

@@ -1,6 +1,6 @@
 # @vatis-tech/asr-client-js
 
-![version](https://img.shields.io/badge/version-1.0.0-blue.svg)
+![version](https://img.shields.io/badge/version-1.1.0-blue.svg)
 ![license](https://img.shields.io/badge/license-MIT-blue.svg)
 ![GitHub issues open](https://img.shields.io/github/issues/Vatis-Tech/asr-client-js.svg)
 ![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/Vatis-Tech/asr-client-js.svg)
@@ -180,6 +180,10 @@ If `log` prop is set to `true` and the `logger` prop is not set, or is not a fun
 
 This is a **Function** that will be called upon successful destruction;
 
+### `errorHandler`
+
+This is a **Function** that will be called upon errors;
+
 ### `host`
 
 This is the host for generating a key. It defaults to "https://vatis.tech/".
@@ -224,8 +228,8 @@ After calling the `pause` method, you can call this one to resume recording.
 
 We officially support the latest versions of the following browsers:
 
-|                                                                   Chrome                                                                    |                                                                   Firefox                                                                    |                                                                   Safari                                                                    |                                                                             Safari                                                                             |                                                                   Edge                                                                    |
-| :-----------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: |
+|                                                              Chrome                                                              |                                                              Firefox                                                              |                                                              Safari                                                              |                                                                       Safari                                                                        |                                                              Edge                                                              |
+| :------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------: |
 | <img src="https://github.com/Vatis-Tech/asr-client-js/blob/main/github-assets/logos/chrome.png?raw=true" width="48" height="48"> | <img src="https://github.com/Vatis-Tech/asr-client-js/blob/main/github-assets/logos/firefox.png?raw=true" width="48" height="48"> | <img src="https://github.com/Vatis-Tech/asr-client-js/blob/main/github-assets/logos/safari.png?raw=true" width="48" height="48"> | <img src="https://github.com/Vatis-Tech/asr-client-js/blob/main/github-assets/logos/safari-technology-preview.png?raw=true" width="48" height="48"> | <img src="https://github.com/Vatis-Tech/asr-client-js/blob/main/github-assets/logos/edge.png?raw=true" width="48" height="48"> |
 
 ## Contributing

dist/CHANGELOG.md

@@ -51,6 +51,26 @@ No fixes were made.
 
 Each time you add new changes to this file, please add them bellow this line - i.e. between the [insertion](#insterion) section and the last version added.
 
+## [1.1.0] - 2022-04-04
+
+### Added
+
+- Added `errorHandler` prop for the client: this will be called now, instead of `console.error` and `throw` of the errors
+
+### Changed
+
+- Changed the way errors are handled: no error is consoled or thrown anymore, they are sent through the `errorHandler` prop so that the user/client can catch them and action accordingly
+
+### Removed
+
+- `const errorMessage = ...`
+- `console.error(errorMessage);`
+- `throw errorMessage;`
+
+### Fixed
+
+No fixes were made.
+
 ## [1.0.0] - 2022-03-28
 
 ### Added

dist/README.md

@@ -1,6 +1,6 @@
 # @vatis-tech/asr-client-js
 
-![version](https://img.shields.io/badge/version-1.0.0-blue.svg)
+![version](https://img.shields.io/badge/version-1.1.0-blue.svg)
 ![license](https://img.shields.io/badge/license-MIT-blue.svg)
 ![GitHub issues open](https://img.shields.io/github/issues/Vatis-Tech/asr-client-js.svg)
 ![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/Vatis-Tech/asr-client-js.svg)
@@ -180,6 +180,10 @@ If `log` prop is set to `true` and the `logger` prop is not set, or is not a fun
 
 This is a **Function** that will be called upon successful destruction;
 
+### `errorHandler`
+
+This is a **Function** that will be called upon errors;
+
 ### `host`
 
 This is the host for generating a key. It defaults to "https://vatis.tech/".
@@ -224,8 +228,8 @@ After calling the `pause` method, you can call this one to resume recording.
 
 We officially support the latest versions of the following browsers:
 
-|                                                                   Chrome                                                                    |                                                                   Firefox                                                                    |                                                                   Safari                                                                    |                                                                             Safari                                                                             |                                                                   Edge                                                                    |
-| :-----------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: |
+|                                                              Chrome                                                              |                                                              Firefox                                                              |                                                              Safari                                                              |                                                                       Safari                                                                        |                                                              Edge                                                              |
+| :------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------: |
 | <img src="https://github.com/Vatis-Tech/asr-client-js/blob/main/github-assets/logos/chrome.png?raw=true" width="48" height="48"> | <img src="https://github.com/Vatis-Tech/asr-client-js/blob/main/github-assets/logos/firefox.png?raw=true" width="48" height="48"> | <img src="https://github.com/Vatis-Tech/asr-client-js/blob/main/github-assets/logos/safari.png?raw=true" width="48" height="48"> | <img src="https://github.com/Vatis-Tech/asr-client-js/blob/main/github-assets/logos/safari-technology-preview.png?raw=true" width="48" height="48"> | <img src="https://github.com/Vatis-Tech/asr-client-js/blob/main/github-assets/logos/edge.png?raw=true" width="48" height="48"> |
 
 ## Contributing

dist/components/ApiKeyGenerator.js

@@ -18,7 +18,8 @@ var ApiKeyGenerator = /*#__PURE__*/function () {
     var apiUrl = _ref.apiUrl,
         responseCallback = _ref.responseCallback,
         apiKey = _ref.apiKey,
-        logger = _ref.logger;
+        logger = _ref.logger,
+        errorHandler = _ref.errorHandler;
 
     _classCallCheck(this, ApiKeyGenerator);
 
@@ -36,6 +37,9 @@ var ApiKeyGenerator = /*#__PURE__*/function () {
 
     _defineProperty(this, "logger", void 0);
 
+    _defineProperty(this, "errorHandler", void 0);
+
+    this.errorHandler = errorHandler;
     this.logger = logger;
     this.logger({
       currentState: "@vatis-tech/asr-client-js: Instantianting the \"ApiKeyGenerator\" plugin.",
@@ -63,13 +67,20 @@ var ApiKeyGenerator = /*#__PURE__*/function () {
   }, {
     key: "onError",
     value: function onError(e) {
-      var errorMessage = "Could not initilize the API KEY.";
-      console.error(errorMessage);
-      throw errorMessage;
+      this.logger({
+        currentState: "@vatis-tech/asr-client-js: Could not initilize the \"ApiKeyGenerator\" plugin.",
+        description: "@vatis-tech/asr-client-js: " + e
+      });
+      this.errorHandler(e);
     }
   }, {
     key: "onLoad",
     value: function onLoad() {
+      if (this.xmlHttp.status !== 200) {
+        this.onError(JSON.parse(this.xmlHttp.responseText));
+        return;
+      }
+
       this.logger({
         currentState: "@vatis-tech/asr-client-js: Initialized the \"ApiKeyGenerator\" plugin.",
         description: "@vatis-tech/asr-client-js: A valid key was received from the Vatis Tech API, in order to use the LIVE ASR service."

dist/components/InstanceReservation.js

@@ -22,7 +22,8 @@ var generateReservationUrl = _index["default"].generateReservationUrl;
 var InstanceReservation = /*#__PURE__*/function () {
   function InstanceReservation(_ref) {
     var responseCallback = _ref.responseCallback,
-        logger = _ref.logger;
+        logger = _ref.logger,
+        errorHandler = _ref.errorHandler;
 
     _classCallCheck(this, InstanceReservation);
 
@@ -40,6 +41,9 @@ var InstanceReservation = /*#__PURE__*/function () {
 
     _defineProperty(this, "logger", void 0);
 
+    _defineProperty(this, "errorHandler", void 0);
+
+    this.errorHandler = errorHandler;
     this.logger = logger;
     this.logger({
       currentState: "@vatis-tech/asr-client-js: Instantianting the \"InstanceReservation\" plugin.",
@@ -71,13 +75,20 @@ var InstanceReservation = /*#__PURE__*/function () {
   }, {
     key: "onError",
     value: function onError(e) {
-      var errorMessage = "Could not reserve a live asr instance.";
-      console.error(errorMessage);
-      throw errorMessage;
+      this.logger({
+        currentState: "@vatis-tech/asr-client-js: Could not initilize the \"InstanceReservation\" plugin.",
+        description: "@vatis-tech/asr-client-js: " + e
+      });
+      this.errorHandler(e);
     }
   }, {
     key: "onLoad",
     value: function onLoad() {
+      if (this.xmlHttp.status !== 200) {
+        this.onError(JSON.parse(this.xmlHttp.responseText));
+        return;
+      }
+
       this.logger({
         currentState: "@vatis-tech/asr-client-js: Initialized the \"InstanceReservation\" plugin.",
         description: "@vatis-tech/asr-client-js: A live asr instance has been reserved."

dist/components/MicrophoneGenerator.js

@@ -31,7 +31,8 @@ var MicrophoneGenerator = /*#__PURE__*/function () {
   function MicrophoneGenerator(_ref) {
     var onDataCallback = _ref.onDataCallback,
         logger = _ref.logger,
-        microphoneTimeslice = _ref.microphoneTimeslice;
+        microphoneTimeslice = _ref.microphoneTimeslice,
+        errorHandler = _ref.errorHandler;
 
     _classCallCheck(this, MicrophoneGenerator);
 
@@ -47,6 +48,9 @@ var MicrophoneGenerator = /*#__PURE__*/function () {
 
     _defineProperty(this, "microphoneTimeslice", void 0);
 
+    _defineProperty(this, "errorHandler", void 0);
+
+    this.errorHandler = errorHandler;
     this.logger = logger;
     this.logger({
       currentState: "@vatis-tech/asr-client-js: Instantianting the \"MicrophoneGenerator\" plugin.",
@@ -165,9 +169,12 @@ var MicrophoneGenerator = /*#__PURE__*/function () {
                     description: "@vatis-tech/asr-client-js: The MicrophoneGenerator was successful into getting user's microphone, and will start sending data each ".concat(_this.microphoneTimeslice, " miliseconds.")
                   });
                 })["catch"](function (err) {
-                  var errorMessage = "Could not initilize the microphone stream with error: " + err;
-                  console.error(errorMessage);
-                  throw errorMessage;
+                  _this.logger({
+                    currentState: "@vatis-tech/asr-client-js: Could not initilize the \"MicrophoneGenerator\" plugin.",
+                    description: "@vatis-tech/asr-client-js: " + err
+                  });
+
+                  _this.errorHandler(err);
                 });
 
               case 3:

dist/components/SocketIOClientGenerator.js

@@ -39,7 +39,8 @@ var SocketIOClientGenerator = /*#__PURE__*/function () {
         destroyVTC = _ref.destroyVTC,
         frameLength = _ref.frameLength,
         frameOverlap = _ref.frameOverlap,
-        bufferOffset = _ref.bufferOffset;
+        bufferOffset = _ref.bufferOffset,
+        errorHandler = _ref.errorHandler;
 
     _classCallCheck(this, SocketIOClientGenerator);
 
@@ -63,6 +64,9 @@ var SocketIOClientGenerator = /*#__PURE__*/function () {
 
     _defineProperty(this, "bufferOffset", void 0);
 
+    _defineProperty(this, "errorHandler", void 0);
+
+    this.errorHandler = errorHandler;
     this.logger = logger;
     this.logger({
       currentState: "@vatis-tech/asr-client-js: Instantianting the \"SocketIOClientGenerator\" plugin.",
@@ -125,9 +129,12 @@ var SocketIOClientGenerator = /*#__PURE__*/function () {
         });
       });
       this.socketRef.on("connect_error", function (error) {
-        var errorMessage = 'Could not initilize the "socket.io-client" with error: ' + error;
-        console.error(errorMessage);
-        throw errorMessage;
+        _this.logger({
+          currentState: "@vatis-tech/asr-client-js: Could not initilize the \"SocketIOClientGenerator\" plugin.",
+          description: "@vatis-tech/asr-client-js: " + error
+        });
+
+        _this.errorHandler(error);
       });
       this.socketRef.on(SOCKET_IO_CLIENT_RESULT_PATH, function (args) {
         _this.onAsrResultCallback(args);