Merge branch 'main' into n2-user-question-history

Author: Nephelite

.gitignore

@@ -44,3 +44,8 @@ ehthumbs.db
 /user-service/user-service/.env
 /backend/user-service/.env
 /frontend/.env
+/addon/chat/Chatio/obj
+/addon/chat/Chatio/Properties/PublishProfiles
+/addon/chat/Chatio/Properties/ServiceDependencies/Chatiox - Web Deploy
+/addon/chat/Chatio/.vs/Chatio
+/addon/chat/Chatio/bin

README.md

@@ -5,16 +5,36 @@
 This project follows a microservices architecture with the following services:
 1. **Frontend** - Port `3000`
 2. **User Service** - Port `3001`
-3. **Question Service** - Port `3002`
+3. **Question Service** - Port `3002` 
 4. **Matching Service** - Port `3003`
 5. **Collaboration Service** - Port `3004`
 6. **MongoDB** - Port `27017` (Database)
 7. **Nginx API Gateway** - Port `80`
 8. **Redis** - Port `6379`
 9. **Zookeeper** - Port `2181`
 10. **Kafka** - Port `9092`, Port `29092`
+11. **Chat Service** (Located in addon/chat)
 
 ### Setting up the Project
+
+### Running the Project with `start.sh`
+
+A `start.sh` script is provided in the root directory to simplify setup. This script will start all services, check for any `.env.example` files, and create the required `.env` files if they don’t already exist.
+
+To run the project, open a terminal in the `cs3219-ay2425s1-project-g25` directory and execute:
+
+    ./start.sh
+
+This script can be run on **Linux**, **macOS**, and **Windows** (with Git Bash or WSL). It will initialize all services and ensure the environment files are set up as needed. 
+
+Ensure the script has execute permissions. If needed, set them by running:
+
+    chmod +x start.sh
+
+
+This will initialize all services and ensure the environment files are set up as needed. Note that running `start.sh` requires Git Bash, WSL, or a similar terminal environment capable of executing Bash scripts.
+
+### Manual Setup
 Copy and paste the .env.example files in each service. Rename them as .env files.
 Files to do this in:
 1. ./
@@ -23,6 +43,7 @@ Files to do this in:
 4. /backend/question-service
 5. /backend/matching-service
 6. /backend/collaboration-service
+
 Then, run `node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"` twice to generate
 your 2 JWT token secrets. For the first one, paste it into the JWT_ACCESS_TOKEN_SECRET variable of
 the .env files in question-service and user-service. Then, copy the second into the
@@ -31,10 +52,15 @@ JWT_REFRESH_TOKEN_SECRET of the .env file in user-service.
 Further note: The DB_CLOUD_URI .env variable in user-service doesn't need to be filled in. A local
 database will be created in the mongoDB service. 
 
-Consult the readme files in the service if there are further configurations needed.
+Consult the readme files in each service if there are further configurations needed.
+
 ### Running the Project
 
-To run all services, execute the following command in the root directory:
+To run the main services, execute the following command in the root directory:
+
+`docker-compose up --build`
+
+To run the chat service, navigate to the addon/chat directory and run:
 
 `docker-compose up --build`
 
