Merge pull request #536 from samwel141/master

feat(transfer): Add prioritization for pending receiver actions in transfer filtering

Author: Kpoke

server/models/Transfer.js

@@ -69,6 +69,7 @@ class Transfer {
     after,
     sort_by,
     order,
+    prioritize_pending_receiver_action_for_wallet_id,
   }) {
     const filter = {
       and: [],
@@ -101,7 +102,19 @@ class Transfer {
     if (after) {
       filter.and.push({ after: { 'transfer.created_at': after } });
     }
-    return this.getByFilter(filter, { offset, limit, sort_by, order });
+    const limitOptions = {
+      offset,
+      limit,
+      sort_by,
+      order,
+    };
+
+    if (prioritize_pending_receiver_action_for_wallet_id !== undefined) {
+      limitOptions.prioritize_pending_receiver_action_for_wallet_id =
+        prioritize_pending_receiver_action_for_wallet_id;
+    }
+
+    return this.getByFilter(filter, limitOptions);
   }
 
   /*

server/repositories/TransferRepository.js

@@ -1,6 +1,7 @@
 const Joi = require('joi');
 const BaseRepository = require('./BaseRepository');
 const TransferEnum = require('../utils/transfer-enum');
+const TrustRelationshipEnums = require('../utils/trust-enums');
 
 class TransferRepository extends BaseRepository {
   constructor(session) {
@@ -131,6 +132,7 @@ class TransferRepository extends BaseRepository {
 
     let order = 'desc';
     let column = 'transfer.created_at';
+    let useDefaultPriorityOrdering = false;
 
     if (limitOptions) {
       if (limitOptions.order) {
@@ -139,7 +141,59 @@ class TransferRepository extends BaseRepository {
       if (limitOptions.sort_by) {
         column = limitOptions.sort_by;
       }
+      if (limitOptions.prioritize_pending_receiver_action_for_wallet_id) {
+        useDefaultPriorityOrdering = true;
+      }
     }
+
+    if (useDefaultPriorityOrdering) {
+      const walletLoginId =
+        limitOptions.prioritize_pending_receiver_action_for_wallet_id;
+
+      promise = promise.orderByRaw(
+        `
+          CASE
+            WHEN transfer.state = ?
+              AND (
+                transfer.destination_wallet_id = ?
+                OR EXISTS (
+                  SELECT 1
+                  FROM wallet_trust
+                  WHERE (
+                    wallet_trust.actor_wallet_id = ?
+                    AND wallet_trust.target_wallet_id = transfer.destination_wallet_id
+                    AND wallet_trust.request_type = ?
+                    AND wallet_trust.state = ?
+                  ) OR (
+                    wallet_trust.target_wallet_id = ?
+                    AND wallet_trust.actor_wallet_id = transfer.destination_wallet_id
+                    AND wallet_trust.request_type = ?
+                    AND wallet_trust.state = ?
+                  )
+                )
+              ) THEN 0
+            WHEN transfer.state = ? THEN 1
+            WHEN transfer.state = ? THEN 2
+            WHEN transfer.state = ? THEN 3
+            ELSE 4
+          END ASC
+        `,
+        [
+          TransferEnum.STATE.pending,
+          walletLoginId,
+          walletLoginId,
+          TrustRelationshipEnums.ENTITY_TRUST_REQUEST_TYPE.manage,
+          TrustRelationshipEnums.ENTITY_TRUST_STATE_TYPE.trusted,
+          walletLoginId,
+          TrustRelationshipEnums.ENTITY_TRUST_REQUEST_TYPE.yield,
+          TrustRelationshipEnums.ENTITY_TRUST_STATE_TYPE.trusted,
+          TransferEnum.STATE.pending,
+          TransferEnum.STATE.completed,
+          TransferEnum.STATE.cancelled,
+        ],
+      );
+    }
+
     promise = promise.orderBy(column, order);
 
     // get the total count (before applying limit and offset options)

server/services/TransferService.js

@@ -27,6 +27,11 @@ class TransferService {
       order,
     } = query;
 
+    const effectiveSortBy = sort_by || 'created_at';
+    const effectiveOrder = order || 'desc';
+    const isDefaultSort =
+      effectiveSortBy === 'created_at' && effectiveOrder === 'desc';
+
     let walletId;
 
     if (wallet) {
@@ -44,8 +49,10 @@ class TransferService {
       after,
       sort_by,
       order,
+      prioritize_pending_receiver_action_for_wallet_id: isDefaultSort
+        ? walletLoginId
+        : undefined,
     });
-
     return { transfers, count };
   }
 

server/services/TransferService.spec.js

@@ -169,6 +169,7 @@ describe('TransferService', () => {
           after: undefined,
           sort_by: undefined,
           order: undefined,
+          prioritize_pending_receiver_action_for_wallet_id: 'walletLoginId',
         }),
       ).eql(true);
       expect(walletGetByIdOrNameStub.notCalled).eql(true);
@@ -200,10 +201,39 @@ describe('TransferService', () => {
           after,
           sort_by: undefined,
           order: undefined,
+          prioritize_pending_receiver_action_for_wallet_id: 'walletLoginId',
         }),
       ).eql(true);
       expect(walletGetByIdOrNameStub.calledOnceWithExactly('wallet')).eql(true);
     });
+
+    it('getByFilter -- skips priority ordering for custom sorts', async () => {
+      await transferService.getByFilter(
+        {
+          state: 'state',
+          limit: 1,
+          offset: 1,
+          sort_by: 'state',
+          order: 'asc',
+        },
+        'walletLoginId',
+      );
+
+      expect(
+        getTransfersStub.calledOnceWithExactly({
+          state: 'state',
+          limit: 1,
+          offset: 1,
+          walletLoginId: 'walletLoginId',
+          walletId: undefined,
+          before: undefined,
+          after: undefined,
+          sort_by: 'state',
+          order: 'asc',
+          prioritize_pending_receiver_action_for_wallet_id: undefined,
+        }),
+      ).eql(true);
+    });
   });
 
   describe('acceptTransfer', () => {