helperline / backend

Backend for the HelperLine.

See Project Details

See Frontend Repository

HelperLine (Backend) - A Hotline for People without Internet Access

See API v1 Documentation

Tech Stack

• React Frontend

• Flask Backend

• Heroku (AWS) Cloud Hosting

• Heroku Postgres Database

• Twilio for SMS, Phone and Email Communication

• Google Maps for Map Components

backend's Issues

Provide timestamps to user in his local time (zip code)

Simple backend fix inside get_all_helper_data.

Email/Phone verification requirement for accepting/forwarding in the backend

This is required from our frontend but not using the plain API.

Dequeuing of Calls

Add method for dequeuing calls from these queues according to the filters.

Add Comments to Calls (Backend)

Possibility to store a comment with each call (in call record itself).

The helper can make notes about a call (no formatting just plan text).

When call is rejected that comment is removed.

Implement Call Forwarding (Backend)

Add all database fields - without scheduling.

Test out call forwarding with Twilio.

Implement the actual forwarding.

Add REST-endpoint to toggle forwarding.

Secure Environment Variables on GCP App Engine

Probably quite easy.

Debug Refactored Backend

Configure Domain for Backend

Make subdomain backend.helperline.io point at backend

Try it first on other domain.

Setup Testing Environment (Backend)

Modify flack_backend/__init__.py for easy switch between Testing and not Testing (On GAE as well as locally).

A dedicated database for testing.

Dedicated environment variables.

Conceptualize list of features to test.

Refactor backend API to be RESTful

Change routes according to the new standard v1.

Do not deploy yet - or if so just with --no-promote

Commits associated with this issue are accidentily mixed up with issue #41 .

Add swagger documentation to a static url

You can simply export the full API documentation as one static html file. This can be a template for the flask backend at the route /v1/docs

Add version numbers to API

Add version numbers to api:

.com/backend/... -> .com/v1/backend/...

This makes it easier to further develop the backend separately from the backend.

The Release CW 15 will be the API version v1.

Call comment not saving

Whenever trying to save a call comment (onBlur of the comment text field) it says "invalid session token".

By using hotline manually one can still edit a confirmed call

Add condition to edit-call-functions or block hotline requests right away.

Migrate from Heroku to GCP App Engine (Backend)

Currently we are host the whole webapp and the hotline on Heroku.

However until now Heroku does not offer any Covid-19 related funding, whereas GCP does.

We could easily switch to the GCP AppEngine. Deploying and scaling seems to be super easy and fast.

Switching from Flask to Sanic

Currently our server side code is synchronous and blocking ...

Because we are using a lot of communication with our MongoDB Atlas Cluster we definitely need to improve our server side code.

The best option for that would be to switch to Sanic: https://sanicframework.org/, https://github.com/huge-success/sanic.

More Precise Error Messages (Backend)

Better status responses about what went wrong for all API endpoints.

Find good JetBrains plugin for OpenAPI with JSON/YAML

This one seems interesting:
https://plugins.jetbrains.com/plugin/12887-openapi-editor

Maybe there are more plugins for VSCode.

Refactor Code for more than two call categories.

From {"local": True/False} to {"call_type": "local"/"global"}.

API documentation

Use a Validation Library for all PUT/POST Routes

E.g. https://docs.python-cerberus.org/

cerberus looks great!

There is also https://pypi.org/project/schema/ but schema seems to be a bit over-engineered for my taste.

Commits associated with this issue are accidentily mixed up with issue #34 .

Reduce Data Transfer (Backend)

Currently with most requests, the result gets send back to the client in the form of the full account/calls data. The frontend state changes only a little bit (e.g. fulfilling a call).

A full fetch after every operation is totally unnecessary!

Goal: Further reduced server load by reducing the amount fetching data that the client already has.

• Account Form
• Filter Settings
• Calls list (accept, fulfill, reject)

Automated Testing (Backend)

Create Test environment: Separate Environment variables and separate testing database.

Add test scripts to backend, testing all API endpoints of the backend.

Unit tests for enqueuing and dequeuing already exists but they are not fully up to date!

Enqueuing of Calls

Add every - for now - incoming call to the local/global call queue.

Actually all three queues (see details tab) are in one single collection with clever querying.

Add phone number (+verification) (Backend)

Add all database fields.

Test out the Twilio SMS API.

Implement the actual SMS verification trigger.

Add REST-endpoint to enter phone number/resend verification.

Receive Calls (Backend)

Replace the current survey with the actual hotline

Receive calls and store/update the caller profile as well as the call record in our database.

Style Verification Email Properly

For now pure html must do it.

Future: Twilio offers templates for emails.

Code Documentation (Backend)

Cleanup - Support Functions

Currently most directories have their own file support_functions.py.

This is very confusing because these support functions do not get used exclusively by this directory but also across directories.

Goal of this refactoring: Support Functions into separate directory and well sorted with clean imports.

Implement Online/Offline Switch (Backend)

Online = Calls get forwarded. Going online is only possible if the number is confirmed!

When Helper does not pick up his phone the call is not fully rejected (still appears in calls list)

Connect "Accept Call" Button and Dequeuing

Automatic Redirect from HTTP to HTTPS

Multiple API Keys for Different Websites for one User

Add one field (e.g. "service") to api key documents.

Refactor MongoDB Database Structure for more efficient queries (JOIN AS)

Cannot change call comment when call is fulfilled.

Really simple fix inside rest_call.py.

Concept for a proper RESTful API

Document this API with https://swagger.io/