824 streamline frontend change level network calls (#839)

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,26 @@
+import { Response } from 'express';
+
+import { LevelGetRequest } from '@src/models/api/LevelGetRequest';
+import { isValidLevel } from '@src/models/level';
+
+function handleLoadLevel(req: LevelGetRequest, res: Response) {
+	const { level } = req.query;
+
+	if (level === undefined) {
+		res.status(400).send('Level not provided');
+		return;
+	}
+
+	if (!isValidLevel(level)) {
+		res.status(400).send('Invalid level');
+		return;
+	}
+
+	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,17 +1,29 @@
 import { Response } from 'express';
 
-import { GetStartRequest } from '@src/models/api/getStartRequest';
-import { LEVEL_NAMES } from '@src/models/level';
+import { StartGetRequest } from '@src/models/api/StartGetRequest';
+import { LEVEL_NAMES, isValidLevel } from '@src/models/level';
 import { getValidOpenAIModels } from '@src/openai';
 import {
 	systemRoleLevel1,
 	systemRoleLevel2,
 	systemRoleLevel3,
 } from '@src/promptTemplates';
 
-function handleStart(req: GetStartRequest, res: Response) {
+import { sendErrorResponse } from './handleError';
+
+function handleStart(req: StartGetRequest, res: Response) {
 	const { level } = req.query;
 
+	if (level === undefined) {
+		sendErrorResponse(res, 400, 'Level not provided');
+		return;
+	}
+
+	if (!isValidLevel(level)) {
+		sendErrorResponse(res, 400, 'Invalid level');
+		return;
+	}
+
 	const systemRoles = [
 		{ level: LEVEL_NAMES.LEVEL_1, systemRole: systemRoleLevel1 },
 		{ level: LEVEL_NAMES.LEVEL_2, systemRole: systemRoleLevel2 },

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[];
@@ -16,6 +16,6 @@ export type GetStartRequest = Request<
 	},
 	never,
 	{
-		level: LEVEL_NAMES;
+		level?: LEVEL_NAMES;
 	}
 >;

backend/src/models/level.ts

@@ -13,6 +13,10 @@ const LEVEL_NAMES = {
 
 type LEVEL_NAMES = (typeof LEVEL_NAMES)[keyof typeof LEVEL_NAMES];
 
+function isValidLevel(levelValue: unknown) {
+	return Object.values(LEVEL_NAMES).includes(levelValue as LEVEL_NAMES);
+}
+
 interface LevelState {
 	level: LEVEL_NAMES;
 	chatHistory: ChatMessage[];
@@ -32,5 +36,5 @@ function getInitialLevelStates() {
 	);
 }
 
-export { getInitialLevelStates, LEVEL_NAMES };
+export { getInitialLevelStates, LEVEL_NAMES, isValidLevel };
 export type { LevelState };

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,
@@ -28,16 +24,8 @@ import {
 import { handleResetProgress } from './controller/resetController';
 import { handleStart } from './controller/startController';
 import { handleTest } from './controller/testController';
-import { ChatModel, defaultChatModel } from './models/chat';
-import { LevelState, getInitialLevelStates } from './models/level';
-
-declare module 'express-session' {
-	interface Session {
-		initialised: boolean;
-		chatModel: ChatModel;
-		levelState: LevelState[];
-	}
-}
+import { defaultChatModel } from './models/chat';
+import { getInitialLevelStates } from './models/level';
 
 const sessionSigningSecret = process.env.SESSION_SECRET;
 if (!sessionSigningSecret) {
@@ -97,19 +85,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/integration/chatController.test.ts

@@ -3,27 +3,12 @@ import { Response } from 'express';
 
 import { handleChatToGPT } from '@src/controller/chatController';
 import { OpenAiChatRequest } from '@src/models/api/OpenAiChatRequest';
-import { ChatModel } from '@src/models/chat';
 import { ChatMessage } from '@src/models/chatMessage';
 import { Defence } from '@src/models/defence';
 import { EmailInfo } from '@src/models/email';
 import { LEVEL_NAMES, LevelState } from '@src/models/level';
 import { systemRoleLevel1 } from '@src/promptTemplates';
 
-declare module 'express-session' {
-	interface Session {
-		initialised: boolean;
-		chatModel: ChatModel;
-		levelState: LevelState[];
-	}
-	interface LevelState {
-		level: LEVEL_NAMES;
-		chatHistory: ChatMessage[];
-		defences: Defence[];
-		sentEmails: EmailInfo[];
-	}
-}
-
 // mock the api call
 const mockCreateChatCompletion =
 	jest.fn<

backend/test/tsconfig.json

@@ -3,5 +3,5 @@
 	"compilerOptions": {
 		"noEmit": true
 	},
-	"include": ["./**/*.ts", "../jest.config.ts"]
+	"include": ["./**/*.ts", "../typings", "../jest.config.ts"]
 }