fix: 🐛 return ResultSet for getHistoricalInstructions

BREAKING CHANGE: 🧨 changes data structure returned by methods
(Identity.getHistoricalInstructions &
Settlements.getHistoricalInstructions)

Author: sansan

src/api/client/Settlements.ts

@@ -21,10 +21,11 @@ import {
   InstructionAffirmationOperation,
   InstructionIdParams,
   ProcedureMethod,
+  ResultSet,
 } from '~/types';
 import { Ensured } from '~/types/utils';
 import { middlewareInstructionToHistoricInstruction } from '~/utils/conversion';
-import { createProcedureMethod } from '~/utils/internal';
+import { calculateNextKey, createProcedureMethod } from '~/utils/internal';
 
 /**
  * Handles all Settlement related functionality
@@ -135,19 +136,29 @@ export class Settlements {
    */
   public async getHistoricalInstructions(
     filter: HistoricalInstructionFilters
-  ): Promise<HistoricInstruction[]> {
+  ): Promise<ResultSet<HistoricInstruction>> {
     const { context } = this;
 
     const query = await historicalInstructionsQuery(filter, context);
 
     const {
       data: {
-        instructions: { nodes: instructionsResult },
+        instructions: { nodes: instructionsResult, totalCount },
       },
     } = await context.queryMiddleware<Ensured<Query, 'instructions'>>(query);
 
-    return instructionsResult.map(instruction =>
-      middlewareInstructionToHistoricInstruction(instruction!, context)
+    const data = instructionsResult.map(middlewareInstruction =>
+      middlewareInstructionToHistoricInstruction(middlewareInstruction, context)
     );
+
+    const count = new BigNumber(totalCount);
+
+    const next = calculateNextKey(count, data.length, filter.start);
+
+    return {
+      data,
+      next,
+      count,
+    };
   }
 }

src/api/client/__tests__/Settlements.ts

@@ -210,7 +210,11 @@ describe('Settlements Class', () => {
 
       const result = await settlements.getHistoricalInstructions({});
 
-      expect(result).toEqual([mockHistoricInstruction]);
+      expect(result).toEqual({
+        data: [mockHistoricInstruction],
+        next: new BigNumber(1),
+        count: new BigNumber(5),
+      });
     });
   });
 });

src/api/entities/Identity/__tests__/index.ts

@@ -1281,6 +1281,12 @@ describe('Identity class', () => {
   });
 
   describe('method: getHistoricalInstructions', () => {
+    let calculateNextSpy: jest.SpyInstance;
+
+    beforeAll(() => {
+      calculateNextSpy = jest.spyOn(utilsInternalModule, 'calculateNextKey');
+    });
+
     it('should return the list of all instructions where the Identity was involved', async () => {
       const identity = new Identity({ did: 'someDid' }, context);
       const middlewareInstructionToHistoricInstructionSpy = jest.spyOn(
@@ -1305,7 +1311,47 @@ describe('Identity class', () => {
 
       const result = await identity.getHistoricalInstructions();
 
-      expect(result).toEqual([mockHistoricInstruction]);
+      expect(result).toEqual({
+        data: [mockHistoricInstruction],
+        next: new BigNumber(1),
+        count: new BigNumber(5),
+      });
+      expect(calculateNextSpy).toHaveBeenCalledWith(new BigNumber(5), 1, undefined);
+    });
+
+    it('should return the list of all instructions where the Identity was involved when using pagination', async () => {
+      const identity = new Identity({ did: 'someDid' }, context);
+      const start = new BigNumber(0);
+
+      const middlewareInstructionToHistoricInstructionSpy = jest.spyOn(
+        utilsConversionModule,
+        'middlewareInstructionToHistoricInstruction'
+      );
+
+      calculateNextSpy = jest.spyOn(utilsInternalModule, 'calculateNextKey');
+      const instructionsResponse = {
+        totalCount: 5,
+        nodes: [{ id: '1' }],
+      };
+
+      const query = await historicalInstructionsQuery({ identity: identity.did }, context);
+
+      dsMockUtils.createApolloQueryMock(query, {
+        instructions: instructionsResponse,
+      });
+
+      const mockHistoricInstruction = 'mockData' as unknown as HistoricInstruction;
+
+      middlewareInstructionToHistoricInstructionSpy.mockReturnValue(mockHistoricInstruction);
+
+      const result = await identity.getHistoricalInstructions({ start });
+
+      expect(result).toEqual({
+        data: [mockHistoricInstruction],
+        next: new BigNumber(1),
+        count: new BigNumber(5),
+      });
+      expect(calculateNextSpy).toHaveBeenCalledWith(new BigNumber(5), 1, start);
     });
   });
 

src/api/entities/Identity/index.ts

@@ -907,20 +907,27 @@ export class Identity extends Entity<UniqueIdentifiers, string> {
    */
   public async getHistoricalInstructions(
     filter?: Omit<HistoricalInstructionFilters, 'identity'>
-  ): Promise<HistoricInstruction[]> {
+  ): Promise<ResultSet<HistoricInstruction>> {
     const { context, did } = this;
 
     const query = await historicalInstructionsQuery({ ...filter, identity: did }, context);
 
     const {
       data: {
-        instructions: { nodes: instructionsResult },
+        instructions: { nodes: instructionsResult, totalCount },
       },
     } = await context.queryMiddleware<Ensured<Query, 'instructions'>>(query);
 
-    return instructionsResult.map(instruction =>
-      middlewareInstructionToHistoricInstruction(instruction, context)
-    );
+    const count = new BigNumber(totalCount);
+    const next = calculateNextKey(count, instructionsResult.length, filter?.start);
+
+    return {
+      data: instructionsResult.map(instruction =>
+        middlewareInstructionToHistoricInstruction(instruction, context)
+      ),
+      next,
+      count,
+    };
   }
 
   /**