Add onJoinRequest, re-document onJoinRequestHandle, fix uncatchable errors (#504)

* Update shortPoll docs

* Add custom timeout function and drop bluebird

Timeout function is documented but internal.
The Promise file/function was internal - so it is NOT semver major as it should not be used outside of the library.
Bluebird is no longer needed.

* Replace timeout with better implementation

New implementation is shorter (44 -> 24 lines), more beautiful and most importantly: it actually works.

Also avoids manually wrapping the original promise, so that's a bonus too.

* Fix timer problem

* use Finally

* Improve error handling across the board

* Add onJoinRequest & Re-document onJoinRequestHandle

* Regenerate yarn.lock

* Fix getRequests error message

Co-authored-by: suufi <[email protected]>
Co-authored-by: suufi <[email protected]>

Author: Neztore

lib/asset/deleteFromInventory.js

@@ -55,6 +55,7 @@ function deleteFromInventory (jar, assetId, xcsrf) {
           reject(new Error(error))
         }
       })
+      .catch(error => reject(error))
   })
 }
 

lib/asset/getProductInfo.js

@@ -44,6 +44,7 @@ function getProductInfo (asset) {
           }
         }
       })
+      .catch(error => reject(error))
   })
 }
 

lib/asset/uploadItem.js

@@ -74,6 +74,7 @@ function uploadItem (jar, file, name, assetType, groupId) {
         }
       })
     })
+      .catch(error => reject(error))
   })
 }
 

lib/avatar/redrawAvatar.js

@@ -35,7 +35,7 @@ function redrawAvatar (jar, token) {
       } else {
         reject(new Error('Redraw avatar failed'))
       }
-    })
+    }).catch(error => reject(error))
   })
 }
 

lib/avatar/removeAssetId.js

@@ -42,7 +42,7 @@ function removeAssetId (assetId, jar, xcsrf) {
         } else {
           resolve()
         }
-      })
+      }).catch(error => reject(error))
   })
 }
 

lib/avatar/wearAssetId.js

@@ -42,7 +42,7 @@ function wearAssetId (assetId, jar, xcsrf) {
         } else {
           resolve()
         }
-      })
+      }).catch(error => reject(error))
   })
 }
 

lib/cache/wrap.js

@@ -1,14 +1,13 @@
 // Includes
 const addIf = require('./addIf.js')
 const options = require('../options.js')
-const promise = require('../internal/promise.js')
 
 // Define
 function wrap (type, index, func) {
   const cache = options.cache
   const group = cache[type]
   if (group.expire > 0 || group.permanent) {
-    return promise(function (resolve, reject) {
+    return new Promise(function (resolve, reject) {
       addIf(cache, type, index, {
         done: resolve,
         add: function (done) {

lib/chat/addUsersToConversation.js

@@ -48,7 +48,7 @@ function addUsersToConversation (conversationId, userIds, jar, token) {
         }
         reject(new Error(error))
       }
-    })
+    }).catch(error => reject(error))
   })
 }
 

lib/chat/removeFromGroupConversation.js

@@ -49,7 +49,7 @@ function removeFromGroupConversation (conversationId, userId, jar, token) {
         }
         reject(new Error(error))
       }
-    })
+    }).catch(error => reject(error))
   })
 }
 

lib/chat/renameGroupConversation.js

@@ -44,7 +44,7 @@ function renameGroupConversation (conversationId, newTitle, jar, token) {
       } else {
         reject(new Error('Rename group chat failed'))
       }
-    })
+    }).catch(error => reject(error))
   })
 }
 

lib/chat/sendChatMessage.js

@@ -44,7 +44,7 @@ function sendChatMessage (conversationId, messageText, jar, token) {
       } else {
         throw new Error('Send chat message failed')
       }
-    })
+    }).catch(error => reject(error))
   })
 }
 

lib/chat/setChatUserTyping.js

@@ -48,7 +48,7 @@ function setChatUserTyping (conversationId, isTyping, jar, token) {
         }
         reject(new Error(error))
       }
