feat(backend/shared): save all messages in ai chat to db bb-454

apps/backend/src/db/migrations/20240920094244_add_thread_id_to_user_details.ts

@@ -0,0 +1,19 @@
+import { type Knex } from "knex";
+
+const TABLE_NAME = "user_details";
+
+const COLUMN_NAME = "thread_id";
+
+function up(knex: Knex): Promise<void> {
+	return knex.schema.alterTable(TABLE_NAME, (table) => {
+		table.string(COLUMN_NAME).unique();
+	});
+}
+
+function down(knex: Knex): Promise<void> {
+	return knex.schema.alterTable(TABLE_NAME, (table) => {
+		table.dropColumn(COLUMN_NAME);
+	});
+}
+
+export { down, up };

apps/backend/src/db/migrations/20240920120005_add_chat_messages_table.ts

@@ -0,0 +1,62 @@
+import { type Knex } from "knex";
+
+const TableName = {
+	CHAT_MESSAGES: "chat_messages",
+	USER_DETAILS: "user_details",
+} as const;
+
+const ColumnName = {
+	AUTHOR: "author",
+	CREATED_AT: "created_at",
+	ID: "id",
+	IS_READ: "is_read",
+	TASK: "task",
+	TEXT: "text",
+	THREAD_ID: "thread_id",
+	TYPE: "type",
+	UPDATED_AT: "updated_at",
+} as const;
+
+const ChatMessageType = {
+	TASK: "task",
+	TEXT: "text",
+} as const;
+
+const ChatMessageAuthor = {
+	ASSISTANT: "assistant",
+	USER: "user",
+} as const;
+
+const DELETE_STRATEGY = "CASCADE";
+
+function up(knex: Knex): Promise<void> {
+	return knex.schema.createTable(TableName.CHAT_MESSAGES, (table) => {
+		table.increments(ColumnName.ID).primary();
+		table.timestamp(ColumnName.CREATED_AT).defaultTo(knex.fn.now());
+		table.timestamp(ColumnName.UPDATED_AT).defaultTo(knex.fn.now());
+		table
+			.enum(ColumnName.AUTHOR, [
+				ChatMessageAuthor.ASSISTANT,
+				ChatMessageAuthor.USER,
+			])
+			.notNullable();
+		table.boolean(ColumnName.IS_READ).notNullable().defaultTo(false);
+		table
+			.enum(ColumnName.TYPE, [ChatMessageType.TASK, ChatMessageType.TEXT])
+			.notNullable();
+		table.string(ColumnName.TEXT);
+		table.json(ColumnName.TASK);
+		table
+			.string(ColumnName.THREAD_ID)
+			.notNullable()
+			.references(ColumnName.THREAD_ID)
+			.inTable(TableName.USER_DETAILS)
+			.onDelete(DELETE_STRATEGY);
+	});
+}
+
+function down(knex: Knex): Promise<void> {
+	return knex.schema.dropTableIfExists(TableName.CHAT_MESSAGES);
+}
+
+export { down, up };

apps/backend/src/db/migrations/20240922132151_update_type_of_text_in_chat_message.ts

@@ -0,0 +1,18 @@
+import { type Knex } from "knex";
+
+const TABLE_NAME = "chat_messages";
+const COLUMN_NAME = "text";
+
+function up(knex: Knex): Promise<void> {
+	return knex.schema.alterTable(TABLE_NAME, function (table) {
+		table.text(COLUMN_NAME).alter();
+	});
+}
+
+function down(knex: Knex): Promise<void> {
+	return knex.schema.alterTable(TABLE_NAME, function (table) {
+		table.string(COLUMN_NAME).alter();
+	});
+}
+
+export { down, up };

apps/backend/src/libs/modules/database/libs/enums/database-table-name.enum.ts

