824 streamline frontend change level network calls

backend/src/controller/chatController.ts

@@ -8,7 +8,6 @@ import {
 import { OpenAiAddInfoToChatHistoryRequest } from '@src/models/api/OpenAiAddInfoToChatHistoryRequest';
 import { OpenAiChatRequest } from '@src/models/api/OpenAiChatRequest';
 import { OpenAiClearRequest } from '@src/models/api/OpenAiClearRequest';
-import { OpenAiGetHistoryRequest } from '@src/models/api/OpenAiGetHistoryRequest';
 import {
 	DefenceReport,
 	ChatHttpResponse,
@@ -359,16 +358,6 @@ function addErrorToChatHistory(
 	});
 }
 
-function handleGetChatHistory(req: OpenAiGetHistoryRequest, res: Response) {
-	const level: number | undefined = req.query.level as number | undefined;
-	if (level !== undefined) {
-		res.send(req.session.levelState[level].chatHistory);
-	} else {
-		res.status(400);
-		res.send('Missing level');
-	}
-}
-
 function handleAddInfoToChatHistory(
 	req: OpenAiAddInfoToChatHistoryRequest,
 	res: Response
@@ -407,9 +396,4 @@ function handleClearChatHistory(req: OpenAiClearRequest, res: Response) {
 	}
 }
 
-export {
-	handleChatToGPT,
-	handleGetChatHistory,
-	handleAddInfoToChatHistory as handleAddInfoToChatHistory,
-	handleClearChatHistory,
-};
+export { handleChatToGPT, handleAddInfoToChatHistory, handleClearChatHistory };

backend/src/controller/defenceController.ts

@@ -9,7 +9,6 @@ import {
 import { DefenceActivateRequest } from '@src/models/api/DefenceActivateRequest';
 import { DefenceConfigResetRequest } from '@src/models/api/DefenceConfigResetRequest';
 import { DefenceConfigureRequest } from '@src/models/api/DefenceConfigureRequest';
-import { DefenceStatusRequest } from '@src/models/api/DefenceStatusRequest';
 import { DefenceConfigItem } from '@src/models/defence';
 import { LEVEL_NAMES } from '@src/models/level';
 
@@ -112,20 +111,9 @@ function handleResetSingleDefence(
 	}
 }
 
-function handleGetDefenceStatus(req: DefenceStatusRequest, res: Response) {
-	const level: number | undefined = req.query.level as number | undefined;
-	if (level !== undefined) {
-		res.send(req.session.levelState[level].defences);
-	} else {
-		res.status(400);
-		res.send('Missing level');
-	}
-}
-
 export {
 	handleDefenceActivation,
 	handleDefenceDeactivation,
 	handleConfigureDefence,
 	handleResetSingleDefence,
-	handleGetDefenceStatus,
 };

backend/src/controller/emailController.ts

@@ -1,19 +1,8 @@
 import { Response } from 'express';
 
 import { EmailClearRequest } from '@src/models/api/EmailClearRequest';
-import { EmailGetRequest } from '@src/models/api/EmailGetRequest';
 import { LEVEL_NAMES } from '@src/models/level';
 
