sayeed1999/ride-sharing-platform

This R&D project contains ridesharing service, keycloak identity provider, api gateway; uses microservices architecture, onion architecture, DDD, TDD, mediaTR and more.

Docker Compose Deployment

Table of Contents

• Prerequisites
• Other Docs
• Setting Up the Project
  • Generate SSL Certificate
  • Set Environment Variables for Docker Compose
  • Set Environment Variables for API development
• Running the Containers
  • Production Environment
  • Development Environment
• Usage
  • Access APIs
  • Access MailHog
• Destroying the Containers
• References

Prerequisites

Before you begin, ensure you have the following installed & running properly on your server:

• Docker Desktop
• WSL (Windows Subsystem for Linux) if the server OS is Windows

Other Docs

Head to other deployment readme files: -

• RabbitMQ
• Redis with Management GUI
• PostgreSQL with PgAdmin
• Keycloak with Nginx & Postgres

Setting Up the Project

Generate SSL Certificate

To obtain a valid SSL certificate for your server, open bash terminal and run the following command:

openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout server.key.pem -out server.crt.pem

This will generate two files on the home directory of the server:

• SSL certificate file (server.key.pem)
• SSL certificate key file (server.crt.pem)

Set Environment Variables for Docker Compose

The docker-compose.yml file requires proper environment variables set before execution.

Following the .env.example file, create another file .env in the same directory, and set proper values. DO NOT expose them!

Set Environment Variables for API development

Skip this if you are not developing API or writing code and debug.

Open Developer PowerShell from project root directory & run the following commands:

setx API__ConnectionStrings__DatabaseConnectionString "<connection_string_here>"
setx API__ClientApplication__AllowedOrigins "http://localhost:3000" (if frontend is running on this domain)
setx API__Keycloak__Host "http://localhost:9990"
setx API__Keycloak__Realm "RideSharing"

Running the Containers

Production Environment

Open Terminal from project /docker directory and run the following command to run all containers in detached mode:

docker compose -f docker-compose-keycloak.prod.yml -f docker-compose-postgres.yml -f docker-compose-rabbitmq.yml -f docker-compose-redis.yml up -d

Development Environment

Open Terminal from project /docker directory and run the following command to run all containers in detached mode:

docker compose -f docker-compose-keycloak.dev.yml -f docker-compose-postgres.yml -f docker-compose-rabbitmq.yml -f docker-compose-redis.yml up -d

Usage

Access APIs

• Access RideSharing API through https:localhost:4000. GET https://localhost:4000 returns RideSharing.InternalAPI is running message.

• Access RideSharing Customer API through https:localhost:5000. GET https://localhost:5000 returns RideSharing.CustomerAPI is running message.

Access MailHog

• Access Local MailHog Server through http://localhost:8025(only for dev env).

Destroying the Containers

Run the following command to destroy all containers:

docker compose down

References

To learn more about each of these topics, head to the following documentations:-

• Keycloak documentation
• Docker documentation
• Nginx documentation

ride-sharing-platform's Issues

take current user from http context and authorize endpoints

we can get the current user from the http execution context
now we have to see is the user authorized to perform the action?
like I should not delete another user's data! right?

blogservice/ implement bfs algorithm to find all friends in facebook

sync keycloak between frontend and backend

user should be able to login from frontend and hit apis on backend
the auth mechanism should prevent XSS attacks

feat: work on start and end trip by driver

Start or End the Trip
Using this API, a driver will be able to start and end the trip.
startTrip(driverID: UUID, tripID: UUID): boolean
endTrip(driverID: UUID, tripID: UUID): boolean
Parameters

Driver ID (UUID): ID of the driver.

Trip ID (UUID): ID of the requested trip.

Returns

Result (boolean): Represents whether the operation was successful or not.

feat: cancel accepted ride functionality by customer before it is started

Deny the Ride
This API will allow the customer to cancel the accepted trip.
denyRide(customerID: UUID, rideID: UUID, reason: string): boolean
Parameters

