Fix: make query limits backwards compatible (#1509)

* fix(paging-query-limits): added maxlimit override for backwards compatibility. Raised limits for endpoints for which explorer requires higher limits

Author: BLuEScioN

src/api/pagination.ts

@@ -65,23 +65,24 @@ const pagingQueryLimits: Record<ResourceType, { defaultLimit: number; maxLimit:
     defaultLimit: 50,
     maxLimit: 200,
   },
-  [ResourceType.Token]: {
-    defaultLimit: 50,
-    maxLimit: 200,
-  },
   [ResourceType.Pox2Event]: {
     defaultLimit: 96,
     maxLimit: 200,
   },
 };
 
-export function getPagingQueryLimit(resourceType: ResourceType, limitOverride?: any) {
+export function getPagingQueryLimit(
+  resourceType: ResourceType,
+  limitOverride?: any,
+  maxLimitOverride?: number
+) {
   const pagingQueryLimit = pagingQueryLimits[resourceType];
   if (!limitOverride) {
     return pagingQueryLimit.defaultLimit;
   }
   const newLimit = parsePagingQueryInput(limitOverride);
-  if (newLimit > pagingQueryLimit.maxLimit) {
+  const maxLimit = maxLimitOverride ?? pagingQueryLimit.maxLimit;
+  if (newLimit > maxLimit) {
     throw new InvalidRequestError(
       `'limit' must be equal to or less than ${pagingQueryLimit.maxLimit}`,
       InvalidRequestErrorType.invalid_query

src/api/routes/tx.ts

@@ -198,7 +198,7 @@ export function createTxRouter(db: PgStore): express.Router {
     '/events',
     cacheHandler,
     asyncHandler(async (req, res, next) => {
-      const limit = getPagingQueryLimit(ResourceType.Tx, req.query['limit']);
+      const limit = getPagingQueryLimit(ResourceType.Tx, req.query['limit'], 100);
       const offset = parsePagingQueryInput(req.query['offset'] ?? 0);
 
       const principalOrTxId = parseAddressOrTxId(req, res, next);
@@ -227,7 +227,7 @@ export function createTxRouter(db: PgStore): express.Router {
         return res.redirect('/extended/v1/tx/0x' + tx_id + url.search);
       }
 
-      const eventLimit = getPagingQueryLimit(ResourceType.Tx, req.query['event_limit']);
+      const eventLimit = getPagingQueryLimit(ResourceType.Tx, req.query['event_limit'], 100);
       const eventOffset = parsePagingQueryInput(req.query['event_offset'] ?? 0);
       const includeUnanchored = isUnanchoredRequest(req, res, next);
       validateRequestHexInput(tx_id);
@@ -276,7 +276,7 @@ export function createTxRouter(db: PgStore): express.Router {
     cacheHandler,
     asyncHandler(async (req, res) => {
       const { block_hash } = req.params;
-      const limit = getPagingQueryLimit(ResourceType.Tx, req.query['limit']);
+      const limit = getPagingQueryLimit(ResourceType.Tx, req.query['limit'], 200);
       const offset = parsePagingQueryInput(req.query['offset'] ?? 0);
       validateRequestHexInput(block_hash);
       const result = await db.getTxsFromBlock({ hash: block_hash }, limit, offset);

src/tests/pagination-tests.ts

@@ -25,4 +25,7 @@ describe('getPagingQueryLimit()', () => {
   test('Error is thrown when value is larger than input', () => {
     expect(() => getPagingQueryLimit(ResourceType.Block, 31)).toThrowError();
   });
+  test('Error is NOT thrown when value is larger than input but a maxLimitOverride has been provided', () => {
+    expect(() => getPagingQueryLimit(ResourceType.Tx, 100, 200)).not.toThrowError();
+  });
 });