blumea / blumea-serverless Goto Github PK

View Code? Open in Web Editor NEW

2.0 1.0 0.0 89 KB

:gear: Simple, fast and reliable Web APIs for Blumea.

Home Page: https://blumea-serverless.vercel.app

License: MIT License

JavaScript 99.27% Dockerfile 0.73%

blumea bloom-filters node-js hacktoberfest hacktoberfest2023

blumea-serverless's Introduction

Blumea Serverless

Blumea's React.js client is powered by this Serverless node application that provides standard utilities and scalability without infrastructure management.

The application is designed to incorporate feedback and mail services, improving user engagement. The Serverless architecture enables rapid development and deployment, reduces operational overhead, and is cost-effective.

🏗️ Deployments

Please note that all APIs prefixed with /api require an API key.

Prod Deployment
Dev Deployment
Prod Deployment 1 - Mail Service Enabled
Prod Deployment 2 - Mail Service Enabled

❔ API Accessibility

All request must contain x-api-key header to access the protected endpoints.

Services

/api/home - Enlists exposed APIs.
/api/mail - Blumea Mail Service.
- POST: /api/mail/generate - Trigger email verification for a client.
- GET: /api/mail/verify/:token - Verify client email - triggered through gmail.
/api/feedback - Users with verified email to submit feedback.

Demo Section Utility

/api/filter_name/create?item= - In house demo for item insertion on a filter instance.
/api/filter_name/search?item= - In house demo for item look up on a filter instance.

Sample

  curl https://blumea-serverless.vercel.app/api/classical/search?item=user17
  -H "x-api-key: ExampleKeyQmx1bWVhIFNlcnZlcmxlc3M="

Options for the filter:
- /api/classical
- /api/counting
- /api/partitioned
- wip /api/cuckoo
- wip /api/scalable

📦 Application Details

blumea-serverless's People

Contributors

Stargazers

Watchers

blumea-serverless's Issues

Application Improvements: Add API response time limiter middleware

A security countermeasure for Denial-Of-Service & DDOS. Slowing down API response times incrementally for a specific user in a given time frame.

📓 Document update : API references

Update readme with API references

JS Stack Error Case: JavaScript heap out of memory

Memory allocation issue leads to JS stack errors. JS engine flagged the error fatal and could cause the app to restart or abruptly shut down.
Preview:

set up routes for Blumea server

Set Up the basic public routes:

/api: GET API Home
/api/support: POST User Query
/api/feedback: POST User Feedback
/api/search?search_query: GET Info Regarding Blumea Services [Optional]

🔒 Add standard auth layer for the APIs

Standard API key auth middleware for all endpoints prefixed /api/

☑️ Redis server setup for Blumea Playground

Configuration

Server: Blumea-redis-server-1
Host: redis-13388.c212.ap-south-1-1.ec2.cloud.redislabs.com
Port: 13388

Requirement

Persistent storage option for Blumea-Playground.

Application Improvements: Add IP based rate limiting middleware

IP-based rate limiter for public endpoints with a standard configuration.

Code Restructure: Rewrite Service layer

Segregation of express routers and the controllers to be done.

🐛 Partitioned Bloom API causes app to crash

Partitioned Bloom API

Error Code: FUNCTION_INVOCATION_TIMEOUT
Endpoint: /api/partitioned

Mail Service: Email validator changes

Improve checks on client email. The code is rudimentary and could potentially cause errors downstream.

Cuckoo Bloom API for Blumea Playground

Required endpoints:

POST \api\cuckoo\create
- Payload:
```
    { 
      item: any
    } 
```
GET \api\cuckoo\search?item=
GET \api\cuckoo\all

Scalable Bloom API for Blumea Playground

Required endpoints:

POST \api\scalable\create
- Payload:
```
    { 
      item: any
    } 
```
GET \api\scalable\search?item=
GET \api\scalable\all

🐛 Partitioned Bloom bug with custom input

Partitioned Bloom FIlter Fails on custom input:
itemcount = 100, fprate = 0.7, fails for Partitioned Bloom instance, we are able to create an instance with >1 false positive rate.

Tests work fine with Classical & Counting Bloom APIs.

Bug Preview:

Ideal Case:

Adjusted fprate and itemcount are used to generate the bloom filter instance.