Cache results from getUsernameHistory (#852)

Cache results from getUsernameHistory

lib/users/getUsernameHistory.js

@@ -1,5 +1,6 @@
 // Includes
 const getPageResults = require('../util/getPageResults.js').func
+const cache = require('../cache')
 
 // Args
 exports.required = ['userId']
@@ -11,7 +12,7 @@ exports.optional = ['limit', 'sortOrder', 'pageCursor']
  * @category User
  * @alias getUsernameHistory
  * @param {number} userId
- * @param {Limit=} [limit=10]
+ * @param {Limit=} [limit=100]
  * @param {SortOrder=} [sortOrder=Asc]
  * @param {string} cursor
  * @returns {Promise<UsernameHistoryEntry[]>}
@@ -31,5 +32,11 @@ function getUsernameHistory (userId, limit, sortOrder, cursor) {
 }
 
 exports.func = function (args) {
-  return getUsernameHistory(args.userId, args.limit, args.sortOrder, args.cursor)
+  let { userId, limit, sortOrder, cursor } = args
+  limit ||= 100
+  sortOrder ||= 'Asc'
+
+  return cache.wrap('UsernameHistory', `${userId}-${limit}-${sortOrder}-${cursor}`, function () {
+    return getUsernameHistory(userId, limit, sortOrder, cursor)
+  })
 }

settings.json

@@ -102,6 +102,12 @@
       "expire": false,
       "refresh": false,
       "desc": "Caches rank by user ID. Changes cannot be anticipated so this is not enabled by default."
+     },
+
+     "UsernameHistory": {
+      "expire": 86400,
+      "refresh": false,
+      "desc": "Caches a user's username history based on user id, limit, sort order, and cursor. The rate limit for the associated endpoint is very low, and this setting should be left alone as a result."
      }
   }
 }