feat(core-api): filter locks by expiration status (ArkEcosystem#3227)

dated · Nov 8, 2019 · 91e815e · 91e815e
1 parent b5ea607
commit 91e815e
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 12 deletions.
diff --git a/__tests__/integration/core-api/handlers/locks.test.ts b/__tests__/integration/core-api/handlers/locks.test.ts
@@ -46,7 +46,7 @@ describe("API 2.0 - Locks", () => {
                     secretHash: transaction.id,
                     expiration: {
                         type: j % 2 === 0 ? 1 : 2,
-                        value: 100 * (j + 1),
+                        value: !j ? 0 : (100 * (j + 1)),
                     },
                     timestamp: (i + 1) * 100000,
                 };
@@ -71,7 +71,7 @@ describe("API 2.0 - Locks", () => {
             const response = await utils.request("GET", "locks", { orderBy: "expirationValue:asc" });
             expect(response).toBeSuccessfulResponse();
             expect(response.data.data).toBeArray();
-            expect(response.data.data[0].expirationValue).toBe(100);
+            expect(response.data.data[0].expirationValue).toBe(0);
         });
 
         it("should GET all the locks by epoch expiration", async () => {
@@ -90,6 +90,22 @@ describe("API 2.0 - Locks", () => {
             expect(response.data.data.every(lock => lock.expirationType === 2)).toBeTrue();
         });
 
+        it("should GET all the locks that are expired", async () => {
+            const response = await utils.request("GET", "locks", { isExpired: true });
+            expect(response).toBeSuccessfulResponse();
+            expect(response.data.data).toBeArray();
+            expect(response.data.data).not.toBeEmpty();
+            expect(response.data.data.every(lock => lock.isExpired)).toBeTrue();
+        });
+
+        it("should GET all the locks that are not expired", async () => {
+            const response = await utils.request("GET", "locks", { isExpired: false });
+            expect(response).toBeSuccessfulResponse();
+            expect(response.data.data).toBeArray();
+            expect(response.data.data).not.toBeEmpty();
+            expect(response.data.data.every(lock => !lock.isExpired)).toBeTrue();
+        });
+
         describe("orderBy", () => {
             it("should be ordered by amount:desc", async () => {
                 const response = await utils.request("GET", "locks", { orderBy: "amount:desc", expirationType: 2 });
@@ -104,7 +120,7 @@ describe("API 2.0 - Locks", () => {
                 }
             });
 
-            it("should be ordered by amount:ascs", async () => {
+            it("should be ordered by amount:asc", async () => {
                 const response = await utils.request("GET", "locks", { orderBy: "amount:asc", expirationType: 2 });
                 expect(response).toBeSuccessfulResponse();
                 expect(response.data.data).toBeArray();

diff --git a/__tests__/unit/core-database/repositories/wallets-business-repository.test.ts b/__tests__/unit/core-database/repositories/wallets-business-repository.test.ts
@@ -11,6 +11,7 @@ import { WalletsBusinessRepository } from "../../../../packages/core-database/sr
 import { DatabaseService } from "../../../../packages/core-database/src/database-service";
 import { Wallets } from "../../../../packages/core-state/src";
 import { Address } from "../../../../packages/crypto/src/identities";
+import { stateStorageStub } from "../__fixtures__/state-storage-stub";
 
 let genesisSenders;
 let repository: Database.IWalletsBusinessRepository;
@@ -266,6 +267,8 @@ describe("Wallet Repository", () => {
             const wallets = generateHtlcLocks();
             walletManager.index(wallets);
 
+            jest.spyOn(stateStorageStub, "getLastBlock").mockReturnValue(genesisBlock);
+
             const locks = repository.search(Database.SearchScope.Locks, {});
             expect(locks.rows).toHaveLength(genesisBlock.transactions.length);
         });

diff --git a/packages/core-api/src/handlers/locks/schema.ts b/packages/core-api/src/handlers/locks/schema.ts
@@ -25,6 +25,7 @@ export const index: object = {
                 .integer()
                 .min(0),
             expirationType: Joi.number().only(1, 2),
+            isExpired: Joi.bool(),
         },
     },
 };
@@ -85,6 +86,7 @@ export const search: object = {
                 .integer()
                 .min(0),
         }),
+        isExpired: Joi.bool(),
     },
 };
 

diff --git a/packages/core-api/src/handlers/locks/transformer.ts b/packages/core-api/src/handlers/locks/transformer.ts
@@ -1,14 +1,10 @@
 import { formatTimestamp } from "@arkecosystem/core-utils";
-import { expirationCalculator } from "@arkecosystem/core-utils";
+import { Interfaces } from "@arkecosystem/crypto";
 
-export const transformLock = lock => {
+export const transformLock = (lock: Interfaces.IHtlcLock) => {
     return {
         ...lock,
         amount: lock.amount.toFixed(),
         timestamp: formatTimestamp(lock.timestamp),
-        isExpired: expirationCalculator.calculateLockExpirationStatus({
-            type: lock.expirationType,
-            value: lock.expirationValue,
-        }),
     };
 };
diff --git a/packages/core-api/src/handlers/wallets/schema.ts b/packages/core-api/src/handlers/wallets/schema.ts
@@ -187,6 +187,7 @@ export const locks: object = {
     query: {
         ...pagination,
         ...{
+            isExpired: Joi.bool(),
             orderBy: Joi.string(),
         },
     },

diff --git a/packages/core-database/src/repositories/utils/filter-rows.ts b/packages/core-database/src/repositories/utils/filter-rows.ts
@@ -12,7 +12,7 @@ export = <T = any>(rows: ReadonlyArray<T>, params: Database.IParameters, filters
     return rows.filter(item => {
         if (filters.hasOwnProperty("exact")) {
             for (const elem of filters.exact) {
-                if (params[elem] && getProperty(item, elem) !== params[elem]) {
+                if (params[elem] !== undefined && getProperty(item, elem) !== params[elem]) {
                     return false;
                 }
             }

diff --git a/packages/core-database/src/repositories/wallets-business-repository.ts b/packages/core-database/src/repositories/wallets-business-repository.ts
@@ -1,5 +1,5 @@
 import { Database, State } from "@arkecosystem/core-interfaces";
-import { delegateCalculator, hasSomeProperty } from "@arkecosystem/core-utils";
+import { delegateCalculator, expirationCalculator, hasSomeProperty } from "@arkecosystem/core-utils";
 import { Interfaces, Utils } from "@arkecosystem/crypto";
 import { searchEntries } from "./utils/search-entries";
 
@@ -18,6 +18,7 @@ interface IUnwrappedHtlcLock {
     timestamp: number;
     expirationType: number;
     expirationValue: number;
+    isExpired: boolean;
     vendorField: string;
 }
 
@@ -179,7 +180,15 @@ export class WalletsBusinessRepository implements Database.IWalletsBusinessRepos
 
     private searchLocks(params: Database.IParameters = {}): ISearchContext<IUnwrappedHtlcLock> {
         const query: Record<string, string[]> = {
-            exact: ["senderPublicKey", "lockId", "recipientId", "secretHash", "expirationType", "vendorField"],
+            exact: [
+                "expirationType",
+                "isExpired",
+                "lockId",
+                "recipientId",
+                "secretHash",
+                "senderPublicKey",
+                "vendorField",
+            ],
             between: ["expirationValue", "amount", "timestamp"],
         };
 
@@ -203,6 +212,9 @@ export class WalletsBusinessRepository implements Database.IWalletsBusinessRepos
                         timestamp: lock.timestamp,
                         expirationType: lock.expiration.type,
                         expirationValue: lock.expiration.value,
+                        isExpired: expirationCalculator.calculateLockExpirationStatus(
+                            lock.expiration,
+                        ),
                         vendorField: lock.vendorField,
                     });
                 }