Streamlining User Interaction with Chat Controller in Laravel | CodeSignal Learn

Streamlining User Interaction with Chat Controller in Laravel | CodeSignal Learn

Streamlining User Interaction with Chat Controller

Welcome to the next step in our journey of building a chatbot service with Laravel . In the previous lesson, we explored the ChatService class, which acts as a bridge between managing chat data and generating AI responses. Now, we will focus on the ChatController, a crucial component that manages chat sessions and handles messages by interacting with both the model and service layers. The controller is responsible for orchestrating the flow of data between the user interface and the backend services, ensuring that user interactions are processed efficiently and effectively.

Implementing the ChatController Class

Ensuring User Session

Before creating a chat, we need to ensure that a user session exists. The ensureUserSession method checks if a user ID is present in the session. If not, it generates a new user ID. PHPpublic function ensureUserSession() { if (!Session::has('user_id')) { Session::put('user_id', (string) Str::uuid()); } return Session::get('user_id'); } This method ensures that a user session is available by checking the session for a user_id. If it doesn't exist, a new user ID is generated and stored in the session.

Creating a New Chat Session

Sign up

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

The ChatController class is the heart of our controller layer. It is responsible for managing chat sessions and processing user messages. Let's begin by examining the structure of the ChatController class.

PHP

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Session;
use App\Services\ChatService;
use Illuminate\Support\Str;

class ChatController extends Controller
{
    protected $chatService;

    public function __construct(ChatService $chatService)
    {
        $this->chatService = $chatService;
    }
}

In this snippet, we:

Use Laravel's Session facade for session management.
Use Str for generating unique identifiers.
Import the ChatService class for managing chat data and processing messages.
Initialize the ChatController with an instance of ChatService.

One of the primary responsibilities of the ChatController is to create new chat sessions. The createChat method simulates a chat creation request.

PHP

public function createChat(Request $request)
{
    $userId = Session::get('user_id');
    if (!$userId) {
        return response()->json(['error' => 'Session expired'], 401);
    }

    $chatId = $this->chatService->createChat($userId);
    return response()->json([
        'chat_id' => $chatId,
        'message' => 'Chat created successfully'
    ]);
}

In this method, we:

Retrieve the user_id: We first check the session for a user_id.
Handle Session Expiry: If the session has expired (i.e., no user_id is found), we return an error response: response()->json(['error' => 'Session expired'], 401). This approach ensures that the client can handle the error gracefully, providing a better user experience.
Create a Chat Session: If the session is valid, we call the createChat method of the ChatService with the user ID to create a new chat session. We then return a response containing a unique chat ID and a success message.

Integrating the Chat Controller in the Main Application

To see the ChatController in action, let's integrate it into the main application. This example demonstrates how to create a chat session and handle a user message, showcasing the controller's functionality. // In routes/web.php use App\Http\Controllers\ChatController; Route::get('/ensure-session', [ChatController::class, 'ensureUserSession']); Route::post('/create-chat', [ChatController::class, 'createChat']); Route::post('/send-message/{chatId}', [ChatController::class, 'sendMessage']); In this example, we define routes for ensuring a user session, creating a chat session, and sending a message. These routes map to the corresponding methods in the ChatController, allowing us to handle requests and demonstrate the controller's functionality.

The sendMessage method is responsible for processing user messages and returning the AI's response or an error message.

PHP

public function sendMessage(Request $request, $chatId)
{
    $userId = Session::get('user_id');
    if (!$userId) {
        return response()->json(['error' => 'Session expired'], 401);
    }

    $userMessage = $request->input('message');
    if (!$chatId || !$userMessage) {
        return response()->json(['error' => 'Missing chat_id or message'], 400);
    }

    try {
        $aiResponse = $this->chatService->processMessage($userId, $chatId, $userMessage);
        return response()->json(['message' => $aiResponse]);
    } catch (\Exception $e) {
        return response()->json(['error' => $e->getMessage()], 500);
    }
}

In this method, we first check if the user session is valid. We then ensure that both chat_id and user_message are provided. If any are missing, an error is returned. The method attempts to process the message using the processMessage method of the ChatService. If successful, the AI's response is returned. If an exception occurs, an appropriate error message is returned.

PHP

// In routes/web.php

use App\Http\Controllers\ChatController;

Route::get('/ensure-session', [ChatController::class, 'ensureUserSession']);
Route::post('/create-chat', [ChatController::class, 'createChat']);
Route::post('/send-message/{chatId}', [ChatController::class, 'sendMessage']);