-    })
+    }).catch(error => reject(error))
   })
 }
 

lib/chat/startGroupConversation.js

@@ -49,7 +49,7 @@ function startGroupConversation (userIds, chatTitle, jar, token) {
         }
         reject(new Error(error))
       }
-    })
+    }).catch(error => reject(error))
   })
 }
 

lib/game/configureGamePass.js

@@ -81,7 +81,7 @@ function configureGamePass (gamePassId, name, description, price, icon, jar, tok
           reject(new Error(`An unexpected error occurred with status code ${res.statusCode}.${priceComment}`))
         }
       }
-    })
+    }).catch(error => reject(error))
   })
 }
 

lib/game/getDeveloperProducts.js

@@ -41,6 +41,7 @@ function getDeveloperProducts (jar, placeId, page) {
           }
         }
       })
+      .catch(error => reject(error))
   })
 }
 

lib/game/getGameInstances.js

@@ -44,6 +44,7 @@ function getGameInstances (jar, placeId, startIndex) {
           }
         }
       })
+      .catch(error => reject(error))
   })
 }
 

lib/game/updateUniverseAccess.js

@@ -43,7 +43,7 @@ function updateUniverseAccess (universeId, isPublic, jar, token) {
       } else {
         reject(new Error(`An unknown error occurred with updateUniverseAccess() | [${statusCode}] universeId: ${universeId}, isPublic: ${isPublic}`))
       }
-    })
+    }).catch(error => reject(error))
   })
 }
 

lib/group/deleteWallPost.js

@@ -46,7 +46,7 @@ function deleteWallPost (jar, token, group, postId) {
             reject(new Error(`${res.statusCode} ${errors.join(', ')}`))
           }
         }
-      })
+      }).catch(error => reject(error))
   })
 }
 

lib/group/exile.js

@@ -45,7 +45,7 @@ function exileUser (group, target, jar, xcsrf) {
         } else {
           resolve()
         }
-      })
+      }).catch(error => reject(error))
   })
 }
 

lib/group/getAuditLog.js

@@ -1,6 +1,5 @@
 // Includes
 const http = require('../util/http.js').func
-const Promise = require('bluebird')
 
 exports.required = ['group']
 exports.optional = ['actionType', 'userId', 'sortOrder', 'limit', 'cursor', 'jar']
@@ -45,7 +44,7 @@ function getAuditLog (group, actionType, userId, sortOrder, limit, cursor, jar)
         } else {
           resolve(responseData)
         }
-      })
+      }).catch(error => reject(error))
   })
 }
 

lib/group/getGroup.js

@@ -41,7 +41,7 @@ function getGroup (groupId) {
             reject(new Error(`${res.statusCode} ${res.body}`))
           }
         }
-      })
+      }).catch(error => reject(error))
   })
 }
 

lib/group/getJoinRequest.js

@@ -1,6 +1,5 @@
 // Includes
 const http = require('../util/http.js').func
-const Promise = require('bluebird')
 
 // Args
 exports.required = ['group', 'userId']
@@ -43,7 +42,7 @@ function getJoinRequest (jar, group, userId) {
             reject(new Error(`${res.statusCode} ${errors.join(', ')}`))
           }
         }
-      })
+      }).catch(error => reject(error))
   })
 }
 

lib/group/getJoinRequests.js

@@ -1,6 +1,5 @@
 // Includes
 const http = require('../util/http.js').func
-const Promise = require('bluebird')
 
 // Args
 exports.required = ['group']
@@ -46,6 +45,7 @@ function getJoinRequests (jar, group, sortOrder, limit, cursor) {
           }
         }
       })
+      .catch(error => reject(error))
   })
 }
 

lib/group/getPlayers.js

@@ -44,7 +44,7 @@ function getPlayersInRoleOnPage (jar, group, rolesetId, sortOrder, limit, cursor
             reject(new Error(`${res.statusCode} ${errors.join(', ')}`))
           }
         }
-      })
+      }).catch(error => reject(error))
   })
 }
 