Customer ID (UUID): ID of the driver.

Ride ID (UUID): ID of the customer requested ride.

Returns

Result (boolean): Represents whether the operation was successful or not.

blogservice/ user should be able to send/accept friend request using api

api should have two endpoints, one for sending friend request, another for accepting request

create trip log controller with service and domain

all trip updates must be in trip log

feat: create aspnetcore identity authorization microservice

blogservice/ when user registers on auth api, the user should be inserted in blog db

currently, the message queue receiver is already receiving new user when a user is registered,

you just have to insert it in database

challenge: dependency injection is an issue here, since the message queue receiver is not a controller, and you cannot inject db context here as do it in controllers...

ridesharing/ create endpoint for request ride & receive ride

1. endpoint to request ride - create trip
2. endpoint to process request - update trip

do r&d on how to do use task.whenall for multi threading in efcore

        // TODO:- EF Core not allowing multiple threading operations on single instance!
        
        var task1 = this.userRepository.FindByIdAsync(userRelation.FromUserId);
        var task2 = this.userRepository.FindByIdAsync(userRelation.ToUserId);
        await Task.WhenAll(task1, task2);

implement pagination in generic ntier repository in all layers

generic repo service controllers must support default pagination in standard format

dockerize application

write separate dockerfile if necessary for each api
write docker compose to run altogether

feat: create separate notification service that is responsible for mail/sms sending and communicates via masstransit

unit tests for customer api features

write proper tests for customer api controller layer, service layer, domain layer, everywhere necessary

cover all scenarios e.g ride requested, accepted, rejected, etc..

feat: use separate logging service that is communicated via kafka

feat: use database triggers & remove log insertion from application layer

the triggers should also be kept in codebase as .sql files just to keep a copy

feat: use spatial data type in postgresql for location for trip source and destination

Background
Currently, we have kept source destination location as simple string for simplicity. We want to have real location data.

Goal
EF Core supports spatial data types. Have a deep look on it. Study. Implement latitude longitude.

rabbitmq/ run scheduler every 24 hour to check if any new user registered in last 24 hour but missing in current service

update schema for customers

one user table should have roles column with jsonb value in postgres containing all roles as string

feat: work on rate trip by customer

Rate the Trip
This API will enable customers to rate the trip.
rateTrip(customerID: UUID, tripID: UUID, rating: int, feedback?: string): boolean

Parameters

Customer ID (UUID): ID of the customer.

Trip ID (UUID): ID of the completed trip.

Rating (int): Rating of the trip.

Feedback (string): Feedback about the trip by the customer (optional).

Returns

Result (boolean): Represents whether the operation was successful or not.

feat: implement canceling trip request functionality

customer can cancel a trip request if he/she wants

redis/ the project should be running smoothly despite of redis instance running or not on server

lets say the project is using redis
but the system has not redis installed
the code should smoothly ignore it instead of crashing down

authservice/ authentication will be only managed from auth service

no service other than authentication service should any code related to user password checking related stuffs.

apigateway/ create an api gateway for all the services

blogservice/ implement bfs algorithm to find all friends of friends in facebook

Hint: you need to run BFS with node depth of exact 02!

Replace MassTransit with RabbitMQ implementation from scratch

The project must implement rabbitmq from code from rabbitmq documentation. not any framework or library. also the code must be reusable like a library.

ridesharing/ use mediatR in between controller and business layer

blogservice/ create posts, comments as nodes, and find all comments associated within a post using DFS algorithm

https not working on docker container

docker compose up -> runs all images as containers

• but each container can only be accessed via http ports
• https wont work
• api gateway wont work
• cannot enter sql server through port
• cannot view swagger

project must not crash doing any rabbitmq operation rather ignore error smoothly

feat: implement cancel accepted ride functionality for driver

