828 streamline network call for toggle defence (#884)

ScottLogic · Apr 8, 2024 · c2923fb · c2923fb
1 parent b1cb014
commit c2923fb
Show file tree

Hide file tree

Showing 5 changed files with 84 additions and 23 deletions.
diff --git a/backend/src/controller/defenceController.ts b/backend/src/controller/defenceController.ts
@@ -59,7 +59,21 @@ function handleDefenceActivation(req: DefenceActivateRequest, res: Response) {
 		defenceId,
 		currentDefences
 	);
-	res.status(200).send();
+
+	const displayedDefenceId = defenceId.replace(/_/g, ' ').toLowerCase();
+	const chatInfoMessage = {
+		infoMessage: `${displayedDefenceId} defence activated`,
+		chatMessageType: 'GENERIC_INFO',
+	} as ChatInfoMessage;
+
+	req.session.levelState[level].chatHistory = pushMessageToHistory(
+		req.session.levelState[level].chatHistory,
+		chatInfoMessage
+	);
+
+	res.send({
+		chatInfoMessage,
+	});
 }
 
 function handleDefenceDeactivation(req: DefenceActivateRequest, res: Response) {
@@ -96,7 +110,21 @@ function handleDefenceDeactivation(req: DefenceActivateRequest, res: Response) {
 		defenceId,
 		currentDefences
 	);
-	res.status(200).send();
+
+	const displayedDefenceId = defenceId.replace(/_/g, ' ').toLowerCase();
+	const chatInfoMessage = {
+		infoMessage: `${displayedDefenceId} defence deactivated`,
+		chatMessageType: 'GENERIC_INFO',
+	} as ChatInfoMessage;
+
+	req.session.levelState[level].chatHistory = pushMessageToHistory(
+		req.session.levelState[level].chatHistory,
+		chatInfoMessage
+	);
+
+	res.send({
+		chatInfoMessage,
+	});
 }
 
 function handleConfigureDefence(req: DefenceConfigureRequest, res: Response) {

diff --git a/backend/test/integration/defenceController.test.ts b/backend/test/integration/defenceController.test.ts
@@ -76,9 +76,10 @@ describe('The correct levels can have their defences changed', () => {
 						: levelState
 				);
 
-				expect(res.status).toHaveBeenCalledWith(200);
 				expect(res.send).toHaveBeenCalled();
-				expect(req.session.levelState).toEqual(newLevelState);
+				expect(req.session.levelState[level].defences).toEqual(
+					newLevelState[level].defences
+				);
 			}
 		);
 	});
@@ -139,9 +140,10 @@ describe('The correct levels can have their defences changed', () => {
 
 				handleDefenceDeactivation(req, res);
 
-				expect(res.status).toHaveBeenCalledWith(200);
 				expect(res.send).toHaveBeenCalled();
-				expect(req.session.levelState).toEqual(getInitialLevelStates());
+				expect(req.session.levelState[level].defences).toEqual(
+					getInitialLevelStates()[level].defences
+				);
 			}
 		);
 	});