@@ -49,8 +75,9 @@ Once the containers are up:
 - Redis: [http://localhost:6379](http://localhost:6379)
 - Zookeeper: [http://localhost:2181](http://localhost:2181)
 - Kafka: [http://localhost:9092](http://localhost:9092)
+- Chat Service: Available through the main application
 
-Note that even after docker says that everything is up and running, there is a risk that they aren't when you load the frontend.  Wait for the frontend logs to show up in the docker logs.
+Note that even after docker says that everything is up and running, there is a risk that they aren't when you load the frontend. Wait for the frontend logs to show up in the docker logs.
 In this event, wait for about a minute before trying again. If that still doesn't work and there are network errors, try
 rebuilding the services by running `docker-compose up --build` again.
 
@@ -64,4 +91,4 @@ rebuilding the services by running `docker-compose up --build` again.
 
 ### Nginx API Gateway
 
-- Nginx runs on port `80` and acts as the API gateway for routing requests to the respective services.
+- Nginx runs on port `80` and acts as the API gateway for routing requests to the respective services.

addon/chat/Chatio/.vs/ProjectEvaluation/chatio.metadata.v7.bin

@@ -0,0 +1,21 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <UserSecretsId>ebee6fc2-2cd0-4bfd-8580-ad97b28e9c5c</UserSecretsId>
+    <DockerDefaultTargetOS>Linux</DockerDefaultTargetOS>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="8.0.10" />
+    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.10" />
+    <PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.19.6" />
+    <PackageReference Include="MongoDB.Driver" Version="3.0.0" />
+    <PackageReference Include="OpenAI" Version="2.0.0" />
+    <PackageReference Include="StackExchange.Redis" Version="2.8.16" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.6.2" />
+  </ItemGroup>
+
+</Project>

addon/chat/Chatio/.vs/ProjectEvaluation/chatio.projects.v7.bin

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="Current" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <ActiveDebugProfile>http</ActiveDebugProfile>
+    <Controller_SelectedScaffolderID>MvcControllerEmptyScaffolder</Controller_SelectedScaffolderID>
+    <Controller_SelectedScaffolderCategoryPath>root/Common/MVC/Controller</Controller_SelectedScaffolderCategoryPath>
+    <NameOfLastUsedPublishProfile>C:\Users\Wwj\source\repos\project_ai\Chatio\Properties\PublishProfiles\Chatiox - Web Deploy.pubxml</NameOfLastUsedPublishProfile>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <DebuggerFlavor>ProjectDebugger</DebuggerFlavor>
+  </PropertyGroup>
+</Project>

addon/chat/Chatio/Chatio.csproj

@@ -0,0 +1,25 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.9.34723.18
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Chatio", "Chatio.csproj", "{03BC4C39-81A2-4440-A442-2B93B0C68BFA}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{03BC4C39-81A2-4440-A442-2B93B0C68BFA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{03BC4C39-81A2-4440-A442-2B93B0C68BFA}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{03BC4C39-81A2-4440-A442-2B93B0C68BFA}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{03BC4C39-81A2-4440-A442-2B93B0C68BFA}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {73C44709-CDEF-4DF9-8E10-62DE730AA6DE}
+	EndGlobalSection
+EndGlobal

addon/chat/Chatio/Chatio.csproj.user

@@ -0,0 +1,7 @@
+namespace Chatio.Configurations;
+
+public class MongoDbSettings
+{
+    public string ConnectionString { get; set; } = null!;
+    public string DatabaseName { get; set; } = null!;
+}

addon/chat/Chatio/Chatio.sln

@@ -0,0 +1,13 @@
+namespace Chatio.Configurations;
+
+public class OpenAiSettings
+{
+    public required string ApiKey { get; set; }
+    public required string DefaultChatModel { get; set; }
+    public required string DefaultEmbeddingModel { get; set; }
+    public double DefaultTemperature { get; set; }
+    public double DefaultTopP { get; set; }
+    public double DefaultFrequencyPenalty { get; set; }
+    public double DefaultPresencePenalty { get; set; }
+    public int DefaultMaxTokens { get; set; }
+}

addon/chat/Chatio/Configurations/MongoDbSettings.cs

@@ -0,0 +1,193 @@
+using StackExchange.Redis;
+using System.Text.Json;
+using Chatio.Dtos;
+
+namespace Chatio.Data.Hub;
+
+public class HubRepository : IHubRepository
+{
+    private readonly IDatabase _database;
+    private const string UserConnectionsKey = "user_connections";
+    private const string UserDetailsKey = "user_details";
+    private const string RoomKey = "room";
+    private const string RoomInfoKey = "room_info";
+    private const string UserRoomsKey = "user_rooms";
+
+    public HubRepository(IConnectionMultiplexer redis)
+    {
+        _database = redis.GetDatabase();
+    }
+
+    // Connection Management
+    public async Task AddConnectionAsync(string connectionId, string userId, string username)
+    {
+        await _database.SetAddAsync($"{UserConnectionsKey}:{userId}", connectionId);
+
+        // Save user details with username
+        var userDetails = new UserDetails
+        {
+            Id = userId,
+            Username = username
+        };
+        await UpdateUserDetailsAsync(userId, userDetails);
+    }
+
+
+    public async Task RemoveConnectionAsync(string connectionId, string userId)
+    {
+        await _database.SetRemoveAsync($"{UserConnectionsKey}:{userId}", connectionId);
+
+        // Clean up if no more connections exist
+        if (!(await _database.SetLengthAsync($"{UserConnectionsKey}:{userId}") > 0))
+        {
+            await _database.KeyDeleteAsync($"{UserConnectionsKey}:{userId}");
+            // Don't remove user details as they might be needed later
+        }
+    }
+
+    public async Task<IEnumerable<string>> GetUserConnectionsAsync(string userId)
+    {
+        var connections = await _database.SetMembersAsync($"{UserConnectionsKey}:{userId}");
+        return connections.Select(c => c.ToString());
+    }
+
+    // User Management
+    public async Task<UserDetails> GetUserDetailsAsync(string userId)
+    {
+        var userDetailsJson = await _database.StringGetAsync($"{UserDetailsKey}:{userId}");
+        if (userDetailsJson.IsNull)
+        {
+            return new UserDetails
+            {
+                Id = userId,
+                Username = $"User_{userId.Substring(0, 6)}" // Default if username not found
+            };
+        }
+        return JsonSerializer.Deserialize<UserDetails>(userDetailsJson.ToString())!;
+    }
+
+
+    public async Task UpdateUserDetailsAsync(string userId, UserDetails details)
+    {
+        var json = JsonSerializer.Serialize(details);
+        await _database.StringSetAsync($"{UserDetailsKey}:{userId}", json);
+    }
+
+    // Room Management
+    public async Task AddUserToRoomAsync(string roomId, string userId)
+    {
+        await _database.SetAddAsync($"{RoomKey}:{roomId}", userId);
+        await _database.SetAddAsync($"{UserRoomsKey}:{userId}", roomId);
+    }
+
+    public async Task RemoveUserFromRoomAsync(string roomId, string userId)
+    {
+        await _database.SetRemoveAsync($"{RoomKey}:{roomId}", userId);
+        await _database.SetRemoveAsync($"{UserRoomsKey}:{userId}", roomId);
+
+        // Clean up empty room
+        if (!(await _database.SetLengthAsync($"{RoomKey}:{roomId}") > 0))
+        {
+            await _database.KeyDeleteAsync($"{RoomKey}:{roomId}");
+            await _database.KeyDeleteAsync($"{RoomInfoKey}:{roomId}");
+        }
+    }
+
+    public async Task<IEnumerable<string>> GetUsersInRoomAsync(string roomId)
+    {
+        var userIds = await _database.SetMembersAsync($"{RoomKey}:{roomId}");
+        return userIds.Select(u => u.ToString());
+    }
+
+    public async Task<IEnumerable<string>> GetUserRoomsAsync(string userId)
+    {
+        var roomIds = await _database.SetMembersAsync($"{UserRoomsKey}:{userId}");
+        return roomIds.Select(r => r.ToString());
+    }
+
+    public async Task<RoomInfo> GetRoomInfoAsync(string roomId)
+    {
+        var roomInfoJson = await _database.StringGetAsync($"{RoomInfoKey}:{roomId}");
+        if (roomInfoJson.IsNull)
+        {
+            // Return default room info if not found
+            return new RoomInfo
+            {
+                Id = roomId,
+                Name = $"Room_{roomId}",
+                Type = "group",
+                CreatedAt = DateTime.UtcNow
+            };
+        }
+        return JsonSerializer.Deserialize<RoomInfo>(roomInfoJson.ToString())!;
+    }
+
+    public async Task UpdateRoomInfoAsync(string roomId, RoomInfo info)
+    {
+        var json = JsonSerializer.Serialize(info);
+        await _database.StringSetAsync($"{RoomInfoKey}:{roomId}", json);
+    }
+
+    // Helper methods for bulk operations
+    public async Task<List<UserInfoDto>> GetParticipantsAsync(IEnumerable<string> userIds)
+    {
+        var participants = new List<UserInfoDto>();
+        foreach (var userId in userIds)
+        {
+            var details = await GetUserDetailsAsync(userId);
+            participants.Add(new UserInfoDto
+            {
+                Id = userId,
+                Username = details.Username
+            });
+        }
+        return participants;
+    }
+    public async Task<List<UserInfoDto>> GetRoomParticipantsAsync(string roomId)
+    {
+        // Get user IDs in the room
+        var userIds = await GetUsersInRoomAsync(roomId);
+
+        // Get participant details for each user ID
+        return await GetParticipantsAsync(userIds);
+    }
+
+    // Optional: Methods for handling message history
+    public async Task SaveMessageAsync(string roomId, MessageDto message)
+    {
+        var messageJson = JsonSerializer.Serialize(message);
+        await _database.ListRightPushAsync($"messages:{roomId}", messageJson);
+        // Optionally trim the list to maintain a maximum history
+        await _database.ListTrimAsync($"messages:{roomId}", 0, 99); // Keep last 100 messages
+    }
+
+    public async Task<List<MessageDto>> GetMessageHistoryAsync(string roomId, int count = 50)
+    {
+        var messages = await _database.ListRangeAsync($"messages:{roomId}", -count, -1);
+        return messages
+            .Select(m => JsonSerializer.Deserialize<MessageDto>(m.ToString())!)
+            .ToList();
+    }
+
+    public async Task<string?> GetUserIdByConnectionAsync(string connectionId)
+    {
+        var server = _database.Multiplexer.GetServer(_database.Multiplexer.GetEndPoints().First());
+
+        foreach (var key in server.Keys(pattern: $"{UserConnectionsKey}:*"))
+        {
+            if (await _database.SetContainsAsync(key, connectionId))
+            {
+                return key.ToString().Split(':').Last(); // Extract userId from the key
+            }
+        }
+
+        return null;
+    }
+
+    public async Task<IEnumerable<string>> GetConnectionIdsByUserIdAsync(string userId)
+    {
+        var connections = await _database.SetMembersAsync($"{UserConnectionsKey}:{userId}");
+        return connections.Select(c => c.ToString());
+    }
+
+}