Deny the Ride
This API will allow the driver to deny the trip.
denyRide(driverID: UUID, rideID: UUID, reason: string): boolean
Parameters

Driver ID (UUID): ID of the driver.

Ride ID (UUID): ID of the customer requested ride.

Returns

Result (boolean): Represents whether the operation was successful or not.

integrate keycloak identity provider

• keycloak instance should be up and running with docker compose
• keycloak should use posgresql as its database
• keycloak database backup should remain on hard disk of the server (data recovery on instance destroy)
• user should signup & get access tokens from keycloak
• api gateway should block requests if found unauthenticated!
• all internal services should independently validate the jwt token from keycloak

add unit tests for service or business layer

feat: integrate redis support at repository level

application layer or controller layer should not get concerned with cache mechanisms

your caching will be handled from ef core or dapper or on a repository on top of it

feat: work on accept ride by driver

Accept the Ride
This API will allow the driver to accept the trip.
acceptRide(driverID: UUID, rideID: UUID): boolean
Parameters

Driver ID (UUID): ID of the driver.

Ride ID (UUID): ID of the customer requested ride.

Returns

Result (boolean): Represents whether the operation was successful or not.

ridesharing/ manage customer driver signup properly

Possible criteria:

• when user is received in ridesharing, dont insert user in db if user has not role customer or driver
• if a user with driver role signs up in auth service, insert driver entity in driver table of ridesharing db
• if the user then adds customer role with update endpoint in auth service, insert customer entity in customer table of ridesharing db
• if user updates mobile number, but user is not present in ridesharing db, then insert
• if user updates mobile number, you may need to update both customer and driver table

manage oidc protocol totally from server side

it is very easy to use keycloak js adapter to login into keycloak from spa application.
but client side auth is less secure than server side auth.
the challenge is to build server side authorization with no control over frontend

feat: work on request ride endpoint

Request a Ride
Through this API, customers will be able to request a ride.
requestRide(customerID: UUID, source: Tuple, destination: Tuple, cabType: Enum, paymentMethod: Enum): Ride
Parameters

Customer ID (UUID): ID of the customer.

Source (Tuple): Tuple containing the latitude and longitude of the trip's starting location.

Destination (Tuple): Tuple containing the latitude and longitude of the trip's destination.

Returns

Result (boolean): Represents whether the operation was successful or not.

feat: use separate database containers for command and queries through dapper and ef core respectively

• dapper should hit query only database container
• ef core should hit command only database container
• try using same volume for both & see it works or not!?

rabbitmq/ when the user updates or deletes account, inform other services too

• if user updates password, dont inform other services
• if user updates necessary information, inform other services
• if user deletes account, inform other services

add unit tests for Entity or Domain layer

feat: work on customer cancel ride endpoint

Cancel the Ride
This API will allow customers to cancel the ride.
cancelRide(customerID: UUID, reason?: string): boolean
Parameters

Customer ID (UUID): ID of the customer.

Reason (UUID): Reason for canceling the ride (optional).

Returns

Result (boolean): Represents whether the operation was successful or not.

feat: create minimal api for ride sharing admin api

redis/ the generic repository layer should support redis caching mechanism

feat: auto cancel ride if no driver accepts in last two minutes

you need to throw a background job using rabbitmq when a ride is created and auto cancel it if not accepted in next one-five mins.

also, if a rider accepts it and cancels it, the auto cancel timeout should get reset (the resetting thing can be done in a follow up PR)

initiate redis connection on RideSharing.CustomerAPI at Program Start

may setup two sample endpoints to test redis connection
one for set cache
one for get cache

blogservice/ Implement user to user friendship scenario like facebook

the graph database must be able to create friends like facebook friends and run bfs algorithm to find all friends of a user

ridesharing/ when user registers in auth api, notify ridesharing service too

currently only blog service db gets inserted when user signs up in auth db.
since fanout exchange is used for this event, add ridesharing too as a subscriber and insert in its database

authorize existing endpoints with proper access level