This is a prototype solution for user event tracking system.
It's built using Node, Express, and TypeScript.
The solution uses core domain, service, and repository abstractions as its design pattern.
express
app
router
core
event
user
userEvent
service
log
validators
event
user
userEvent
infrastructure
repos
event
user
userEvent
Clone the latest sources from GitHub.
git clone https://github.com/pacjman/api-node-userevents.gitInstall solution dependencies.
npm installTo build solution locally type the following into your shell:
npm run buildTo run solution locally type the following in your shell:
npm run startPostman collection & env are included which cover the expected api functionality: here.
These could be improved to cover more scenarios and different outcomes.
The collection covers a few areas.
- "sanity checks" to exercise the request validators are sane.
- "create checks" to exercise the repository logic works.
- "v1" to reflect supported operations in RESTful api with sample uses.
/v1
/event
GET - report known events
200/OK w/ payload
POST - save an event
200/OK when event created successfully
204/NO CONTENT when event already exists
+ server warning logged
400/BAD REQUEST when invalid request criteria given
- invalid request model
- invalid or missing event type
/user
GET - report known user events
(optional query string filters. zero, one, or both can be employed per request)
email query parameter to optionally filter by email address
created date parameter to optionally filter by arbitrary date
which covers yesterday requirement
200/OK w/ user event payload
400/BAD REQUEST when invalid request criteria given
- invalid request model
- invalid email
- invalid created date
POST - save user event
200/OK when user event created successfully
400/BAD REQUEST when invalid request criteria given
- invalid request model
- invalid user
- invalid event
/user
GET - report known users
2OO/OK w/ payload
401/UNAUTHORIZED response when client not authorized by expected api key (shared)
POST - save a user
200/OK response when user created successfully
204/NO CONTENT reponse when user already exists
+ server warning logged
/ping
GET - simple uptime check
200/OK response w/ "PONG" payload
POST v1/event
{
"type": "LOGIN"
}
POST v1/user
{
"email": "[email protected]",
"password": "passwordIsPizza",
"phone": "503-525-9555"
}
POST v1/event/user
{
"type": "LOGIN",
"email": "[email protected]"
}
- Api is not secured, should it be? One of the api endpoints employs simple api key, & could be adapted across endpoints.
- Email and event type are case-sensitive matches. Should one or both be case insensitive?
- Should password be required to persist a user event? Currently not required.
- Password reported from
GET /v1/userendpoint, not the best security. Should the password be hashed and/or omitted? For reporting? For storage?
- Load/Concurrency testing. Not considered in prototype.
- Design emphasizes an extensible single responsibility pattern. For example, one or more repositories could be backed by a different database technology like sqlite or mysql.
- Prototype is a bit clumsy/verbose and could be streamlined using middleware abstraction to improve code readability.
- The solution includes Dockerized container option and simple deployment ferry using ssh.
- Inspect the
.envfile forx-api-key. This value is required as client header value. (See postman tests for sample use on routeGET /v1/user)
cat .env
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent