Skip to content

Commit

Permalink
chore: refactor lease process pool to make it more readable and easie…
Browse files Browse the repository at this point in the history 
…r to work with
  • Loading branch information
@SewerynKras
SewerynKras committed May 16, 2024
1 parent 27d7a91 commit ad7c3bd
Show file tree
Hide file tree
Showing 6 changed files with 111 additions and 106 deletions.
125 changes: 58 additions & 67 deletions src/agreement/lease-process-pool.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ const marketModule = imock<MarketModule>();
function getMockLeaseProcess() {
return {
hasActivity: () => false,
fetchAgreementState: () => Promise.resolve("Approved"),
agreement: { id: "1", getDto: () => ({}) } as Agreement,
} as LeaseProcess;
}
Expand Down Expand Up @@ -54,7 +55,7 @@ describe("LeaseProcessPool", () => {

await pool.ready();

expect(pool.getAvailable()).toBe(5);
expect(pool.getAvailableSize()).toBe(5);
verify(proposalPool.acquire()).times(5);
});
it("retries on error", async () => {
Expand All @@ -74,7 +75,7 @@ describe("LeaseProcessPool", () => {

await pool.ready();

expect(pool.getAvailable()).toBe(3);
expect(pool.getAvailableSize()).toBe(3);
verify(proposalPool.acquire()).times(5);
});
it("stops retrying after timeout", async () => {
Expand All @@ -95,14 +96,13 @@ describe("LeaseProcessPool", () => {
await expect(pool.ready(AbortSignal.timeout(60))).rejects.toThrow(
"Could not create enough lease processes to reach the minimum pool size in time",
);
expect(pool.getAvailable()).toBe(1);
expect(pool.getAvailableSize()).toBe(1);
// first loop 3 times, then 2 times
verify(proposalPool.acquire()).times(5);
});
});
describe("acquire()", () => {
it("takes a random lease process from the pool if none have activities", async () => {
when(agreementApi.getAgreement(_)).thenResolve({ getState: () => "Approved" } as Agreement);
const pool = getLeasePool({ min: 3 });
const lease1 = getMockLeaseProcess();
const lease2 = getMockLeaseProcess();
Expand All @@ -112,12 +112,11 @@ describe("LeaseProcessPool", () => {
pool["lowPriority"].add(lease3);

const leaseProcess = await pool.acquire();
expect(pool.getBorrowed()).toBe(1);
expect(pool.getAvailable()).toBe(2);
expect(pool.getBorrowedSize()).toBe(1);
expect(pool.getAvailableSize()).toBe(2);
expect([lease1, lease2, lease3]).toContain(leaseProcess);
});
it("prioritizes lease processes from high priority pool", async () => {
when(agreementApi.getAgreement(_)).thenResolve({ getState: () => "Approved" } as Agreement);
const pool = getLeasePool({ min: 3 });
const lease1 = getMockLeaseProcess();
const lease2 = getMockLeaseProcess();
Expand All @@ -127,24 +126,22 @@ describe("LeaseProcessPool", () => {
pool["lowPriority"].add(lease3);

const leaseProcess = await pool.acquire();
expect(pool.getBorrowed()).toBe(1);
expect(pool.getAvailable()).toBe(2);
expect(pool.getBorrowedSize()).toBe(1);
expect(pool.getAvailableSize()).toBe(2);
expect(leaseProcess).toBe(lease2);
});
it("creates a new lease process if none are available", async () => {
LeaseProcessPool.prototype["createNewLeaseProcess"] = jest
.fn()
.mockResolvedValue({ agreement: { id: "1", getDto: () => ({}) } } as LeaseProcess);

const pool = getLeasePool({ min: 3 });
// @ts-expect-error private method
jest.spyOn(pool, "createNewLeaseProcess").mockImplementation(() => Promise.resolve(getMockLeaseProcess()));

expect(pool.getSize()).toBe(0);
await pool.acquire();
expect(pool.getSize()).toBe(1);
expect(pool.getBorrowed()).toBe(1);
expect(pool.getAvailable()).toBe(0);
expect(pool.getBorrowedSize()).toBe(1);
expect(pool.getAvailableSize()).toBe(0);
});
it("waits for a lease to become available when the pool is full", async () => {
when(agreementApi.getAgreement(_)).thenResolve({ getState: () => "Approved" } as Agreement);
const pool = getLeasePool({ min: 3, max: 3 });
const lease1 = getMockLeaseProcess();
const lease2 = getMockLeaseProcess();
Expand All @@ -157,61 +154,60 @@ describe("LeaseProcessPool", () => {
await pool.acquire();
await pool.acquire();

expect(pool.getAvailable()).toBe(0);
expect(pool.getBorrowed()).toBe(3);
expect(pool.getAvailableSize()).toBe(0);
expect(pool.getBorrowedSize()).toBe(3);
const acquiredLeasePromise = pool.acquire();
// go to the next tick
await Promise.resolve();
expect(pool["acquireQueue"].length).toBe(1);
pool.release(acquiredLease1);
await acquiredLeasePromise;
expect(pool.getAvailable()).toBe(0);
expect(pool.getBorrowed()).toBe(3);
expect(pool.getAvailableSize()).toBe(0);
expect(pool.getBorrowedSize()).toBe(3);
expect(pool["acquireQueue"].length).toBe(0);
});
it("validates the lease process before returning it", async () => {
const pool = getLeasePool({ min: 3 });
const newlyCreatedLease = getMockLeaseProcess();
jest.spyOn(pool, "destroy");
when(agreementApi.getAgreement(_))
.thenResolve({
getState: () => "Expired",
} as Agreement)
.thenResolve({ getState: () => "Approved" } as Agreement);
// @ts-expect-error private method
jest.spyOn(pool, "createNewLeaseProcess").mockResolvedValue(newlyCreatedLease);

const lease1 = getMockLeaseProcess();
lease1.fetchAgreementState = jest.fn().mockResolvedValue("Expired");
const lease2 = getMockLeaseProcess();
lease2.fetchAgreementState = jest.fn().mockResolvedValue("Expired");
pool["lowPriority"].add(lease1);
pool["lowPriority"].add(lease2);

expect(pool.getBorrowed()).toBe(0);
expect(pool.getAvailable()).toBe(2);
expect(pool.getBorrowedSize()).toBe(0);
expect(pool.getAvailableSize()).toBe(2);
const leaseProcess = await pool.acquire();
expect(pool.getBorrowed()).toBe(1);
expect(pool.getAvailable()).toBe(0);
expect(leaseProcess).toBe(lease2);
expect(pool.getBorrowedSize()).toBe(1);
expect(pool.getAvailableSize()).toBe(0);
expect(leaseProcess).toBe(newlyCreatedLease);
expect(pool["destroy"]).toHaveBeenCalledWith(lease1);
expect(pool["destroy"]).toHaveBeenCalledWith(lease2);
});
});
describe("release()", () => {
it("releases a lease process back to the pool", async () => {
when(agreementApi.getAgreement(_)).thenResolve({ getState: () => "Approved" } as Agreement);
const pool = getLeasePool({ min: 3 });
const lease1 = getMockLeaseProcess();
const lease2 = getMockLeaseProcess();
pool["lowPriority"].add(lease1);
pool["lowPriority"].add(lease2);

const leaseProcess = await pool.acquire();
expect(pool.getBorrowed()).toBe(1);
expect(pool.getAvailable()).toBe(1);
expect(pool.getBorrowedSize()).toBe(1);
expect(pool.getAvailableSize()).toBe(1);
await pool.release(leaseProcess);
expect(pool.getBorrowed()).toBe(0);
expect(pool.getAvailable()).toBe(2);
expect(pool.getBorrowedSize()).toBe(0);
expect(pool.getAvailableSize()).toBe(2);
expect(pool["lowPriority"].has(lease1)).toBe(true);
expect(pool["lowPriority"].has(lease2)).toBe(true);
});
it("releases a lease process back to the high priority pool if it has an activity", async () => {
when(agreementApi.getAgreement(_)).thenResolve({ getState: () => "Approved" } as Agreement);
const pool = getLeasePool({ min: 3 });
const lease1 = getMockLeaseProcess();
const lease2 = getMockLeaseProcess();
Expand All @@ -221,17 +217,16 @@ describe("LeaseProcessPool", () => {
pool["lowPriority"].add(lease3);

const leaseProcess = await pool.acquire();
expect(pool.getBorrowed()).toBe(1);
expect(pool.getAvailable()).toBe(2);
expect(pool.getBorrowedSize()).toBe(1);
expect(pool.getAvailableSize()).toBe(2);
leaseProcess.hasActivity = () => true;
await pool.release(leaseProcess);
expect(pool.getBorrowed()).toBe(0);
expect(pool.getAvailable()).toBe(3);
expect(pool.getBorrowedSize()).toBe(0);
expect(pool.getAvailableSize()).toBe(3);
expect(pool["highPriority"].size).toBe(1);
expect(pool["lowPriority"].size).toBe(2);
});
it("destroys the lease process if the pool is full", async () => {
when(agreementApi.getAgreement(_)).thenResolve({ getState: () => "Approved" } as Agreement);
const pool = getLeasePool({ max: 2 });
jest.spyOn(pool, "destroy");
const lease1 = getMockLeaseProcess();
Expand All @@ -242,56 +237,53 @@ describe("LeaseProcessPool", () => {
pool["lowPriority"].add(lease2);

const acquiredLease1 = await pool.acquire();
expect(pool.getBorrowed()).toBe(1);
expect(pool.getAvailable()).toBe(1);
expect(pool.getBorrowedSize()).toBe(1);
expect(pool.getAvailableSize()).toBe(1);

pool["lowPriority"].add(lease3);

await pool.release(acquiredLease1);
expect(pool.getBorrowed()).toBe(0);
expect(pool.getAvailable()).toBe(2);
expect(pool.getBorrowedSize()).toBe(0);
expect(pool.getAvailableSize()).toBe(2);
expect(pool["lowPriority"].has(lease2)).toBe(true);
expect(pool["lowPriority"].has(lease3)).toBe(true);
expect(pool["destroy"]).toHaveBeenCalledWith(lease1);
});
it("destroys the lease process if it is invalid", async () => {
when(agreementApi.getAgreement(_))
.thenResolve({ getState: () => "Approved" } as Agreement)
.thenResolve({ getState: () => "Expired" } as Agreement);
const pool = getLeasePool({ max: 1 });
jest.spyOn(pool, "destroy");
const lease1 = getMockLeaseProcess();

pool["lowPriority"].add(lease1);

const acquiredLease1 = await pool.acquire();
expect(pool.getBorrowed()).toBe(1);
expect(pool.getAvailable()).toBe(0);
expect(pool.getBorrowedSize()).toBe(1);
expect(pool.getAvailableSize()).toBe(0);

acquiredLease1.fetchAgreementState = jest.fn().mockResolvedValue("Expired");

await pool.release(acquiredLease1);
expect(pool.getBorrowed()).toBe(0);
expect(pool.getAvailable()).toBe(0);
expect(pool.getBorrowedSize()).toBe(0);
expect(pool.getAvailableSize()).toBe(0);
expect(pool["destroy"]).toHaveBeenCalledWith(lease1);
});
});
describe("destroy()", () => {
it("removes the lease process from the pool", async () => {
when(agreementApi.getAgreement(_)).thenResolve({ getState: () => "Approved" } as Agreement);
const pool = getLeasePool({ max: 1 });
const lease1 = getMockLeaseProcess();
pool["lowPriority"].add(lease1);

const leaseProcess = await pool.acquire();
expect(pool.getBorrowed()).toBe(1);
expect(pool.getAvailable()).toBe(0);
expect(pool.getBorrowedSize()).toBe(1);
expect(pool.getAvailableSize()).toBe(0);
pool.destroy(leaseProcess);
expect(pool.getBorrowed()).toBe(0);
expect(pool.getAvailable()).toBe(0);
expect(pool.getBorrowedSize()).toBe(0);
expect(pool.getAvailableSize()).toBe(0);
});
});
describe("drainAndClear", () => {
it("destroys all lease processes in the pool", async () => {
when(agreementApi.getAgreement(_)).thenResolve({ getState: () => "Approved" } as Agreement);
const pool = getLeasePool({ max: 3 });
jest.spyOn(pool, "destroy");
const lease1 = getMockLeaseProcess();
Expand All @@ -303,17 +295,16 @@ describe("LeaseProcessPool", () => {

await pool.acquire();
await pool.acquire();
expect(pool.getBorrowed()).toBe(2);
expect(pool.getAvailable()).toBe(1);
expect(pool.getBorrowedSize()).toBe(2);
expect(pool.getAvailableSize()).toBe(1);
await pool.drainAndClear();
expect(pool.getBorrowed()).toBe(0);
expect(pool.getAvailable()).toBe(0);
expect(pool.getBorrowedSize()).toBe(0);
expect(pool.getAvailableSize()).toBe(0);
expect(pool["destroy"]).toHaveBeenCalledWith(lease1);
expect(pool["destroy"]).toHaveBeenCalledWith(lease2);
expect(pool["destroy"]).toHaveBeenCalledWith(lease3);
});
it("prevents new leases from being acquired during the drain", async () => {
when(agreementApi.getAgreement(_)).thenResolve({ getState: () => "Approved" } as Agreement);
const pool = getLeasePool({ max: 3 });
const realDestroy = pool.destroy;
jest.spyOn(pool, "destroy").mockImplementation(async (...args) => {
Expand All @@ -329,13 +320,13 @@ describe("LeaseProcessPool", () => {

await pool.acquire();
await pool.acquire();
expect(pool.getBorrowed()).toBe(2);
expect(pool.getAvailable()).toBe(1);
expect(pool.getBorrowedSize()).toBe(2);
expect(pool.getAvailableSize()).toBe(1);
const drainPromise = pool.drainAndClear();
expect(pool.acquire()).rejects.toThrow("The pool is in draining mode");
await drainPromise;
expect(pool.getBorrowed()).toBe(0);
expect(pool.getAvailable()).toBe(0);
expect(pool.getBorrowedSize()).toBe(0);
expect(pool.getAvailableSize()).toBe(0);
expect(pool["destroy"]).toHaveBeenCalledWith(lease1);
expect(pool["destroy"]).toHaveBeenCalledWith(lease2);
expect(pool["destroy"]).toHaveBeenCalledWith(lease3);
Expand Down
Loading

0 comments on commit ad7c3bd

Please sign in to comment.