-function handleGetEmails(req: EmailGetRequest, res: Response) {
-	const level: number | undefined = req.query.level as number | undefined;
-	if (level !== undefined) {
-		res.send(req.session.levelState[level].sentEmails);
-	} else {
-		res.status(400);
-		res.send('Missing level');
-	}
-}
-
 function handleClearEmails(req: EmailClearRequest, res: Response) {
 	const level = req.body.level;
 	if (level !== undefined && level >= LEVEL_NAMES.LEVEL_1) {
@@ -26,4 +15,4 @@ function handleClearEmails(req: EmailClearRequest, res: Response) {
 	}
 }
 
-export { handleGetEmails, handleClearEmails };
+export { handleClearEmails };

backend/src/controller/levelController.ts

@@ -0,0 +1,15 @@
+import { Response } from 'express';
+
+import { LevelGetRequest } from '@src/models/api/LevelGetRequest';
+
+function handleLoadLevel(req: LevelGetRequest, res: Response) {
+	const { level } = req.query;
+
+	res.send({
+		emails: req.session.levelState[level].sentEmails,
+		chatHistory: req.session.levelState[level].chatHistory,
+		defences: req.session.levelState[level].defences,
+	});
+}
+
+export { handleLoadLevel };

backend/src/controller/startController.ts

@@ -1,6 +1,6 @@
 import { Response } from 'express';
 
-import { GetStartRequest } from '@src/models/api/getStartRequest';
+import { StartGetRequest } from '@src/models/api/StartGetRequest';
 import { LEVEL_NAMES } from '@src/models/level';
 import { getValidOpenAIModels } from '@src/openai';
 import {
@@ -9,7 +9,7 @@ import {
 	systemRoleLevel3,
 } from '@src/promptTemplates';
 
-function handleStart(req: GetStartRequest, res: Response) {
+function handleStart(req: StartGetRequest, res: Response) {
 	const { level } = req.query;
 
 	const systemRoles = [

backend/src/models/api/LevelGetRequest.ts

@@ -0,0 +1,19 @@
+import { Request } from 'express';
+
+import { ChatMessage } from '@src/models/chatMessage';
+import { Defence } from '@src/models/defence';
+import { EmailInfo } from '@src/models/email';
+import { LEVEL_NAMES } from '@src/models/level';
+
+export type LevelGetRequest = Request<
+	never,
+	{
+		emails: EmailInfo[];
+		chatHistory: ChatMessage[];
+		defences: Defence[];
+	},
+	never,
+	{
+		level: LEVEL_NAMES;
+	}
+>;

backend/src/models/api/getStartRequest.ts → backend/src/models/api/StartGetRequest.ts

@@ -5,7 +5,7 @@ import { Defence } from '@src/models/defence';
 import { EmailInfo } from '@src/models/email';
 import { LEVEL_NAMES } from '@src/models/level';
 
-export type GetStartRequest = Request<
+export type StartGetRequest = Request<
 	never,
 	{
 		emails: EmailInfo[];

backend/src/sessionRoutes.ts

@@ -5,21 +5,17 @@ import memoryStoreFactory from 'memorystore';
 
 import {
 	handleChatToGPT,
-	handleGetChatHistory,
 	handleAddInfoToChatHistory,
 	handleClearChatHistory,
 } from './controller/chatController';
 import {
 	handleConfigureDefence,
 	handleDefenceActivation,
 	handleDefenceDeactivation,
-	handleGetDefenceStatus,
 	handleResetSingleDefence,
 } from './controller/defenceController';
-import {
-	handleClearEmails,
-	handleGetEmails,
-} from './controller/emailController';
+import { handleClearEmails } from './controller/emailController';
+import { handleLoadLevel } from './controller/levelController';
 import {
 	handleConfigureModel,
 	handleGetModel,
@@ -97,19 +93,18 @@ router.use((req, _res, next) => {
 // handshake
 router.get('/start', handleStart);
 
+router.get('/level', handleLoadLevel);
+
 // defences
-router.get('/defence/status', handleGetDefenceStatus);
 router.post('/defence/activate', handleDefenceActivation);
 router.post('/defence/deactivate', handleDefenceDeactivation);
 router.post('/defence/configure', handleConfigureDefence);
 router.post('/defence/resetConfig', handleResetSingleDefence);
 
 // emails
-router.get('/email/get', handleGetEmails);
 router.post('/email/clear', handleClearEmails);
 
 // chat
-router.get('/openai/history', handleGetChatHistory);
 router.post('/openai/chat', handleChatToGPT);
 router.post('/openai/addInfoToHistory', handleAddInfoToChatHistory);
 router.post('/openai/clear', handleClearChatHistory);

backend/test/unit/controller/chatController.test.ts

@@ -5,13 +5,11 @@ import {
 	handleAddInfoToChatHistory,
 	handleChatToGPT,
 	handleClearChatHistory,
-	handleGetChatHistory,
 } from '@src/controller/chatController';
 import { detectTriggeredInputDefences, transformMessage } from '@src/defence';
 import { OpenAiAddInfoToChatHistoryRequest } from '@src/models/api/OpenAiAddInfoToChatHistoryRequest';
 import { OpenAiChatRequest } from '@src/models/api/OpenAiChatRequest';
 import { OpenAiClearRequest } from '@src/models/api/OpenAiClearRequest';
-import { OpenAiGetHistoryRequest } from '@src/models/api/OpenAiGetHistoryRequest';
 import {
 	DefenceReport,
 	ChatModel,
@@ -741,55 +739,6 @@ describe('handleChatToGPT unit tests', () => {
 	});
 });
 
-describe('handleGetChatHistory', () => {
-	function getRequestMock(level?: LEVEL_NAMES, chatHistory?: ChatMessage[]) {
-		return {
-			query: {
-				level: level ?? undefined,
-			},
-			session: {
-				levelState: [
-					{
-						chatHistory: chatHistory ?? [],
-					},
-				],
-			},
-		} as OpenAiGetHistoryRequest;
-	}
-
-	const chatHistory: ChatMessage[] = [
-		{
-			completion: { role: 'system', content: 'You are a helpful chatbot' },
-			chatMessageType: 'SYSTEM',
-		},
-		{
-			completion: { role: 'assistant', content: 'Hello human' },
-			chatMessageType: 'BOT',
-		},
-		{
-			completion: { role: 'user', content: 'How are you?' },
-			chatMessageType: 'USER',
-		},
-	];
-	test('GIVEN a valid level WHEN handleGetChatHistory called THEN return chat history', () => {
-		const req = getRequestMock(LEVEL_NAMES.LEVEL_1, chatHistory);
-		const res = responseMock();
-
-		handleGetChatHistory(req, res);
-		expect(res.send).toHaveBeenCalledWith(chatHistory);
-	});
-
-	test('GIVEN undefined level WHEN handleGetChatHistory called THEN return 400', () => {
-		const req = getRequestMock();
-		const res = responseMock();
-
-		handleGetChatHistory(req, res);
-
-		expect(res.status).toHaveBeenCalledWith(400);
-		expect(res.send).toHaveBeenCalledWith('Missing level');
-	});
-});
-
 describe('handleAddInfoToChatHistory', () => {
 	function getAddInfoToChatHistoryRequestMock(
 		infoMessage: string,

backend/test/unit/controller/emailController.test.ts

@@ -1,12 +1,8 @@
 import { expect, test, jest, describe } from '@jest/globals';
 import { Response } from 'express';
 
-import {
-	handleClearEmails,
-	handleGetEmails,
-} from '@src/controller/emailController';
+import { handleClearEmails } from '@src/controller/emailController';
 import { EmailClearRequest } from '@src/models/api/EmailClearRequest';
-import { EmailGetRequest } from '@src/models/api/EmailGetRequest';
 import { ChatModel } from '@src/models/chat';
 import { ChatMessage } from '@src/models/chatMessage';
 import { Defence } from '@src/models/defence';
@@ -47,41 +43,6 @@ const emails: EmailInfo[] = [
 	},
 ];
 
-describe('handleGetEmails', () => {
-	test('GIVEN valid level WHEN handleGetEmails called THEN returns sent emails', () => {
-		const req = {
-			query: {
-				level: 0,
-			},
-			session: {
-				levelState: [
-					{
-						sentEmails: emails,
-					},
-				],
-			},
-		} as EmailGetRequest;
-
-		const res = responseMock();
-
-		handleGetEmails(req, res);
-
-		expect(res.send).toHaveBeenCalledWith(emails);
-	});
-
-	test('GIVEN missing level WHEN handleGetEmails called THEN returns 400 ', () => {
-		const req = {
-			query: {},
-		} as EmailGetRequest;
-
-		const res = responseMock();
-		handleGetEmails(req, res);
-
-		expect(res.status).toHaveBeenCalledWith(400);
-		expect(res.send).toHaveBeenCalledWith('Missing level');
-	});
-});
-
 describe('handleClearEmails', () => {
 	test('GIVEN valid level WHEN handleClearEmails called THEN sets emails to empty', () => {
 		const req = {

frontend/src/App.tsx

@@ -7,7 +7,7 @@ import MissionInformation from './components/Overlay/MissionInformation';
 import OverlayWelcome from './components/Overlay/OverlayWelcome';
 import ResetProgressOverlay from './components/Overlay/ResetProgress';
 import { LEVEL_NAMES } from './models/level';
-import { levelService } from './service';
+import { resetService } from './service';
 
 import './App.css';
 import './Theme.css';
@@ -205,7 +205,7 @@ function App() {
 		console.log('resetting progress for all levels');
 
 		// reset on the backend
-		await levelService.resetAllLevelProgress();
+		await resetService.resetAllLevelProgress();
 
 		localStorage.setItem('numCompletedLevels', '0');
 		setNumCompletedLevels(0);