Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pixelcaliber/chat-application-user-service
User mirco-service that enables secure login, register of users using JWT and additionally provides efficient search mechanism for any user based on its username
https://github.com/pixelcaliber/chat-application-user-service
flask-application jwt-authentication postgresql python3
Last synced: about 6 hours ago
JSON representation
User mirco-service that enables secure login, register of users using JWT and additionally provides efficient search mechanism for any user based on its username
- Host: GitHub
- URL: https://github.com/pixelcaliber/chat-application-user-service
- Owner: pixelcaliber
- Created: 2024-01-23T10:26:57.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-03-26T07:02:29.000Z (8 months ago)
- Last Synced: 2024-03-27T07:48:36.170Z (8 months ago)
- Topics: flask-application, jwt-authentication, postgresql, python3
- Language: Python
- Homepage:
- Size: 208 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# chat-application-user-service
### User mirco-service: Part of chat application, it enables secure login, signin and registration of users using JWT, also additionally provides efficient search mechanism for any user based on its username
### Additionally, whenever a new user registers we send a notification to them using Firebase Cloud Messaging and Kafka for scalability, based on the FCM token of users' device, refer: notification service repo for more details
- so, this service is a producer of kafka notification events, we are pushing those events into a topic for worker to consume and generate notifications on user devices
tech-stack: Postgres, Python, flask, Kafka
### User Service:
1. User is registered and the credentials are stored in the Postgres.
2. Registered user are able to login to use the chat application.
3. This service uses JWT for secure authentication and authorisation.
4. User database is postgres that stores all the user details and credentials.
5. Additionally, the User Service facilitates user searches by username, returning the corresponding username and user ID upon finding an exact match.
6. Whenever new user registers we send a notification to the user using Firebase Cloud Messaging based on the FCM token of users' device, refer: notification service repo for more detials
7. User service is a producer of kafka notification events and we push those events into a topic for worker to consume
### API Contracts:
User Service:
```
POST: /register
req:
{
username: String,
password: String,
email: String
}
response:
{
access_token: String
username: String,
user_id: UUIDv4
}
POST: /login
req:
{
username: String,
password: String,
}
response:
{
access_token: String
username: String,
user_id: UUIDv4
}
GET: /users/show
response:
{
"users" = [
{
"username": String,
"user_id": UUIDv4
},
{
"username": String,
"user_id": UUIDv4
},..]
}
GET: /users/show?username={username}
response:
{
"username": String,
"user_id": UUIDv4
}
This api is returning the user with the given username
by querying the postgres User table with the matching records.
```
Websocket endpoints:
```
@socketio.on('connect', namespace='/chat')
- to connect the user to the messaging service
@socketio.on('disconnect', namespace='/chat')
- to disconnect user from the messaging service
@socketio.on('start_private_chat', namespace='/chat')
- checks if there exists a history of chat btw user1 and user2
- if exists then retrieve the chat_id
- if not then generate a new chat_id and insert it into the user_chat table along with
user_id and timestamp
- creates a room for 2 users with room_id = chat_id
- users can connect to this room and exchange messages
@socketio.on('send_message', namespace='/chat')
- push the message into the database with the message_id chat_id, sender_id, etc (see the model schema for details)
- emit a receive_message event so that users can receive messages
whoever are listening to this event in the same room
@socketio.on('receive_message', namespace='/chat')
- sends an acknowledment to the users
```