feat: AV.setRequestTimeout

Author: leeyeh

src/av.js

@@ -13,6 +13,7 @@ AV._config = {
   useMasterKey: false,
   production: null,
   realtime: null,
+  requestTimeout: null,
 };
 
 // configs shared by all AV instances

src/init.js

@@ -154,7 +154,7 @@ AV._setServerURLs = (urls, disableAppRouter = true) => {
   }
 };
 /**
- * set server URLs for services.
+ * Set server URLs for services.
  * @function AV.setServerURLs
  * @since 3.0.0
  * @param {String|ServerURLs} urls URLs for services. if a string was given, it will be applied for all services.
@@ -166,6 +166,17 @@ AV.keepErrorRawMessage = value => {
   AV._sharedConfig.keepErrorRawMessage = value;
 };
 
+/**
+ * Set a deadline for requests to complete.
+ * Note that file upload requests are not affected.
+ * @function AV.setRequestTimeout
+ * @since 3.6.0
+ * @param {number} ms 
+ */
+AV.setRequestTimeout = ms => {
+  AV._config.requestTimeout = ms;
+}
+
 // backword compatible
 AV.initialize = AV.init;
 

src/request.js

@@ -119,9 +119,10 @@ const request = ({ service, version, method, path, query, data = {}, authOptions
     throw new Error('Not initialized');
   }
   AV._appRouter.refresh();
+  const { requestTimeout: timeout } = AV._config;
   const url = createApiUrl({ service, path, version });
   return setHeaders(authOptions, signKey).then(
-    headers => ajax({ method, url, query, data, headers })
+    headers => ajax({ method, url, query, data, headers, timeout })
       .catch((error) => {
         let errorJSON = {
           code: error.code || -1,

src/utils/index.js

@@ -7,7 +7,7 @@ const Promise = require('../promise');
 
 let requestsCount = 0;
 
-const ajax = ({ method, url, query, data, headers = {}, onprogress }) => {
+const ajax = ({ method, url, query, data, headers = {}, onprogress, timeout }) => {
   const count = requestsCount++;
 
   debugRequest(`request(${count})`, method, url, query, data, headers);
@@ -31,6 +31,9 @@ const ajax = ({ method, url, query, data, headers = {}, onprogress }) => {
     if (onprogress) {
       req.on('progress', onprogress);
     }
+    if (timeout) {
+      req.timeout(timeout);
+    }
     req.end((err, res) => {
       if (err) {
         if (res) {

storage.d.ts

@@ -808,6 +808,7 @@ export function init(options: {
 }): void;
 export function setServerURLs(urls: string|ServerURLs): void;
 export function setProduction(production: boolean): void;
+export function setRequestTimeout(ms: number): void;
 export function parseJSON(json: any): Object|File|any;
 export function request(options: {
   method: string,