Backend Challenge

Create a service to allowed to filter the data obtained from an external API that does not allow the filter of any kind, the data of this is updated every N hours, in the update they can disappear or add elements.

Based on the example build filters for each of these categories id, eyeColor, tags,

To complete the execution, you must work on the ./src folder, you can add as many files and dependencies as required. In the same way, images can be added to the Dockerfile if a service is required, eg databases.

It can include databases, cronjobs, system scripts, etc. if necessary, the important thing is to provide filtering speed, up-to-date and consistent data.

URLs

The base code must be completed for the following URLs to work correctly, the first returns a single element, the second all matches.

/users/:id
/users?filter=value

You can explore the tests to learn a little about the expected performance.

Sample data

[{
  "_id": "5f7e0c4bc17a34141a957b59",
  "index": 0,
  "guid": "8e4ba647-a4da-4d45-b92a-6d9230484227",
  "isActive": false,
  "balance": "$2,648.30",
  "picture": "http://placehold.it/32x32",
  "age": 23,
  "eyeColor": "blue", // one of ("blue", "brown", "green")
  "name": {
    "first": "Roslyn",
    "last": "Pickett"
  },
  "company": "EWAVES",
  "email": "roslyn.pickett@ewaves.me",
  "phone": "+1 (856) 400-3165",
  "address": "479 Sumner Place, Vowinckel, Puerto Rico, 4398",
  "about": "Mollit eu voluptate qui do duis elit officia anim.",
  "registered": "Friday, July 24, 2015 8:18 PM",
  "latitude": "-28.502876",
  "longitude": "-64.265012",
  "tags": [ "irure", "est", "aute", "cillum", "dolore" ], // dynamic dic
  "range": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ],
  "friends": [
    { "id": 0, "name": "Sandoval Sawyer" },
    { "id": 1, "name": "Bernadine Bass" },
    { "id": 2, "name": "Bobbie Lee" }
  ],
  "greeting": "Hello, Roslyn! You have 9 unread messages.",
  "favoriteFruit": "strawberry" // one of ('apple', 'banana', 'strawberry')
}]

Extra points

Extra points, Improve the score.

Filtered by geo-zone [latitude, longitude]
Date range on registered
Filtered by friends by name
Filtering by multiple tags (like / users? Tags = value1, value2, value3)
Be able to combine two or more filters (like / users? Filter = value & filter2 = value2)
Sort by date of registration registered
Include cache and/or search optimization
Complement the tests
Understand and adhere to the style code
Constant and clear commis

Run enviroment

# before to start make a fork
git clone https://github.com/{{githubuser}}/backend-challenge
cd backend-challenge
docker-compose build
docker-compose up

# To run test
docker ps # To show id of containers `backend-challenge_src`
docker exec -it container_id bash
npm run test

Delivery process

First, you must create a fork of this repository
Works and sends constant commits to the repository in personal
Send a pull request to the original repo (extra points)
Send the address of your fork (the repo in your user)

Initial Setup

make a .env folder and set the environment fields in it

 NODE_ENV = test

 TEST_USERNAME = <test_user>
 TEST_PASS = <test_user_password>

 # Example using MongoDB Atlas

 # MONGODB_URI = mongodb+srv://<username>:<password>@<DB_URL>/<database_name>?retryWrites=true&w=majority
 # MONGODB_DB = <db_name>

To Run API

Intall the dependencies via npm install
Run the Server - npm start
Run the worker Worker - npm run worker (Currently set to run every 1 min, can be modified as needed)

API endpoint syntax and URL formats

Tag filter /users?tags = <value1, value2, value3,...value100>
Id filter /users?id = <userID>
EyeColor filter /users?eyecolor = <eyeColor>
Friend Name filter /users?friend = <friendName>
Geozone filter /users?geozone=<longitude>,<latitude>
Date range from /users?registered = <StartDate> - <EndDate>, any correct date format is ok ,(startDate < endDate)
Sort by date of registration /users?sortDate = <asc> , default is dsc order
Two or more filters (like /users?filter = <value> & filter2 = <value2>)

Performance Related additions

Included indexing to optimze search
Auto-connect Database failure if anytime happens
Filters options are case-insensitive, to give more flexiblity
Dates can be of any correct format type, to give more flexiblity
Worker (cron-job) task will only run after it gets connected to the database, otherwise it will try reconnect first

rahul3v / backend-challenge