diff --git a/backend/test/unit/controller/defenceController.test.ts b/backend/test/unit/controller/defenceController.test.ts
@@ -35,7 +35,7 @@ function responseMock() {
 }
 
 describe('handleDefenceActivation', () => {
-	test('WHEN passed sensible parameters THEN activates defence', () => {
+	test('WHEN passed sensible parameters THEN activates defence AND adds info message to history AND returns info message', () => {
 		const mockActivateDefence = activateDefence as jest.MockedFunction<
 			typeof activateDefence
 		>;
@@ -59,10 +59,12 @@ describe('handleDefenceActivation', () => {
 								config: [],
 							},
 						] as Defence[],
+						chatHistory: [] as ChatMessage[],
 					},
 				],
 			},
 		} as DefenceActivateRequest;
+		const res = responseMock();
 
 		const configuredDefences: Defence[] = [
 			{
@@ -73,7 +75,7 @@ describe('handleDefenceActivation', () => {
 		];
 		mockActivateDefence.mockReturnValueOnce(configuredDefences);
 
-		handleDefenceActivation(req, responseMock());
+		handleDefenceActivation(req, res);
 
 		expect(mockActivateDefence).toHaveBeenCalledTimes(1);
 		expect(mockActivateDefence).toHaveBeenCalledWith(
@@ -89,6 +91,17 @@ describe('handleDefenceActivation', () => {
 		expect(req.session.levelState[LEVEL_NAMES.SANDBOX].defences).toEqual(
 			configuredDefences
 		);
+
+		const expectedChatInfoMessage = {
+			infoMessage: 'prompt evaluation llm defence activated',
+			chatMessageType: 'GENERIC_INFO',
+		} as ChatInfoMessage;
+		expect(
+			req.session.levelState[LEVEL_NAMES.SANDBOX].chatHistory.at(-1)
+		).toEqual(expectedChatInfoMessage);
+		expect(res.send).toHaveBeenCalledWith({
+			chatInfoMessage: expectedChatInfoMessage,
+		});
 	});
 
 	test('WHEN missing defenceId THEN does not activate defence', () => {
@@ -200,7 +213,7 @@ describe('handleDefenceActivation', () => {
 });
 
 describe('handleDefenceDeactivation', () => {
-	test('WHEN passed sensible parameters THEN deactivates defence', () => {
+	test('WHEN passed sensible parameters THEN deactivates defence AND adds info message to history AND returns info message', () => {
 		const mockDeactivateDefence = deactivateDefence as jest.MockedFunction<
 			typeof deactivateDefence
 		>;
@@ -224,10 +237,12 @@ describe('handleDefenceDeactivation', () => {
 								config: [],
 							},
 						] as Defence[],
+						chatHistory: [] as ChatMessage[],
 					},
 				],
 			},
 		} as DefenceActivateRequest;
+		const res = responseMock();
 
 		const configuredDefences: Defence[] = [
 			{
@@ -238,7 +253,7 @@ describe('handleDefenceDeactivation', () => {
 		];
 		mockDeactivateDefence.mockReturnValueOnce(configuredDefences);
 
-		handleDefenceDeactivation(req, responseMock());
+		handleDefenceDeactivation(req, res);
 
 		expect(mockDeactivateDefence).toHaveBeenCalledTimes(1);
 		expect(mockDeactivateDefence).toHaveBeenCalledWith(
@@ -254,6 +269,17 @@ describe('handleDefenceDeactivation', () => {
 		expect(req.session.levelState[LEVEL_NAMES.SANDBOX].defences).toEqual(
 			configuredDefences
 		);
+
+		const expectedChatInfoMessage = {
+			infoMessage: 'prompt evaluation llm defence deactivated',
+			chatMessageType: 'GENERIC_INFO',
+		} as ChatInfoMessage;
+		expect(
+			req.session.levelState[LEVEL_NAMES.SANDBOX].chatHistory.at(-1)
+		).toEqual(expectedChatInfoMessage);
+		expect(res.send).toHaveBeenCalledWith({
+			chatInfoMessage: expectedChatInfoMessage,
+		});
 	});
 
 	test('WHEN missing defenceId THEN does not deactivate defence', () => {

diff --git a/frontend/src/components/MainComponent/MainComponent.tsx b/frontend/src/components/MainComponent/MainComponent.tsx
@@ -232,23 +232,23 @@ function MainComponent({
 	}
 
 	async function setDefenceToggle(defence: Defence) {
-		await defenceService.toggleDefence(
+		const chatInfoMessage = await defenceService.toggleDefence(
 			defence.id,
 			defence.isActive,
 			currentLevel
 		);
 
-		const newDefenceDetails = defences.map((defenceDetail) => {
-			if (defenceDetail.id === defence.id) {
-				defenceDetail.isActive = !defence.isActive;
-				const action = defenceDetail.isActive ? 'activated' : 'deactivated';
-				const infoMessage = `${defence.name} defence ${action}`;
-				addInfoMessage(infoMessage.toLowerCase());
-			}
-			return defenceDetail;
-		});
+		if (chatInfoMessage) {
+			addChatMessage(chatInfoMessage);
+			const newDefenceDetails = defences.map((defenceDetail) => {
+				if (defenceDetail.id === defence.id) {
+					defenceDetail.isActive = !defence.isActive;
+				}
+				return defenceDetail;
+			});
 
-		setDefences(newDefenceDetails);
+			setDefences(newDefenceDetails);
+		}
 	}
 
 	async function setDefenceConfiguration(

diff --git a/frontend/src/service/defenceService.ts b/frontend/src/service/defenceService.ts
@@ -41,7 +41,7 @@ async function toggleDefence(
 	defenceId: DEFENCE_ID,
 	isActive: boolean,
 	level: LEVEL_NAMES
-): Promise<boolean> {
+): Promise<ChatMessage | null> {
 	const requestPath = isActive ? 'deactivate' : 'activate';
 	const response = await sendRequest(`${PATH}${requestPath}`, {
 		method: 'POST',
@@ -50,7 +50,12 @@ async function toggleDefence(
 		},
 		body: JSON.stringify({ defenceId, level }),
 	});
-	return response.status === 200;
+	if (response.status !== 200) return null;
+
+	const { chatInfoMessage } =
+		(await response.json()) as ChatInfoMessageResponse;
+
+	return makeChatMessageFromDTO(chatInfoMessage);
 }
 
 async function configureDefence(