Refactor API failure logic into DialogUserSubmitErrorHandlerService

https://bugzilla.redhat.com/show_bug.cgi?id=1591484
ManageIQ · Jun 29, 2018 · da230c6 · da230c6
1 parent e79b2ce
commit da230c6
Show file tree

Hide file tree

Showing 5 changed files with 73 additions and 46 deletions.
diff --git a/app/assets/javascripts/controllers/dialog_user/dialog_user_controller.js b/app/assets/javascripts/controllers/dialog_user/dialog_user_controller.js
@@ -1,4 +1,4 @@
-ManageIQ.angular.app.controller('dialogUserController', ['API', 'dialogFieldRefreshService', 'miqService', 'dialogId', 'apiSubmitEndpoint', 'apiAction', 'finishSubmitEndpoint', 'cancelEndpoint', 'resourceActionId', 'targetId', 'targetType', function(API, dialogFieldRefreshService, miqService, dialogId, apiSubmitEndpoint, apiAction, finishSubmitEndpoint, cancelEndpoint, resourceActionId, targetId, targetType) {
+ManageIQ.angular.app.controller('dialogUserController', ['API', 'dialogFieldRefreshService', 'miqService', 'dialogUserSubmitErrorHandlerService', 'dialogId', 'apiSubmitEndpoint', 'apiAction', 'finishSubmitEndpoint', 'cancelEndpoint', 'resourceActionId', 'targetId', 'targetType', function(API, dialogFieldRefreshService, miqService, dialogUserSubmitErrorHandlerService, dialogId, apiSubmitEndpoint, apiAction, finishSubmitEndpoint, cancelEndpoint, resourceActionId, targetId, targetType) {
   var vm = this;
 
   vm.$onInit = function() {
@@ -58,15 +58,7 @@ ManageIQ.angular.app.controller('dialogUserController', ['API', 'dialogFieldRefr
     API.post(apiSubmitEndpoint, apiData, {skipErrors: [400]}).then(function() {
       miqService.redirectBack(__('Order Request was Submitted'), 'info', finishSubmitEndpoint);
     }).catch(function(err) {
-      miqService.sparkleOff();
-      var fullErrorMessage = err.data.error.message;
-      var allErrorMessages = fullErrorMessage.split('-')[1].split(',');
-      clearFlash();
-      _.forEach(allErrorMessages, (function(errorMessage) {
-        add_flash(errorMessage, 'error');
-      }));
-      console.error(err);
-      return Promise.reject(err);
+      return Promise.reject(dialogUserSubmitErrorHandlerService.handleError(err));
     });
   }
 

diff --git a/app/assets/javascripts/controllers/dialog_user/dialog_user_reconfigure_controller.js b/app/assets/javascripts/controllers/dialog_user/dialog_user_reconfigure_controller.js
@@ -1,4 +1,4 @@
-ManageIQ.angular.app.controller('dialogUserReconfigureController', ['API', 'dialogFieldRefreshService', 'miqService', 'resourceActionId', 'targetId', function(API, dialogFieldRefreshService, miqService, resourceActionId, targetId) {
+ManageIQ.angular.app.controller('dialogUserReconfigureController', ['API', 'dialogFieldRefreshService', 'miqService', 'dialogUserSubmitErrorHandlerService', 'resourceActionId', 'targetId', function(API, dialogFieldRefreshService, miqService, dialogUserSubmitErrorHandlerService, resourceActionId, targetId) {
   var vm = this;
 
   vm.$onInit = function() {
@@ -32,7 +32,7 @@ ManageIQ.angular.app.controller('dialogUserReconfigureController', ['API', 'dial
       dialogId: vm.dialogId,
       resourceActionId: resourceActionId,
       targetId: targetId,
-      targetType: "service"
+      targetType: "service",
     };
 
     return dialogFieldRefreshService.refreshField(vm.dialogData, [field.name], vm.refreshUrl, idList);
@@ -52,15 +52,7 @@ ManageIQ.angular.app.controller('dialogUserReconfigureController', ['API', 'dial
     return API.post(apiSubmitEndpoint, apiData, {skipErrors: [400]}).then(function() {
       miqService.redirectBack(__('Order Request was Submitted'), 'info', '/service/explorer');
     }).catch(function(err) {
-      miqService.sparkleOff();
-      var fullErrorMessage = err.data.error.message;
-      var allErrorMessages = fullErrorMessage.split('-')[1].split(',');
-      clearFlash();
-      _.forEach(allErrorMessages, (function(errorMessage) {
-        add_flash(errorMessage, 'error');
-      }));
-      console.error(err);
-      return Promise.reject(err);
+      return Promise.reject(dialogUserSubmitErrorHandlerService.handleError(err));
     });
   }
 

diff --git a/app/assets/javascripts/services/dialog_user_submit_error_handler_service.js b/app/assets/javascripts/services/dialog_user_submit_error_handler_service.js
@@ -0,0 +1,13 @@
+ManageIQ.angular.app.service('dialogUserSubmitErrorHandlerService', ['miqService', function(miqService) {
+  this.handleError = function(err) {
+    miqService.sparkleOff();
+    var fullErrorMessage = err.data.error.message;
+    var allErrorMessages = fullErrorMessage.split('-')[1].split(',');
+    clearFlash();
+    _.forEach(allErrorMessages, function(errorMessage) {
+      add_flash(errorMessage, 'error');
+    });
+    console.error(err);
+    return err;
+  };
+}]);
diff --git a/spec/javascripts/controllers/dialog_user/dialog_user_controller.spec.js b/spec/javascripts/controllers/dialog_user/dialog_user_controller.spec.js
@@ -1,11 +1,16 @@
 describe('dialogUserController', function() {
-  var $controller, API, dialogFieldRefreshService, miqService;
+  var $controller, API, dialogFieldRefreshService, dialogUserSubmitErrorHandlerService, miqService;
 
   beforeEach(module('ManageIQ'));
 
-  beforeEach(inject(function(_$controller_, _API_, _dialogFieldRefreshService_, _miqService_) {
+  beforeEach(inject(function(_$controller_,
+                             _API_,
+                             _dialogFieldRefreshService_,
+                             _dialogUserSubmitErrorHandlerService_,
+                             _miqService_) {
     API = _API_;
     dialogFieldRefreshService = _dialogFieldRefreshService_;
+    dialogUserSubmitErrorHandlerService = _dialogUserSubmitErrorHandlerService_;
     miqService = _miqService_;
 
     var responseResult = {content: ['the dialog']};
@@ -15,6 +20,7 @@ describe('dialogUserController', function() {
     });
 
     spyOn(dialogFieldRefreshService, 'refreshField');
+    spyOn(dialogUserSubmitErrorHandlerService, 'handleError');
     spyOn(miqService, 'miqAjaxButton');
     spyOn(miqService, 'redirectBack');
     spyOn(miqService, 'sparkleOn');
@@ -24,6 +30,7 @@ describe('dialogUserController', function() {
     $controller = _$controller_('dialogUserController', {
       API: API,
       dialogFieldRefreshService: dialogFieldRefreshService,
+      dialogUserSubmitErrorHandlerService: dialogUserSubmitErrorHandlerService,
       miqService: miqService,
       dialogId: '1234',
       apiSubmitEndpoint: 'submit endpoint',
@@ -201,36 +208,18 @@ describe('dialogUserController', function() {
     });
 
     context('when the API call fails', function() {
+      var rejectionData;
+
       beforeEach(function() {
-        var rejectionData = {data: {error: {message: "Failed! -One,Two"}}};
+        rejectionData = {data: {error: {message: "Failed! -One,Two"}}};
         spyOn(API, 'post').and.returnValue(Promise.reject(rejectionData));
-        spyOn(window, 'clearFlash');
-        spyOn(window, 'add_flash');
-      });
-
-      it('turns off the sparkle', function(done) {
-        $controller.submitButtonClicked();
-        setTimeout(function() {
-          expect(miqService.sparkleOff).toHaveBeenCalled();
-          done();
-        });
-      });
-
-      it('clears flash messages', function(done) {
-        $controller.submitButtonClicked();
-
-        setTimeout(function() {
-          expect(window.clearFlash).toHaveBeenCalled();
-          done();
-        });
       });
 
-      it('adds flash messages for each message after the -', function(done) {
+      it('delegates to the dialogUserSubmitErrorHandlerService', function(done) {
         $controller.submitButtonClicked();
 
         setTimeout(function() {
-          expect(window.add_flash).toHaveBeenCalledWith('One', 'error');
-          expect(window.add_flash).toHaveBeenCalledWith('Two', 'error');
+          expect(dialogUserSubmitErrorHandlerService.handleError).toHaveBeenCalledWith(rejectionData);
           done();
         });
       });

diff --git a/spec/javascripts/services/dialog_user_submit_error_handling_service_spec.js b/spec/javascripts/services/dialog_user_submit_error_handling_service_spec.js
@@ -0,0 +1,41 @@
+describe('dialogUserSubmitErrorHandlerService', function() {
+  var testService, miqService;
+
+  beforeEach(module('ManageIQ'));
+
+  beforeEach(inject(function(dialogUserSubmitErrorHandlerService, _miqService_) {
+    testService = dialogUserSubmitErrorHandlerService;
+    miqService = _miqService_;
+  }));
+
+  describe('#handleError', function() {
+    var errorData;
+
+    beforeEach(function() {
+      errorData = {data: {error: {message: "Failed! -One,Two"}}};
+      spyOn(miqService, 'sparkleOff');
+      spyOn(window, 'clearFlash');
+      spyOn(window, 'add_flash');
+    });
+
+    it('turns off the sparkle', function() {
+      testService.handleError(errorData);
+      expect(miqService.sparkleOff).toHaveBeenCalled();
+    });
+
+    it('clears flash messages', function() {
+      testService.handleError(errorData);
+      expect(window.clearFlash).toHaveBeenCalled();
+    });
+
+    it('adds flash messages for each message after the -', function() {
+      testService.handleError(errorData);
+      expect(window.add_flash).toHaveBeenCalledWith('One', 'error');
+      expect(window.add_flash).toHaveBeenCalledWith('Two', 'error');
+    });
+
+    it('returns the error data to bubble up to the parent', function() {
+      expect(testService.handleError(errorData)).toEqual(errorData);
+    });
+  });
+});