@@ -1,5 +1,6 @@
 const DatabaseTableName = {
 	CATEGORIES: "categories",
+	CHAT_MESSAGES: "chat_messages",
 	FILES: "files",
 	MIGRATIONS: "migrations",
 	ONBOARDING_ANSWERS: "onboarding_answers",

apps/backend/src/modules/ai-assistant/ai-assistant.controller.ts

@@ -11,8 +11,10 @@ import { type UserDto } from "~/modules/users/users.js";
 import { type AIAssistantService } from "./ai-assistant.service.js";
 import { AIAssistantApiPath } from "./libs/enums/enums.js";
 import {
+	type AIAssistantAcceptTaskRequestDto,
+	type AIAssistantChangeTaskRequestDto,
 	type AIAssistantCreateMultipleTasksDto,
-	type AIAssistantRequestDto,
+	type AIAssistantExplainTaskRequestDto,
 	type AIAssistantSuggestTaskRequestDto,
 	type ThreadMessageCreateDto,
 } from "./libs/types/types.js";
@@ -286,6 +288,7 @@ class AIAssistantController extends BaseController {
 				this.addMessageToConversation(
 					options as APIHandlerOptions<{
 						body: ThreadMessageCreateDto;
+						user: UserDto;
 					}>,
 				),
 			method: "POST",
@@ -299,7 +302,7 @@ class AIAssistantController extends BaseController {
 			handler: (options) =>
 				this.changeTaskSuggestion(
 					options as APIHandlerOptions<{
-						body: AIAssistantRequestDto;
+						body: AIAssistantChangeTaskRequestDto;
 						user: UserDto;
 					}>,
 				),
@@ -314,7 +317,7 @@ class AIAssistantController extends BaseController {
 			handler: (options) =>
 				this.explainTasksSuggestion(
 					options as APIHandlerOptions<{
-						body: AIAssistantRequestDto;
+						body: AIAssistantExplainTaskRequestDto;
 						user: UserDto;
 					}>,
 				),
@@ -359,7 +362,7 @@ class AIAssistantController extends BaseController {
 			handler: (options) =>
 				this.acceptTask(
 					options as APIHandlerOptions<{
-						body: AIAssistantRequestDto;
+						body: AIAssistantAcceptTaskRequestDto;
 						user: UserDto;
 					}>,
 				),
@@ -387,11 +390,10 @@ class AIAssistantController extends BaseController {
 	 *           schema:
 	 *             type: object
 	 *             properties:
-	 *               threadId:
+	 *               text:
 	 *                 type: string
-	 *                 description: Identifier for the thread
-	 *                 example: "thread_5kL0dVY9ADvmNz8U33P7qFX3"
-	 *               payload:
+	 *                 description: Text of user message
+	 *               task:
 	 *                 $ref: '#/components/schemas/TaskPayload'
 	 *     responses:
 	 *       200:
@@ -404,7 +406,7 @@ class AIAssistantController extends BaseController {
 
 	private async acceptTask(
 		options: APIHandlerOptions<{
-			body: AIAssistantRequestDto;
+			body: AIAssistantAcceptTaskRequestDto;
 			user: UserDto;
 		}>,
 	): Promise<APIHandlerResponse> {
@@ -420,7 +422,7 @@ class AIAssistantController extends BaseController {
 	 * @swagger
 	 * /assistant/chat/accept-tasks:
 	 *   post:
-	 *     summary: Accept tasks suggestions
+	 *     summary: Accept task suggestions
 	 *     tags:
 	 *       - AI Assistant
 	 *     security:
@@ -430,27 +432,23 @@ class AIAssistantController extends BaseController {
 	 *       content:
 	 *         application/json:
 	 *           schema:
-	 *             type: object
+	 *             type: array
 	 *             properties:
 	 *               threadId:
 	 *                 type: string
 	 *                 description: Identifier for the thread
 	 *                 example: "thread_5kL0dVY9ADvmNz8U33P7qFX3"
 	 *               payload:
-	 *                 type: array
-	 *                 description: Array of tasks to accept
-	 *                 items:
-	 *                   $ref: '#/components/schemas/TaskPayload'
+	 *                 $ref: '#/components/schemas/TaskPayload'
 	 *     responses:
 	 *       200:
-	 *         description: Returns the accepted tasks
+	 *         description: Returns the accepted task
 	 *         content:
 	 *           application/json:
 	 *             schema:
-	 *               type: array
-	 *               items:
-	 *                 $ref: '#/components/schemas/Task'
+	 *               $ref: '#/components/schemas/Task'
 	 */
+
 	private async acceptTasks(
 		options: APIHandlerOptions<{
 			body: AIAssistantCreateMultipleTasksDto;
@@ -485,10 +483,6 @@ class AIAssistantController extends BaseController {
 	 *                 type: string
 	 *                 description: The text message to add to the thread
 	 *                 example: "Hello, how can I assist you?"
-	 *               threadId:
-	 *                 type: string
-	 *                 description: Identifier for the conversation thread
-	 *                 example: "thread_abc123"
 	 *     responses:
 	 *       200:
 	 *         description: Indicates if the message was successfully added
@@ -502,12 +496,13 @@ class AIAssistantController extends BaseController {
 	private async addMessageToConversation(
 		options: APIHandlerOptions<{
 			body: ThreadMessageCreateDto;
+			user: UserDto;
 		}>,
 	): Promise<APIHandlerResponse> {
-		const { body } = options;
+		const { body, user } = options;
 
 		return {
-			payload: await this.openAIService.addMessageToThread(body),
+			payload: await this.openAIService.addMessageToThread(body, user),
 			status: HTTPCode.OK,
 		};
 	}
@@ -528,14 +523,11 @@ class AIAssistantController extends BaseController {
 	 *           schema:
 	 *             type: object
 	 *             properties:
-	 *               threadId:
+	 *               text:
 	 *                 type: string
-	 *                 description: Identifier for the thread
-	 *                 example: "thread_5kL0dVY9ADvmNz8U33P7qFX3"
-	 *               payload:
-	 *                 type: array
-	 *                 items:
-	 *                   $ref: '#/components/schemas/TaskPayload'
+	 *                 description: Text of user message
+	 *               task:
+	 *                 $ref: '#/components/schemas/TaskPayload'
 	 *     responses:
 	 *       200:
 	 *         description: Returns task suggestions for the provided categories
@@ -551,14 +543,10 @@ class AIAssistantController extends BaseController {
 	 *                     oneOf:
 	 *                       - $ref: '#/components/schemas/ChatMessageText'
 	 *                       - $ref: '#/components/schemas/ChatMessageTask'
-	 *                 threadId:
-	 *                   type: string
-	 *                   description: Identifier for the chat thread.
-	 *                   example: "thread_QwWiRV7jFYMz0i0YGcRvcRsU"
 	 */
 	private async changeTaskSuggestion(
 		options: APIHandlerOptions<{
-			body: AIAssistantRequestDto;
+			body: AIAssistantChangeTaskRequestDto;
 			user: UserDto;
 		}>,
 	): Promise<APIHandlerResponse> {
@@ -586,14 +574,11 @@ class AIAssistantController extends BaseController {
 	 *           schema:
 	 *             type: object
 	 *             properties:
-	 *               threadId:
+	 *               text:
 	 *                 type: string
-	 *                 description: Identifier for the thread
-	 *                 example: "thread_5kL0dVY9ADvmNz8U33P7qFX3"
-	 *               payload:
-	 *                 type: array
-	 *                 items:
-	 *                   $ref: '#/components/schemas/TaskPayload'
+	 *                 description: Text of user message
+	 *               task:
+	 *                 $ref: '#/components/schemas/TaskPayload'
 	 *     responses:
 	 *       200:
 	 *         description: Returns explanations for the provided task suggestions
@@ -609,20 +594,17 @@ class AIAssistantController extends BaseController {
 	 *                     oneOf:
 	 *                       - $ref: '#/components/schemas/ChatMessageTextExplanation'
 	 *                       - $ref: '#/components/schemas/ChatMessageTask'
-	 *                 threadId:
-	 *                   type: string
-	 *                   description: Identifier for the chat thread.
-	 *                   example: "thread_QwWiRV7jFYMz0i0YGcRvcRsU"
 	 */
 	private async explainTasksSuggestion(
 		options: APIHandlerOptions<{
-			body: AIAssistantRequestDto;
+			body: AIAssistantExplainTaskRequestDto;
+			user: UserDto;
 		}>,
 	): Promise<APIHandlerResponse> {
-		const { body } = options;
+		const { body, user } = options;
 
 		return {
-			payload: await this.openAIService.explainTasksSuggestion(body),
+			payload: await this.openAIService.explainTaskSuggestion(body, user),
 			status: HTTPCode.OK,
 		};
 	}
@@ -651,10 +633,6 @@ class AIAssistantController extends BaseController {
 	 *                   type: array
 	 *                   description: Array of chat messages (initially empty).
 	 *                   example: []
-	 *                 threadId:
-	 *                   type: string
-	 *                   description: Identifier for the chat thread.
-	 *                   example: "thread_QwWiRV7jFYMz0i0YGcRvcRsU"
 	 */
 	private async initializeNewChat(
 		options: APIHandlerOptions<{
@@ -690,10 +668,9 @@ class AIAssistantController extends BaseController {
 	 *                 description: Array of selected categories for task suggestions
 	 *                 items:
 	 *                   $ref: '#/components/schemas/SelectedCategory'
-	 *               threadId:
+	 *               text:
 	 *                 type: string
-	 *                 description: Identifier for the thread
-	 *                 example: "thread_abc123"
+	 *                 description:Text of user message
 	 *     responses:
 	 *       200:
 	 *         description: Returns task suggestions for the provided categories
@@ -709,21 +686,17 @@ class AIAssistantController extends BaseController {
 	 *                     oneOf:
 	 *                       - $ref: '#/components/schemas/ChatMessageText'
 	 *                       - $ref: '#/components/schemas/ChatMessageTask'
-	 *                 threadId:
-	 *                   type: string
-	 *                   description: Identifier for the chat thread.
-	 *                   example: "thread_QwWiRV7jFYMz0i0YGcRvcRsU"
 	 */
 	private async suggestTasksForCategories(
 		options: APIHandlerOptions<{
 			body: AIAssistantSuggestTaskRequestDto;
 			user: UserDto;
 		}>,
 	): Promise<APIHandlerResponse> {
-		const { body } = options;
+		const { body, user } = options;
 
 		return {
-			payload: await this.openAIService.suggestTasksForCategories(body),
+			payload: await this.openAIService.suggestTasksForCategories(body, user),
 			status: HTTPCode.OK,
 		};
 	}