task-management-system

README

Task Management System

Overview

The Task Management Systerm allows users to manage task.

1. Technologies Used

• Programming Language: Go (Golang)
• Web Framework: Fiber
• Authentication: JWT (JSON Web Tokens)
• Database: MongoDB Atlas (Managed NoSQL database)

2. Models

erDiagram
    USER {
      string ID PK "Primary key (UUID)"
      string Username "Username of the user"
      string Password "Hashed password"
      date CreatedAt "Date of account creation"
    }

    TASK {
      string ID PK "Primary key (UUID)"
      string Title "Title of the task"
      string Description "Detailed description of the task"
      string Status "Status of the task (e.g., pending, completed)"
      date DueDate "Due date for the task"
      string UserID FK "Foreign key referencing USER ID"
    }

    USER ||--o{ TASK : "owns"

3. API Endpoints

User Management Endpoints

• POST /signup
  • Description: Registers a new user.
• POST /signin
  • Description: Authenticates a user and generates a JWT token.
• POST /signout
  • Description: Invalidates the user's JWT token.

Task Management Endpoints

• POST /tasks

  • Description: Creates a new task.

• GET /tasks

  • Description: Retrieves all tasks for the authenticated user.

• GET /tasks/:id

  • Description: Retrieves a specific task by ID.

• PUT /tasks/:id

  • Description: Updates a task by ID.

• DELETE /tasks/:id

  • Description: Deletes a task by ID.

4. Database Setup

• Database: MongoDB Atlas
• Connection: MongoDB URI stored in environment variables.

5. Authentication

• JWT (JSON Web Token): Used to authenticate users and secure API endpoints.

6. Architecture Diagram

Flow diagram

---
title: Flow diagram for Task management system
---

flowchart TD

A[User Request] --> B[Validate JWT Token]

B -->|Valid Token| C[Check User's Access to Task Resources]
B -->|Invalid Token| G[Return 401 Unauthorized Error]

C --> D{Access Granted?}
D -->|Yes| E[Perform CRUD Operations on Task Resources]
D -->|No| G[Return 403 Forbidden Error]

E --> F[Update MongoDB Database]
F --> H[Return Success Response to User]

G -->|End of Process| I
H -->|End of Process| I

Sequence Diagram

---
--- title: Sequence diagram for Task management system---
---

sequenceDiagram

actor User

participant TaskManagementService as Task mng service

participant MongoDB

  

rect red

Note over User, TaskManagementService: Unauthenticated Flow

  

User ->> TaskManagementService: GET /tasks (Unauthenticated)

TaskManagementService -->> User: 401 Unauthenticated Error

  

User ->> TaskManagementService: POST /tasks (Unauthenticated)

TaskManagementService -->> User: 401 Unauthenticated Error

  

User ->> TaskManagementService: PUT /tasks/:id (Unauthenticated)

TaskManagementService -->> User: 401 Unauthenticated Error

  

User ->> TaskManagementService: DELETE /tasks/:id (Unauthenticated)

TaskManagementService -->> User: 401 Unauthenticated Error

end

rect green

Note over User, TaskManagementService: Authenticated Flow

  

User ->> TaskManagementService: POST /signup

TaskManagementService ->> MongoDB: Save new user data

MongoDB -->> TaskManagementService: User created response

TaskManagementService -->> User: User registered successfully

  

User ->> TaskManagementService: POST /signin

TaskManagementService ->> MongoDB: Validate user credentials

MongoDB -->> TaskManagementService: Credentials valid

TaskManagementService -->> User: JWT token issued

  

User ->> TaskManagementService: GET /tasks (Authenticated)

TaskManagementService ->> MongoDB: Fetch tasks for user

MongoDB -->> TaskManagementService: List of tasks

TaskManagementService -->> User: List of tasks

  

User ->> TaskManagementService: POST /tasks (Authenticated)

TaskManagementService ->> MongoDB: Create new task

MongoDB -->> TaskManagementService: Task created

TaskManagementService -->> User: Task created successfully

  

User ->> TaskManagementService: PUT /tasks/:id (Authenticated)

TaskManagementService ->> MongoDB: Update task by ID

MongoDB -->> TaskManagementService: Task updated

TaskManagementService -->> User: Task updated successfully

  

User ->> TaskManagementService: DELETE /tasks/:id (Authenticated)

TaskManagementService ->> MongoDB: Delete task by ID

MongoDB -->> TaskManagementService: Task deleted

TaskManagementService -->> User: Task deleted successfully

  

User ->> TaskManagementService: POST /signout

TaskManagementService -->> User: JWT token invalidated

end

7. Unit Test Cases

User Management Endpoints

• POST /signup

  • Test for successful user registration.
  • Test for duplicate username registration.
  • Test for missing or invalid fields in the request body.

• POST /signin

  • Test for successful authentication and token generation.
  • Test for incorrect username or password.
  • Test for missing fields in the request.

• POST /signout

  • Test for successful token invalidation.

Task Management Endpoints

• POST /tasks

  • Test for successful task creation.
  • Test for creating a task with missing or invalid fields.
  • Test for unauthorized access without a valid JWT.

• GET /tasks

  • Test for retrieving all tasks for the authenticated user.
  • Test for unauthorized access without a valid JWT.

• GET /tasks/:id

  • Test for retrieving a specific task by ID.
  • Test for retrieving a task that doesn’t exist.
  • Test for unauthorized access.

• PUT /tasks/:id

  • Test for successful task update.
  • Test for updating a task that doesn’t exist.
  • Test for unauthorized access.

• DELETE /tasks/:id

  • Test for successful task deletion.
  • Test for deleting a task that doesn’t exist.
  • Test for unauthorized access.

8. Error Handling

• Error Codes: Standard HTTP status codes are used for errors.
• Error Messages: Custom error messages are provided to assist in debugging.

9. Environment Variables

Create a .env file with the following configuration:

MONGODB_URI="your-mongodb-atlas-uri"
JWT_SECRET="your-jwt-secret-key"

10. Dev environment setup

Prerequisites

• Golang (v1.17 or later recommended)
• Docker (for containerized deployment)
• MongoDB Atlas (setup with connection credentials)
• Git (for version control)
• Environment Variables: The .env file should be created as per instructions in the Environment Variables section.

Install Dependencies

make setup

Run Tests

make test

Generate Test Coverage Report

make test-report

Run Locally

make run

Run in Docker

Build the Docker image:

make docker-build

Run the Docker container:

make docker-run

To clean up generated files such as coverage reports:

make clean