Merge pull request #459 from samwel141/master

Created sortable trust relationships

Author: Kpoke

server/handlers/trustHandler.spec.js

@@ -14,6 +14,7 @@ const TrustService = require('../services/TrustService');
 const JWTService = require('../services/JWTService');
 const TrustRelationshipEnums = require('../utils/trust-enums');
 
+
 describe('trustRouter', () => {
   let app;
   const authenticatedWalletId = uuid.v4();
@@ -192,32 +193,43 @@ describe('trustRouter', () => {
       expect(res.body.message).match(/request_type.*one.*of/);
     });
 
-    it('successfully', async () => {
-      const limit = 10;
-      const offset = 0;
-      const count = 1;
-      const getAllTrustRelationshipsStub = sinon
-        .stub(TrustService.prototype, 'getAllTrustRelationships')
-        .resolves({
-          result: [{ id: trustId }],
-          count
-        });
-      const res = await request(app).get(
-        `/trust_relationships?type=${TrustRelationshipEnums.ENTITY_TRUST_TYPE.send}&request_type=${TrustRelationshipEnums.ENTITY_TRUST_REQUEST_TYPE.send}&state=${TrustRelationshipEnums.ENTITY_TRUST_STATE_TYPE.trusted}&limit=${limit}&offset=${offset}`,
-      );
-      expect(res).property('statusCode').eq(200);
-      expect(res.body.trust_relationships).lengthOf(1);
-      expect(res.body.trust_relationships[0]).eql({ id: trustId });
-      expect(getAllTrustRelationshipsStub).calledWith({
-        state: TrustRelationshipEnums.ENTITY_TRUST_STATE_TYPE.trusted,
-        type: TrustRelationshipEnums.ENTITY_TRUST_TYPE.send,
-        request_type: TrustRelationshipEnums.ENTITY_TRUST_REQUEST_TYPE.send,
-        limit,
-        offset,
-        walletId: authenticatedWalletId,
+  it('successfully', async () => {
+    const limit = 10;
+    const offset = 0;
+    const count = 1;
+    const orderBy = 'created_at'; 
+    const order = 'desc'; 
+  
+    const getAllTrustRelationshipsStub = sinon
+      .stub(TrustService.prototype, 'getAllTrustRelationships')
+      .resolves({
+        result: [{ id: trustId }],
+        count
       });
+  
+    const res = await request(app).get(
+      `/trust_relationships?type=${TrustRelationshipEnums.ENTITY_TRUST_TYPE.send}&request_type=${TrustRelationshipEnums.ENTITY_TRUST_REQUEST_TYPE.send}&state=${TrustRelationshipEnums.ENTITY_TRUST_STATE_TYPE.trusted}&limit=${limit}&offset=${offset}&order=${order}&sort_by=${orderBy}`,
+    );
+  
+    expect(res).property('statusCode').eq(200);
+    expect(res.body.trust_relationships).to.have.lengthOf(1);
+    expect(res.body.trust_relationships[0]).to.eql({ id: trustId });
+  
+    expect(getAllTrustRelationshipsStub).to.have.been.calledWith({
+      state: TrustRelationshipEnums.ENTITY_TRUST_STATE_TYPE.trusted,
+      type: TrustRelationshipEnums.ENTITY_TRUST_TYPE.send,
+      request_type: TrustRelationshipEnums.ENTITY_TRUST_REQUEST_TYPE.send,
+      limit,
+      offset,
+      order,
+      sort_by: orderBy,
+      walletId: authenticatedWalletId,
     });
   });
+});
+  
+
+
 
   describe('get /trust_relationships/:id', () => {
     it('missed parameters -- relationshipId must be a guid', async () => {

server/handlers/trustHandler/index.js

@@ -14,7 +14,10 @@ const trustGet = async (req, res) => {
     state,
     type,
     request_type,
-    limit, offset
+    limit, 
+    offset,
+    sort_by,
+    order
   } = validatedQuery;
 
   const { wallet_id } = req;
@@ -29,11 +32,13 @@ const trustGet = async (req, res) => {
     request_type,
     offset,
     limit,
+    sort_by,
+    order
   });
 
   res.status(200).json({
     trust_relationships,
-    query: { limit, offset },
+    query: { limit, offset, sort_by, order },
     total,
   });
 };

server/handlers/trustHandler/schemas.js

@@ -13,6 +13,8 @@ const trustGetQuerySchema = Joi.object({
   ),
   offset: Joi.number().integer().min(0).default(0),
   limit: Joi.number().integer().min(1).max(2000).default(500),
+  sort_by: Joi.string().valid( 'state', 'created_at', 'updated_at').default('created_at'),
+  order: Joi.string().valid('asc', 'desc').default('desc'),
 });
 
 const trustPostSchema = Joi.object({

server/handlers/walletHandler.spec.js

@@ -38,8 +38,8 @@ describe('walletRouter', () => {
   describe('get /wallets', () => {
     it('no limit parameter(1000 as default)', async () => {
       const res = await request(app).get('/wallets');
-      expect(res).property('statusCode').eq(200);
-    });
+            expect(res).property('statusCode').eq(200);
+          });
 
     it('successfully', async () => {
       const walletId = uuid.v4();

server/models/Trust.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-unused-vars */
 const Joi = require('joi');
 const log = require('loglevel');
 const TrustRepository = require('../repositories/TrustRepository');
@@ -25,6 +26,8 @@ class Trust {
     request_type,
     offset,
     limit,
+    sort_by,
+    order
   }) {
     const filter = {
       and: [
@@ -52,7 +55,7 @@ class Trust {
   /*
    * Get all trust relationships by filters, setting filter to undefined to allow all data
    */
-  async getAllTrustRelationships({ walletId, state, type, request_type, offset, limit }) {
+  async getAllTrustRelationships({ walletId, state, type, request_type, offset, limit, sort_by, order }) {
 
     const filter = {
       and: [
@@ -68,7 +71,7 @@ class Trust {
     if (request_type) {
       filter.and.push({ request_type });
     }
-    return this._trustRepository.getAllByFilter(filter, { offset, limit });
+    return this._trustRepository.getAllByFilter(filter, { offset, limit, sort_by, order });
   }
 
   /*

server/repositories/TrustRepository.js

@@ -76,64 +76,76 @@ class TrustRepository extends BaseRepository {
       promise = promise.offset(limitOptions.offset);
     }
 
+    let order = 'desc';
+    let column = 'wallet_trust.created_at';
+
+    if (limitOptions) {
+      if (limitOptions.order) {
+        order = limitOptions.order;
+      }
+      if (limitOptions.sort_by) {
+        column = limitOptions.sort_by;
+      }
+    }
+    promise = promise.orderBy(column, order);
+
     return promise;
   }
 
-  async getAllByFilter(filter, limitOptions) {
-    let promise = this._session
-      .getDB()
-      .select(
-        'wallet_trust.id',
-        'wallet_trust.actor_wallet_id',
-        'wallet_trust.target_wallet_id',
-        'wallet_trust.type',
-        'wallet_trust.originator_wallet_id',
-        'wallet_trust.request_type',
-        'wallet_trust.state',
-        'wallet_trust.created_at',
-        'wallet_trust.updated_at',
-        'wallet_trust.active',
-        'originator_wallet.name as originating_wallet',
-        'actor_wallet.name as actor_wallet',
-        'target_wallet.name as target_wallet',
-      )
-      .from('wallet_trust')
-      .leftJoin(
-        'wallet as originator_wallet',
-        'wallet_trust.originator_wallet_id',
-        '=',
-        'originator_wallet.id',
-      )
-      .leftJoin(
-        'wallet as actor_wallet',
-        'wallet_trust.actor_wallet_id',
-        '=',
-        'actor_wallet.id',
-      )
-      .leftJoin(
-        'wallet as target_wallet',
-        'wallet_trust.target_wallet_id',
-        '=',
-        'target_wallet.id',
-      )
-      .where((builder) => this.whereBuilder(filter, builder))
-      .distinctOn('wallet_trust.id'); // distinct on id to avoid duplicates
+async getAllByFilter(filter, limitOptions) {
+  const subquery = this._session.getDB()
+    .select(
+      'wallet_trust.id',
+      'wallet_trust.actor_wallet_id',
+      'wallet_trust.target_wallet_id',
+      'wallet_trust.type',
+      'wallet_trust.originator_wallet_id',
+      'wallet_trust.request_type',
+      'wallet_trust.state',
+      'wallet_trust.created_at',
+      'wallet_trust.updated_at',
+      'wallet_trust.active',
+      'originator_wallet.name as originating_wallet',
+      'actor_wallet.name as actor_wallet',
+      'target_wallet.name as target_wallet',
+    )
+    .from('wallet_trust')
+    .leftJoin('wallet as originator_wallet', 'wallet_trust.originator_wallet_id', '=', 'originator_wallet.id')
+    .leftJoin('wallet as actor_wallet', 'wallet_trust.actor_wallet_id', '=', 'actor_wallet.id')
+    .leftJoin('wallet as target_wallet', 'wallet_trust.target_wallet_id', '=', 'target_wallet.id')
+    .where((builder) => this.whereBuilder(filter, builder))
+    .distinctOn('wallet_trust.id')
+    .orderBy('wallet_trust.id', 'asc'); 
 
-    // get the total count (before applying limit and offset options)
-    const count = await this._session.getDB().from(promise.as('p')).count('*');
+  let derivedTable = this._session.getDB().select('*').from(subquery.as('subquery'));
 
-    if (limitOptions && limitOptions.limit) {
-      promise = promise.limit(limitOptions.limit);
-    }
+  let order = 'desc';
+  let column = 'created_at';
 
-    if (limitOptions && limitOptions.offset) {
-      promise = promise.offset(limitOptions.offset);
+  if (limitOptions) {
+    if (limitOptions.order) {
+      order = limitOptions.order;
     }
+    if (limitOptions.sort_by) {
+      column = limitOptions.sort_by;
+    }
+  }
 
-    const result = await promise;
+  derivedTable = derivedTable.orderBy(column, order);
 
-    return { result, count: +count[0].count };
+  if (limitOptions && limitOptions.limit) {
+    derivedTable = derivedTable.limit(limitOptions.limit);
   }
+  if (limitOptions && limitOptions.offset) {
+    derivedTable = derivedTable.offset(limitOptions.offset);
+  }
+
+  const result = await derivedTable;
+
+  const {count} = result[0];
+
+  return { result, count: +count };
+}
 }
 
 module.exports = TrustRepository;

server/repositories/WalletRepository.js

@@ -64,7 +64,7 @@ class WalletRepository extends BaseRepository {
     created_at_end_date,
     getCount,
   ) {
-    let query = this._session
+        let query = this._session
       .getDB()
       .select('id', 'name', 'about', 'logo_url', 'created_at')
       .table('wallet')
@@ -144,7 +144,6 @@ class WalletRepository extends BaseRepository {
     }
 
     const wallets = await query;
-
     if (getCount) {
       const count = await countQuery;
       return { wallets, count: +count[0].count };

server/services/TrustService.js

@@ -13,7 +13,7 @@ class TrustService {
 
   async getTrustRelationships(
     loggedInWalletId,
-    { walletId, state, type, request_type, offset, limit },
+    { walletId, state, type, request_type, offset, limit,sort_by, order },
   ) {
     // check if wallet exists first
     // throws error if no wallet matching walletId exists
@@ -27,6 +27,8 @@ class TrustService {
       request_type,
       offset,
       limit,
+      sort_by,
+      order
     });
   }
 
@@ -37,6 +39,9 @@ class TrustService {
     request_type,
     offset,
     limit,
+    sort_by,
+    order,
+    
   }) {
     return this._trust.getAllTrustRelationships({
       walletId,
@@ -45,6 +50,8 @@ class TrustService {
       request_type,
       offset,
       limit,
+      sort_by,
+      order
     });
   }
 

server/services/TrustService.spec.js

@@ -38,6 +38,8 @@ describe('TrustService', () => {
         request_type: 'request_type',
         limit: 1,
         offset: 0,
+        sort_by: 'sort_by',
+        order: 'order',
       },
     );
 
@@ -55,6 +57,8 @@ describe('TrustService', () => {
         request_type: 'request_type',
         limit: 1,
         offset: 0,
+        sort_by: 'sort_by',
+        order: 'order'
       }),
     ).eql(true);
   });