Allow specifying custom timeout and callback if POST fails

Author: drojf

httpGUI/.editorconfig

@@ -0,0 +1,11 @@
+[*.html]
+charset=utf-8
+insert_final_newline=true
+indent_style=tab
+indent_size=4
+
+[*.js]
+charset=utf-8
+insert_final_newline=true
+indent_style=space
+indent_size=2

httpGUI/installer.html

@@ -439,6 +439,7 @@ <h4>This patch is only for WINDOWS. It does not work on Mac or Linux</h4>
 												<div v-if="pathAutoDetectionInProgress">
 													<br>
 													<h3><span>Please wait, path autodetection in progress</span><span class="loader"></span></h3>
+													<h4>Detection may take up to {{ TIMEOUT_AUTO_DETECT_PATHS }} seconds.</h4>
 												</div>
 												<!-- Section allowing you to start install or choose game path to install -->
 												<div v-bind:class="{ 'greyed-out-disabled': pathAutoDetectionInProgress }">

httpGUI/python-patcher-lib.js

@@ -184,6 +184,7 @@ window.onload = function onWindowLoaded() {
       partiallyUninstalledPaths: [],
       installErrorDescription: "",
       installDataLoaded: false,
+      TIMEOUT_AUTO_DETECT_PATHS: 15,
     },
     methods: {
       doInstall(deleteVersionInformation) {
@@ -215,7 +216,8 @@ Continue install anyway?`)) {
             } else {
               app.selectedInstallPath = responseData.path;
             }
-          });
+          },
+          Infinity);
         } else {
           app.selectedInstallPath = pathToInstall;
         }
@@ -338,6 +340,11 @@ Continue install anyway?`)) {
               this.selectedInstallPath = this.fullInstallConfigs[0].path;
               this.showPathSelectionButtons = false;
             }
+          },
+          app.TIMEOUT_AUTO_DETECT_PATHS * 1000,
+          (errorMessage) => {
+            app.pathAutoDetectionInProgress = false;
+            alert(`Couldn't autodetect game path due to an error - please select game path manually.\n\nError: ${errorMessage}`);
           });
         } else {
           this.fullInstallConfigs = [];

httpGUI/python-patcher-rest-lib.js

@@ -41,20 +41,27 @@ function decodeJSONResponse(jsonString) {
 //
 // - onSuccessCallback (function(object)): A fn executed when a response is received
 //      from the server. The fn should take the returned object as its only argument
-function doPost(requestType, requestData, onSuccessCallback) {
+function doPost(requestType, requestData, onSuccessCallback, timeout, onErrorCallback) {
   const http = new XMLHttpRequest();
   const url = 'installer_data'; // in python, is stored in 'self.path' on the handler class
 
+  function errorHandler(msg) {
+    const message = `[${requestType}] POST Error - "${msg}" - You must have the install loader window/console open - it is required for the installation.`;
+    console.log(message);
+    POSTNotificationErrorCallback(message);
+    if (typeof onErrorCallback !== 'undefined') {
+      onErrorCallback(msg);
+    }
+  }
+
   // in python, is retrieved by calling 'self.rfile.read(content_length)',
   // where content_length is in the header (see python code)
   http.open('POST', url, true);
 
   // Send the proper header information along with the request
   http.setRequestHeader('Content-type', 'application/x-www-form-urlencoded');
 
-  // Call a function when the state changes.
-  // TODO: add timeout here to notify user if server has crashed or stopped working
-  http.onreadystatechange = function onReadyStateChange() {
+  http.onload = () => {
     if (http.readyState === 4) {
       if (http.status === 200) {
         const [responseType, responseDataObject] = decodeJSONResponse(http.responseText);
@@ -67,18 +74,26 @@ function doPost(requestType, requestData, onSuccessCallback) {
           onSuccessCallback(responseDataObject);
         }
       } else {
-        const errorCodeString = http.status === 0 ? '' : `[${http.status}]`;
-        const message = `POST Error ${errorCodeString} on [${requestType}] - Please check the install loader window/console is open - it is required for the installation.`;
-        console.log(message);
-        POSTNotificationErrorCallback(message);
+        errorHandler(`Unexpected HTTP Status [${http.status}]`);
       }
     }
   };
 
-  // Use a timeout of 8 seconds. After this POSTNotificationErrorCallback() will be called
-  if (requestType !== 'showFileChooser') {
-    http.timeout = 8000;
-  }
+  http.onabort = () => {
+    errorHandler('POST Aborted');
+  };
+
+  http.onerror = function () {
+    errorHandler('POST Error');
+  };
+
+  http.ontimeout = function (e) {
+    errorHandler(`POST Timeout (${http.timeout / 1000}s)`);
+  };
+
+  // Use a timeout of 8 seconds by default.
+  // After this errorHandler()/POSTNotificationErrorCallback() will be called
+  http.timeout = timeout !== 'undefined' ? timeout : 8000;
 
   http.send(makeJSONRequest(requestType, requestData));
 }