feat(api-request): check token expires and send token update request in advance

Author: leomp12

lib/methods/api-request.js

@@ -7,6 +7,8 @@ const apiRequest = client => {
   const getAuth = require('./get-auth')(client)
   // delete no more valid authentications
   const deleteAuth = require('./delete-auth')(client)
+  // handle access token refresh
+  const refreshToken = require('./refresh-token')(client)
 
   // count per store running request
   // prevent rate limit error
@@ -33,6 +35,15 @@ const apiRequest = client => {
           options.accessToken = accessToken
         }
 
+        // fallback dealing with out of date tokens
+        let isRefreshingToken = false
+        const askRefreshToken = () => {
+          if (!isRefreshingToken) {
+            refreshToken(storeId, myId).catch(console.error)
+            isRefreshingToken = true
+          }
+        }
+
         // send HTTP request
         let retries = 0
         const send = () => {
@@ -89,32 +100,41 @@ const apiRequest = client => {
                   return retry(8500, error)
                 }
 
-                if (status === 401 && authenticated && auth.row && config) {
+                if (status === 401 && authenticated) {
                   // authentication error
-                  // not authorized by auth scope ?
-                  // mark returned error object
-                  error.appErrorLog = true
-
-                  // try to log error on app hidden data
-                  ecomClient.store({
-                    ...options,
-                    url: '/applications/' + auth.row.application_id + '/hidden_data.json',
-                    method: 'PATCH',
-                    data: {
-                      last_api_error: {
-                        url: config.url,
-                        method: config.method,
-                        response: data
+                  if (data && data.error_code === 132 && !retries) {
+                    // "Token was valid, but expired"
+                    const delayMs = isRefreshingToken ? 2500 : 8500
+                    askRefreshToken()
+                    return retry(delayMs, error)
+                  }
+
+                  if (auth.row && config) {
+                    // not authorized by auth scope ?
+                    // mark returned error object
+                    error.appErrorLog = true
+
+                    // try to log error on app hidden data
+                    ecomClient.store({
+                      ...options,
+                      url: '/applications/' + auth.row.application_id + '/hidden_data.json',
+                      method: 'PATCH',
+                      data: {
+                        last_api_error: {
+                          url: config.url,
+                          method: config.method,
+                          response: data
+                        }
                       }
-                    }
-                  }).then(() => {
-                    error.appErrorLogged = true
-                    reject(error)
-                  }).catch(err => {
-                    error.appErrorLog = err
-                    reject(error)
-                  })
-                  return
+                    }).then(() => {
+                      error.appErrorLogged = true
+                      reject(error)
+                    }).catch(err => {
+                      error.appErrorLog = err
+                      reject(error)
+                    })
+                    return
+                  }
                 }
               } else if (!retries) {
                 // timeout?
@@ -132,15 +152,27 @@ const apiRequest = client => {
           send()
         } else {
           // control requests with delay
+          let delayMs
           let delayFactor = running[storeId]
           if (typeof delayFactor !== 'number') {
+            // first concurrent request with this store
             running[storeId] = delayFactor = 0
+            if (auth.row && auth.row.expires) {
+              const tokenTimestamp = new Date(auth.row.expires).getTime()
+              if (tokenTimestamp <= Date.now() + 1000 * 60 * 10) {
+                // send token update request in advance
+                askRefreshToken()
+                if (tokenTimestamp <= Date.now() + 1000 * 5) {
+                  delayMs = 6000
+                }
+              }
+            }
           }
           running[storeId]++
           setTimeout(() => {
             running[storeId]--
             send()
-          }, delayFactor * 200)
+          }, delayMs || delayFactor * 200)
         }
       }