Remove the blockHash and blockNumber fields from getTransactions()

The function getTransactions() is too flexible to optimize. This patch is a
groundwork before optimizing the performance of getTransactions().

Author: joojis

src/models/logic/transaction.ts

@@ -392,28 +392,13 @@ async function getTransactionHashes(params: {
     page: number;
     itemsPerPage: number;
     type?: string[] | null;
-    tracker?: H256 | null;
-    blockNumber?: number | null;
-    blockHash?: H256 | null;
     includePending?: boolean | null;
     onlySuccessful?: boolean | null;
 }): Promise<string[]> {
     const where: Sequelize.WhereOptions<TransactionAttribute> = {};
     if (params.type != null) {
         where.type = { [Sequelize.Op.in]: params.type };
     }
-    if (params.tracker != null) {
-        where.tracker = params.tracker.value;
-    }
-    if (params.blockNumber != null) {
-        where.blockNumber = params.blockNumber;
-    }
-    if (params.blockHash != null) {
-        where.blockHash = params.blockHash.value;
-    }
-    if (params.onlySuccessful) {
-        where.errorHint = null;
-    }
     if (params.includePending !== true) {
         where.isPending = false;
     }
@@ -451,8 +436,6 @@ export async function getTransactions(params: {
     assetType?: H160 | null;
     type?: string[] | null;
     tracker?: H256 | null;
-    blockNumber?: number | null;
-    blockHash?: H256 | null;
     page: number;
     itemsPerPage: number;
     includePending?: boolean | null;
@@ -488,6 +471,27 @@ export async function getTransactions(params: {
     }
 }
 
+export async function getTransactionsOfBlock(params: {
+    page: number;
+    itemsPerPage: number;
+    blockNumber: number;
+}) {
+    try {
+        const { page, itemsPerPage, blockNumber } = params;
+
+        return models.Transaction.findAll({
+            where: { blockNumber },
+            order: [["transactionIndex", "DESC"]],
+            limit: itemsPerPage,
+            offset: (page - 1) * itemsPerPage,
+            include: [...fullIncludeArray]
+        });
+    } catch (err) {
+        console.error(err);
+        throw Exception.DBError();
+    }
+}
+
 export async function getNumberOfEachTransactionType(
     params: {
         blockNumber: number;
@@ -513,22 +517,12 @@ export async function getNumberOfEachTransactionType(
 function buildQueryForTransactions(params: {
     type?: string[] | null;
     tracker?: H256 | null;
-    blockNumber?: number | null;
-    blockHash?: H256 | null;
     includePending?: boolean | null;
     onlySuccessful?: boolean | null;
 }) {
     return {
         ...(params.type ? { type: { [Sequelize.Op.in]: params.type } } : {}),
         ...(params.tracker ? { tracker: params.tracker.value } : {}),
-        ...(params.blockNumber != null
-            ? { blockNumber: params.blockNumber }
-            : {}),
-        ...(params.blockHash
-            ? {
-                  blockHash: params.blockHash.value
-              }
-            : {}),
         ...(params.onlySuccessful ? { errorHint: null } : {}),
         ...(params.includePending !== true ? { isPending: false } : {})
         /* FIXME: onlyConfirmed, confirmThreshold */

src/routers/block.ts

@@ -215,6 +215,7 @@ export function handle(context: IndexerContext, router: Router) {
     router.get(
         "/block/:hashOrNumber/tx",
         validate({
+            // FIXME: Throw an error if hashOrNumber is not hash or number
             query: {
                 ...paginationSchema
             }
@@ -226,23 +227,15 @@ export function handle(context: IndexerContext, router: Router) {
                 (req.query.itemsPerPage &&
                     parseInt(req.query.itemsPerPage, 10)) ||
                 15;
-            let hashValue;
-            let numberValue;
-            // FIXME: Throw an error if hashOrNumber is not hash or number
-            try {
-                hashValue = new H256(hashOrNumber);
-            } catch (e) {
-                if (!isNaN(hashOrNumber)) {
-                    numberValue = parseInt(hashOrNumber, 10);
-                }
-            }
+
             try {
-                const txs = await TransactionModel.getTransactions({
+                const block =
+                    H256.check(hashOrNumber) &&
+                    (await BlockModel.getByHash(new H256(hashOrNumber)));
+                const txs = await TransactionModel.getTransactionsOfBlock({
                     page,
                     itemsPerPage,
-                    ...(hashValue
-                        ? { blockHash: hashValue }
-                        : { blockNumber: numberValue })
+                    blockNumber: block ? block.get().number : hashOrNumber
                 });
                 res.json(txs.map(tx => tx.get({ plain: true })));
             } catch (e) {

test/mint-transfer.spec.ts

@@ -115,11 +115,13 @@ describe("mint-transfer-synchronized", function() {
         expect(mintBlockInst.get({ plain: true }).hash).equal(
             mintBlock.hash.value
         );
-        const mintBlockTransactions = await TransactionModel.getTransactions({
-            blockNumber: bestBlockNumber - 1,
-            page: 1,
-            itemsPerPage: 15
-        }).then(txs => txs.map(tx => tx.get({ plain: true })));
+        const mintBlockTransactions = await TransactionModel.getTransactionsOfBlock(
+            {
+                blockNumber: bestBlockNumber - 1,
+                page: 1,
+                itemsPerPage: 15
+            }
+        ).then(txs => txs.map(tx => tx.get({ plain: true })));
         expect(mintBlockTransactions[0].hash).equal(
             mintBlock.transactions[0].hash().value
         );
@@ -132,7 +134,7 @@ describe("mint-transfer-synchronized", function() {
         expect(transferBlockInst.get({ plain: true }).hash).equal(
             transferBlock.hash.value
         );
-        const transferBlockTransactions = await TransactionModel.getTransactions(
+        const transferBlockTransactions = await TransactionModel.getTransactionsOfBlock(
             {
                 blockNumber: bestBlockNumber,
                 page: 1,