Let ajax function return all data on not ok (#976)

Let ajax functions return all data on not ok so we can examine the error code if necessary.
DistributedProofreaders · Dec 10, 2023 · d7a1767 · d7a1767
1 parent 965a8d5
commit d7a1767
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 18 deletions.
diff --git a/SETUP/tests/jsTests/ajaxTests.js b/SETUP/tests/jsTests/ajaxTests.js
@@ -1,4 +1,4 @@
-/* global QUnit ajax */
+/* global QUnit ajax AJAX_ERROR_CODES */
 /* exported codeUrl */
 
 let codeUrl = "https://www.dummy.org";
@@ -27,7 +27,7 @@ QUnit.module("Ajax test", function() {
 
         return ajax("GET", "myUrl", {}, {}, fetchPromise)
             .then(function() {}, function(data) {
-                assert.strictEqual(data, "Incorrect response type");
+                assert.deepEqual(data, {error: "Incorrect response type", code: AJAX_ERROR_CODES.INCORRECT_RESPONSE_TYPE});
             });
     });
 
@@ -40,7 +40,7 @@ QUnit.module("Ajax test", function() {
 
         return ajax("GET", "myUrl", {}, {}, fetchPromise)
             .then(function() {}, function(data) {
-                assert.strictEqual(data, "not found");
+                assert.strictEqual(data.error, "not found");
             });
     });
 
@@ -53,7 +53,18 @@ QUnit.module("Ajax test", function() {
 
         return ajax("GET", "myUrl", {}, {}, fetchPromise)
             .then(function() {}, function(data) {
-                assert.strictEqual(data, "Unknown error");
+                assert.deepEqual(data, {error: "Unknown error", code: AJAX_ERROR_CODES.UNKNOWN_ERROR});
+            });
+    });
+
+    QUnit.test("Network error", function (assert) {
+        function fetchPromise() {
+            return Promise.reject();
+        }
+
+        return ajax("GET", "myUrl", {}, {}, fetchPromise)
+            .then(function() {}, function(data) {
+                assert.deepEqual(data, {error: "Network error", code: AJAX_ERROR_CODES.NETWORK_ERROR});
             });
     });
 

diff --git a/scripts/api.js b/scripts/api.js
@@ -1,5 +1,11 @@
 /*global codeUrl */
-/* exported ajax */
+/* exported ajax ajaxAlert AJAX_ERROR_CODES */
+
+const AJAX_ERROR_CODES = {
+    UNKNOWN_ERROR: 999,
+    INCORRECT_RESPONSE_TYPE: 998,
+    NETWORK_ERROR: 997,
+};
 
 function ajax(method, apiUrl, queryParams = {}, data = {}, fetchPromise = fetch) {
     let url = new URL(codeUrl + "/api/index.php");
@@ -25,20 +31,25 @@ function ajax(method, apiUrl, queryParams = {}, data = {}, fetchPromise = fetch)
             .then(function(response) {
                 const contentType = response.headers.get('content-type');
                 if (!contentType || !contentType.includes('application/json')) {
-                    reject("Incorrect response type");
+                    reject({error: "Incorrect response type", code: AJAX_ERROR_CODES.INCORRECT_RESPONSE_TYPE});
                 } else if(response.ok) {
                     resolve(response.json());
                 } else {
                     response.json()
                         .then(function(data) {
-                            let message = data.error;
-                            if(!message) {
-                                message = "Unknown error";
+                            if(!data) {
+                                data = {error: "Unknown error", code: AJAX_ERROR_CODES.UNKNOWN_ERROR};
                             }
-                            reject(message);
+                            reject(data);
                         });
                 }
             })
-            .catch(reject);
+            .catch(function() {
+                reject({error: "Network error", code: AJAX_ERROR_CODES.NETWORK_ERROR});
+            });
     });
 }
+
+function ajaxAlert(data) {
+    alert(data.error);
+}
diff --git a/scripts/page_browse.js b/scripts/page_browse.js
@@ -1,4 +1,4 @@
-/*global $ proofIntData ajax makeImageWidget makeTextWidget viewSplitter */
+/*global $ proofIntData ajax ajaxAlert makeImageWidget makeTextWidget viewSplitter */
 /* exported pageBrowse */
 
 function makePageControl(pages, selectedImageFileName, changePage) {
@@ -124,8 +124,8 @@ function pageBrowse(params, storageKey, replaceUrl, mentorMode = false, setShowF
                         });
                         resolve();
                     })
-                    .catch(function(error) {
-                        alert(error);
+                    .catch(function(data) {
+                        ajaxAlert(data);
                         reject();
                     });
             }
@@ -167,7 +167,7 @@ function pageBrowse(params, storageKey, replaceUrl, mentorMode = false, setShowF
                     ajax("GET", `v1/projects/${projectId}/pages/${imageFileName}/pagerounds/${round}`)
                         .then(function(data) {
                             textWidget.setText(data.text);
-                        }, alert);
+                        }, ajaxAlert);
                 }
                 replaceUrl();
             }
@@ -330,7 +330,7 @@ function pageBrowse(params, storageKey, replaceUrl, mentorMode = false, setShowF
 
     function getPages() {
         ajax("GET", `v1/projects/${projectId}/pages`)
-            .then(displayPages, alert);
+            .then(displayPages, ajaxAlert);
     }
 
     function showProjectInfo(projectData) {
@@ -348,8 +348,8 @@ function pageBrowse(params, storageKey, replaceUrl, mentorMode = false, setShowF
 
     getProjectData = function() {
         ajax("GET", `v1/projects/${projectId}`)
-            .then(showProjectInfo, function(error) {
-                alert(error);
+            .then(showProjectInfo, function(data) {
+                ajaxAlert(data);
                 selectAProject();
             });
     };