@@ -71,7 +71,7 @@ function getPlayersInRole (jar, group, rolesetId, sortOrder, limit, cursor, curr
           .then(function (newCurrentPlayers) {
             return resolve(newCurrentPlayers)
           })
-      })
+      }).catch(error => reject(error))
   })
 }
 

lib/group/getRole.js

@@ -1,6 +1,5 @@
 // Dependencies
 const entities = require('entities')
-const Promise = require('bluebird')
 
 // Includes
 const getRoles = require('./getRoles.js').func

lib/group/getRolePermissions.js

@@ -40,7 +40,7 @@ function getRolePermissions (group, rolesetId, jar) {
         } else {
           resolve(responseData)
         }
-      })
+      }).catch(error => reject(error))
   })
 }
 

lib/group/getRoles.js

@@ -44,7 +44,7 @@ function getRoles (group) {
           }
           resolve(roles)
         }
-      })
+      }).catch(error => reject(error))
   })
 }
 

lib/group/getShout.js

@@ -1,6 +1,5 @@
 // Includes
 const http = require('../util/http.js').func
-const Promise = require('bluebird')
 
 // Args
 exports.required = ['group']

lib/group/getWall.js

@@ -1,5 +1,4 @@
 const http = require('../util/http.js').func
-const Promise = require('bluebird')
 
 exports.required = ['group']
 exports.optional = ['sortOrder', 'limit', 'cursor', 'jar']
@@ -42,7 +41,7 @@ function getPosts (group, sortOrder, limit, cursor, jar) {
         } else {
           resolve(responseData)
         }
-      })
+      }).catch(error => reject(error))
   })
 }
 

lib/group/groupPayout.js

@@ -54,7 +54,7 @@ function groupPayout (jar, token, group, data, recurring, usePercentage) {
             reject(new Error(`${res.statusCode} ${errors.join(', ')}`))
           }
         }
-      })
+      }).catch(error => reject(error))
   })
 }
 

lib/group/handleJoinRequest.js

@@ -46,7 +46,7 @@ function handleJoinRequest (group, userId, accept, jar, xcsrf) {
         } else {
           resolve()
         }
-      })
+      }).catch(error => reject(error))
   })
 }
 

lib/group/onJoinRequest.js

@@ -0,0 +1,63 @@
+// Includes
+const settings = require('../../settings.json')
+const shortPoll = require('../util/shortPoll.js').func
+const getJoinRequests = require('./getJoinRequests.js').func
+const promiseTimeout = require('../internal/timeout')
+
+// Args
+exports.required = ['group']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when someone makes a request to join the group.
+ * @category Group
+ * @alias onJoinRequest
+ * @param {number} group - The id of the group.
+ * @returns An EventEmitter that emits when someone tries to join.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const e = noblox.onJoinRequest()
+ * e.on("data", function(data) {
+ *  console.log("New request!", data)
+ * })
+ * e.on("error", function (err) {
+ *   ...
+ * })
+ **/
+
+async function getRequests (jar, group, cursor) {
+  const requests = []
+  const res = await promiseTimeout(getJoinRequests({ jar, group, cursor, limit: 100 }), settings.event.timeout, 'getRequests onJoinRequests internal')
+  requests.push.apply(requests, res.data)
+  if (res.nextPageCursor) {
+    requests.push.apply(requests, await getRequests(jar, group, res.nextPageCursor))
+  }
+  return requests
+}
+
+// Define
+exports.func = function (args) {
+  return shortPoll({
+    getLatest: function (latest) {
+      return getRequests(args.jar, args.group)
+        .then(function (requests) {
+          const given = []
+          for (const key in requests) {
+            if (Object.prototype.hasOwnProperty.call(requests, key)) {
+              const date = new Date(requests[key].created.slice(0, requests[key].created.lastIndexOf('.')))
+              if (date > latest) {
+                latest = date
+                given.push(requests[key])
+              }
+            }
+          }
+          return {
+            latest: latest,
+            data: given
+          }
+        })
+    },
+    delay: 'onJoinRequest'
+  })
+}