Updated insurance tests

Added logging of items attachments that are being removed
Only add items with a price to weight dictionary
This commit is contained in:
Dev 2024-05-06 19:33:44 +01:00
parent 77a5b0a4b4
commit fa76578880
2 changed files with 57 additions and 210 deletions

View File

@ -474,9 +474,29 @@ export class InsuranceController
toDelete.add(attachmentId); toDelete.add(attachmentId);
} }
this.logAttachmentsBeingRemoved(attachmentIdsToRemove, attachments, weightedAttachmentByPrice);
this.logger.debug(`Number of attachments to be deleted: ${attachmentIdsToRemove.length}`); this.logger.debug(`Number of attachments to be deleted: ${attachmentIdsToRemove.length}`);
} }
protected logAttachmentsBeingRemoved(
attachmentIdsToRemove: string[],
attachments: Item[],
attachmentPrices: Record<string, number>,
): void
{
let index = 1;
for (const attachmentId of attachmentIdsToRemove)
{
this.logger.debug(
`Attachment ${index} Id: ${attachmentId} Tpl: ${
attachments.find((x) => x._id === attachmentId)?._tpl
} - Price: ${attachmentPrices[attachmentId]}`,
);
index++;
}
}
protected weightAttachmentsByPrice(attachments: Item[]): Record<string, number> protected weightAttachmentsByPrice(attachments: Item[]): Record<string, number>
{ {
const result: Record<string, number> = {}; const result: Record<string, number> = {};
@ -485,7 +505,10 @@ export class InsuranceController
for (const attachment of attachments) for (const attachment of attachments)
{ {
const price = this.ragfairPriceService.getDynamicItemPrice(attachment._tpl, this.roubleTpl); const price = this.ragfairPriceService.getDynamicItemPrice(attachment._tpl, this.roubleTpl);
result[attachment._id] = Math.round(price); if (price)
{
result[attachment._id] = Math.round(price);
}
} }
this.weightedRandomHelper.reduceWeightValues(result); this.weightedRandomHelper.reduceWeightValues(result);

View File

@ -928,7 +928,7 @@ describe("InsuranceController", () =>
describe("processAttachmentByParent", () => describe("processAttachmentByParent", () =>
{ {
it("should handle sorting, rolling, and deleting attachments by calling helper methods", () => it("should handle weighing and counting of attachments by calling helper methods", () =>
{ {
const insured = insuranceFixture[0]; const insured = insuranceFixture[0];
const itemsMap = insuranceController.itemHelper.generateItemsMap(insured.items); const itemsMap = insuranceController.itemHelper.generateItemsMap(insured.items);
@ -941,49 +941,24 @@ describe("InsuranceController", () =>
const toDelete = new Set<string>(); const toDelete = new Set<string>();
// Mock helper methods. // Mock helper methods.
const mockSortAttachmentsByPrice = vi.spyOn(insuranceController, "sortAttachmentsByPrice"); const weightAttachmentsByPrice = vi.spyOn(insuranceController, "weightAttachmentsByPrice");
const mockCountSuccessfulRolls = vi.spyOn(insuranceController, "countSuccessfulRolls").mockReturnValue(4); const getAttachmentCountToRemove = vi.spyOn(insuranceController, "getAttachmentCountToRemove")
const mockAttachmentDeletionByValue = vi.spyOn(insuranceController, "attachmentDeletionByValue"); .mockReturnValue(4);
const logAttachmentsBeingRemoved = vi.spyOn(insuranceController, "logAttachmentsBeingRemoved");
// Execute the method. // Execute the method.
insuranceController.processAttachmentByParent(attachments, insured.traderId, toDelete); insuranceController.processAttachmentByParent(attachments, insured.traderId, toDelete);
// Verify that helper methods are called. // Verify that helper methods are called.
expect(mockSortAttachmentsByPrice).toHaveBeenCalledWith(attachments); expect(weightAttachmentsByPrice).toHaveBeenCalledWith(attachments);
expect(mockCountSuccessfulRolls).toHaveBeenCalled(); expect(getAttachmentCountToRemove).toHaveBeenCalled();
expect(mockAttachmentDeletionByValue).toHaveBeenCalled(); expect(logAttachmentsBeingRemoved).toHaveBeenCalled();
});
it("should log attachment details and number of attachments to be deleted", () =>
{
const insured = insuranceFixture[0];
const itemsMap = insuranceController.itemHelper.generateItemsMap(insured.items);
const parentAttachmentsMap = insuranceController.populateParentAttachmentsMap(
insuranceController.hashUtil.generate(),
insured,
itemsMap,
);
const attachments = parentAttachmentsMap.entries().next().value;
const toDelete = new Set<string>();
const successfulRolls = 4;
// Mock helper methods.
const mockLogAttachmentsDetails = vi.spyOn(insuranceController, "logAttachmentsDetails");
vi.spyOn(insuranceController, "countSuccessfulRolls").mockReturnValue(successfulRolls);
const mockLoggerDebug = vi.spyOn(insuranceController.logger, "debug").mockImplementation(vi.fn());
// Execute the method.
insuranceController.processAttachmentByParent(attachments, insured.traderId, toDelete);
// Verify that the logs were called/written.
expect(mockLogAttachmentsDetails).toBeCalled();
expect(mockLoggerDebug).toHaveBeenCalledWith(`Number of attachments to be deleted: ${successfulRolls}`);
}); });
}); });
describe("sortAttachmentsByPrice", () => describe("getAttachmentCountToRemove", () =>
{ {
it("should sort the attachments array by dynamicPrice in descending order", () => it("should handle returning a count of attachments that should be removed that is below the total attachment count", () =>
{ {
const insured = insuranceFixture[0]; const insured = insuranceFixture[0];
const itemsMap = insuranceController.itemHelper.generateItemsMap(insured.items); const itemsMap = insuranceController.itemHelper.generateItemsMap(insured.items);
@ -995,20 +970,12 @@ describe("InsuranceController", () =>
const attachments = parentAttachmentsMap.entries().next().value; const attachments = parentAttachmentsMap.entries().next().value;
const attachmentCount = attachments.length; const attachmentCount = attachments.length;
// Execute the method. const result = insuranceController.getAttachmentCountToRemove(attachments, insured.traderId);
const sortedAttachments = insuranceController.sortAttachmentsByPrice(attachments);
// Verify the length of the sorted attachments array is unchanged expect(result).lessThanOrEqual(attachmentCount);
expect(sortedAttachments.length).toBe(attachmentCount);
// Verify that the attachments are sorted by dynamicPrice in descending order
for (let i = 1; i < sortedAttachments.length; i++)
{
expect(sortedAttachments[i - 1].dynamicPrice).toBeGreaterThanOrEqual(sortedAttachments[i].dynamicPrice);
}
}); });
it("should place attachments with null dynamicPrice at the bottom of the sorted list", () => it("should handle returning 0 when chanceNoAttachmentsTakenPercent is 100%", () =>
{ {
const insured = insuranceFixture[0]; const insured = insuranceFixture[0];
const itemsMap = insuranceController.itemHelper.generateItemsMap(insured.items); const itemsMap = insuranceController.itemHelper.generateItemsMap(insured.items);
@ -1018,133 +985,36 @@ describe("InsuranceController", () =>
itemsMap, itemsMap,
); );
const attachments = parentAttachmentsMap.entries().next().value; const attachments = parentAttachmentsMap.entries().next().value;
insuranceController.insuranceConfig.chanceNoAttachmentsTakenPercent = 100;
// Set the dynamicPrice of the first attachment to null. const result = insuranceController.getAttachmentCountToRemove(attachments, insured.traderId);
vi.spyOn(insuranceController.ragfairPriceService, "getDynamicItemPrice").mockReturnValue(666)
.mockReturnValueOnce(null);
// Execute the method.
const sortedAttachments = insuranceController.sortAttachmentsByPrice(attachments);
// Verify that the attachments with null dynamicPrice are at the bottom of the list
const nullPriceAttachments = sortedAttachments.slice(-1);
for (const attachment of nullPriceAttachments)
{
expect(attachment.dynamicPrice).toBeNull();
}
// Verify that the rest of the attachments are sorted by dynamicPrice in descending order
for (let i = 1; i < sortedAttachments.length - 2; i++)
{
expect(sortedAttachments[i - 1].dynamicPrice).toBeGreaterThanOrEqual(sortedAttachments[i].dynamicPrice);
}
});
});
describe("logAttachmentsDetails", () =>
{
it("should log details for each attachment", () =>
{
const attachments = [{ _id: "item1", name: "Item 1", dynamicPrice: 100 }, {
_id: "item2",
name: "Item 2",
dynamicPrice: 200,
}];
// Mock the logger.debug function.
const loggerDebugSpy = vi.spyOn(insuranceController.logger, "debug");
// Execute the method.
insuranceController.logAttachmentsDetails(attachments);
// Verify that logger.debug was called correctly.
expect(loggerDebugSpy).toHaveBeenCalledTimes(2);
expect(loggerDebugSpy).toHaveBeenNthCalledWith(1, "Attachment 1: \"Item 1\" - Price: 100");
expect(loggerDebugSpy).toHaveBeenNthCalledWith(2, "Attachment 2: \"Item 2\" - Price: 200");
});
it("should not log anything when there are no attachments", () =>
{
const attachments = [];
// Mock the logger.debug function.
const loggerDebugSpy = vi.spyOn(insuranceController.logger, "debug");
// Execute the method.
insuranceController.logAttachmentsDetails(attachments);
// Verify that logger.debug was called correctly.
expect(loggerDebugSpy).not.toHaveBeenCalled();
});
});
describe("countSuccessfulRolls", () =>
{
it("should count the number of successful rolls made in the rollForDelete method", () =>
{
const insured = insuranceFixture[0];
const itemsMap = insuranceController.itemHelper.generateItemsMap(insured.items);
const parentAttachmentsMap = insuranceController.populateParentAttachmentsMap(
insuranceController.hashUtil.generate(),
insured,
itemsMap,
);
const attachments = parentAttachmentsMap.values().next().value;
// Mock rollForDelete to return true for the first two attachments.
const mockRollForDelete = vi.spyOn(insuranceController, "rollForDelete").mockReturnValue(false)
.mockReturnValueOnce(true).mockReturnValueOnce(true);
// Execute the method.
const result = insuranceController.countSuccessfulRolls(attachments, insured.traderId);
// Verify that two successful rolls were counted.
expect(mockRollForDelete).toHaveBeenCalledTimes(attachments.length);
expect(result).toBe(2);
});
it("should return zero if no successful rolls were made in the rollForDelete method", () =>
{
const insured = insuranceFixture[0];
const itemsMap = insuranceController.itemHelper.generateItemsMap(insured.items);
const parentAttachmentsMap = insuranceController.populateParentAttachmentsMap(
insuranceController.hashUtil.generate(),
insured,
itemsMap,
);
const attachments = parentAttachmentsMap.values().next().value;
// Mock rollForDelete to return false.
const mockRollForDelete = vi.spyOn(insuranceController, "rollForDelete").mockReturnValue(false);
// Execute the method.
const result = insuranceController.countSuccessfulRolls(attachments, insured.traderId);
// Verify that zero successful rolls were counted.
expect(mockRollForDelete).toHaveBeenCalledTimes(attachments.length);
expect(result).toBe(0); expect(result).toBe(0);
}); });
it("should return zero if there are no attachments", () => it("should handle returning 0 when all attachments are below configured threshold price", () =>
{ {
const insured = insuranceFixture[0]; const insured = insuranceFixture[0];
const attachments = []; const itemsMap = insuranceController.itemHelper.generateItemsMap(insured.items);
const parentAttachmentsMap = insuranceController.populateParentAttachmentsMap(
insuranceController.hashUtil.generate(),
insured,
itemsMap,
);
const attachments = parentAttachmentsMap.values().next().value;
insuranceController.insuranceConfig.minAttachmentRoublePriceToBeTaken = 2;
vi.spyOn(insuranceController.ragfairPriceService, "getDynamicItemPrice").mockReturnValue(1);
// Spy on rollForDelete to ensure it is not called. const weightedAttachments = insuranceController.weightAttachmentsByPrice(attachments);
const mockRollForDelete = vi.spyOn(insuranceController, "rollForDelete"); const result = insuranceController.getAttachmentCountToRemove(weightedAttachments, insured.traderId);
// Execute the method.
const result = insuranceController.countSuccessfulRolls(attachments, insured.traderId);
// Verify that zero successful rolls were returned.
expect(mockRollForDelete).not.toHaveBeenCalled();
expect(result).toBe(0); expect(result).toBe(0);
}); });
}); });
describe("attachmentDeletionByValue", () => describe("weightAttachmentsByPrice", () =>
{ {
it("should add the correct number of attachments to the toDelete set", () => it("Should create a dictionary of 2 items with weights of 1 for each", () =>
{ {
const insured = insuranceFixture[0]; const insured = insuranceFixture[0];
const itemsMap = insuranceController.itemHelper.generateItemsMap(insured.items); const itemsMap = insuranceController.itemHelper.generateItemsMap(insured.items);
@ -1155,57 +1025,11 @@ describe("InsuranceController", () =>
); );
const attachments = parentAttachmentsMap.values().next().value; const attachments = parentAttachmentsMap.values().next().value;
const successfulRolls = 2; vi.spyOn(insuranceController.ragfairPriceService, "getDynamicItemPrice").mockReturnValue(1);
const toDelete = new Set<string>();
// Execute the method. const result = insuranceController.weightAttachmentsByPrice(attachments);
insuranceController.attachmentDeletionByValue(attachments, successfulRolls, toDelete); expect(Object.keys(result).length).toBe(2);
expect(Object.values(result)).toStrictEqual([1, 1]);
// Should add the first two valuable attachments to the toDelete set.
expect(toDelete.size).toEqual(successfulRolls);
});
it("should not add any attachments to toDelete if successfulRolls is zero", () =>
{
const insured = insuranceFixture[0];
const itemsMap = insuranceController.itemHelper.generateItemsMap(insured.items);
const parentAttachmentsMap = insuranceController.populateParentAttachmentsMap(
insuranceController.hashUtil.generate(),
insured,
itemsMap,
);
const attachments = parentAttachmentsMap.values().next().value;
const successfulRolls = 0;
const toDelete = new Set<string>();
// Execute the method.
insuranceController.attachmentDeletionByValue(attachments, successfulRolls, toDelete);
// Should be empty.
expect(toDelete.size).toEqual(successfulRolls);
});
it("should add all attachments to toDelete if successfulRolls is greater than the number of attachments", () =>
{
const insured = insuranceFixture[0];
const itemsMap = insuranceController.itemHelper.generateItemsMap(insured.items);
const parentAttachmentsMap = insuranceController.populateParentAttachmentsMap(
insuranceController.hashUtil.generate(),
insured,
itemsMap,
);
const attachments = parentAttachmentsMap.values().next().value;
const successfulRolls = 999;
const toDelete = new Set<string>();
// Execute the method.
insuranceController.attachmentDeletionByValue(attachments, successfulRolls, toDelete);
// Should be empty.
expect(toDelete.size).toBeLessThan(successfulRolls);
expect(toDelete.size).toEqual(attachments.length);
}); });
}); });