Merge pull request #565 from apinf/feature/api-backend-error-handling

Feature/api backend error handling - redoes #527

Author: mauriciovieira

client/views/api_backends/autoform.js

@@ -1,10 +1,61 @@
 AutoForm.hooks({
   apiBackends: {
-    onSuccess: function (formType, backendId) {
-      // Send the API Backend to API Umbrella
-      Meteor.call('createApiBackendOnApiUmbrella', backendId);
-      // Redirect to the just created API Backend page
-      Router.go('viewApiBackend', {_id: backendId});
+    beginSubmit: function () {
+      // Disable form elements while submitting form
+      $('[data-schema-key], button').attr("disabled", "disabled");
+    },
+    endSubmit: function () {
+      // Enable form elements after form submission
+      $('[data-schema-key], button').removeAttr("disabled");
+    },
+    before: {
+      insert: function (apiBackendForm) {
+        // Keep the context to use inside the callback function
+        var context = this;
+
+        // Send the API Backend to API Umbrella
+        response = Meteor.call('createApiBackendOnApiUmbrella', apiBackendForm, function(error, apiUmbrellaWebResponse) {
+
+          //apiUmbrellaWebResponse contents
+          // apiUmbrellaWebResponse = {
+          //   result: {},
+          //   http_status: 200,
+          //   errors: {}
+          // };
+
+          if (apiUmbrellaWebResponse.http_status === 200) {
+            // Submit form on meteor:api-umbrella success
+            context.result(apiBackendForm);
+          } else {
+            // Error data structure returned.
+            // nowadays, jerry-rig solution:
+            // {"default":'{"backend_protocol":["is not included in the list"]}}'
+            // after https://github.com/brylie/meteor-api-umbrella/issues/1 is resolved, it should be:
+            // {"frontend_host":["must be in the format of \"example.com\""],
+            //  "backend_host":["must be in the format of \"example.com\""],
+            //  "base":["must have at least one url_matches"],
+            //  "servers[0].host":["must be in the format of \"example.com\"","Could not resolve host: no address for http://api.example.com"],
+            //  "servers[0].port":["can't be blank","is not included in the list"]}
+            var errors = _.values(apiUmbrellaWebResponse.errors);
+
+            // Flatten all error descriptions to show using sAlert
+            errors = _.flatten(errors);
+            _.each(errors, function(error) {
+              //Display error to the user, keep the sAlert box visible.
+              sAlert.error(error, {timeout: 'none'});
+              // TODO: Figure out a way to send the errors back to the autoform fields, as if it were client validation,
+              //   and get rid of sAlert here.
+            });
+
+            //Cancel form submission on error, so user see the sAlert.error message and edit the incorrect fields
+            context.result(false);
+         }
+        });
+      }
+    },
+    onSuccess: function (formType, apiBackendId) {
+      //Redirect to the just created API Backend page
+      Router.go('viewApiBackend', {_id: apiBackendId});
     }
   }
 });

server/methods/apiBackends.js

@@ -17,19 +17,42 @@ Meteor.methods({
       });
     };
   },
-  'createApiBackendOnApiUmbrella': function (apiBackendId) {
-    console.log('Submitting Backend to API Umbrella.')
-    // Get the API Backend object
-    var apiBackend = ApiBackends.findOne(apiBackendId);
-
+  createApiBackendOnApiUmbrella: function (apiBackendForm) {
     // Construct an API Backend object for API Umbrella with one 'api' key
     var constructedBackend = {
-      "api": apiBackend
+      "api": apiBackendForm
+    };
+
+    // Response object to be send back to client layer.
+    var apiUmbrellaWebResponse = {
+      result: {},
+      http_status: 200,
+      errors: {}
     };
 
-    // Send the API Backend to API Umbrella
-    var response = apiUmbrellaWeb.adminApi.v1.apiBackends.createApiBackend(constructedBackend);
+    try {
+      // Send the API Backend to API Umbrella's endpoint for creation in the backend
+      apiUmbrellaWebResponse.result = apiUmbrellaWeb.adminApi.v1.apiBackends.createApiBackend(constructedBackend);
+    } catch (apiUmbrellaError) {
+
+      //apiUmbrellaError.message now is a string like
+      // example 1:
+      // '{"default":'{"backend_protocol":["is not included in the list"]}}'
+      // ex 2:
+      // '{"errors":{"frontend_host":["must be in the format of \"example.com\""],
+      //            "backend_host":["must be in the format of \"example.com\""],
+      //            "base":["must have at least one url_matches"],
+      //            "servers[0].host":["must be in the format of \"example.com\"","Could not resolve host: no address for http://api.example.com"],
+      //            "servers[0].port":["can't be blank","is not included in the list"]}'
+      // }
+      //after https://github.com/brylie/meteor-api-umbrella/issues/1 is closed, this code must be changed to something like:
+      // apiUmbrellaWebResponse.errors = error.errors
+      // apiUmbrellaWebResponse.status = error.http_status
+      // or http://docs.meteor.com/#/full/meteor_error should be considered
 
-    // TODO: Add error checking to ensure backend successfully inserted in API Umbrella
+      //set the errors object
+      apiUmbrellaWebResponse.errors = {'default': [apiUmbrellaError.message]};
+      apiUmbrellaWebResponse.http_status = 422;
+    }
   }
 });